Actual source code: petscoptions.h
petsc-3.7.5 2017-01-01
1: /*
2: Routines to determine options set in the options database.
3: */
6: #include <petscsys.h>
7: #include <petscviewertypes.h>
9: typedef struct _n_PetscOptions* PetscOptions;
10: PETSC_EXTERN PetscErrorCode PetscOptionsCreate(PetscOptions *);
11: PETSC_EXTERN PetscErrorCode PetscOptionsDestroy(PetscOptions *);
13: PETSC_EXTERN PetscErrorCode PetscOptionsHasName(PetscOptions,const char[],const char[],PetscBool *);
14: PETSC_EXTERN PetscErrorCode PetscOptionsGetInt(PetscOptions,const char[],const char [],PetscInt *,PetscBool *);
15: PETSC_EXTERN PetscErrorCode PetscOptionsGetBool(PetscOptions,const char[],const char [],PetscBool *,PetscBool *);
16: PETSC_EXTERN PetscErrorCode PetscOptionsGetReal(PetscOptions,const char[],const char[],PetscReal *,PetscBool *);
17: PETSC_EXTERN PetscErrorCode PetscOptionsGetScalar(PetscOptions,const char[],const char[],PetscScalar *,PetscBool *);
18: PETSC_EXTERN PetscErrorCode PetscOptionsGetIntArray(PetscOptions,const char[],const char[],PetscInt[],PetscInt *,PetscBool *);
19: PETSC_EXTERN PetscErrorCode PetscOptionsGetRealArray(PetscOptions,const char[],const char[],PetscReal[],PetscInt *,PetscBool *);
20: PETSC_EXTERN PetscErrorCode PetscOptionsGetScalarArray(PetscOptions,const char[],const char[],PetscScalar[],PetscInt *,PetscBool *);
21: PETSC_EXTERN PetscErrorCode PetscOptionsGetBoolArray(PetscOptions,const char[],const char[],PetscBool [],PetscInt *,PetscBool *);
22: PETSC_EXTERN PetscErrorCode PetscOptionsGetString(PetscOptions,const char[],const char[],char[],size_t,PetscBool *);
23: PETSC_EXTERN PetscErrorCode PetscOptionsGetStringArray(PetscOptions,const char[],const char[],char*[],PetscInt*,PetscBool *);
24: PETSC_EXTERN PetscErrorCode PetscOptionsGetEList(PetscOptions,const char[],const char[],const char*const*,PetscInt,PetscInt*,PetscBool *);
25: PETSC_EXTERN PetscErrorCode PetscOptionsGetEnum(PetscOptions,const char[],const char[],const char*const*,PetscEnum*,PetscBool *);
26: PETSC_EXTERN PetscErrorCode PetscOptionsGetEnumArray(PetscOptions,const char[],const char[],const char*const*,PetscEnum*,PetscInt *,PetscBool *);
27: PETSC_EXTERN PetscErrorCode PetscOptionsValidKey(const char[],PetscBool *);
29: PETSC_EXTERN PetscErrorCode PetscOptionsSetAlias(PetscOptions,const char[],const char[]);
30: PETSC_EXTERN PetscErrorCode PetscOptionsSetValue(PetscOptions,const char[],const char[]);
31: PETSC_EXTERN PetscErrorCode PetscOptionsClearValue(PetscOptions,const char[]);
33: PETSC_EXTERN PetscErrorCode PetscOptionsAllUsed(PetscOptions,PetscInt*);
34: PETSC_EXTERN PetscErrorCode PetscOptionsUsed(PetscOptions,const char *,PetscBool*);
35: PETSC_EXTERN PetscErrorCode PetscOptionsLeft(PetscOptions);
36: PETSC_EXTERN PetscErrorCode PetscOptionsView(PetscOptions,PetscViewer);
38: PETSC_EXTERN PetscErrorCode PetscOptionsCreateDefault(void);
39: PETSC_EXTERN PetscErrorCode PetscOptionsInsert(PetscOptions,int*,char ***,const char[]);
40: PETSC_EXTERN PetscErrorCode PetscOptionsInsertFile(MPI_Comm,PetscOptions,const char[],PetscBool );
41: #if defined(PETSC_HAVE_YAML)
42: PETSC_EXTERN PetscErrorCode PetscOptionsInsertFileYAML(MPI_Comm,const char[],PetscBool);
43: #endif
44: PETSC_EXTERN PetscErrorCode PetscOptionsInsertString(PetscOptions,const char[]);
45: PETSC_EXTERN PetscErrorCode PetscOptionsDestroyDefault(void);
46: PETSC_EXTERN PetscErrorCode PetscOptionsClear(PetscOptions);
47: PETSC_EXTERN PetscErrorCode PetscOptionsPrefixPush(PetscOptions,const char[]);
48: PETSC_EXTERN PetscErrorCode PetscOptionsPrefixPop(PetscOptions);
50: PETSC_EXTERN PetscErrorCode PetscOptionsReject(PetscOptions,const char[],const char[]);
51: PETSC_EXTERN PetscErrorCode PetscOptionsGetAll(PetscOptions,char*[]);
53: PETSC_EXTERN PetscErrorCode PetscOptionsGetenv(MPI_Comm,const char[],char[],size_t,PetscBool *);
54: PETSC_EXTERN PetscErrorCode PetscOptionsStringToInt(const char[],PetscInt*);
55: PETSC_EXTERN PetscErrorCode PetscOptionsStringToReal(const char[],PetscReal*);
56: PETSC_EXTERN PetscErrorCode PetscOptionsStringToBool(const char[],PetscBool*);
58: PETSC_EXTERN PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*)(const char[], const char[], void*), void *, PetscErrorCode (*)(void**));
59: PETSC_EXTERN PetscErrorCode PetscOptionsMonitorCancel(void);
60: PETSC_EXTERN PetscErrorCode PetscOptionsMonitorDefault(const char[], const char[], void *);
62: PETSC_EXTERN PetscBool PetscOptionsPublish;
65: /*
66: See manual page for PetscOptionsBegin()
68: PetscOptionsItem and PetscOptionsItems are a single option (such as ksp_type) and a collection of such single
69: options being handled with a PetscOptionsBegin/End()
71: */
72: typedef enum {OPTION_INT,OPTION_BOOL,OPTION_REAL,OPTION_FLIST,OPTION_STRING,OPTION_REAL_ARRAY,OPTION_SCALAR_ARRAY,OPTION_HEAD,OPTION_INT_ARRAY,OPTION_ELIST,OPTION_BOOL_ARRAY,OPTION_STRING_ARRAY} PetscOptionType;
73: typedef struct _n_PetscOptionItem* PetscOptionItem;
74: struct _n_PetscOptionItem{
75: char *option;
76: char *text;
77: void *data; /* used to hold the default value and then any value it is changed to by GUI */
78: PetscFunctionList flist; /* used for available values for PetscOptionsList() */
79: const char *const *list; /* used for available values for PetscOptionsEList() */
80: char nlist; /* number of entries in list */
81: char *man;
82: size_t arraylength; /* number of entries in data in the case that it is an array (of PetscInt etc) */
83: PetscBool set; /* the user has changed this value in the GUI */
84: PetscOptionType type;
85: PetscOptionItem next;
86: char *pman;
87: void *edata;
88: };
90: typedef struct _p_PetscOptionItems {
91: PetscInt count;
92: PetscOptionItem next;
93: char *prefix,*pprefix;
94: char *title;
95: MPI_Comm comm;
96: PetscBool printhelp,changedmethod,alreadyprinted;
97: PetscObject object;
98: PetscOptions options;
99: } PetscOptionItems;
102: /*MC
103: PetscOptionsBegin - Begins a set of queries on the options database that are related and should be
104: displayed on the same window of a GUI that allows the user to set the options interactively. Often one should
105: use PetscObjectOptionsBegin() rather than this call.
107: Synopsis:
108: #include <petscoptions.h>
109: PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[])
111: Collective on MPI_Comm
113: Input Parameters:
114: + comm - communicator that shares GUI
115: . prefix - options prefix for all options displayed on window
116: . title - short descriptive text, for example "Krylov Solver Options"
117: - mansec - section of manual pages for options, for example KSP
119: Level: intermediate
121: Notes: Needs to be ended by a call the PetscOptionsEnd()
122: Can add subheadings with PetscOptionsHead()
124: Developer notes: PetscOptionsPublish is set in PetscOptionsCheckInitial_Private() with -saws_options. When PetscOptionsPublish is set the
125: $ loop between PetscOptionsBegin() and PetscOptionsEnd() is run THREE times with PetscOptionsPublishCount of values -1,0,1 otherwise
126: $ the loop is run ONCE with a PetscOptionsPublishCount of 1.
127: $ = -1 : The PetscOptionsInt() etc just call the PetscOptionsGetInt() etc
128: $ = 0 : The GUI objects are created in PetscOptionsInt() etc and displayed in PetscOptionsEnd() and the options
129: $ database updated updated with user changes; PetscOptionsGetInt() etc are also called
130: $ = 1 : The PetscOptionsInt() etc again call the PetscOptionsGetInt() etc (possibly getting new values), in addition the help message and
131: $ default values are printed if -help was given.
132: $ When PetscOptionsObject.changedmethod is set this causes PetscOptionsPublishCount to be reset to -2 (so in the next loop iteration it is -1)
133: $ and the whole process is repeated. This is to handle when, for example, the KSPType is changed thus changing the list of
134: $ options available so they need to be redisplayed so the user can change the. Chaning PetscOptionsObjects.changedmethod is never
135: $ currently set.
138: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
139: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
140: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
141: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
142: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
143: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
144: PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()
146: M*/
147: #define PetscOptionsBegin(comm,prefix,mess,sec) 0; do {\
148: PetscOptionItems PetscOptionsObjectBase;\
149: PetscOptionItems *PetscOptionsObject = &PetscOptionsObjectBase; \
150: PetscMemzero(PetscOptionsObject,sizeof(PetscOptionItems)); \
151: for (PetscOptionsObject->count=(PetscOptionsPublish?-1:1); PetscOptionsObject->count<2; PetscOptionsObject->count++) {\
152: PetscErrorCode _5_PetscOptionsBegin_Private(PetscOptionsObject,comm,prefix,mess,sec);CHKERRQ(_5_ierr);
154: /*MC
155: PetscObjectOptionsBegin - Begins a set of queries on the options database that are related and should be
156: displayed on the same window of a GUI that allows the user to set the options interactively.
158: Synopsis:
159: #include <petscoptions.h>
160: PetscErrorCode PetscObjectOptionsBegin(PetscObject obj)
162: Collective on PetscObject
164: Input Parameters:
165: . obj - object to set options for
167: Level: intermediate
169: Notes: Needs to be ended by a call the PetscOptionsEnd()
170: Can add subheadings with PetscOptionsHead()
172: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
173: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
174: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
175: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
176: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
177: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
178: PetscOptionsFList(), PetscOptionsEList()
180: M*/
181: #define PetscObjectOptionsBegin(obj) 0; do { \
182: PetscOptionItems PetscOptionsObjectBase;\
183: PetscOptionItems *PetscOptionsObject = &PetscOptionsObjectBase; \
184: PetscOptionsObject->options = ((PetscObject)obj)->options; \
185: for (PetscOptionsObject->count=(PetscOptionsPublish?-1:1); PetscOptionsObject->count<2; PetscOptionsObject->count++) {\
186: PetscErrorCode _5_PetscObjectOptionsBegin_Private(PetscOptionsObject,obj);CHKERRQ(_5_ierr);
188: /*MC
189: PetscOptionsEnd - Ends a set of queries on the options database that are related and should be
190: displayed on the same window of a GUI that allows the user to set the options interactively.
192: Collective on the MPI_Comm used in PetscOptionsBegin()
194: Synopsis:
195: #include <petscoptions.h>
196: PetscErrorCode PetscOptionsEnd(void)
198: Level: intermediate
200: Notes: Needs to be preceded by a call to PetscOptionsBegin() or PetscObjectOptionsBegin()
202: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
203: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
204: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
205: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
206: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
207: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
208: PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()
210: M*/
211: #define PetscOptionsEnd() _5_PetscOptionsEnd_Private(PetscOptionsObject);CHKERRQ(_5_ierr);}} while (0)
213: PETSC_EXTERN PetscErrorCode PetscOptionsBegin_Private(PetscOptionItems *,MPI_Comm,const char[],const char[],const char[]);
214: PETSC_EXTERN PetscErrorCode PetscObjectOptionsBegin_Private(PetscOptionItems *,PetscObject);
215: PETSC_EXTERN PetscErrorCode PetscOptionsEnd_Private(PetscOptionItems *);
216: PETSC_EXTERN PetscErrorCode PetscOptionsHead(PetscOptionItems *,const char[]);
218: /*MC
219: PetscOptionsTail - Ends a section of options begun with PetscOptionsHead()
220: See, for example, KSPSetFromOptions_GMRES().
222: Collective on the communicator passed in PetscOptionsBegin()
224: Synopsis:
225: #include <petscoptions.h>
226: PetscErrorCode PetscOptionsTail(void)
228: Level: intermediate
230: Notes: Must be between a PetscOptionsBegin()/PetscObjectOptionsBegin() and a PetscOptionsEnd()
232: Must be preceded by a call to PetscOptionsHead() in the same function.
234: This needs to be used only if the code below PetscOptionsTail() can be run ONLY once.
235: See, for example, PCSetFromOptions_Composite(). This is a return(0) in it for early exit
236: from the function.
238: This is only for use with the PETSc options GUI
240: Concepts: options database^subheading
242: .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
243: PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
244: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
245: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
246: PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
247: PetscOptionsFList(), PetscOptionsEList(), PetscOptionsEnum()
248: M*/
249: #define PetscOptionsTail() 0; {if (PetscOptionsObject->count != 1) return(0);}
251: #define PetscOptionsEnum(a,b,c,d,e,f,g) PetscOptionsEnum_Private(PetscOptionsObject,a,b,c,d,e,f,g)
252: #define PetscOptionsInt(a,b,c,d,e,f) PetscOptionsInt_Private(PetscOptionsObject,a,b,c,d,e,f)
253: #define PetscOptionsReal(a,b,c,d,e,f) PetscOptionsReal_Private(PetscOptionsObject,a,b,c,d,e,f)
254: #define PetscOptionsScalar(a,b,c,d,e,f) PetscOptionsScalar_Private(PetscOptionsObject,a,b,c,d,e,f)
255: #define PetscOptionsName(a,b,c,d) PetscOptionsName_Private(PetscOptionsObject,a,b,c,d)
256: #define PetscOptionsString(a,b,c,d,e,f,g) PetscOptionsString_Private(PetscOptionsObject,a,b,c,d,e,f,g)
257: #define PetscOptionsBool(a,b,c,d,e,f) PetscOptionsBool_Private(PetscOptionsObject,a,b,c,d,e,f)
258: #define PetscOptionsBoolGroupBegin(a,b,c,d) PetscOptionsBoolGroupBegin_Private(PetscOptionsObject,a,b,c,d)
259: #define PetscOptionsBoolGroup(a,b,c,d) PetscOptionsBoolGroup_Private(PetscOptionsObject,a,b,c,d)
260: #define PetscOptionsBoolGroupEnd(a,b,c,d) PetscOptionsBoolGroupEnd_Private(PetscOptionsObject,a,b,c,d)
261: #define PetscOptionsFList(a,b,c,d,e,f,g,h) PetscOptionsFList_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
262: #define PetscOptionsEList(a,b,c,d,e,f,g,h) PetscOptionsEList_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
263: #define PetscOptionsRealArray(a,b,c,d,e,f) PetscOptionsRealArray_Private(PetscOptionsObject,a,b,c,d,e,f)
264: #define PetscOptionsScalarArray(a,b,c,d,e,f) PetscOptionsScalarArray_Private(PetscOptionsObject,a,b,c,d,e,f)
265: #define PetscOptionsIntArray(a,b,c,d,e,f) PetscOptionsIntArray_Private(PetscOptionsObject,a,b,c,d,e,f)
266: #define PetscOptionsStringArray(a,b,c,d,e,f) PetscOptionsStringArray_Private(PetscOptionsObject,a,b,c,d,e,f)
267: #define PetscOptionsBoolArray(a,b,c,d,e,f) PetscOptionsBoolArray_Private(PetscOptionsObject,a,b,c,d,e,f)
268: #define PetscOptionsEnumArray(a,b,c,d,e,f,g) PetscOptionsEnumArray_Private(PetscOptionsObject,a,b,c,d,e,f,g)
271: PETSC_EXTERN PetscErrorCode PetscOptionsEnum_Private(PetscOptionItems*,const char[],const char[],const char[],const char *const*,PetscEnum,PetscEnum*,PetscBool *);
272: PETSC_EXTERN PetscErrorCode PetscOptionsInt_Private(PetscOptionItems*,const char[],const char[],const char[],PetscInt,PetscInt*,PetscBool *);
273: PETSC_EXTERN PetscErrorCode PetscOptionsReal_Private(PetscOptionItems*,const char[],const char[],const char[],PetscReal,PetscReal*,PetscBool *);
274: PETSC_EXTERN PetscErrorCode PetscOptionsScalar_Private(PetscOptionItems*,const char[],const char[],const char[],PetscScalar,PetscScalar*,PetscBool *);
275: PETSC_EXTERN PetscErrorCode PetscOptionsName_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
276: PETSC_EXTERN PetscErrorCode PetscOptionsString_Private(PetscOptionItems*,const char[],const char[],const char[],const char[],char*,size_t,PetscBool *);
277: PETSC_EXTERN PetscErrorCode PetscOptionsBool_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool ,PetscBool *,PetscBool *);
278: PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroupBegin_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
279: PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroup_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
280: PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroupEnd_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
281: PETSC_EXTERN PetscErrorCode PetscOptionsFList_Private(PetscOptionItems*,const char[],const char[],const char[],PetscFunctionList,const char[],char[],size_t,PetscBool *);
282: PETSC_EXTERN PetscErrorCode PetscOptionsEList_Private(PetscOptionItems*,const char[],const char[],const char[],const char*const*,PetscInt,const char[],PetscInt*,PetscBool *);
283: PETSC_EXTERN PetscErrorCode PetscOptionsRealArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscReal[],PetscInt*,PetscBool *);
284: PETSC_EXTERN PetscErrorCode PetscOptionsScalarArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscScalar[],PetscInt*,PetscBool *);
285: PETSC_EXTERN PetscErrorCode PetscOptionsIntArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscInt[],PetscInt*,PetscBool *);
286: PETSC_EXTERN PetscErrorCode PetscOptionsStringArray_Private(PetscOptionItems*,const char[],const char[],const char[],char*[],PetscInt*,PetscBool *);
287: PETSC_EXTERN PetscErrorCode PetscOptionsBoolArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool [],PetscInt*,PetscBool *);
288: PETSC_EXTERN PetscErrorCode PetscOptionsEnumArray_Private(PetscOptionItems*,const char[],const char[],const char[],const char *const*,PetscEnum[],PetscInt*,PetscBool *);
291: PETSC_EXTERN PetscErrorCode PetscOptionsSetFromOptions(PetscOptions);
292: PETSC_EXTERN PetscErrorCode PetscOptionsSAWsDestroy(void);
294: PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscOptionItems*,PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*);
295: PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscOptionItems*,PetscObject);
296: PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject);
298: #endif