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