/* Routines to determine options set in the options database. */ #if !defined(__PETSCOPTIONS_H) #define __PETSCOPTIONS_H #include "petscsys.h" PETSC_EXTERN_CXX_BEGIN extern PetscErrorCode PetscOptionsHasName(const char[],const char[],PetscBool *); PetscPolymorphicSubroutine(PetscOptionsHasName,(const char b[],PetscBool *f),(PETSC_NULL,b,f)) extern PetscErrorCode PetscOptionsGetInt(const char[],const char [],PetscInt *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetInt,(const char b[],PetscInt *i,PetscBool *f),(PETSC_NULL,b,i,f)) extern PetscErrorCode PetscOptionsGetBool(const char[],const char [],PetscBool *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetBool,(const char b[],PetscBool *i,PetscBool *f),(PETSC_NULL,b,i,f)) extern PetscErrorCode PetscOptionsGetReal(const char[],const char[],PetscReal *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetReal,(const char b[],PetscReal *i,PetscBool *f),(PETSC_NULL,b,i,f)) extern PetscErrorCode PetscOptionsGetScalar(const char[],const char[],PetscScalar *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetScalar,(const char b[],PetscScalar i[],PetscBool *f),(PETSC_NULL,b,i,f)) extern PetscErrorCode PetscOptionsGetIntArray(const char[],const char[],PetscInt[],PetscInt *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetIntArray,(const char b[],PetscInt i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) extern PetscErrorCode PetscOptionsGetRealArray(const char[],const char[],PetscReal[],PetscInt *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetRealArray,(const char b[],PetscReal i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) extern PetscErrorCode PetscOptionsGetBoolArray(const char[],const char[],PetscBool [],PetscInt *,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetBoolArray,(const char b[],PetscBool i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) extern PetscErrorCode PetscOptionsGetString(const char[],const char[],char[],size_t,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetString,(const char b[],char i[],size_t s,PetscBool *f),(PETSC_NULL,b,i,s,f)) extern PetscErrorCode PetscOptionsGetStringArray(const char[],const char[],char*[],PetscInt*,PetscBool *); PetscPolymorphicSubroutine(PetscOptionsGetStringArray,(const char b[],char *i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) extern PetscErrorCode PetscOptionsGetEList(const char[],const char[],const char*const*,PetscInt,PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsGetEnum(const char[],const char[],const char*const*,PetscEnum*,PetscBool *); extern PetscErrorCode PetscOptionsValidKey(const char[],PetscBool *); extern PetscErrorCode PetscOptionsSetAlias(const char[],const char[]); extern PetscErrorCode PetscOptionsSetValue(const char[],const char[]); extern PetscErrorCode PetscOptionsClearValue(const char[]); extern PetscErrorCode PetscOptionsAllUsed(int*); extern PetscErrorCode PetscOptionsLeft(void); extern PetscErrorCode PetscOptionsView(PetscViewer); extern PetscErrorCode PetscOptionsCreate(void); extern PetscErrorCode PetscOptionsInsert(int*,char ***,const char[]); extern PetscErrorCode PetscOptionsInsertFile(MPI_Comm,const char[],PetscBool ); extern PetscErrorCode PetscOptionsInsertString(const char[]); extern PetscErrorCode PetscOptionsDestroy(void); extern PetscErrorCode PetscOptionsClear(void); extern PetscErrorCode PetscOptionsPrefixPush(const char[]); extern PetscErrorCode PetscOptionsPrefixPop(void); extern PetscErrorCode PetscOptionsReject(const char[],const char[]); extern PetscErrorCode PetscOptionsGetAll(char*[]); extern PetscErrorCode PetscOptionsGetenv(MPI_Comm,const char[],char[],size_t,PetscBool *); extern PetscErrorCode PetscOptionsStringToInt(const char[],PetscInt*); extern PetscErrorCode PetscOptionsStringToReal(const char[],PetscReal*); extern PetscErrorCode PetscOptionsStringToBool(const char[],PetscBool*); extern PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*)(const char[], const char[], void*), void *, PetscErrorCode (*)(void*)); extern PetscErrorCode PetscOptionsMonitorCancel(void); extern PetscErrorCode PetscOptionsMonitorDefault(const char[], const char[], void *); extern PetscBool PetscOptionsPublish; extern PetscInt PetscOptionsPublishCount; /*MC PetscOptionsBegin - Begins a set of queries on the options database that are related and should be displayed on the same window of a GUI that allows the user to set the options interactively. Synopsis: PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[]) Collective on MPI_Comm Input Parameters: + comm - communicator that shares GUI . prefix - options prefix for all options displayed on window . title - short descriptive text, for example "Krylov Solver Options" - mansec - section of manual pages for options, for example KSP Level: intermediate Notes: Needs to be ended by a call the PetscOptionsEnd() Can add subheadings with PetscOptionsHead() Developer notes: PetscOptionsPublish is set in PetscOptionsCheckInitial_Private() with -options_gui. When PetscOptionsPublish is set the $ loop between PetscOptionsBegin() and PetscOptionsEnd() is run THREE times with PetscOptionsPublishCount of values -1,0,1 otherwise $ the loop is run ONCE with a PetscOptionsPublishCount of 1. $ = -1 : The PetscOptionsInt() etc just call the PetscOptionsGetInt() etc $ = 0 : The GUI objects are created in PetscOptionsInt() etc and displayed in PetscOptionsEnd() and the options $ database updated updated with user changes; PetscOptionsGetInt() etc are also called $ = 1 : The PetscOptionsInt() etc again call the PetscOptionsGetInt() etc (possibly getting new values), in addition the help message and $ default values are printed if -help was given. $ When PetscOptionsObject.changedmethod is set this causes PetscOptionsPublishCount to be reset to -2 (so in the next loop iteration it is -1) $ and the whole process is repeated. This is to handle when, for example, the KSPType is changed thus changing the list of $ options available so they need to be redisplayed so the user can change the. Chaning PetscOptionsObjects.changedmethod is never $ currently set. .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsList(), PetscOptionsEList() M*/ #define PetscOptionsBegin(comm,prefix,mess,sec) 0; {\ for (PetscOptionsPublishCount=(PetscOptionsPublish?-1:1); PetscOptionsPublishCount<2; PetscOptionsPublishCount++) {\ PetscErrorCode _5_ierr = PetscOptionsBegin_Private(comm,prefix,mess,sec);CHKERRQ(_5_ierr); /*MC PetscOptionsEnd - Ends a set of queries on the options database that are related and should be displayed on the same window of a GUI that allows the user to set the options interactively. Collective on the MPI_Comm used in PetscOptionsBegin() Synopsis: PetscErrorCode PetscOptionsEnd(void) Level: intermediate Notes: Needs to be preceded by a call to PetscOptionsBegin() .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsList(), PetscOptionsEList() M*/ #define PetscOptionsEnd() _5_ierr = PetscOptionsEnd_Private();CHKERRQ(_5_ierr);}} extern PetscErrorCode PetscOptionsBegin_Private(MPI_Comm,const char[],const char[],const char[]); extern PetscErrorCode PetscOptionsEnd_Private(void); extern PetscErrorCode PetscOptionsHead(const char[]); /*MC PetscOptionsTail - Ends a section of options begun with PetscOptionsHead() See, for example, KSPSetFromOptions_GMRES(). Collective on the communicator passed in PetscOptionsBegin() Synopsis: PetscErrorCode PetscOptionsTail(void) Level: intermediate Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd() Must be preceded by a call to PetscOptionsHead() in the same function. This needs to be used only if the code below PetscOptionsTail() can be run ONLY once. See, for example, PCSetFromOptions_Composite(). This is a return(0) in it for early exit from the function. This is only for use with the PETSc options GUI; which does not currently exist. Concepts: options database^subheading .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsList(), PetscOptionsEList(), PetscOptionsEnum() M*/ #define PetscOptionsTail() 0; {if (PetscOptionsPublishCount != 1) PetscFunctionReturn(0);} extern PetscErrorCode PetscOptionsEnum(const char[],const char[],const char[],const char *const*,PetscEnum,PetscEnum*,PetscBool *); extern PetscErrorCode PetscOptionsInt(const char[],const char[],const char[],PetscInt,PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsReal(const char[],const char[],const char[],PetscReal,PetscReal*,PetscBool *); extern PetscErrorCode PetscOptionsScalar(const char[],const char[],const char[],PetscScalar,PetscScalar*,PetscBool *); extern PetscErrorCode PetscOptionsName(const char[],const char[],const char[],PetscBool *); extern PetscErrorCode PetscOptionsString(const char[],const char[],const char[],const char[],char*,size_t,PetscBool *); extern PetscErrorCode PetscOptionsBool(const char[],const char[],const char[],PetscBool ,PetscBool *,PetscBool *); extern PetscErrorCode PetscOptionsBoolGroupBegin(const char[],const char[],const char[],PetscBool *); extern PetscErrorCode PetscOptionsBoolGroup(const char[],const char[],const char[],PetscBool *); extern PetscErrorCode PetscOptionsBoolGroupEnd(const char[],const char[],const char[],PetscBool *); extern PetscErrorCode PetscOptionsList(const char[],const char[],const char[],PetscFList,const char[],char[],size_t,PetscBool *); extern PetscErrorCode PetscOptionsEList(const char[],const char[],const char[],const char*const*,PetscInt,const char[],PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsRealArray(const char[],const char[],const char[],PetscReal[],PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsIntArray(const char[],const char[],const char[],PetscInt[],PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsStringArray(const char[],const char[],const char[],char*[],PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsBoolArray(const char[],const char[],const char[],PetscBool [],PetscInt*,PetscBool *); extern PetscErrorCode PetscOptionsSetFromOptions(void); extern PetscErrorCode PetscOptionsAMSDestroy(void); PETSC_EXTERN_CXX_END /* See manual page for PetscOptionsBegin() */ typedef enum {OPTION_INT,OPTION_LOGICAL,OPTION_REAL,OPTION_LIST,OPTION_STRING,OPTION_REAL_ARRAY,OPTION_HEAD,OPTION_INT_ARRAY,OPTION_ELIST,OPTION_LOGICAL_ARRAY,OPTION_STRING_ARRAY} PetscOptionType; typedef struct _n_PetscOptions* PetscOptions; struct _n_PetscOptions { char *option; char *text; void *data; /* used to hold the default value and then any value it is changed to by GUI */ PetscFList flist; /* used for available values for PetscOptionsList() */ const char *const *list; /* used for available values for PetscOptionsEList() */ char nlist; /* number of entries in list */ char *man; size_t arraylength; /* number of entries in data in the case that it is an array (of PetscInt etc) */ PetscBool set; /* the user has changed this value in the GUI */ PetscOptionType type; PetscOptions next; char *pman; void *edata; }; typedef struct { PetscOptions next; char *prefix,*pprefix; char *title; MPI_Comm comm; PetscBool printhelp,changedmethod,alreadyprinted; } PetscOptionsObjectType; #endif