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