1 /* 2 Routines to determine options set in the options database. 3 */ 4 #if !defined(__PETSCOPTIONS_H) 5 #define __PETSCOPTIONS_H 6 #include "petscsys.h" 7 PETSC_EXTERN_CXX_BEGIN 8 9 extern PetscErrorCode PetscOptionsHasName(const char[],const char[],PetscBool *); 10 PetscPolymorphicSubroutine(PetscOptionsHasName,(const char b[],PetscBool *f),(PETSC_NULL,b,f)) 11 extern PetscErrorCode PetscOptionsGetInt(const char[],const char [],PetscInt *,PetscBool *); 12 PetscPolymorphicSubroutine(PetscOptionsGetInt,(const char b[],PetscInt *i,PetscBool *f),(PETSC_NULL,b,i,f)) 13 extern PetscErrorCode PetscOptionsGetBool(const char[],const char [],PetscBool *,PetscBool *); 14 PetscPolymorphicSubroutine(PetscOptionsGetBool,(const char b[],PetscBool *i,PetscBool *f),(PETSC_NULL,b,i,f)) 15 extern PetscErrorCode PetscOptionsGetReal(const char[],const char[],PetscReal *,PetscBool *); 16 PetscPolymorphicSubroutine(PetscOptionsGetReal,(const char b[],PetscReal *i,PetscBool *f),(PETSC_NULL,b,i,f)) 17 extern PetscErrorCode PetscOptionsGetScalar(const char[],const char[],PetscScalar *,PetscBool *); 18 PetscPolymorphicSubroutine(PetscOptionsGetScalar,(const char b[],PetscScalar i[],PetscBool *f),(PETSC_NULL,b,i,f)) 19 extern PetscErrorCode PetscOptionsGetIntArray(const char[],const char[],PetscInt[],PetscInt *,PetscBool *); 20 PetscPolymorphicSubroutine(PetscOptionsGetIntArray,(const char b[],PetscInt i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) 21 extern PetscErrorCode PetscOptionsGetRealArray(const char[],const char[],PetscReal[],PetscInt *,PetscBool *); 22 PetscPolymorphicSubroutine(PetscOptionsGetRealArray,(const char b[],PetscReal i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) 23 extern PetscErrorCode PetscOptionsGetBoolArray(const char[],const char[],PetscBool [],PetscInt *,PetscBool *); 24 PetscPolymorphicSubroutine(PetscOptionsGetBoolArray,(const char b[],PetscBool i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) 25 extern PetscErrorCode PetscOptionsGetString(const char[],const char[],char[],size_t,PetscBool *); 26 PetscPolymorphicSubroutine(PetscOptionsGetString,(const char b[],char i[],size_t s,PetscBool *f),(PETSC_NULL,b,i,s,f)) 27 extern PetscErrorCode PetscOptionsGetStringArray(const char[],const char[],char*[],PetscInt*,PetscBool *); 28 PetscPolymorphicSubroutine(PetscOptionsGetStringArray,(const char b[],char *i[],PetscInt *ii,PetscBool *f),(PETSC_NULL,b,i,ii,f)) 29 extern PetscErrorCode PetscOptionsGetEList(const char[],const char[],const char*const*,PetscInt,PetscInt*,PetscBool *); 30 extern PetscErrorCode PetscOptionsGetEnum(const char[],const char[],const char*const*,PetscEnum*,PetscBool *); 31 extern PetscErrorCode PetscOptionsValidKey(const char[],PetscBool *); 32 33 extern PetscErrorCode PetscOptionsSetAlias(const char[],const char[]); 34 extern PetscErrorCode PetscOptionsSetValue(const char[],const char[]); 35 extern PetscErrorCode PetscOptionsClearValue(const char[]); 36 37 extern PetscErrorCode PetscOptionsAllUsed(int*); 38 extern PetscErrorCode PetscOptionsLeft(void); 39 extern PetscErrorCode PetscOptionsView(PetscViewer); 40 41 extern PetscErrorCode PetscOptionsCreate(void); 42 extern PetscErrorCode PetscOptionsInsert(int*,char ***,const char[]); 43 extern PetscErrorCode PetscOptionsInsertFile(MPI_Comm,const char[],PetscBool ); 44 extern PetscErrorCode PetscOptionsInsertString(const char[]); 45 extern PetscErrorCode PetscOptionsDestroy(void); 46 extern PetscErrorCode PetscOptionsClear(void); 47 extern PetscErrorCode PetscOptionsPrefixPush(const char[]); 48 extern PetscErrorCode PetscOptionsPrefixPop(void); 49 50 extern PetscErrorCode PetscOptionsReject(const char[],const char[]); 51 extern PetscErrorCode PetscOptionsGetAll(char*[]); 52 53 extern PetscErrorCode PetscOptionsGetenv(MPI_Comm,const char[],char[],size_t,PetscBool *); 54 extern PetscErrorCode PetscOptionsStringToInt(const char[],PetscInt*); 55 extern PetscErrorCode PetscOptionsStringToReal(const char[],PetscReal*); 56 extern PetscErrorCode PetscOptionsStringToBool(const char[],PetscBool*); 57 58 extern PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*)(const char[], const char[], void*), void *, PetscErrorCode (*)(void*)); 59 extern PetscErrorCode PetscOptionsMonitorCancel(void); 60 extern PetscErrorCode PetscOptionsMonitorDefault(const char[], const char[], void *); 61 62 extern PetscBool PetscOptionsPublish; 63 extern PetscInt PetscOptionsPublishCount; 64 65 /*MC 66 PetscOptionsBegin - Begins a set of queries on the options database that are related and should be 67 displayed on the same window of a GUI that allows the user to set the options interactively. 68 69 Synopsis: PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[]) 70 71 Collective on MPI_Comm 72 73 Input Parameters: 74 + comm - communicator that shares GUI 75 . prefix - options prefix for all options displayed on window 76 . title - short descriptive text, for example "Krylov Solver Options" 77 - mansec - section of manual pages for options, for example KSP 78 79 Level: intermediate 80 81 Notes: Needs to be ended by a call the PetscOptionsEnd() 82 Can add subheadings with PetscOptionsHead() 83 84 Developer notes: PetscOptionsPublish is set in PetscOptionsCheckInitial_Private() with -options_gui. When PetscOptionsPublish is set the 85 $ loop between PetscOptionsBegin() and PetscOptionsEnd() is run THREE times with PetscOptionsPublishCount of values -1,0,1 otherwise 86 $ the loop is run ONCE with a PetscOptionsPublishCount of 1. 87 $ = -1 : The PetscOptionsInt() etc just call the PetscOptionsGetInt() etc 88 $ = 0 : The GUI objects are created in PetscOptionsInt() etc and displayed in PetscOptionsEnd() and the options 89 $ database updated updated with user changes; PetscOptionsGetInt() etc are also called 90 $ = 1 : The PetscOptionsInt() etc again call the PetscOptionsGetInt() etc (possibly getting new values), in addition the help message and 91 $ default values are printed if -help was given. 92 $ When PetscOptionsObject.changedmethod is set this causes PetscOptionsPublishCount to be reset to -2 (so in the next loop iteration it is -1) 93 $ and the whole process is repeated. This is to handle when, for example, the KSPType is changed thus changing the list of 94 $ options available so they need to be redisplayed so the user can change the. Chaning PetscOptionsObjects.changedmethod is never 95 $ currently set. 96 97 98 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 99 PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 100 PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 101 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 102 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 103 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 104 PetscOptionsList(), PetscOptionsEList() 105 106 M*/ 107 #define PetscOptionsBegin(comm,prefix,mess,sec) 0; {\ 108 for (PetscOptionsPublishCount=(PetscOptionsPublish?-1:1); PetscOptionsPublishCount<2; PetscOptionsPublishCount++) {\ 109 PetscErrorCode _5_ierr = PetscOptionsBegin_Private(comm,prefix,mess,sec);CHKERRQ(_5_ierr); 110 111 /*MC 112 PetscOptionsEnd - Ends a set of queries on the options database that are related and should be 113 displayed on the same window of a GUI that allows the user to set the options interactively. 114 115 Collective on the MPI_Comm used in PetscOptionsBegin() 116 117 Synopsis: PetscErrorCode PetscOptionsEnd(void) 118 119 Level: intermediate 120 121 Notes: Needs to be preceded by a call to PetscOptionsBegin() 122 123 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 124 PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 125 PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 126 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 127 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 128 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 129 PetscOptionsList(), PetscOptionsEList() 130 131 M*/ 132 #define PetscOptionsEnd() _5_ierr = PetscOptionsEnd_Private();CHKERRQ(_5_ierr);}} 133 134 extern PetscErrorCode PetscOptionsBegin_Private(MPI_Comm,const char[],const char[],const char[]); 135 extern PetscErrorCode PetscOptionsEnd_Private(void); 136 extern PetscErrorCode PetscOptionsHead(const char[]); 137 138 /*MC 139 PetscOptionsTail - Ends a section of options begun with PetscOptionsHead() 140 See, for example, KSPSetFromOptions_GMRES(). 141 142 Collective on the communicator passed in PetscOptionsBegin() 143 144 Synopsis: PetscErrorCode PetscOptionsTail(void) 145 146 Level: intermediate 147 148 Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd() 149 150 Must be preceded by a call to PetscOptionsHead() in the same function. 151 152 This needs to be used only if the code below PetscOptionsTail() can be run ONLY once. 153 See, for example, PCSetFromOptions_Composite(). This is a return(0) in it for early exit 154 from the function. 155 156 This is only for use with the PETSc options GUI; which does not currently exist. 157 158 Concepts: options database^subheading 159 160 .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 161 PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 162 PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 163 PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 164 PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 165 PetscOptionsList(), PetscOptionsEList(), PetscOptionsEnum() 166 M*/ 167 #define PetscOptionsTail() 0; {if (PetscOptionsPublishCount != 1) PetscFunctionReturn(0);} 168 169 extern PetscErrorCode PetscOptionsEnum(const char[],const char[],const char[],const char *const*,PetscEnum,PetscEnum*,PetscBool *); 170 extern PetscErrorCode PetscOptionsInt(const char[],const char[],const char[],PetscInt,PetscInt*,PetscBool *); 171 extern PetscErrorCode PetscOptionsReal(const char[],const char[],const char[],PetscReal,PetscReal*,PetscBool *); 172 extern PetscErrorCode PetscOptionsScalar(const char[],const char[],const char[],PetscScalar,PetscScalar*,PetscBool *); 173 extern PetscErrorCode PetscOptionsName(const char[],const char[],const char[],PetscBool *); 174 extern PetscErrorCode PetscOptionsString(const char[],const char[],const char[],const char[],char*,size_t,PetscBool *); 175 extern PetscErrorCode PetscOptionsBool(const char[],const char[],const char[],PetscBool ,PetscBool *,PetscBool *); 176 extern PetscErrorCode PetscOptionsBoolGroupBegin(const char[],const char[],const char[],PetscBool *); 177 extern PetscErrorCode PetscOptionsBoolGroup(const char[],const char[],const char[],PetscBool *); 178 extern PetscErrorCode PetscOptionsBoolGroupEnd(const char[],const char[],const char[],PetscBool *); 179 extern PetscErrorCode PetscOptionsList(const char[],const char[],const char[],PetscFList,const char[],char[],size_t,PetscBool *); 180 extern PetscErrorCode PetscOptionsEList(const char[],const char[],const char[],const char*const*,PetscInt,const char[],PetscInt*,PetscBool *); 181 extern PetscErrorCode PetscOptionsRealArray(const char[],const char[],const char[],PetscReal[],PetscInt*,PetscBool *); 182 extern PetscErrorCode PetscOptionsIntArray(const char[],const char[],const char[],PetscInt[],PetscInt*,PetscBool *); 183 extern PetscErrorCode PetscOptionsStringArray(const char[],const char[],const char[],char*[],PetscInt*,PetscBool *); 184 extern PetscErrorCode PetscOptionsBoolArray(const char[],const char[],const char[],PetscBool [],PetscInt*,PetscBool *); 185 186 extern PetscErrorCode PetscOptionsSetFromOptions(void); 187 extern PetscErrorCode PetscOptionsAMSDestroy(void); 188 PETSC_EXTERN_CXX_END 189 190 /* 191 See manual page for PetscOptionsBegin() 192 */ 193 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; 194 typedef struct _n_PetscOptions* PetscOptions; 195 struct _n_PetscOptions { 196 char *option; 197 char *text; 198 void *data; /* used to hold the default value and then any value it is changed to by GUI */ 199 PetscFList flist; /* used for available values for PetscOptionsList() */ 200 const char *const *list; /* used for available values for PetscOptionsEList() */ 201 char nlist; /* number of entries in list */ 202 char *man; 203 size_t arraylength; /* number of entries in data in the case that it is an array (of PetscInt etc) */ 204 PetscBool set; /* the user has changed this value in the GUI */ 205 PetscOptionType type; 206 PetscOptions next; 207 char *pman; 208 void *edata; 209 }; 210 211 typedef struct { 212 PetscOptions next; 213 char *prefix,*pprefix; 214 char *title; 215 MPI_Comm comm; 216 PetscBool printhelp,changedmethod,alreadyprinted; 217 } PetscOptionsObjectType; 218 #endif 219