Actual source code: petscoptions.h

petsc-master 2018-05-24
Report Typos and Errors
  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 PetscOptionsLeftGet(PetscOptions,PetscInt*,char***,char***);
 37: PETSC_EXTERN PetscErrorCode PetscOptionsLeftRestore(PetscOptions,PetscInt*,char***,char***);
 38: PETSC_EXTERN PetscErrorCode PetscOptionsView(PetscOptions,PetscViewer);

 40: PETSC_EXTERN PetscErrorCode PetscOptionsCreateDefault(void);
 41: PETSC_EXTERN PetscErrorCode PetscOptionsInsert(PetscOptions,int*,char ***,const char[]);
 42: PETSC_EXTERN PetscErrorCode PetscOptionsInsertFile(MPI_Comm,PetscOptions,const char[],PetscBool );
 43: #if defined(PETSC_HAVE_YAML)
 44: PETSC_EXTERN PetscErrorCode PetscOptionsInsertFileYAML(MPI_Comm,const char[],PetscBool);
 45: #endif
 46: PETSC_EXTERN PetscErrorCode PetscOptionsInsertString(PetscOptions,const char[]);
 47: PETSC_EXTERN PetscErrorCode PetscOptionsDestroyDefault(void);
 48: PETSC_EXTERN PetscErrorCode PetscOptionsClear(PetscOptions);
 49: PETSC_EXTERN PetscErrorCode PetscOptionsPrefixPush(PetscOptions,const char[]);
 50: PETSC_EXTERN PetscErrorCode PetscOptionsPrefixPop(PetscOptions);

 52: PETSC_EXTERN PetscErrorCode PetscOptionsReject(PetscOptions,const char[],const char[]);
 53: PETSC_EXTERN PetscErrorCode PetscOptionsGetAll(PetscOptions,char*[]);

 55: PETSC_EXTERN PetscErrorCode PetscOptionsGetenv(MPI_Comm,const char[],char[],size_t,PetscBool  *);
 56: PETSC_EXTERN PetscErrorCode PetscOptionsStringToInt(const char[],PetscInt*);
 57: PETSC_EXTERN PetscErrorCode PetscOptionsStringToReal(const char[],PetscReal*);
 58: PETSC_EXTERN PetscErrorCode PetscOptionsStringToBool(const char[],PetscBool*);

 60: PETSC_EXTERN PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*)(const char[], const char[], void*), void *, PetscErrorCode (*)(void**));
 61: PETSC_EXTERN PetscErrorCode PetscOptionsMonitorCancel(void);
 62: PETSC_EXTERN PetscErrorCode PetscOptionsMonitorDefault(const char[], const char[], void *);

 64: PETSC_EXTERN PetscBool PetscOptionsPublish;


 67: /*
 68:     See manual page for PetscOptionsBegin()

 70:     PetscOptionsItem and PetscOptionsItems are a single option (such as ksp_type) and a collection of such single
 71:   options being handled with a PetscOptionsBegin/End()

 73: */
 74: 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;
 75: typedef struct _n_PetscOptionItem* PetscOptionItem;
 76: struct _n_PetscOptionItem{
 77:   char              *option;
 78:   char              *text;
 79:   void              *data;         /* used to hold the default value and then any value it is changed to by GUI */
 80:   PetscFunctionList flist;         /* used for available values for PetscOptionsList() */
 81:   const char *const *list;        /* used for available values for PetscOptionsEList() */
 82:   char              nlist;         /* number of entries in list */
 83:   char              *man;
 84:   size_t            arraylength;   /* number of entries in data in the case that it is an array (of PetscInt etc) */
 85:   PetscBool         set;           /* the user has changed this value in the GUI */
 86:   PetscOptionType   type;
 87:   PetscOptionItem   next;
 88:   char              *pman;
 89:   void              *edata;
 90: };

 92: typedef struct _p_PetscOptionItems {
 93:   PetscInt         count;
 94:   PetscOptionItem  next;
 95:   char             *prefix,*pprefix;
 96:   char             *title;
 97:   MPI_Comm         comm;
 98:   PetscBool        printhelp,changedmethod,alreadyprinted;
 99:   PetscObject      object;
100:   PetscOptions     options;
101: } PetscOptionItems;


