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