104: /*MC
105:     PetscOptionsBegin - Begins a set of queries on the options database that are related and should be
106:      displayed on the same window of a GUI that allows the user to set the options interactively. Often one should 
107:      use PetscObjectOptionsBegin() rather than this call.

109:    Synopsis:
110:     #include <petscoptions.h>
111:     PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[])

113:     Collective on MPI_Comm

115:   Input Parameters:
116: +   comm - communicator that shares GUI
117: .   prefix - options prefix for all options displayed on window
118: .   title - short descriptive text, for example "Krylov Solver Options"
119: -   mansec - section of manual pages for options, for example KSP

121:   Level: intermediate

123:   Notes:
124:     Needs to be ended by a call the PetscOptionsEnd()
125:          Can add subheadings with PetscOptionsHead()

127:   Developer Notes:
128:     PetscOptionsPublish is set in PetscOptionsCheckInitial_Private() with -saws_options. When PetscOptionsPublish is set the
129: $             loop between PetscOptionsBegin() and PetscOptionsEnd() is run THREE times with PetscOptionsPublishCount of values -1,0,1 otherwise
130: $             the loop is run ONCE with a PetscOptionsPublishCount of 1.
131: $             = -1 : The PetscOptionsInt() etc just call the PetscOptionsGetInt() etc
132: $             = 0  : The GUI objects are created in PetscOptionsInt() etc and displayed in PetscOptionsEnd() and the options
133: $                    database updated updated with user changes; PetscOptionsGetInt() etc are also called
134: $             = 1 : The PetscOptionsInt() etc again call the PetscOptionsGetInt() etc (possibly getting new values), in addition the help message and
135: $                   default values are printed if -help was given.
136: $           When PetscOptionsObject.changedmethod is set this causes PetscOptionsPublishCount to be reset to -2 (so in the next loop iteration it is -1)
137: $           and the whole process is repeated. This is to handle when, for example, the KSPType is changed thus changing the list of
138: $           options available so they need to be redisplayed so the user can change the. Chaning PetscOptionsObjects.changedmethod is never
139: $           currently set.


142: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
143:           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
144:           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
145:           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
146:           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
147:           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
148:           PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()

150: M*/
151: #define    PetscOptionsBegin(comm,prefix,mess,sec) 0; do {\
152:              PetscOptionItems PetscOptionsObjectBase;\
153:              PetscOptionItems *PetscOptionsObject = &PetscOptionsObjectBase; \
154:              PetscMemzero(PetscOptionsObject,sizeof(PetscOptionItems)); \
155:              for (PetscOptionsObject->count=(PetscOptionsPublish?-1:1); PetscOptionsObject->count<2; PetscOptionsObject->count++) {\
156:              PetscErrorCode _5_PetscOptionsBegin_Private(PetscOptionsObject,comm,prefix,mess,sec);CHKERRQ(_5_ierr);

158: /*MC
159:     PetscObjectOptionsBegin - Begins a set of queries on the options database that are related and should be
160:      displayed on the same window of a GUI that allows the user to set the options interactively.

162:    Synopsis:
163:     #include <petscoptions.h>
164:     PetscErrorCode PetscObjectOptionsBegin(PetscObject obj)

166:     Collective on PetscObject

168:   Input Parameters:
169: .   obj - object to set options for

171:   Level: intermediate

173:   Notes:
174:     Needs to be ended by a call the PetscOptionsEnd()
175:          Can add subheadings with PetscOptionsHead()

177: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
178:           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
179:           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
180:           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
181:           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
182:           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
183:           PetscOptionsFList(), PetscOptionsEList()

185: M*/
186: #define PetscObjectOptionsBegin(obj) 0; do {                            \
187:              PetscOptionItems PetscOptionsObjectBase;\
188:              PetscOptionItems *PetscOptionsObject = &PetscOptionsObjectBase; \
189:              PetscOptionsObject->options = ((PetscObject)obj)->options; \
190:              for (PetscOptionsObject->count=(PetscOptionsPublish?-1:1); PetscOptionsObject->count<2; PetscOptionsObject->count++) {\
191:              PetscErrorCode _5_PetscObjectOptionsBegin_Private(PetscOptionsObject,obj);CHKERRQ(_5_ierr);

193: /*MC
194:     PetscOptionsEnd - Ends a set of queries on the options database that are related and should be
195:      displayed on the same window of a GUI that allows the user to set the options interactively.

197:     Collective on the MPI_Comm used in PetscOptionsBegin()

199:    Synopsis:
200:      #include <petscoptions.h>
201:      PetscErrorCode PetscOptionsEnd(void)

203:   Level: intermediate

205:   Notes:
206:     Needs to be preceded by a call to PetscOptionsBegin() or PetscObjectOptionsBegin()

208: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
209:           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
210:           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
211:           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
212:           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
213:           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
214:           PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()

216: M*/
217: #define    PetscOptionsEnd() _5_PetscOptionsEnd_Private(PetscOptionsObject);CHKERRQ(_5_ierr);}} while (0)

219: PETSC_EXTERN PetscErrorCode PetscOptionsBegin_Private(PetscOptionItems *,MPI_Comm,const char[],const char[],const char[]);
220: PETSC_EXTERN PetscErrorCode PetscObjectOptionsBegin_Private(PetscOptionItems *,PetscObject);
221: PETSC_EXTERN PetscErrorCode PetscOptionsEnd_Private(PetscOptionItems *);
222: PETSC_EXTERN PetscErrorCode PetscOptionsHead(PetscOptionItems *,const char[]);

224: /*MC
225:      PetscOptionsTail - Ends a section of options begun with PetscOptionsHead()
226:             See, for example, KSPSetFromOptions_GMRES().

228:    Collective on the communicator passed in PetscOptionsBegin()

230:    Synopsis:
231:      #include <petscoptions.h>
232:      PetscErrorCode PetscOptionsTail(void)

234:   Level: intermediate

236:    Notes:
237:     Must be between a PetscOptionsBegin()/PetscObjectOptionsBegin() and a PetscOptionsEnd()

239:           Must be preceded by a call to PetscOptionsHead() in the same function.

241:           This needs to be used only if the code below PetscOptionsTail() can be run ONLY once.
242:       See, for example, PCSetFromOptions_Composite(). This is a return(0) in it for early exit
243:       from the function.

245:           This is only for use with the PETSc options GUI

247:    Concepts: options database^subheading

249: .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
250:            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
251:           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
252:           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
253:           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
254:           PetscOptionsFList(), PetscOptionsEList(), PetscOptionsEnum()
255: M*/
256: #define    PetscOptionsTail() 0; {if (PetscOptionsObject->count != 1) return(0);}

258: #define PetscOptionsEnum(a,b,c,d,e,f,g) PetscOptionsEnum_Private(PetscOptionsObject,a,b,c,d,e,f,g)
259: #define PetscOptionsInt(a,b,c,d,e,f) PetscOptionsInt_Private(PetscOptionsObject,a,b,c,d,e,f)
260: #define PetscOptionsReal(a,b,c,d,e,f) PetscOptionsReal_Private(PetscOptionsObject,a,b,c,d,e,f)
261: #define PetscOptionsScalar(a,b,c,d,e,f) PetscOptionsScalar_Private(PetscOptionsObject,a,b,c,d,e,f)
262: #define PetscOptionsName(a,b,c,d) PetscOptionsName_Private(PetscOptionsObject,a,b,c,d)
263: #define PetscOptionsString(a,b,c,d,e,f,g) PetscOptionsString_Private(PetscOptionsObject,a,b,c,d,e,f,g)
264: #define PetscOptionsBool(a,b,c,d,e,f) PetscOptionsBool_Private(PetscOptionsObject,a,b,c,d,e,f)
265: #define PetscOptionsBoolGroupBegin(a,b,c,d) PetscOptionsBoolGroupBegin_Private(PetscOptionsObject,a,b,c,d)
266: #define PetscOptionsBoolGroup(a,b,c,d) PetscOptionsBoolGroup_Private(PetscOptionsObject,a,b,c,d)
267: #define PetscOptionsBoolGroupEnd(a,b,c,d) PetscOptionsBoolGroupEnd_Private(PetscOptionsObject,a,b,c,d)
268: #define PetscOptionsFList(a,b,c,d,e,f,g,h) PetscOptionsFList_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
269: #define PetscOptionsEList(a,b,c,d,e,f,g,h) PetscOptionsEList_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
270: #define PetscOptionsRealArray(a,b,c,d,e,f) PetscOptionsRealArray_Private(PetscOptionsObject,a,b,c,d,e,f)
271: #define PetscOptionsScalarArray(a,b,c,d,e,f) PetscOptionsScalarArray_Private(PetscOptionsObject,a,b,c,d,e,f)
272: #define PetscOptionsIntArray(a,b,c,d,e,f) PetscOptionsIntArray_Private(PetscOptionsObject,a,b,c,d,e,f)
273: #define PetscOptionsStringArray(a,b,c,d,e,f) PetscOptionsStringArray_Private(PetscOptionsObject,a,b,c,d,e,f)
274: #define PetscOptionsBoolArray(a,b,c,d,e,f) PetscOptionsBoolArray_Private(PetscOptionsObject,a,b,c,d,e,f)
275: #define PetscOptionsEnumArray(a,b,c,d,e,f,g) PetscOptionsEnumArray_Private(PetscOptionsObject,a,b,c,d,e,f,g)


278: PETSC_EXTERN PetscErrorCode PetscOptionsEnum_Private(PetscOptionItems*,const char[],const char[],const char[],const char *const*,PetscEnum,PetscEnum*,PetscBool *);
279: PETSC_EXTERN PetscErrorCode PetscOptionsInt_Private(PetscOptionItems*,const char[],const char[],const char[],PetscInt,PetscInt*,PetscBool *);
280: PETSC_EXTERN PetscErrorCode PetscOptionsReal_Private(PetscOptionItems*,const char[],const char[],const char[],PetscReal,PetscReal*,PetscBool *);
281: PETSC_EXTERN PetscErrorCode PetscOptionsScalar_Private(PetscOptionItems*,const char[],const char[],const char[],PetscScalar,PetscScalar*,PetscBool *);
282: PETSC_EXTERN PetscErrorCode PetscOptionsName_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
283: PETSC_EXTERN PetscErrorCode PetscOptionsString_Private(PetscOptionItems*,const char[],const char[],const char[],const char[],char*,size_t,PetscBool *);
284: PETSC_EXTERN PetscErrorCode PetscOptionsBool_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool ,PetscBool *,PetscBool *);
285: PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroupBegin_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
286: PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroup_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
287: PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroupEnd_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool *);
288: PETSC_EXTERN PetscErrorCode PetscOptionsFList_Private(PetscOptionItems*,const char[],const char[],const char[],PetscFunctionList,const char[],char[],size_t,PetscBool *);
289: PETSC_EXTERN PetscErrorCode PetscOptionsEList_Private(PetscOptionItems*,const char[],const char[],const char[],const char*const*,PetscInt,const char[],PetscInt*,PetscBool *);
290: PETSC_EXTERN PetscErrorCode PetscOptionsRealArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscReal[],PetscInt*,PetscBool *);
291: PETSC_EXTERN PetscErrorCode PetscOptionsScalarArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscScalar[],PetscInt*,PetscBool *);
292: PETSC_EXTERN PetscErrorCode PetscOptionsIntArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscInt[],PetscInt*,PetscBool *);
293: PETSC_EXTERN PetscErrorCode PetscOptionsStringArray_Private(PetscOptionItems*,const char[],const char[],const char[],char*[],PetscInt*,PetscBool *);
294: PETSC_EXTERN PetscErrorCode PetscOptionsBoolArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool [],PetscInt*,PetscBool *);
295: PETSC_EXTERN PetscErrorCode PetscOptionsEnumArray_Private(PetscOptionItems*,const char[],const char[],const char[],const char *const*,PetscEnum[],PetscInt*,PetscBool *);


298: PETSC_EXTERN PetscErrorCode PetscOptionsSetFromOptions(PetscOptions);
299: PETSC_EXTERN PetscErrorCode PetscOptionsSAWsDestroy(void);

301: PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscOptionItems*,PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*);
302: PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscOptionItems*,PetscObject);
303: PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject);

305: #endif