173fca5a0SBarry Smith /* Define Feature test macros to make sure atoll is available (SVr4, POSIX.1-2001, 4.3BSD, C99), not in (C89 and POSIX.1-1996) */ 20039db0dSBarry Smith #define PETSC_DESIRE_FEATURE_TEST_MACROS /* for atoll() */ 3e5ea902fSJed Brown 4e5c89e4eSSatish Balay /* 53fc1eb6aSBarry Smith These routines simplify the use of command line, file options, etc., and are used to manipulate the options database. 63fc1eb6aSBarry Smith This provides the low-level interface, the high level interface is in aoptions.c 7e5c89e4eSSatish Balay 83fc1eb6aSBarry Smith Some routines use regular malloc and free because it cannot know what malloc is requested with the 93fc1eb6aSBarry Smith options database until it has already processed the input. 10e5c89e4eSSatish Balay */ 11e5c89e4eSSatish Balay 12af0996ceSBarry Smith #include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/ 13665c2dedSJed Brown #include <petscviewer.h> 14ad1ac5ecSJed Brown #include <ctype.h> 15e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MALLOC_H) 16e5c89e4eSSatish Balay #include <malloc.h> 17e5c89e4eSSatish Balay #endif 18ef279fd6SBarry Smith #if defined(PETSC_HAVE_STRINGS_H) 19ef279fd6SBarry Smith # include <strings.h> /* strcasecmp */ 20ef279fd6SBarry Smith #endif 21e5c89e4eSSatish Balay 222d747510SLisandro Dalcin #if defined(PETSC_HAVE_STRCASECMP) 232d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) strcasecmp(a,b) 242d747510SLisandro Dalcin #elif defined(PETSC_HAVE_STRICMP) 252d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) stricmp(a,b) 262d747510SLisandro Dalcin #else 272d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) Error_strcasecmp_not_found 282d747510SLisandro Dalcin #endif 292d747510SLisandro Dalcin 302d747510SLisandro Dalcin #include <petsc/private/hashtable.h> 312d747510SLisandro Dalcin 322d747510SLisandro Dalcin /* This assumes ASCII encoding and ignores locale settings */ 332d747510SLisandro Dalcin /* Using tolower() is about 2X slower in microbenchmarks */ 349fbee547SJacob Faibussowitsch static inline int PetscToLower(int c) 352d747510SLisandro Dalcin { 362d747510SLisandro Dalcin return ((c >= 'A') & (c <= 'Z')) ? c + 'a' - 'A' : c; 372d747510SLisandro Dalcin } 382d747510SLisandro Dalcin 392d747510SLisandro Dalcin /* Bob Jenkins's one at a time hash function (case-insensitive) */ 409fbee547SJacob Faibussowitsch static inline unsigned int PetscOptHash(const char key[]) 412d747510SLisandro Dalcin { 422d747510SLisandro Dalcin unsigned int hash = 0; 432d747510SLisandro Dalcin while (*key) { 442d747510SLisandro Dalcin hash += PetscToLower(*key++); 452d747510SLisandro Dalcin hash += hash << 10; 462d747510SLisandro Dalcin hash ^= hash >> 6; 472d747510SLisandro Dalcin } 482d747510SLisandro Dalcin hash += hash << 3; 492d747510SLisandro Dalcin hash ^= hash >> 11; 502d747510SLisandro Dalcin hash += hash << 15; 512d747510SLisandro Dalcin return hash; 522d747510SLisandro Dalcin } 532d747510SLisandro Dalcin 549fbee547SJacob Faibussowitsch static inline int PetscOptEqual(const char a[],const char b[]) 552d747510SLisandro Dalcin { 562d747510SLisandro Dalcin return !PetscOptNameCmp(a,b); 572d747510SLisandro Dalcin } 582d747510SLisandro Dalcin 592d747510SLisandro Dalcin KHASH_INIT(HO, kh_cstr_t, int, 1, PetscOptHash, PetscOptEqual) 602d747510SLisandro Dalcin 61e5c89e4eSSatish Balay /* 623fc1eb6aSBarry Smith This table holds all the options set by the user. For simplicity, we use a static size database 63e5c89e4eSSatish Balay */ 64c5c1f447SLisandro Dalcin #define MAXOPTNAME PETSC_MAX_OPTION_NAME 65e5c89e4eSSatish Balay #define MAXOPTIONS 512 66e5c89e4eSSatish Balay #define MAXALIASES 25 6774e0666dSJed Brown #define MAXPREFIXES 25 682d747510SLisandro Dalcin #define MAXOPTIONSMONITORS 5 69e5c89e4eSSatish Balay 704416b707SBarry Smith struct _n_PetscOptions { 713de2bfdfSBarry Smith PetscOptions previous; 722d747510SLisandro Dalcin int N; /* number of options */ 732d747510SLisandro Dalcin char *names[MAXOPTIONS]; /* option names */ 742d747510SLisandro Dalcin char *values[MAXOPTIONS]; /* option values */ 752d747510SLisandro Dalcin PetscBool used[MAXOPTIONS]; /* flag option use */ 76c5b5d8d5SVaclav Hapla PetscBool precedentProcessed; 77081c24baSBoyana Norris 782d747510SLisandro Dalcin /* Hash table */ 792d747510SLisandro Dalcin khash_t(HO) *ht; 802d747510SLisandro Dalcin 812d747510SLisandro Dalcin /* Prefixes */ 822d747510SLisandro Dalcin int prefixind; 832d747510SLisandro Dalcin int prefixstack[MAXPREFIXES]; 842d747510SLisandro Dalcin char prefix[MAXOPTNAME]; 852d747510SLisandro Dalcin 862d747510SLisandro Dalcin /* Aliases */ 872d747510SLisandro Dalcin int Naliases; /* number or aliases */ 882d747510SLisandro Dalcin char *aliases1[MAXALIASES]; /* aliased */ 892d747510SLisandro Dalcin char *aliases2[MAXALIASES]; /* aliasee */ 902d747510SLisandro Dalcin 912d747510SLisandro Dalcin /* Help */ 922d747510SLisandro Dalcin PetscBool help; /* flag whether "-help" is in the database */ 93d314f959SVaclav Hapla PetscBool help_intro; /* flag whether "-help intro" is in the database */ 942d747510SLisandro Dalcin 952d747510SLisandro Dalcin /* Monitors */ 96c5b5d8d5SVaclav Hapla PetscBool monitorFromOptions, monitorCancel; 97081c24baSBoyana Norris PetscErrorCode (*monitor[MAXOPTIONSMONITORS])(const char[],const char[],void*); /* returns control to user after */ 98c2efdce3SBarry Smith PetscErrorCode (*monitordestroy[MAXOPTIONSMONITORS])(void**); /* */ 99081c24baSBoyana Norris void *monitorcontext[MAXOPTIONSMONITORS]; /* to pass arbitrary user data into monitor */ 100081c24baSBoyana Norris PetscInt numbermonitors; /* to, for instance, detect options being set */ 1014416b707SBarry Smith }; 102e5c89e4eSSatish Balay 103b4205f0bSBarry Smith static PetscOptions defaultoptions = NULL; /* the options database routines query this object for options */ 1042d747510SLisandro Dalcin 105c5b5d8d5SVaclav Hapla /* list of options which preceed others, i.e., are processed in PetscOptionsProcessPrecedentFlags() */ 106d06005cbSLisandro Dalcin static const char *precedentOptions[] = {"-options_monitor","-options_monitor_cancel","-help","-skip_petscrc"}; 107d06005cbSLisandro Dalcin enum PetscPrecedentOption {PO_OPTIONS_MONITOR,PO_OPTIONS_MONITOR_CANCEL,PO_HELP,PO_SKIP_PETSCRC,PO_NUM}; 108c5b5d8d5SVaclav Hapla 109c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsSetValue_Private(PetscOptions,const char[],const char[],int*); 110c5b5d8d5SVaclav Hapla 111081c24baSBoyana Norris /* 112081c24baSBoyana Norris Options events monitor 113081c24baSBoyana Norris */ 1142d747510SLisandro Dalcin static PetscErrorCode PetscOptionsMonitor(PetscOptions options,const char name[],const char value[]) 115e5c89e4eSSatish Balay { 116e5c89e4eSSatish Balay PetscFunctionBegin; 117c5b5d8d5SVaclav Hapla if (!value) value = ""; 1185f80ce2aSJacob Faibussowitsch if (options->monitorFromOptions) CHKERRQ(PetscOptionsMonitorDefault(name,value,NULL)); 1195f80ce2aSJacob Faibussowitsch for (PetscInt i=0; i<options->numbermonitors; i++) CHKERRQ((*options->monitor[i])(name,value,options->monitorcontext[i])); 120e5c89e4eSSatish Balay PetscFunctionReturn(0); 121e5c89e4eSSatish Balay } 122e5c89e4eSSatish Balay 1232d747510SLisandro Dalcin /*@ 1242d747510SLisandro Dalcin PetscOptionsCreate - Creates an empty options database. 125e5c89e4eSSatish Balay 1261c9f3c13SBarry Smith Logically collective 1271c9f3c13SBarry Smith 128e5c89e4eSSatish Balay Output Parameter: 1292d747510SLisandro Dalcin . options - Options database object 130e5c89e4eSSatish Balay 131e5c89e4eSSatish Balay Level: advanced 132e5c89e4eSSatish Balay 1331c9f3c13SBarry Smith Developer Note: We may want eventually to pass a MPI_Comm to determine the ownership of the object 1341c9f3c13SBarry Smith 135b4205f0bSBarry Smith .seealso: PetscOptionsDestroy(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 136e5c89e4eSSatish Balay @*/ 1372d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreate(PetscOptions *options) 1382d747510SLisandro Dalcin { 139*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 140*39a651e2SJacob Faibussowitsch PetscValidPointer(options,1); 1412d747510SLisandro Dalcin *options = (PetscOptions)calloc(1,sizeof(**options)); 142*39a651e2SJacob Faibussowitsch PetscCheck(*options,PETSC_COMM_SELF,PETSC_ERR_MEM,"Failed to allocate the options database"); 143*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 1442d747510SLisandro Dalcin } 1452d747510SLisandro Dalcin 1462d747510SLisandro Dalcin /*@ 1472d747510SLisandro Dalcin PetscOptionsDestroy - Destroys an option database. 1482d747510SLisandro Dalcin 1491c9f3c13SBarry Smith Logically collective on whatever communicator was associated with the call to PetscOptionsCreate() 1501c9f3c13SBarry Smith 1512d747510SLisandro Dalcin Input Parameter: 1522d747510SLisandro Dalcin . options - the PetscOptions object 1532d747510SLisandro Dalcin 1543de2bfdfSBarry Smith Level: advanced 1552d747510SLisandro Dalcin 156b4205f0bSBarry Smith .seealso: PetscOptionsInsert(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 1572d747510SLisandro Dalcin @*/ 1582d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroy(PetscOptions *options) 159e5c89e4eSSatish Balay { 160362febeeSStefano Zampini PetscFunctionBegin; 161*39a651e2SJacob Faibussowitsch if (!*options) PetscFunctionReturn(0); 1625f80ce2aSJacob Faibussowitsch PetscCheck(!(*options)->previous,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"You are destroying an option that has been used with PetscOptionsPush() but does not have a corresponding PetscOptionsPop()"); 163*39a651e2SJacob Faibussowitsch CHKERRQ(PetscOptionsClear(*options)); 1642d747510SLisandro Dalcin /* XXX what about monitors ? */ 1652800570dSLisandro Dalcin free(*options); 1662d747510SLisandro Dalcin *options = NULL; 167e5c89e4eSSatish Balay PetscFunctionReturn(0); 168e5c89e4eSSatish Balay } 169e5c89e4eSSatish Balay 1702d747510SLisandro Dalcin /* 1712d747510SLisandro Dalcin PetscOptionsCreateDefault - Creates the default global options database 1722d747510SLisandro Dalcin */ 1732d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreateDefault(void) 174e5c89e4eSSatish Balay { 175*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 176*39a651e2SJacob Faibussowitsch if (PetscUnlikely(!defaultoptions)) CHKERRQ(PetscOptionsCreate(&defaultoptions)); 177*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 1782d747510SLisandro Dalcin } 1792d747510SLisandro Dalcin 180b4205f0bSBarry Smith /*@ 181b4205f0bSBarry Smith PetscOptionsPush - Push a new PetscOptions object as the default provider of options 1821c9f3c13SBarry Smith Allows using different parts of a code to use different options databases 183b4205f0bSBarry Smith 184b4205f0bSBarry Smith Logically Collective 185b4205f0bSBarry Smith 186b4205f0bSBarry Smith Input Parameter: 187b4205f0bSBarry Smith . opt - the options obtained with PetscOptionsCreate() 188b4205f0bSBarry Smith 189b4205f0bSBarry Smith Notes: 190b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 1911c9f3c13SBarry Smith 1929666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 1931c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 1941c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 1951c9f3c13SBarry Smith on different ranks. 196b4205f0bSBarry Smith 1973de2bfdfSBarry Smith Level: advanced 1983de2bfdfSBarry Smith 1993c6db4c4SPierre Jolivet .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsInsert(), PetscOptionsSetValue(), PetscOptionsLeft() 200b4205f0bSBarry Smith 201b4205f0bSBarry Smith @*/ 202b4205f0bSBarry Smith PetscErrorCode PetscOptionsPush(PetscOptions opt) 203b4205f0bSBarry Smith { 204b4205f0bSBarry Smith PetscFunctionBegin; 2055f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsCreateDefault()); 206b4205f0bSBarry Smith opt->previous = defaultoptions; 207b4205f0bSBarry Smith defaultoptions = opt; 208b4205f0bSBarry Smith PetscFunctionReturn(0); 209b4205f0bSBarry Smith } 210b4205f0bSBarry Smith 211b4205f0bSBarry Smith /*@ 212b4205f0bSBarry Smith PetscOptionsPop - Pop the most recent PetscOptionsPush() to return to the previous default options 213b4205f0bSBarry Smith 2141c9f3c13SBarry Smith Logically collective on whatever communicator was associated with the call to PetscOptionsCreate() 215b4205f0bSBarry Smith 216b4205f0bSBarry Smith Notes: 217b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 218b4205f0bSBarry Smith Allows using different parts of a code to use different options databases 219b4205f0bSBarry Smith 2203de2bfdfSBarry Smith Level: advanced 2213de2bfdfSBarry Smith 2223c6db4c4SPierre Jolivet .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsInsert(), PetscOptionsSetValue(), PetscOptionsLeft() 223b4205f0bSBarry Smith 224b4205f0bSBarry Smith @*/ 225b4205f0bSBarry Smith PetscErrorCode PetscOptionsPop(void) 226b4205f0bSBarry Smith { 2273de2bfdfSBarry Smith PetscOptions current = defaultoptions; 2283de2bfdfSBarry Smith 229b4205f0bSBarry Smith PetscFunctionBegin; 23028b400f6SJacob Faibussowitsch PetscCheck(defaultoptions,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Missing default options"); 23128b400f6SJacob Faibussowitsch PetscCheck(defaultoptions->previous,PETSC_COMM_SELF,PETSC_ERR_PLIB,"PetscOptionsPop() called too many times"); 232b4205f0bSBarry Smith defaultoptions = defaultoptions->previous; 2333de2bfdfSBarry Smith current->previous = NULL; 234b4205f0bSBarry Smith PetscFunctionReturn(0); 235b4205f0bSBarry Smith } 236b4205f0bSBarry Smith 2372d747510SLisandro Dalcin /* 2382d747510SLisandro Dalcin PetscOptionsDestroyDefault - Destroys the default global options database 2392d747510SLisandro Dalcin */ 2402d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroyDefault(void) 2412d747510SLisandro Dalcin { 242*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 243*39a651e2SJacob Faibussowitsch if (!defaultoptions) PetscFunctionReturn(0); 2443de2bfdfSBarry Smith /* Destroy any options that the user forgot to pop */ 2453de2bfdfSBarry Smith while (defaultoptions->previous) { 246*39a651e2SJacob Faibussowitsch PetscOptions tmp = defaultoptions; 247*39a651e2SJacob Faibussowitsch 2485f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPop()); 2495f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsDestroy(&tmp)); 2503de2bfdfSBarry Smith } 251*39a651e2SJacob Faibussowitsch CHKERRQ(PetscOptionsDestroy(&defaultoptions)); 252*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 253e5c89e4eSSatish Balay } 254e5c89e4eSSatish Balay 25594ef8ddeSSatish Balay /*@C 2567cd08cecSJed Brown PetscOptionsValidKey - PETSc Options database keys must begin with one or two dashes (-) followed by a letter. 2573fc1eb6aSBarry Smith 258447722d5SBarry Smith Not collective 2591c9f3c13SBarry Smith 2603fc1eb6aSBarry Smith Input Parameter: 2612d747510SLisandro Dalcin . key - string to check if valid 2623fc1eb6aSBarry Smith 2633fc1eb6aSBarry Smith Output Parameter: 2642d747510SLisandro Dalcin . valid - PETSC_TRUE if a valid key 2653fc1eb6aSBarry Smith 266f6680f47SSatish Balay Level: intermediate 2673fc1eb6aSBarry Smith @*/ 2682d747510SLisandro Dalcin PetscErrorCode PetscOptionsValidKey(const char key[],PetscBool *valid) 26996fc60bcSBarry Smith { 270f603b5e9SToby Isaac char *ptr; 2717c5db45bSBarry Smith 27296fc60bcSBarry Smith PetscFunctionBegin; 2732d747510SLisandro Dalcin if (key) PetscValidCharPointer(key,1); 274dadcf809SJacob Faibussowitsch PetscValidBoolPointer(valid,2); 2752d747510SLisandro Dalcin *valid = PETSC_FALSE; 2762d747510SLisandro Dalcin if (!key) PetscFunctionReturn(0); 2772d747510SLisandro Dalcin if (key[0] != '-') PetscFunctionReturn(0); 2782d747510SLisandro Dalcin if (key[1] == '-') key++; 279c850d057SPierre Jolivet if (!isalpha((int)key[1])) PetscFunctionReturn(0); 2802d747510SLisandro Dalcin (void) strtod(key,&ptr); 281c850d057SPierre Jolivet if (ptr != key && !(*ptr == '_' || isalnum((int)*ptr))) PetscFunctionReturn(0); 2822d747510SLisandro Dalcin *valid = PETSC_TRUE; 28396fc60bcSBarry Smith PetscFunctionReturn(0); 28496fc60bcSBarry Smith } 28596fc60bcSBarry Smith 286e5c89e4eSSatish Balay /*@C 287e5c89e4eSSatish Balay PetscOptionsInsertString - Inserts options into the database from a string 288e5c89e4eSSatish Balay 2891c9f3c13SBarry Smith Logically Collective 290e5c89e4eSSatish Balay 291d8d19677SJose E. Roman Input Parameters: 292080f0011SToby Isaac + options - options object 293080f0011SToby Isaac - in_str - string that contains options separated by blanks 294e5c89e4eSSatish Balay 295e5c89e4eSSatish Balay Level: intermediate 296e5c89e4eSSatish Balay 2979666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 2981c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 2991c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 3001c9f3c13SBarry Smith on different ranks. 3011c9f3c13SBarry Smith 302e5c89e4eSSatish Balay Contributed by Boyana Norris 303e5c89e4eSSatish Balay 30488c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 305acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 306e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 307e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 308acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 309a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsInsertFile() 310e5c89e4eSSatish Balay @*/ 311c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertString(PetscOptions options,const char in_str[]) 312e5c89e4eSSatish Balay { 313d06005cbSLisandro Dalcin MPI_Comm comm = PETSC_COMM_SELF; 314d06005cbSLisandro Dalcin char *first,*second; 3159c9d3cfdSBarry Smith PetscToken token; 316e5c89e4eSSatish Balay 317e5c89e4eSSatish Balay PetscFunctionBegin; 3185f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(in_str,' ',&token)); 3195f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 32096fc60bcSBarry Smith while (first) { 321d06005cbSLisandro Dalcin PetscBool isfile,isfileyaml,isstringyaml,ispush,ispop,key; 3225f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(first,"-options_file",&isfile)); 3235f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(first,"-options_file_yaml",&isfileyaml)); 3245f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(first,"-options_string_yaml",&isstringyaml)); 3255f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(first,"-prefix_push",&ispush)); 3265f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(first,"-prefix_pop",&ispop)); 3275f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(first,&key)); 328d06005cbSLisandro Dalcin if (!key) { 3295f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 330d06005cbSLisandro Dalcin } else if (isfile) { 3315f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&second)); 3325f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFile(comm,options,second,PETSC_TRUE)); 3335f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 334d06005cbSLisandro Dalcin } else if (isfileyaml) { 3355f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&second)); 3365f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFileYAML(comm,options,second,PETSC_TRUE)); 3375f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 338d06005cbSLisandro Dalcin } else if (isstringyaml) { 3395f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&second)); 3405f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertStringYAML(options,second)); 3415f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 342d06005cbSLisandro Dalcin } else if (ispush) { 3435f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&second)); 3445f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPrefixPush(options,second)); 3455f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 3469db968c8SJed Brown } else if (ispop) { 3475f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPrefixPop(options)); 3485f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 349d06005cbSLisandro Dalcin } else { 3505f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&second)); 3515f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(second,&key)); 35296fc60bcSBarry Smith if (!key) { 3535f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue(options,first,second)); 3545f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&first)); 35596fc60bcSBarry Smith } else { 3565f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue(options,first,NULL)); 35796fc60bcSBarry Smith first = second; 35896fc60bcSBarry Smith } 359e5c89e4eSSatish Balay } 360e5c89e4eSSatish Balay } 3615f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 362e5c89e4eSSatish Balay PetscFunctionReturn(0); 363e5c89e4eSSatish Balay } 364e5c89e4eSSatish Balay 3653fc1eb6aSBarry Smith /* 3663fc1eb6aSBarry Smith Returns a line (ended by a \n, \r or null character of any length. Result should be freed with free() 3673fc1eb6aSBarry Smith */ 3685fa91da5SBarry Smith static char *Petscgetline(FILE * f) 3695fa91da5SBarry Smith { 3705fa91da5SBarry Smith size_t size = 0; 3715fa91da5SBarry Smith size_t len = 0; 3725fa91da5SBarry Smith size_t last = 0; 3730298fd71SBarry Smith char *buf = NULL; 3745fa91da5SBarry Smith 37502c9f0b5SLisandro Dalcin if (feof(f)) return NULL; 3765fa91da5SBarry Smith do { 3775fa91da5SBarry Smith size += 1024; /* BUFSIZ is defined as "the optimal read size for this platform" */ 3786e0c8459SSatish Balay buf = (char*)realloc((void*)buf,size); /* realloc(NULL,n) is the same as malloc(n) */ 3795fa91da5SBarry Smith /* Actually do the read. Note that fgets puts a terminal '\0' on the 3805fa91da5SBarry Smith end of the string, so we make sure we overwrite this */ 381e86f3e45SDave May if (!fgets(buf+len,1024,f)) buf[len]=0; 3825fa91da5SBarry Smith PetscStrlen(buf,&len); 3835fa91da5SBarry Smith last = len - 1; 3845fa91da5SBarry Smith } while (!feof(f) && buf[last] != '\n' && buf[last] != '\r'); 38508ac41f7SSatish Balay if (len) return buf; 3865fa91da5SBarry Smith free(buf); 38702c9f0b5SLisandro Dalcin return NULL; 3885fa91da5SBarry Smith } 3895fa91da5SBarry Smith 390be10d61cSLisandro Dalcin static PetscErrorCode PetscOptionsFilename(MPI_Comm comm,const char file[],char filename[PETSC_MAX_PATH_LEN],PetscBool *yaml) 391be10d61cSLisandro Dalcin { 392be10d61cSLisandro Dalcin char fname[PETSC_MAX_PATH_LEN+8],path[PETSC_MAX_PATH_LEN+8],*tail; 393e5c89e4eSSatish Balay 394be10d61cSLisandro Dalcin PetscFunctionBegin; 395362febeeSStefano Zampini *yaml = PETSC_FALSE; 3965f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrreplace(comm,file,fname,sizeof(fname))); 3975f80ce2aSJacob Faibussowitsch CHKERRQ(PetscFixFilename(fname,path)); 3985f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrendswith(path,":yaml",yaml)); 399be10d61cSLisandro Dalcin if (*yaml) { 4005f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrrchr(path,':',&tail)); 401be10d61cSLisandro Dalcin tail[-1] = 0; /* remove ":yaml" suffix from path */ 402be10d61cSLisandro Dalcin } 4035f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(filename,path,PETSC_MAX_PATH_LEN)); 404a1d2f846SLisandro Dalcin /* check for standard YAML and JSON filename extensions */ 4055f80ce2aSJacob Faibussowitsch if (!*yaml) CHKERRQ(PetscStrendswith(filename,".yaml",yaml)); 4065f80ce2aSJacob Faibussowitsch if (!*yaml) CHKERRQ(PetscStrendswith(filename,".yml", yaml)); 4075f80ce2aSJacob Faibussowitsch if (!*yaml) CHKERRQ(PetscStrendswith(filename,".json",yaml)); 408a1d2f846SLisandro Dalcin if (!*yaml) { /* check file contents */ 409a1d2f846SLisandro Dalcin PetscMPIInt rank; 4105f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Comm_rank(comm,&rank)); 411dd400576SPatrick Sanan if (rank == 0) { 412a1d2f846SLisandro Dalcin FILE *fh = fopen(filename,"r"); 413a1d2f846SLisandro Dalcin if (fh) { 414a1d2f846SLisandro Dalcin char buf[6] = ""; 415a1d2f846SLisandro Dalcin if (fread(buf,1,6,fh) > 0) { 4165f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncmp(buf,"%YAML ",6,yaml)); /* check for '%YAML' tag */ 4175f80ce2aSJacob Faibussowitsch if (!*yaml) CHKERRQ(PetscStrncmp(buf,"---",3,yaml)); /* check for document start */ 418a1d2f846SLisandro Dalcin } 419a1d2f846SLisandro Dalcin (void)fclose(fh); 420a1d2f846SLisandro Dalcin } 421a1d2f846SLisandro Dalcin } 4225f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(yaml,1,MPIU_BOOL,0,comm)); 423a1d2f846SLisandro Dalcin } 424be10d61cSLisandro Dalcin PetscFunctionReturn(0); 425be10d61cSLisandro Dalcin } 426e5c89e4eSSatish Balay 427be10d61cSLisandro Dalcin static PetscErrorCode PetscOptionsInsertFilePetsc(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require) 428e5c89e4eSSatish Balay { 4298c0b561eSLisandro Dalcin char *string,*vstring = NULL,*astring = NULL,*packed = NULL; 4307fb43599SVaclav Hapla char *tokens[4]; 43113e3f751SJed Brown size_t i,len,bytes; 432e5c89e4eSSatish Balay FILE *fd; 4337fb43599SVaclav Hapla PetscToken token=NULL; 434ed9cf6e9SBarry Smith int err; 435581bbe83SVaclav Hapla char *cmatch; 436581bbe83SVaclav Hapla const char cmt='#'; 4379210b8eaSVaclav Hapla PetscInt line=1; 4383a018368SJed Brown PetscMPIInt rank,cnt=0,acnt=0,counts[2]; 4399210b8eaSVaclav Hapla PetscBool isdir,alias=PETSC_FALSE,valid; 440e5c89e4eSSatish Balay 441e5c89e4eSSatish Balay PetscFunctionBegin; 4425f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMemzero(tokens,sizeof(tokens))); 4435f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Comm_rank(comm,&rank)); 444dd400576SPatrick Sanan if (rank == 0) { 4458c0b561eSLisandro Dalcin char fpath[PETSC_MAX_PATH_LEN]; 4468c0b561eSLisandro Dalcin char fname[PETSC_MAX_PATH_LEN]; 44705c7dedfSBarry Smith 4485f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrreplace(PETSC_COMM_SELF,file,fpath,sizeof(fpath))); 4495f80ce2aSJacob Faibussowitsch CHKERRQ(PetscFixFilename(fpath,fname)); 4508c0b561eSLisandro Dalcin 451e5c89e4eSSatish Balay fd = fopen(fname,"r"); 4525f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTestDirectory(fname,'r',&isdir)); 4532c71b3e2SJacob Faibussowitsch PetscCheckFalse(isdir && require,PETSC_COMM_SELF,PETSC_ERR_USER,"Specified options file %s is a directory",fname); 454ad38b122SPatrick Sanan if (fd && !isdir) { 4553a018368SJed Brown PetscSegBuffer vseg,aseg; 4565f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferCreate(1,4000,&vseg)); 4575f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferCreate(1,2000,&aseg)); 4583a018368SJed Brown 4599b754dc9SBarry Smith /* the following line will not work when opening initial files (like .petscrc) since info is not yet set */ 4605f80ce2aSJacob Faibussowitsch CHKERRQ(PetscInfo(NULL,"Opened options file %s\n",file)); 461e24ecc5dSJed Brown 4625fa91da5SBarry Smith while ((string = Petscgetline(fd))) { 4634704e885SBarry Smith /* eliminate comments from each line */ 4645f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrchr(string,cmt,&cmatch)); 46590f79514SSatish Balay if (cmatch) *cmatch = 0; 4665f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(string,&len)); 4675981331cSSatish Balay /* replace tabs, ^M, \n with " " */ 468e5c89e4eSSatish Balay for (i=0; i<len; i++) { 4695981331cSSatish Balay if (string[i] == '\t' || string[i] == '\r' || string[i] == '\n') { 470e5c89e4eSSatish Balay string[i] = ' '; 471e5c89e4eSSatish Balay } 472e5c89e4eSSatish Balay } 4735f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(string,' ',&token)); 4745f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&tokens[0])); 4757fb43599SVaclav Hapla if (!tokens[0]) { 47602b0d46eSSatish Balay goto destroy; 4777fb43599SVaclav Hapla } else if (!tokens[0][0]) { /* if token 0 is empty (string begins with spaces), redo */ 4785f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&tokens[0])); 47990f79514SSatish Balay } 4807fb43599SVaclav Hapla for (i=1; i<4; i++) { 4815f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&tokens[i])); 4827fb43599SVaclav Hapla } 4837fb43599SVaclav Hapla if (!tokens[0]) { 4842662f744SSatish Balay goto destroy; 4857fb43599SVaclav Hapla } else if (tokens[0][0] == '-') { 4865f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(tokens[0],&valid)); 48728b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %" PetscInt_FMT ": invalid option %s",fname,line,tokens[0]); 4885f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(tokens[0],&len)); 4895f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGet(vseg,len+1,&vstring)); 4905f80ce2aSJacob Faibussowitsch CHKERRQ(PetscArraycpy(vstring,tokens[0],len)); 491e24ecc5dSJed Brown vstring[len] = ' '; 4927fb43599SVaclav Hapla if (tokens[1]) { 4935f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(tokens[1],&valid)); 49428b400f6SJacob Faibussowitsch PetscCheck(!valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %" PetscInt_FMT ": cannot specify two options per line (%s %s)",fname,line,tokens[0],tokens[1]); 4955f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(tokens[1],&len)); 4965f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGet(vseg,len+3,&vstring)); 497e24ecc5dSJed Brown vstring[0] = '"'; 4985f80ce2aSJacob Faibussowitsch CHKERRQ(PetscArraycpy(vstring+1,tokens[1],len)); 499e24ecc5dSJed Brown vstring[len+1] = '"'; 500e24ecc5dSJed Brown vstring[len+2] = ' '; 50109192fe3SBarry Smith } 50290f79514SSatish Balay } else { 5035f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(tokens[0],"alias",&alias)); 5049210b8eaSVaclav Hapla if (alias) { 5055f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(tokens[1],&valid)); 50628b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %" PetscInt_FMT ": invalid aliased option %s",fname,line,tokens[1]); 5072c71b3e2SJacob Faibussowitsch PetscCheckFalse(!tokens[2],PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %" PetscInt_FMT ": alias missing for %s",fname,line,tokens[1]); 5085f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(tokens[2],&valid)); 50928b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %" PetscInt_FMT ": invalid aliasee option %s",fname,line,tokens[2]); 5105f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(tokens[1],&len)); 5115f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGet(aseg,len+1,&astring)); 5125f80ce2aSJacob Faibussowitsch CHKERRQ(PetscArraycpy(astring,tokens[1],len)); 513e24ecc5dSJed Brown astring[len] = ' '; 514e24ecc5dSJed Brown 5155f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(tokens[2],&len)); 5165f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGet(aseg,len+1,&astring)); 5175f80ce2aSJacob Faibussowitsch CHKERRQ(PetscArraycpy(astring,tokens[2],len)); 518e24ecc5dSJed Brown astring[len] = ' '; 51998921bdaSJacob Faibussowitsch } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown first token in options file %s line %" PetscInt_FMT ": %s",fname,line,tokens[0]); 5209210b8eaSVaclav Hapla } 5219210b8eaSVaclav Hapla { 5229210b8eaSVaclav Hapla const char *extraToken = alias ? tokens[3] : tokens[2]; 52328b400f6SJacob Faibussowitsch PetscCheck(!extraToken,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %" PetscInt_FMT ": extra token %s",fname,line,extraToken); 524e5c89e4eSSatish Balay } 52502b0d46eSSatish Balay destroy: 5264b40f50bSBarry Smith free(string); 5275f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 5289210b8eaSVaclav Hapla alias = PETSC_FALSE; 5299210b8eaSVaclav Hapla line++; 530e5c89e4eSSatish Balay } 531ed9cf6e9SBarry Smith err = fclose(fd); 53228b400f6SJacob Faibussowitsch PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file %s",fname); 5335f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGetSize(aseg,&bytes)); /* size without null termination */ 5345f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMPIIntCast(bytes,&acnt)); 5355f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGet(aseg,1,&astring)); 536e24ecc5dSJed Brown astring[0] = 0; 5375f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGetSize(vseg,&bytes)); /* size without null termination */ 5385f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMPIIntCast(bytes,&cnt)); 5395f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferGet(vseg,1,&vstring)); 540e24ecc5dSJed Brown vstring[0] = 0; 5415f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMalloc1(2+acnt+cnt,&packed)); 5425f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferExtractTo(aseg,packed)); 5435f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferExtractTo(vseg,packed+acnt+1)); 5445f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferDestroy(&aseg)); 5455f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSegBufferDestroy(&vseg)); 54628b400f6SJacob Faibussowitsch } else PetscCheck(!require,PETSC_COMM_SELF,PETSC_ERR_USER,"Unable to open options file %s",fname); 5479b754dc9SBarry Smith } 54805c7dedfSBarry Smith 5493a018368SJed Brown counts[0] = acnt; 5503a018368SJed Brown counts[1] = cnt; 5514201f521SBarry Smith err = MPI_Bcast(counts,2,MPI_INT,0,comm); 55228b400f6SJacob Faibussowitsch PetscCheck(!err,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in first MPI collective call, could be caused by using an incorrect mpiexec or a network problem, it can be caused by having VPN running: see https://petsc.org/release/faq/"); 5533a018368SJed Brown acnt = counts[0]; 5543a018368SJed Brown cnt = counts[1]; 5553a018368SJed Brown if (rank) { 5565f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMalloc1(2+acnt+cnt,&packed)); 5573a018368SJed Brown } 5583a018368SJed Brown if (acnt || cnt) { 5595f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(packed,2+acnt+cnt,MPI_CHAR,0,comm)); 5603a018368SJed Brown astring = packed; 5613a018368SJed Brown vstring = packed + acnt + 1; 5623a018368SJed Brown } 5633a018368SJed Brown 5649b754dc9SBarry Smith if (acnt) { 5655f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(astring,' ',&token)); 5665f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&tokens[0])); 5677fb43599SVaclav Hapla while (tokens[0]) { 5685f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&tokens[1])); 5695f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetAlias(options,tokens[0],tokens[1])); 5705f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&tokens[0])); 5719b754dc9SBarry Smith } 5725f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 5739b754dc9SBarry Smith } 5749b754dc9SBarry Smith 5759b754dc9SBarry Smith if (cnt) { 5765f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertString(options,vstring)); 577e5c89e4eSSatish Balay } 5785f80ce2aSJacob Faibussowitsch CHKERRQ(PetscFree(packed)); 579e5c89e4eSSatish Balay PetscFunctionReturn(0); 580e5c89e4eSSatish Balay } 581e5c89e4eSSatish Balay 582d06005cbSLisandro Dalcin /*@C 583be10d61cSLisandro Dalcin PetscOptionsInsertFile - Inserts options into the database from a file. 584be10d61cSLisandro Dalcin 585be10d61cSLisandro Dalcin Collective 586be10d61cSLisandro Dalcin 587d8d19677SJose E. Roman Input Parameters: 588be10d61cSLisandro Dalcin + comm - the processes that will share the options (usually PETSC_COMM_WORLD) 589be10d61cSLisandro Dalcin . options - options database, use NULL for default global database 590be10d61cSLisandro Dalcin . file - name of file, 591be10d61cSLisandro Dalcin ".yml" and ".yaml" filename extensions are inserted as YAML options, 592be10d61cSLisandro Dalcin append ":yaml" to filename to force YAML options. 593be10d61cSLisandro Dalcin - require - if PETSC_TRUE will generate an error if the file does not exist 594be10d61cSLisandro Dalcin 595be10d61cSLisandro Dalcin Notes: 596be10d61cSLisandro Dalcin Use # for lines that are comments and which should be ignored. 597be10d61cSLisandro Dalcin Usually, instead of using this command, one should list the file name in the call to PetscInitialize(), this insures that certain options 598be10d61cSLisandro Dalcin such as -log_view or -malloc_debug are processed properly. This routine only sets options into the options database that will be processed by later 599be10d61cSLisandro Dalcin calls to XXXSetFromOptions() it should not be used for options listed under PetscInitialize(). 600be10d61cSLisandro Dalcin The collectivity of this routine is complex; only the MPI processes in comm will 601be10d61cSLisandro Dalcin have the affect of these options. If some processes that create objects call this routine and others do 602be10d61cSLisandro Dalcin not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 603be10d61cSLisandro Dalcin on different ranks. 604be10d61cSLisandro Dalcin 605be10d61cSLisandro Dalcin Level: developer 606be10d61cSLisandro Dalcin 607be10d61cSLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 608be10d61cSLisandro Dalcin PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 609be10d61cSLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 610be10d61cSLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 611be10d61cSLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 612be10d61cSLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 613be10d61cSLisandro Dalcin 614be10d61cSLisandro Dalcin @*/ 615be10d61cSLisandro Dalcin PetscErrorCode PetscOptionsInsertFile(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require) 616be10d61cSLisandro Dalcin { 617be10d61cSLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 618be10d61cSLisandro Dalcin PetscBool yaml; 619be10d61cSLisandro Dalcin 620be10d61cSLisandro Dalcin PetscFunctionBegin; 6215f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFilename(comm,file,filename,&yaml)); 622be10d61cSLisandro Dalcin if (yaml) { 6235f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFileYAML(comm,options,filename,require)); 624be10d61cSLisandro Dalcin } else { 6255f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFilePetsc(comm,options,filename,require)); 626be10d61cSLisandro Dalcin } 627be10d61cSLisandro Dalcin PetscFunctionReturn(0); 628be10d61cSLisandro Dalcin } 629be10d61cSLisandro Dalcin 630be10d61cSLisandro Dalcin /*@C 631d06005cbSLisandro Dalcin PetscOptionsInsertArgs - Inserts options into the database from a array of strings 632d06005cbSLisandro Dalcin 633d06005cbSLisandro Dalcin Logically Collective 634d06005cbSLisandro Dalcin 635d8d19677SJose E. Roman Input Parameters: 636d06005cbSLisandro Dalcin + options - options object 637d06005cbSLisandro Dalcin . argc - the array lenght 638d06005cbSLisandro Dalcin - args - the string array 639d06005cbSLisandro Dalcin 640d06005cbSLisandro Dalcin Level: intermediate 641d06005cbSLisandro Dalcin 642d06005cbSLisandro Dalcin .seealso: PetscOptions, PetscOptionsInsertString(), PetscOptionsInsertFile() 643d06005cbSLisandro Dalcin @*/ 644d06005cbSLisandro Dalcin PetscErrorCode PetscOptionsInsertArgs(PetscOptions options,int argc,char *args[]) 64585079163SJed Brown { 646d06005cbSLisandro Dalcin MPI_Comm comm = PETSC_COMM_WORLD; 647d06005cbSLisandro Dalcin int left = PetscMax(argc,0); 648d06005cbSLisandro Dalcin char *const *eargs = args; 64985079163SJed Brown 65085079163SJed Brown PetscFunctionBegin; 65185079163SJed Brown while (left) { 652d06005cbSLisandro Dalcin PetscBool isfile,isfileyaml,isstringyaml,ispush,ispop,key; 6535f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(eargs[0],"-options_file",&isfile)); 6545f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(eargs[0],"-options_file_yaml",&isfileyaml)); 6555f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(eargs[0],"-options_string_yaml",&isstringyaml)); 6565f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(eargs[0],"-prefix_push",&ispush)); 6575f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(eargs[0],"-prefix_pop",&ispop)); 6585f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(eargs[0],&key)); 659093de6efSBarry Smith if (!key) { 66085079163SJed Brown eargs++; left--; 661d06005cbSLisandro Dalcin } else if (isfile) { 6622c71b3e2SJacob Faibussowitsch PetscCheckFalse(left <= 1 || eargs[1][0] == '-',PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 6635f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFile(comm,options,eargs[1],PETSC_TRUE)); 66485079163SJed Brown eargs += 2; left -= 2; 665d06005cbSLisandro Dalcin } else if (isfileyaml) { 6662c71b3e2SJacob Faibussowitsch PetscCheckFalse(left <= 1 || eargs[1][0] == '-',PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file_yaml filename option"); 6675f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFileYAML(comm,options,eargs[1],PETSC_TRUE)); 668d06005cbSLisandro Dalcin eargs += 2; left -= 2; 669d06005cbSLisandro Dalcin } else if (isstringyaml) { 6702c71b3e2SJacob Faibussowitsch PetscCheckFalse(left <= 1 || eargs[1][0] == '-',PETSC_COMM_SELF,PETSC_ERR_USER,"Missing string for -options_string_yaml string option"); 6715f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertStringYAML(options,eargs[1])); 672d06005cbSLisandro Dalcin eargs += 2; left -= 2; 673d06005cbSLisandro Dalcin } else if (ispush) { 6742c71b3e2SJacob Faibussowitsch PetscCheckFalse(left <= 1,PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option"); 6752c71b3e2SJacob Faibussowitsch PetscCheckFalse(eargs[1][0] == '-',PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option (prefixes cannot start with '-')"); 6765f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPrefixPush(options,eargs[1])); 6779db968c8SJed Brown eargs += 2; left -= 2; 678d06005cbSLisandro Dalcin } else if (ispop) { 6795f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPrefixPop(options)); 6809db968c8SJed Brown eargs++; left--; 6817935c3d8SJed Brown } else { 6827935c3d8SJed Brown PetscBool nextiskey = PETSC_FALSE; 6835f80ce2aSJacob Faibussowitsch if (left >= 2) CHKERRQ(PetscOptionsValidKey(eargs[1],&nextiskey)); 68498b6bf53SJed Brown if (left < 2 || nextiskey) { 6855f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue(options,eargs[0],NULL)); 68685079163SJed Brown eargs++; left--; 68785079163SJed Brown } else { 6885f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue(options,eargs[0],eargs[1])); 68985079163SJed Brown eargs += 2; left -= 2; 69085079163SJed Brown } 69185079163SJed Brown } 6927935c3d8SJed Brown } 69385079163SJed Brown PetscFunctionReturn(0); 69485079163SJed Brown } 69585079163SJed Brown 6969fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscOptionsStringToBoolIfSet_Private(enum PetscPrecedentOption opt,const char *val[],PetscBool set[],PetscBool *flg) 697c5b5d8d5SVaclav Hapla { 698c5b5d8d5SVaclav Hapla PetscFunctionBegin; 699c5b5d8d5SVaclav Hapla if (set[opt]) { 7005f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToBool(val[opt],flg)); 701c5b5d8d5SVaclav Hapla } else *flg = PETSC_FALSE; 702c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 703c5b5d8d5SVaclav Hapla } 704c5b5d8d5SVaclav Hapla 705c5b5d8d5SVaclav Hapla /* Process options with absolute precedence */ 706c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsProcessPrecedentFlags(PetscOptions options,int argc,char *args[],PetscBool *skip_petscrc,PetscBool *skip_petscrc_set) 707c5b5d8d5SVaclav Hapla { 708c5b5d8d5SVaclav Hapla const char* const *opt = precedentOptions; 709c5b5d8d5SVaclav Hapla const size_t n = PO_NUM; 710c5b5d8d5SVaclav Hapla size_t o; 711c5b5d8d5SVaclav Hapla int a; 712c5b5d8d5SVaclav Hapla const char **val; 713c5b5d8d5SVaclav Hapla PetscBool *set; 714c5b5d8d5SVaclav Hapla 715c5b5d8d5SVaclav Hapla PetscFunctionBegin; 7165f80ce2aSJacob Faibussowitsch CHKERRQ(PetscCalloc2(n,&val,n,&set)); 717c5b5d8d5SVaclav Hapla 718c5b5d8d5SVaclav Hapla /* Look for options possibly set using PetscOptionsSetValue beforehand */ 719c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 7205f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,NULL,opt[o],&val[o],&set[o])); 721c5b5d8d5SVaclav Hapla } 722c5b5d8d5SVaclav Hapla 723a5b23f4aSJose E. Roman /* Loop through all args to collect last occurring value of each option */ 724c5b5d8d5SVaclav Hapla for (a=1; a<argc; a++) { 725c5b5d8d5SVaclav Hapla PetscBool valid, eq; 726c5b5d8d5SVaclav Hapla 7275f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(args[a],&valid)); 728c5b5d8d5SVaclav Hapla if (!valid) continue; 729c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 7305f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(args[a],opt[o],&eq)); 731c5b5d8d5SVaclav Hapla if (eq) { 732c5b5d8d5SVaclav Hapla set[o] = PETSC_TRUE; 733c5b5d8d5SVaclav Hapla if (a == argc-1 || !args[a+1] || !args[a+1][0] || args[a+1][0] == '-') val[o] = NULL; 734c5b5d8d5SVaclav Hapla else val[o] = args[a+1]; 735c5b5d8d5SVaclav Hapla break; 736c5b5d8d5SVaclav Hapla } 737c5b5d8d5SVaclav Hapla } 738c5b5d8d5SVaclav Hapla } 739c5b5d8d5SVaclav Hapla 740c5b5d8d5SVaclav Hapla /* Process flags */ 7415f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(val[PO_HELP], "intro", &options->help_intro)); 742d314f959SVaclav Hapla if (options->help_intro) options->help = PETSC_TRUE; 7435f80ce2aSJacob Faibussowitsch else CHKERRQ(PetscOptionsStringToBoolIfSet_Private(PO_HELP, val,set,&options->help)); 7445f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToBoolIfSet_Private(PO_OPTIONS_MONITOR_CANCEL,val,set,&options->monitorCancel)); 7455f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToBoolIfSet_Private(PO_OPTIONS_MONITOR, val,set,&options->monitorFromOptions)); 7465f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToBoolIfSet_Private(PO_SKIP_PETSCRC, val,set,skip_petscrc)); 747c5b5d8d5SVaclav Hapla *skip_petscrc_set = set[PO_SKIP_PETSCRC]; 748c5b5d8d5SVaclav Hapla 749c5b5d8d5SVaclav Hapla /* Store precedent options in database and mark them as used */ 750c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 751c5b5d8d5SVaclav Hapla if (set[o]) { 7525f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue_Private(options,opt[o],val[o],&a)); 753d06005cbSLisandro Dalcin options->used[a] = PETSC_TRUE; 754c5b5d8d5SVaclav Hapla } 755c5b5d8d5SVaclav Hapla } 756c5b5d8d5SVaclav Hapla 7575f80ce2aSJacob Faibussowitsch CHKERRQ(PetscFree2(val,set)); 758c5b5d8d5SVaclav Hapla options->precedentProcessed = PETSC_TRUE; 759c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 760c5b5d8d5SVaclav Hapla } 761c5b5d8d5SVaclav Hapla 7629fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscOptionsSkipPrecedent(PetscOptions options,const char name[],PetscBool *flg) 763c5b5d8d5SVaclav Hapla { 764*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 765*39a651e2SJacob Faibussowitsch PetscValidBoolPointer(flg,3); 766c5b5d8d5SVaclav Hapla *flg = PETSC_FALSE; 767c5b5d8d5SVaclav Hapla if (options->precedentProcessed) { 768*39a651e2SJacob Faibussowitsch for (int i = 0; i < PO_NUM; ++i) { 769c5b5d8d5SVaclav Hapla if (!PetscOptNameCmp(precedentOptions[i],name)) { 770c5b5d8d5SVaclav Hapla /* check if precedent option has been set already */ 771*39a651e2SJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,NULL,name,NULL,flg)); 772c5b5d8d5SVaclav Hapla if (*flg) break; 773c5b5d8d5SVaclav Hapla } 774c5b5d8d5SVaclav Hapla } 775c5b5d8d5SVaclav Hapla } 776*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 777c5b5d8d5SVaclav Hapla } 77885079163SJed Brown 779e5c89e4eSSatish Balay /*@C 780e5c89e4eSSatish Balay PetscOptionsInsert - Inserts into the options database from the command line, 781e5c89e4eSSatish Balay the environmental variable and a file. 782e5c89e4eSSatish Balay 7831c9f3c13SBarry Smith Collective on PETSC_COMM_WORLD 7841c9f3c13SBarry Smith 785e5c89e4eSSatish Balay Input Parameters: 786c5929fdfSBarry Smith + options - options database or NULL for the default global database 787c5929fdfSBarry Smith . argc - count of number of command line arguments 788e5c89e4eSSatish Balay . args - the command line arguments 789be10d61cSLisandro Dalcin - file - [optional] PETSc database file, append ":yaml" to filename to specify YAML options format. 790be10d61cSLisandro Dalcin Use NULL or empty string to not check for code specific file. 791be10d61cSLisandro Dalcin Also checks ~/.petscrc, .petscrc and petscrc. 792c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 793e5c89e4eSSatish Balay 794e5c89e4eSSatish Balay Note: 795e5c89e4eSSatish Balay Since PetscOptionsInsert() is automatically called by PetscInitialize(), 796e5c89e4eSSatish Balay the user does not typically need to call this routine. PetscOptionsInsert() 797e5c89e4eSSatish Balay can be called several times, adding additional entries into the database. 798e5c89e4eSSatish Balay 799081c24baSBoyana Norris Options Database Keys: 800d06005cbSLisandro Dalcin + -options_file <filename> - read options from a file 801d06005cbSLisandro Dalcin - -options_file_yaml <filename> - read options from a YAML file 802c5b5d8d5SVaclav Hapla 803c5b5d8d5SVaclav Hapla See PetscInitialize() for options related to option database monitoring. 804081c24baSBoyana Norris 805e5c89e4eSSatish Balay Level: advanced 806e5c89e4eSSatish Balay 8072d747510SLisandro Dalcin .seealso: PetscOptionsDestroy(), PetscOptionsView(), PetscOptionsInsertString(), PetscOptionsInsertFile(), 80896fc60bcSBarry Smith PetscInitialize() 809e5c89e4eSSatish Balay @*/ 810c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsert(PetscOptions options,int *argc,char ***args,const char file[]) 811e5c89e4eSSatish Balay { 812d06005cbSLisandro Dalcin MPI_Comm comm = PETSC_COMM_WORLD; 813e5c89e4eSSatish Balay PetscMPIInt rank; 814c5b5d8d5SVaclav Hapla PetscBool hasArgs = (argc && *argc) ? PETSC_TRUE : PETSC_FALSE; 815c5b5d8d5SVaclav Hapla PetscBool skipPetscrc = PETSC_FALSE, skipPetscrcSet = PETSC_FALSE; 816e5c89e4eSSatish Balay 817e5c89e4eSSatish Balay PetscFunctionBegin; 8182c71b3e2SJacob Faibussowitsch PetscCheckFalse(hasArgs && !(args && *args),comm,PETSC_ERR_ARG_NULL,"*argc > 1 but *args not given"); 8195f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Comm_rank(comm,&rank)); 820e5c89e4eSSatish Balay 821c5b5d8d5SVaclav Hapla if (!options) { 8225f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsCreateDefault()); 823c5b5d8d5SVaclav Hapla options = defaultoptions; 824c5b5d8d5SVaclav Hapla } 825c5b5d8d5SVaclav Hapla if (hasArgs) { 826c5b5d8d5SVaclav Hapla /* process options with absolute precedence */ 8275f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsProcessPrecedentFlags(options,*argc,*args,&skipPetscrc,&skipPetscrcSet)); 828c5b5d8d5SVaclav Hapla } 8294b09e917SBarry Smith if (file && file[0]) { 8305f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFile(comm,options,file,PETSC_TRUE)); 831c5b5d8d5SVaclav Hapla /* if -skip_petscrc has not been set from command line, check whether it has been set in the file */ 8325f80ce2aSJacob Faibussowitsch if (!skipPetscrcSet) CHKERRQ(PetscOptionsGetBool(options,NULL,"-skip_petscrc",&skipPetscrc,NULL)); 833321366bcSBarry Smith } 834c5b5d8d5SVaclav Hapla if (!skipPetscrc) { 835be10d61cSLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 8365f80ce2aSJacob Faibussowitsch CHKERRQ(PetscGetHomeDirectory(filename,sizeof(filename))); 8375f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(filename,(int)sizeof(filename),MPI_CHAR,0,comm)); 8385f80ce2aSJacob Faibussowitsch if (filename[0]) CHKERRQ(PetscStrcat(filename,"/.petscrc")); 8395f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFile(comm,options,filename,PETSC_FALSE)); 8405f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFile(comm,options,".petscrc",PETSC_FALSE)); 8415f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertFile(comm,options,"petscrc",PETSC_FALSE)); 842e5c89e4eSSatish Balay } 843e5c89e4eSSatish Balay 8442d747510SLisandro Dalcin /* insert environment options */ 845e5c89e4eSSatish Balay { 8462d747510SLisandro Dalcin char *eoptions = NULL; 847e5c89e4eSSatish Balay size_t len = 0; 848dd400576SPatrick Sanan if (rank == 0) { 849e5c89e4eSSatish Balay eoptions = (char*)getenv("PETSC_OPTIONS"); 8505f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(eoptions,&len)); 851e5c89e4eSSatish Balay } 8525f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(&len,1,MPIU_SIZE_T,0,comm)); 853e5c89e4eSSatish Balay if (len) { 8545f80ce2aSJacob Faibussowitsch if (rank) CHKERRQ(PetscMalloc1(len+1,&eoptions)); 8555f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(eoptions,len,MPI_CHAR,0,comm)); 85696fc60bcSBarry Smith if (rank) eoptions[len] = 0; 8575f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertString(options,eoptions)); 8585f80ce2aSJacob Faibussowitsch if (rank) CHKERRQ(PetscFree(eoptions)); 859e5c89e4eSSatish Balay } 860e5c89e4eSSatish Balay } 861e5c89e4eSSatish Balay 862d06005cbSLisandro Dalcin /* insert YAML environment options */ 86356a31166SBarry Smith { 8649fc438c3SToby Isaac char *eoptions = NULL; 8659fc438c3SToby Isaac size_t len = 0; 866dd400576SPatrick Sanan if (rank == 0) { 8679fc438c3SToby Isaac eoptions = (char*)getenv("PETSC_OPTIONS_YAML"); 8685f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(eoptions,&len)); 8699fc438c3SToby Isaac } 8705f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(&len,1,MPIU_SIZE_T,0,comm)); 8719fc438c3SToby Isaac if (len) { 8725f80ce2aSJacob Faibussowitsch if (rank) CHKERRQ(PetscMalloc1(len+1,&eoptions)); 8735f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Bcast(eoptions,len,MPI_CHAR,0,comm)); 8749fc438c3SToby Isaac if (rank) eoptions[len] = 0; 8755f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsInsertStringYAML(options,eoptions)); 8765f80ce2aSJacob Faibussowitsch if (rank) CHKERRQ(PetscFree(eoptions)); 8779fc438c3SToby Isaac } 8789fc438c3SToby Isaac } 8793bcbd388SSean Farley 880c5b5d8d5SVaclav Hapla /* insert command line options here because they take precedence over arguments in petscrc/environment */ 8815f80ce2aSJacob Faibussowitsch if (hasArgs) CHKERRQ(PetscOptionsInsertArgs(options,*argc-1,*args+1)); 882e5c89e4eSSatish Balay PetscFunctionReturn(0); 883e5c89e4eSSatish Balay } 884e5c89e4eSSatish Balay 885e5c89e4eSSatish Balay /*@C 88688c29154SBarry Smith PetscOptionsView - Prints the options that have been loaded. This is 887e5c89e4eSSatish Balay useful for debugging purposes. 888e5c89e4eSSatish Balay 889c139c21fSBarry Smith Logically Collective on PetscViewer 890e5c89e4eSSatish Balay 891d8d19677SJose E. Roman Input Parameters: 892a2b725a8SWilliam Gropp + options - options database, use NULL for default global database 893a2b725a8SWilliam Gropp - viewer - must be an PETSCVIEWERASCII viewer 894e5c89e4eSSatish Balay 895e5c89e4eSSatish Balay Options Database Key: 89626a7e8d4SBarry Smith . -options_view - Activates PetscOptionsView() within PetscFinalize() 897e5c89e4eSSatish Balay 8989666a313SBarry Smith Notes: 8999666a313SBarry Smith Only the rank zero process of MPI_Comm used to create view prints the option values. Other processes 9001c9f3c13SBarry Smith may have different values but they are not printed. 9011c9f3c13SBarry Smith 902e5c89e4eSSatish Balay Level: advanced 903e5c89e4eSSatish Balay 904e5c89e4eSSatish Balay .seealso: PetscOptionsAllUsed() 905e5c89e4eSSatish Balay @*/ 906c5929fdfSBarry Smith PetscErrorCode PetscOptionsView(PetscOptions options,PetscViewer viewer) 907e5c89e4eSSatish Balay { 908431c96f7SBarry Smith PetscInt i; 90988c29154SBarry Smith PetscBool isascii; 910e5c89e4eSSatish Balay 911e5c89e4eSSatish Balay PetscFunctionBegin; 9122d747510SLisandro Dalcin if (viewer) PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 913c5929fdfSBarry Smith options = options ? options : defaultoptions; 91488c29154SBarry Smith if (!viewer) viewer = PETSC_VIEWER_STDOUT_WORLD; 9155f80ce2aSJacob Faibussowitsch CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii)); 91628b400f6SJacob Faibussowitsch PetscCheck(isascii,PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Only supports ASCII viewer"); 91788c29154SBarry Smith 9182d747510SLisandro Dalcin if (!options->N) { 9195f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"#No PETSc Option Table entries\n")); 9202d747510SLisandro Dalcin PetscFunctionReturn(0); 92130694fe9SBarry Smith } 9222d747510SLisandro Dalcin 9235f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"#PETSc Option Table entries:\n")); 924e5c89e4eSSatish Balay for (i=0; i<options->N; i++) { 925e5c89e4eSSatish Balay if (options->values[i]) { 9265f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"-%s %s\n",options->names[i],options->values[i])); 927e5c89e4eSSatish Balay } else { 9285f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"-%s\n",options->names[i])); 929e5c89e4eSSatish Balay } 930e5c89e4eSSatish Balay } 9315f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"#End of PETSc Option Table entries\n")); 932e5c89e4eSSatish Balay PetscFunctionReturn(0); 933e5c89e4eSSatish Balay } 934e5c89e4eSSatish Balay 935e11779c2SBarry Smith /* 936e11779c2SBarry Smith Called by error handlers to print options used in run 937e11779c2SBarry Smith */ 93895c0884eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsViewError(void) 939e11779c2SBarry Smith { 940e11779c2SBarry Smith PetscInt i; 9414416b707SBarry Smith PetscOptions options = defaultoptions; 942e11779c2SBarry Smith 943e11779c2SBarry Smith PetscFunctionBegin; 944e11779c2SBarry Smith if (options->N) { 945e11779c2SBarry Smith (*PetscErrorPrintf)("PETSc Option Table entries:\n"); 946e11779c2SBarry Smith } else { 947e11779c2SBarry Smith (*PetscErrorPrintf)("No PETSc Option Table entries\n"); 948e11779c2SBarry Smith } 949e11779c2SBarry Smith for (i=0; i<options->N; i++) { 950e11779c2SBarry Smith if (options->values[i]) { 951e11779c2SBarry Smith (*PetscErrorPrintf)("-%s %s\n",options->names[i],options->values[i]); 952e11779c2SBarry Smith } else { 953e11779c2SBarry Smith (*PetscErrorPrintf)("-%s\n",options->names[i]); 954e11779c2SBarry Smith } 955e11779c2SBarry Smith } 956e11779c2SBarry Smith PetscFunctionReturn(0); 957e11779c2SBarry Smith } 958e11779c2SBarry Smith 959e5c89e4eSSatish Balay /*@C 96074e0666dSJed Brown PetscOptionsPrefixPush - Designate a prefix to be used by all options insertions to follow. 96174e0666dSJed Brown 9621c9f3c13SBarry Smith Logically Collective 96374e0666dSJed Brown 964d8d19677SJose E. Roman Input Parameters: 965c5929fdfSBarry Smith + options - options database, or NULL for the default global database 966c5929fdfSBarry Smith - prefix - The string to append to the existing prefix 9679db968c8SJed Brown 9689db968c8SJed Brown Options Database Keys: 9699db968c8SJed Brown + -prefix_push <some_prefix_> - push the given prefix 9709db968c8SJed Brown - -prefix_pop - pop the last prefix 9719db968c8SJed Brown 9729db968c8SJed Brown Notes: 9739db968c8SJed Brown It is common to use this in conjunction with -options_file as in 9749db968c8SJed Brown 9759db968c8SJed Brown $ -prefix_push system1_ -options_file system1rc -prefix_pop -prefix_push system2_ -options_file system2rc -prefix_pop 9769db968c8SJed Brown 9779db968c8SJed Brown where the files no longer require all options to be prefixed with -system2_. 97874e0666dSJed Brown 9799666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 9801c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 9811c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 9821c9f3c13SBarry Smith on different ranks. 9831c9f3c13SBarry Smith 98474e0666dSJed Brown Level: advanced 98574e0666dSJed Brown 9861c9f3c13SBarry Smith .seealso: PetscOptionsPrefixPop(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsSetValue() 98774e0666dSJed Brown @*/ 988c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPush(PetscOptions options,const char prefix[]) 98974e0666dSJed Brown { 99074e0666dSJed Brown size_t n; 99174e0666dSJed Brown PetscInt start; 9922d747510SLisandro Dalcin char key[MAXOPTNAME+1]; 9932d747510SLisandro Dalcin PetscBool valid; 99474e0666dSJed Brown 99574e0666dSJed Brown PetscFunctionBegin; 996064a246eSJacob Faibussowitsch PetscValidCharPointer(prefix,2); 997c5929fdfSBarry Smith options = options ? options : defaultoptions; 9982c71b3e2SJacob Faibussowitsch PetscCheckFalse(options->prefixind >= MAXPREFIXES,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum depth of prefix stack %d exceeded, recompile \n src/sys/objects/options.c with larger value for MAXPREFIXES",MAXPREFIXES); 9992d747510SLisandro Dalcin key[0] = '-'; /* keys must start with '-' */ 10005f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(key+1,prefix,sizeof(key)-1)); 10015f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(key,&valid)); 10028bf569ecSLisandro Dalcin if (!valid && options->prefixind > 0 && isdigit((int)prefix[0])) valid = PETSC_TRUE; /* If the prefix stack is not empty, make numbers a valid prefix */ 100328b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_USER,"Given prefix \"%s\" not valid (the first character must be a letter%s, do not include leading '-')",prefix,options->prefixind?" or digit":""); 100474e0666dSJed Brown start = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 10055f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(prefix,&n)); 10062c71b3e2SJacob Faibussowitsch PetscCheckFalse(n+1 > sizeof(options->prefix)-start,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum prefix length %zu exceeded",sizeof(options->prefix)); 10075f80ce2aSJacob Faibussowitsch CHKERRQ(PetscArraycpy(options->prefix+start,prefix,n+1)); 100874e0666dSJed Brown options->prefixstack[options->prefixind++] = start+n; 100974e0666dSJed Brown PetscFunctionReturn(0); 101074e0666dSJed Brown } 101174e0666dSJed Brown 1012c5929fdfSBarry Smith /*@C 101374e0666dSJed Brown PetscOptionsPrefixPop - Remove the latest options prefix, see PetscOptionsPrefixPush() for details 101474e0666dSJed Brown 10151c9f3c13SBarry Smith Logically Collective on the MPI_Comm that called PetscOptionsPrefixPush() 101674e0666dSJed Brown 1017c5929fdfSBarry Smith Input Parameters: 1018c5929fdfSBarry Smith . options - options database, or NULL for the default global database 1019c5929fdfSBarry Smith 102074e0666dSJed Brown Level: advanced 102174e0666dSJed Brown 10221c9f3c13SBarry Smith .seealso: PetscOptionsPrefixPush(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsSetValue() 102374e0666dSJed Brown @*/ 1024c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPop(PetscOptions options) 102574e0666dSJed Brown { 102674e0666dSJed Brown PetscInt offset; 102774e0666dSJed Brown 102874e0666dSJed Brown PetscFunctionBegin; 1029c5929fdfSBarry Smith options = options ? options : defaultoptions; 10302c71b3e2SJacob Faibussowitsch PetscCheckFalse(options->prefixind < 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"More prefixes popped than pushed"); 103174e0666dSJed Brown options->prefixind--; 103274e0666dSJed Brown offset = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 103374e0666dSJed Brown options->prefix[offset] = 0; 103474e0666dSJed Brown PetscFunctionReturn(0); 103574e0666dSJed Brown } 103674e0666dSJed Brown 1037a542b6e8SBarry Smith /*@C 1038a542b6e8SBarry Smith PetscOptionsClear - Removes all options form the database leaving it empty. 1039a542b6e8SBarry Smith 10401c9f3c13SBarry Smith Logically Collective 10411c9f3c13SBarry Smith 1042c5929fdfSBarry Smith Input Parameters: 1043c5929fdfSBarry Smith . options - options database, use NULL for the default global database 1044c5929fdfSBarry Smith 10459666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 10461c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 10471c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 10481c9f3c13SBarry Smith on different ranks. 10491c9f3c13SBarry Smith 1050a542b6e8SBarry Smith Level: developer 1051a542b6e8SBarry Smith 1052a542b6e8SBarry Smith .seealso: PetscOptionsInsert() 1053a542b6e8SBarry Smith @*/ 1054c5929fdfSBarry Smith PetscErrorCode PetscOptionsClear(PetscOptions options) 1055a542b6e8SBarry Smith { 1056a542b6e8SBarry Smith PetscInt i; 1057a542b6e8SBarry Smith 1058*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 1059c5929fdfSBarry Smith options = options ? options : defaultoptions; 1060*39a651e2SJacob Faibussowitsch if (!options) PetscFunctionReturn(0); 10612d747510SLisandro Dalcin 1062a542b6e8SBarry Smith for (i=0; i<options->N; i++) { 1063a542b6e8SBarry Smith if (options->names[i]) free(options->names[i]); 1064a542b6e8SBarry Smith if (options->values[i]) free(options->values[i]); 1065a542b6e8SBarry Smith } 10662d747510SLisandro Dalcin options->N = 0; 10672d747510SLisandro Dalcin 1068a542b6e8SBarry Smith for (i=0; i<options->Naliases; i++) { 1069a542b6e8SBarry Smith free(options->aliases1[i]); 1070a542b6e8SBarry Smith free(options->aliases2[i]); 1071a542b6e8SBarry Smith } 1072a542b6e8SBarry Smith options->Naliases = 0; 1073a542b6e8SBarry Smith 10742d747510SLisandro Dalcin /* destroy hash table */ 10752d747510SLisandro Dalcin kh_destroy(HO,options->ht); 10762d747510SLisandro Dalcin options->ht = NULL; 10770eb63584SBarry Smith 10782d747510SLisandro Dalcin options->prefixind = 0; 10792d747510SLisandro Dalcin options->prefix[0] = 0; 10802d747510SLisandro Dalcin options->help = PETSC_FALSE; 1081*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 10824416b707SBarry Smith } 10834416b707SBarry Smith 10842d747510SLisandro Dalcin /*@C 10852d747510SLisandro Dalcin PetscOptionsSetAlias - Makes a key and alias for another key 10862d747510SLisandro Dalcin 10871c9f3c13SBarry Smith Logically Collective 10882d747510SLisandro Dalcin 10892d747510SLisandro Dalcin Input Parameters: 10902d747510SLisandro Dalcin + options - options database, or NULL for default global database 10912d747510SLisandro Dalcin . newname - the alias 10922d747510SLisandro Dalcin - oldname - the name that alias will refer to 10932d747510SLisandro Dalcin 10942d747510SLisandro Dalcin Level: advanced 10952d747510SLisandro Dalcin 10969666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 10971c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 10981c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 10991c9f3c13SBarry Smith on different ranks. 11001c9f3c13SBarry Smith 11012d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 11022d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 11032d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 11042d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 11052d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 11062d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 11072d747510SLisandro Dalcin @*/ 11082d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetAlias(PetscOptions options,const char newname[],const char oldname[]) 11092d747510SLisandro Dalcin { 11102d747510SLisandro Dalcin PetscInt n; 11112d747510SLisandro Dalcin size_t len; 11129210b8eaSVaclav Hapla PetscBool valid; 11132d747510SLisandro Dalcin 11142d747510SLisandro Dalcin PetscFunctionBegin; 11152d747510SLisandro Dalcin PetscValidCharPointer(newname,2); 11162d747510SLisandro Dalcin PetscValidCharPointer(oldname,3); 11172d747510SLisandro Dalcin options = options ? options : defaultoptions; 11185f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(newname,&valid)); 111928b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid aliased option %s",newname); 11205f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(oldname,&valid)); 112128b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid aliasee option %s",oldname); 11222d747510SLisandro Dalcin 11232d747510SLisandro Dalcin n = options->Naliases; 11242c71b3e2SJacob Faibussowitsch PetscCheckFalse(n >= MAXALIASES,PETSC_COMM_SELF,PETSC_ERR_MEM,"You have defined to many PETSc options aliases, limit %d recompile \n src/sys/objects/options.c with larger value for MAXALIASES",MAXALIASES); 11252d747510SLisandro Dalcin 11262d747510SLisandro Dalcin newname++; oldname++; 11275f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(newname,&len)); 11282d747510SLisandro Dalcin options->aliases1[n] = (char*)malloc((len+1)*sizeof(char)); 11295f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcpy(options->aliases1[n],newname)); 11305f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(oldname,&len)); 11312d747510SLisandro Dalcin options->aliases2[n] = (char*)malloc((len+1)*sizeof(char)); 11325f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcpy(options->aliases2[n],oldname)); 11332d747510SLisandro Dalcin options->Naliases++; 11342d747510SLisandro Dalcin PetscFunctionReturn(0); 11352d747510SLisandro Dalcin } 11364416b707SBarry Smith 1137e5c89e4eSSatish Balay /*@C 1138e5c89e4eSSatish Balay PetscOptionsSetValue - Sets an option name-value pair in the options 1139e5c89e4eSSatish Balay database, overriding whatever is already present. 1140e5c89e4eSSatish Balay 11411c9f3c13SBarry Smith Logically Collective 1142e5c89e4eSSatish Balay 1143e5c89e4eSSatish Balay Input Parameters: 1144c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1145c5929fdfSBarry Smith . name - name of option, this SHOULD have the - prepended 11462d747510SLisandro Dalcin - value - the option value (not used for all options, so can be NULL) 1147e5c89e4eSSatish Balay 1148e5c89e4eSSatish Balay Level: intermediate 1149e5c89e4eSSatish Balay 1150e5c89e4eSSatish Balay Note: 1151d49172ceSBarry Smith This function can be called BEFORE PetscInitialize() 1152d49172ceSBarry Smith 11539666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 11541c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 11551c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 11561c9f3c13SBarry Smith on different ranks. 11571c9f3c13SBarry Smith 11582d747510SLisandro Dalcin Developers Note: Uses malloc() directly because PETSc may not be initialized yet. 1159b0250c70SBarry Smith 11602d747510SLisandro Dalcin .seealso: PetscOptionsInsert(), PetscOptionsClearValue() 1161e5c89e4eSSatish Balay @*/ 11622d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetValue(PetscOptions options,const char name[],const char value[]) 1163e5c89e4eSSatish Balay { 1164*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 1165*39a651e2SJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue_Private(options,name,value,NULL)); 1166*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 1167c5b5d8d5SVaclav Hapla } 1168c5b5d8d5SVaclav Hapla 1169c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsSetValue_Private(PetscOptions options,const char name[],const char value[],int *pos) 1170c5b5d8d5SVaclav Hapla { 1171e5c89e4eSSatish Balay size_t len; 11722d747510SLisandro Dalcin int N,n,i; 1173e5c89e4eSSatish Balay char **names; 11742d747510SLisandro Dalcin char fullname[MAXOPTNAME] = ""; 1175c5b5d8d5SVaclav Hapla PetscBool flg; 1176e5c89e4eSSatish Balay 1177*39a651e2SJacob Faibussowitsch PetscFunctionBegin; 11787272c0d2SVaclav Hapla if (!options) { 1179*39a651e2SJacob Faibussowitsch CHKERRQ(PetscOptionsCreateDefault()); 11807272c0d2SVaclav Hapla options = defaultoptions; 1181c5929fdfSBarry Smith } 1182*39a651e2SJacob Faibussowitsch PetscCheck(name[0] == '-',PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"name %s must start with '-'",name); 11832d747510SLisandro Dalcin 1184*39a651e2SJacob Faibussowitsch CHKERRQ(PetscOptionsSkipPrecedent(options,name,&flg)); 1185*39a651e2SJacob Faibussowitsch if (flg) PetscFunctionReturn(0); 1186e5c89e4eSSatish Balay 11872d747510SLisandro Dalcin name++; /* skip starting dash */ 11882d747510SLisandro Dalcin 118974e0666dSJed Brown if (options->prefixind > 0) { 1190d49172ceSBarry Smith strncpy(fullname,options->prefix,sizeof(fullname)); 11912d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 119289ae1891SBarry Smith strncat(fullname,name,sizeof(fullname)-strlen(fullname)-1); 11932d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 119474e0666dSJed Brown name = fullname; 119574e0666dSJed Brown } 119674e0666dSJed Brown 119774e0666dSJed Brown /* check against aliases */ 1198e5c89e4eSSatish Balay N = options->Naliases; 1199e5c89e4eSSatish Balay for (i=0; i<N; i++) { 12002d747510SLisandro Dalcin int result = PetscOptNameCmp(options->aliases1[i],name); 12012d747510SLisandro Dalcin if (!result) { name = options->aliases2[i]; break; } 1202e5c89e4eSSatish Balay } 1203e5c89e4eSSatish Balay 12042d747510SLisandro Dalcin /* slow search */ 12052d747510SLisandro Dalcin N = n = options->N; 1206e5c89e4eSSatish Balay names = options->names; 1207e5c89e4eSSatish Balay for (i=0; i<N; i++) { 12082d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 12092d747510SLisandro Dalcin if (!result) { 12102d747510SLisandro Dalcin n = i; goto setvalue; 12112d747510SLisandro Dalcin } else if (result > 0) { 12122d747510SLisandro Dalcin n = i; break; 1213e5c89e4eSSatish Balay } 1214e5c89e4eSSatish Balay } 1215*39a651e2SJacob Faibussowitsch PetscCheck(N < MAXOPTIONS,PETSC_COMM_SELF,PETSC_ERR_MEM,"Number of options %d < max number of options %d, can not allocate enough space",N,MAXOPTIONS); 1216*39a651e2SJacob Faibussowitsch 12172d747510SLisandro Dalcin /* shift remaining values up 1 */ 1218e5c89e4eSSatish Balay for (i=N; i>n; i--) { 12195e8c5e88SLisandro Dalcin options->names[i] = options->names[i-1]; 1220e5c89e4eSSatish Balay options->values[i] = options->values[i-1]; 1221e5c89e4eSSatish Balay options->used[i] = options->used[i-1]; 1222e5c89e4eSSatish Balay } 12232d747510SLisandro Dalcin options->names[n] = NULL; 12242d747510SLisandro Dalcin options->values[n] = NULL; 12252d747510SLisandro Dalcin options->used[n] = PETSC_FALSE; 12262d747510SLisandro Dalcin options->N++; 12272d747510SLisandro Dalcin 12282d747510SLisandro Dalcin /* destroy hash table */ 12292d747510SLisandro Dalcin kh_destroy(HO,options->ht); 12302d747510SLisandro Dalcin options->ht = NULL; 12312d747510SLisandro Dalcin 12322d747510SLisandro Dalcin /* set new name */ 123370d8d27cSBarry Smith len = strlen(name); 12345e8c5e88SLisandro Dalcin options->names[n] = (char*)malloc((len+1)*sizeof(char)); 1235*39a651e2SJacob Faibussowitsch PetscCheck(options->names[n],PETSC_COMM_SELF,PETSC_ERR_MEM,"Failed to allocate option name"); 1236d49172ceSBarry Smith strcpy(options->names[n],name); 12372d747510SLisandro Dalcin 12382d747510SLisandro Dalcin setvalue: 12392d747510SLisandro Dalcin /* set new value */ 12402d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1241d49172ceSBarry Smith len = value ? strlen(value) : 0; 12425e8c5e88SLisandro Dalcin if (len) { 1243e5c89e4eSSatish Balay options->values[n] = (char*)malloc((len+1)*sizeof(char)); 1244d49172ceSBarry Smith if (!options->values[n]) return PETSC_ERR_MEM; 1245d49172ceSBarry Smith strcpy(options->values[n],value); 12462d747510SLisandro Dalcin } else { 12472d747510SLisandro Dalcin options->values[n] = NULL; 12482d747510SLisandro Dalcin } 12492d747510SLisandro Dalcin 125091ad3481SVaclav Hapla /* handle -help so that it can be set from anywhere */ 125191ad3481SVaclav Hapla if (!PetscOptNameCmp(name,"help")) { 125291ad3481SVaclav Hapla options->help = PETSC_TRUE; 1253d06005cbSLisandro Dalcin options->help_intro = (value && !PetscOptNameCmp(value,"intro")) ? PETSC_TRUE : PETSC_FALSE; 125491ad3481SVaclav Hapla options->used[n] = PETSC_TRUE; 125591ad3481SVaclav Hapla } 125691ad3481SVaclav Hapla 12575f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsMonitor(options,name,value)); 1258c5b5d8d5SVaclav Hapla if (pos) *pos = n; 1259*39a651e2SJacob Faibussowitsch PetscFunctionReturn(0); 1260e5c89e4eSSatish Balay } 1261e5c89e4eSSatish Balay 1262e5c89e4eSSatish Balay /*@C 1263e5c89e4eSSatish Balay PetscOptionsClearValue - Clears an option name-value pair in the options 1264e5c89e4eSSatish Balay database, overriding whatever is already present. 1265e5c89e4eSSatish Balay 12661c9f3c13SBarry Smith Logically Collective 1267e5c89e4eSSatish Balay 1268d8d19677SJose E. Roman Input Parameters: 1269c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1270a2b725a8SWilliam Gropp - name - name of option, this SHOULD have the - prepended 1271e5c89e4eSSatish Balay 1272e5c89e4eSSatish Balay Level: intermediate 1273e5c89e4eSSatish Balay 12749666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 12751c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 12761c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 12771c9f3c13SBarry Smith on different ranks. 12781c9f3c13SBarry Smith 1279e5c89e4eSSatish Balay .seealso: PetscOptionsInsert() 1280e5c89e4eSSatish Balay @*/ 12812d747510SLisandro Dalcin PetscErrorCode PetscOptionsClearValue(PetscOptions options,const char name[]) 1282e5c89e4eSSatish Balay { 12832d747510SLisandro Dalcin int N,n,i; 12842d747510SLisandro Dalcin char **names; 1285e5c89e4eSSatish Balay 1286e5c89e4eSSatish Balay PetscFunctionBegin; 1287c5929fdfSBarry Smith options = options ? options : defaultoptions; 12882c71b3e2SJacob Faibussowitsch PetscCheckFalse(name[0] != '-',PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1289c9dcd962SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = options->help_intro = PETSC_FALSE; 12902d747510SLisandro Dalcin 12912d747510SLisandro Dalcin name++; /* skip starting dash */ 12922d747510SLisandro Dalcin 12932d747510SLisandro Dalcin /* slow search */ 12942d747510SLisandro Dalcin N = n = options->N; 1295e5c89e4eSSatish Balay names = options->names; 1296e5c89e4eSSatish Balay for (i=0; i<N; i++) { 12972d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 12982d747510SLisandro Dalcin if (!result) { 12992d747510SLisandro Dalcin n = i; break; 13002d747510SLisandro Dalcin } else if (result > 0) { 13012d747510SLisandro Dalcin n = N; break; 1302e5c89e4eSSatish Balay } 13032d747510SLisandro Dalcin } 13042d747510SLisandro Dalcin if (n == N) PetscFunctionReturn(0); /* it was not present */ 1305e5c89e4eSSatish Balay 13062d747510SLisandro Dalcin /* remove name and value */ 13072d747510SLisandro Dalcin if (options->names[n]) free(options->names[n]); 13082d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1309e5c89e4eSSatish Balay /* shift remaining values down 1 */ 1310e5c89e4eSSatish Balay for (i=n; i<N-1; i++) { 13115e8c5e88SLisandro Dalcin options->names[i] = options->names[i+1]; 1312e5c89e4eSSatish Balay options->values[i] = options->values[i+1]; 1313e5c89e4eSSatish Balay options->used[i] = options->used[i+1]; 1314e5c89e4eSSatish Balay } 1315e5c89e4eSSatish Balay options->N--; 13162d747510SLisandro Dalcin 13172d747510SLisandro Dalcin /* destroy hash table */ 13182d747510SLisandro Dalcin kh_destroy(HO,options->ht); 13192d747510SLisandro Dalcin options->ht = NULL; 13202d747510SLisandro Dalcin 13215f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsMonitor(options,name,NULL)); 1322e5c89e4eSSatish Balay PetscFunctionReturn(0); 1323e5c89e4eSSatish Balay } 1324e5c89e4eSSatish Balay 1325e5c89e4eSSatish Balay /*@C 13262d747510SLisandro Dalcin PetscOptionsFindPair - Gets an option name-value pair from the options database. 1327e5c89e4eSSatish Balay 13282d747510SLisandro Dalcin Not Collective 1329e5c89e4eSSatish Balay 1330e5c89e4eSSatish Balay Input Parameters: 13312d747510SLisandro Dalcin + options - options database, use NULL for the default global database 13322d747510SLisandro Dalcin . pre - the string to prepend to the name or NULL, this SHOULD NOT have the "-" prepended 13332d747510SLisandro Dalcin - name - name of option, this SHOULD have the "-" prepended 1334e5c89e4eSSatish Balay 13352d747510SLisandro Dalcin Output Parameters: 13362d747510SLisandro Dalcin + value - the option value (optional, not used for all options) 13372d747510SLisandro Dalcin - set - whether the option is set (optional) 1338e5c89e4eSSatish Balay 13399666a313SBarry Smith Notes: 13409666a313SBarry Smith Each process may find different values or no value depending on how options were inserted into the database 13411c9f3c13SBarry Smith 13422d747510SLisandro Dalcin Level: developer 13432d747510SLisandro Dalcin 13442d747510SLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsClearValue() 1345e5c89e4eSSatish Balay @*/ 13462d747510SLisandro Dalcin PetscErrorCode PetscOptionsFindPair(PetscOptions options,const char pre[],const char name[],const char *value[],PetscBool *set) 1347e5c89e4eSSatish Balay { 13482d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1349daabea38SBarry Smith PetscBool usehashtable = PETSC_TRUE; 13502d747510SLisandro Dalcin PetscBool matchnumbers = PETSC_TRUE; 1351e5c89e4eSSatish Balay 1352e5c89e4eSSatish Balay PetscFunctionBegin; 1353c5929fdfSBarry Smith options = options ? options : defaultoptions; 13542c71b3e2SJacob Faibussowitsch PetscCheckFalse(pre && PetscUnlikely(pre[0] == '-'),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 13552c71b3e2SJacob Faibussowitsch PetscCheckFalse(name[0] != '-',PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1356e5c89e4eSSatish Balay 13572d747510SLisandro Dalcin name++; /* skip starting dash */ 1358e5c89e4eSSatish Balay 13597cd08cecSJed Brown /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 13602d747510SLisandro Dalcin if (pre && pre[0]) { 13612d747510SLisandro Dalcin char *ptr = buf; 13622d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 13635f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(ptr,pre,buf+sizeof(buf)-ptr)); 13645f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlcat(buf,name,sizeof(buf))); 13652d747510SLisandro Dalcin name = buf; 13667cd08cecSJed Brown } 13672d747510SLisandro Dalcin 136876bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 13692f828895SJed Brown PetscBool valid; 13702d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 13715f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(key+1,name,sizeof(key)-1)); 13725f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(key,&valid)); 137328b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid option '%s' obtained from pre='%s' and name='%s'",key,pre?pre:"",name); 13742f828895SJed Brown } 1375e5c89e4eSSatish Balay 13762d747510SLisandro Dalcin if (!options->ht && usehashtable) { 13772d747510SLisandro Dalcin int i,ret; 13782d747510SLisandro Dalcin khiter_t it; 13792d747510SLisandro Dalcin khash_t(HO) *ht; 13802d747510SLisandro Dalcin ht = kh_init(HO); 138128b400f6SJacob Faibussowitsch PetscCheck(ht,PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13822d747510SLisandro Dalcin ret = kh_resize(HO,ht,options->N*2); /* twice the required size to reduce risk of collisions */ 138328b400f6SJacob Faibussowitsch PetscCheck(!ret,PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13842d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 13852d747510SLisandro Dalcin it = kh_put(HO,ht,options->names[i],&ret); 13862c71b3e2SJacob Faibussowitsch PetscCheckFalse(ret != 1,PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13872d747510SLisandro Dalcin kh_val(ht,it) = i; 13882d747510SLisandro Dalcin } 13892d747510SLisandro Dalcin options->ht = ht; 13902d747510SLisandro Dalcin } 13912d747510SLisandro Dalcin 13922d747510SLisandro Dalcin if (usehashtable) 13932d747510SLisandro Dalcin { /* fast search */ 13942d747510SLisandro Dalcin khash_t(HO) *ht = options->ht; 13952d747510SLisandro Dalcin khiter_t it = kh_get(HO,ht,name); 13962d747510SLisandro Dalcin if (it != kh_end(ht)) { 13972d747510SLisandro Dalcin int i = kh_val(ht,it); 1398e5c89e4eSSatish Balay options->used[i] = PETSC_TRUE; 13992d747510SLisandro Dalcin if (value) *value = options->values[i]; 14002d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 14012d747510SLisandro Dalcin PetscFunctionReturn(0); 14022d747510SLisandro Dalcin } 14032d747510SLisandro Dalcin } else 14042d747510SLisandro Dalcin { /* slow search */ 14052d747510SLisandro Dalcin int i, N = options->N; 14062d747510SLisandro Dalcin for (i=0; i<N; i++) { 1407daabea38SBarry Smith int result = PetscOptNameCmp(options->names[i],name); 14082d747510SLisandro Dalcin if (!result) { 14092d747510SLisandro Dalcin options->used[i] = PETSC_TRUE; 14102d747510SLisandro Dalcin if (value) *value = options->values[i]; 14112d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 14122d747510SLisandro Dalcin PetscFunctionReturn(0); 14132d747510SLisandro Dalcin } else if (result > 0) { 1414e5c89e4eSSatish Balay break; 1415e5c89e4eSSatish Balay } 1416e5c89e4eSSatish Balay } 14172d747510SLisandro Dalcin } 14182d747510SLisandro Dalcin 14192d747510SLisandro Dalcin /* 14202d747510SLisandro Dalcin The following block slows down all lookups in the most frequent path (most lookups are unsuccessful). 14212d747510SLisandro Dalcin Maybe this special lookup mode should be enabled on request with a push/pop API. 14222d747510SLisandro Dalcin The feature of matching _%d_ used sparingly in the codebase. 14232d747510SLisandro Dalcin */ 14242d747510SLisandro Dalcin if (matchnumbers) { 14252d747510SLisandro Dalcin int i,j,cnt = 0,locs[16],loce[16]; 1426e5c89e4eSSatish Balay /* determine the location and number of all _%d_ in the key */ 14272d747510SLisandro Dalcin for (i=0; name[i]; i++) { 14282d747510SLisandro Dalcin if (name[i] == '_') { 14292d747510SLisandro Dalcin for (j=i+1; name[j]; j++) { 14302d747510SLisandro Dalcin if (name[j] >= '0' && name[j] <= '9') continue; 14312d747510SLisandro Dalcin if (name[j] == '_' && j > i+1) { /* found a number */ 1432e5c89e4eSSatish Balay locs[cnt] = i+1; 1433e5c89e4eSSatish Balay loce[cnt++] = j+1; 1434e5c89e4eSSatish Balay } 14352d747510SLisandro Dalcin i = j-1; 1436e5c89e4eSSatish Balay break; 1437e5c89e4eSSatish Balay } 1438e5c89e4eSSatish Balay } 1439e5c89e4eSSatish Balay } 1440e5c89e4eSSatish Balay for (i=0; i<cnt; i++) { 14412d747510SLisandro Dalcin PetscBool found; 14422d747510SLisandro Dalcin char opt[MAXOPTNAME+1] = "-", tmp[MAXOPTNAME]; 14435f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(tmp,name,PetscMin((size_t)(locs[i]+1),sizeof(tmp)))); 14445f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlcat(opt,tmp,sizeof(opt))); 14455f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlcat(opt,name+loce[i],sizeof(opt))); 14465f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,NULL,opt,value,&found)); 14472d747510SLisandro Dalcin if (found) {if (set) *set = PETSC_TRUE; PetscFunctionReturn(0);} 1448e5c89e4eSSatish Balay } 1449e5c89e4eSSatish Balay } 14502d747510SLisandro Dalcin 14512d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1452e5c89e4eSSatish Balay PetscFunctionReturn(0); 1453e5c89e4eSSatish Balay } 1454e5c89e4eSSatish Balay 1455d6ced9c0SMatthew G. Knepley /* Check whether any option begins with pre+name */ 14562d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions options,const char pre[], const char name[],const char *value[],PetscBool *set) 1457514bf10dSMatthew G Knepley { 14582d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1459d6ced9c0SMatthew G. Knepley int numCnt = 0, locs[16],loce[16]; 1460514bf10dSMatthew G Knepley 1461514bf10dSMatthew G Knepley PetscFunctionBegin; 1462c5929fdfSBarry Smith options = options ? options : defaultoptions; 14632c71b3e2SJacob Faibussowitsch PetscCheckFalse(pre && pre[0] == '-',PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 14642c71b3e2SJacob Faibussowitsch PetscCheckFalse(name[0] != '-',PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1465514bf10dSMatthew G Knepley 14662d747510SLisandro Dalcin name++; /* skip starting dash */ 1467514bf10dSMatthew G Knepley 1468514bf10dSMatthew G Knepley /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 14692d747510SLisandro Dalcin if (pre && pre[0]) { 14702d747510SLisandro Dalcin char *ptr = buf; 14712d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 14725f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(ptr,pre,sizeof(buf)+(size_t)(ptr-buf))); 14735f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlcat(buf,name,sizeof(buf))); 14742d747510SLisandro Dalcin name = buf; 1475514bf10dSMatthew G Knepley } 14762d747510SLisandro Dalcin 147776bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1478514bf10dSMatthew G Knepley PetscBool valid; 14792d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 14805f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(key+1,name,sizeof(key)-1)); 14815f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsValidKey(key,&valid)); 148228b400f6SJacob Faibussowitsch PetscCheck(valid,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid option '%s' obtained from pre='%s' and name='%s'",key,pre?pre:"",name); 1483514bf10dSMatthew G Knepley } 1484514bf10dSMatthew G Knepley 1485d6ced9c0SMatthew G. Knepley /* determine the location and number of all _%d_ in the key */ 1486d6ced9c0SMatthew G. Knepley { 1487d6ced9c0SMatthew G. Knepley int i,j; 1488d6ced9c0SMatthew G. Knepley for (i=0; name[i]; i++) { 1489d6ced9c0SMatthew G. Knepley if (name[i] == '_') { 1490d6ced9c0SMatthew G. Knepley for (j=i+1; name[j]; j++) { 1491d6ced9c0SMatthew G. Knepley if (name[j] >= '0' && name[j] <= '9') continue; 1492d6ced9c0SMatthew G. Knepley if (name[j] == '_' && j > i+1) { /* found a number */ 1493d6ced9c0SMatthew G. Knepley locs[numCnt] = i+1; 1494d6ced9c0SMatthew G. Knepley loce[numCnt++] = j+1; 1495d6ced9c0SMatthew G. Knepley } 1496d6ced9c0SMatthew G. Knepley i = j-1; 1497d6ced9c0SMatthew G. Knepley break; 1498d6ced9c0SMatthew G. Knepley } 1499d6ced9c0SMatthew G. Knepley } 1500d6ced9c0SMatthew G. Knepley } 1501d6ced9c0SMatthew G. Knepley } 1502d6ced9c0SMatthew G. Knepley 15032d747510SLisandro Dalcin { /* slow search */ 1504d6ced9c0SMatthew G. Knepley int c, i; 15052d747510SLisandro Dalcin size_t len; 15062d747510SLisandro Dalcin PetscBool match; 1507d6ced9c0SMatthew G. Knepley 1508d6ced9c0SMatthew G. Knepley for (c = -1; c < numCnt; ++c) { 1509d6ced9c0SMatthew G. Knepley char opt[MAXOPTNAME+1] = "", tmp[MAXOPTNAME]; 1510d6ced9c0SMatthew G. Knepley 1511d6ced9c0SMatthew G. Knepley if (c < 0) { 15125f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcpy(opt,name)); 1513d6ced9c0SMatthew G. Knepley } else { 15145f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncpy(tmp,name,PetscMin((size_t)(locs[c]+1),sizeof(tmp)))); 15155f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlcat(opt,tmp,sizeof(opt))); 15165f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlcat(opt,name+loce[c],sizeof(opt))); 1517d6ced9c0SMatthew G. Knepley } 15185f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(opt,&len)); 15192d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15205f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrncmp(options->names[i],opt,len,&match)); 1521514bf10dSMatthew G Knepley if (match) { 1522514bf10dSMatthew G Knepley options->used[i] = PETSC_TRUE; 15232d747510SLisandro Dalcin if (value) *value = options->values[i]; 15242d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 15252d747510SLisandro Dalcin PetscFunctionReturn(0); 1526514bf10dSMatthew G Knepley } 1527514bf10dSMatthew G Knepley } 15282d747510SLisandro Dalcin } 1529d6ced9c0SMatthew G. Knepley } 15302d747510SLisandro Dalcin 15312d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1532514bf10dSMatthew G Knepley PetscFunctionReturn(0); 1533514bf10dSMatthew G Knepley } 1534514bf10dSMatthew G Knepley 1535e5c89e4eSSatish Balay /*@C 1536e5c89e4eSSatish Balay PetscOptionsReject - Generates an error if a certain option is given. 1537e5c89e4eSSatish Balay 15381c9f3c13SBarry Smith Not Collective 1539e5c89e4eSSatish Balay 1540e5c89e4eSSatish Balay Input Parameters: 15415c9cc608SHong Zhang + options - options database, use NULL for default global database 15422d747510SLisandro Dalcin . pre - the option prefix (may be NULL) 15432d747510SLisandro Dalcin . name - the option name one is seeking 15440298fd71SBarry Smith - mess - error message (may be NULL) 1545e5c89e4eSSatish Balay 1546e5c89e4eSSatish Balay Level: advanced 1547e5c89e4eSSatish Balay 1548e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 1549acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1550e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1551e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1552acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1553a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1554e5c89e4eSSatish Balay @*/ 15552d747510SLisandro Dalcin PetscErrorCode PetscOptionsReject(PetscOptions options,const char pre[],const char name[],const char mess[]) 1556e5c89e4eSSatish Balay { 1557ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 1558e5c89e4eSSatish Balay 1559e5c89e4eSSatish Balay PetscFunctionBegin; 15605f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsHasName(options,pre,name,&flag)); 1561e5c89e4eSSatish Balay if (flag) { 15622c71b3e2SJacob Faibussowitsch PetscCheckFalse(mess && mess[0],PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s with %s",pre?pre:"",name+1,mess); 156398921bdaSJacob Faibussowitsch else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s",pre?pre:"",name+1); 1564e5c89e4eSSatish Balay } 1565e5c89e4eSSatish Balay PetscFunctionReturn(0); 1566e5c89e4eSSatish Balay } 1567e5c89e4eSSatish Balay 1568e5c89e4eSSatish Balay /*@C 15692d747510SLisandro Dalcin PetscOptionsHasHelp - Determines whether the "-help" option is in the database. 15702d747510SLisandro Dalcin 15712d747510SLisandro Dalcin Not Collective 15722d747510SLisandro Dalcin 15732d747510SLisandro Dalcin Input Parameters: 15742d747510SLisandro Dalcin . options - options database, use NULL for default global database 15752d747510SLisandro Dalcin 15762d747510SLisandro Dalcin Output Parameters: 15772d747510SLisandro Dalcin . set - PETSC_TRUE if found else PETSC_FALSE. 15782d747510SLisandro Dalcin 15792d747510SLisandro Dalcin Level: advanced 15802d747510SLisandro Dalcin 15812d747510SLisandro Dalcin .seealso: PetscOptionsHasName() 15822d747510SLisandro Dalcin @*/ 15832d747510SLisandro Dalcin PetscErrorCode PetscOptionsHasHelp(PetscOptions options,PetscBool *set) 15842d747510SLisandro Dalcin { 15852d747510SLisandro Dalcin PetscFunctionBegin; 1586dadcf809SJacob Faibussowitsch PetscValidBoolPointer(set,2); 15872d747510SLisandro Dalcin options = options ? options : defaultoptions; 15882d747510SLisandro Dalcin *set = options->help; 15892d747510SLisandro Dalcin PetscFunctionReturn(0); 15902d747510SLisandro Dalcin } 15912d747510SLisandro Dalcin 1592d314f959SVaclav Hapla PetscErrorCode PetscOptionsHasHelpIntro_Internal(PetscOptions options,PetscBool *set) 1593d314f959SVaclav Hapla { 1594d314f959SVaclav Hapla PetscFunctionBegin; 1595dadcf809SJacob Faibussowitsch PetscValidBoolPointer(set,2); 1596d314f959SVaclav Hapla options = options ? options : defaultoptions; 1597d314f959SVaclav Hapla *set = options->help_intro; 1598d314f959SVaclav Hapla PetscFunctionReturn(0); 1599d314f959SVaclav Hapla } 1600d314f959SVaclav Hapla 16012d747510SLisandro Dalcin /*@C 1602e24fcbf7SPierre Jolivet PetscOptionsHasName - Determines whether a certain option is given in the database. This returns true whether the option is a number, string or Boolean, even 1603e24fcbf7SPierre Jolivet if its value is set to false. 1604e5c89e4eSSatish Balay 1605e5c89e4eSSatish Balay Not Collective 1606e5c89e4eSSatish Balay 1607e5c89e4eSSatish Balay Input Parameters: 16085c9cc608SHong Zhang + options - options database, use NULL for default global database 16093de71b31SHong Zhang . pre - string to prepend to the name or NULL 16103de71b31SHong Zhang - name - the option one is seeking 1611e5c89e4eSSatish Balay 1612e5c89e4eSSatish Balay Output Parameters: 161396ef3cdfSSatish Balay . set - PETSC_TRUE if found else PETSC_FALSE. 1614e5c89e4eSSatish Balay 1615e5c89e4eSSatish Balay Level: beginner 1616e5c89e4eSSatish Balay 161795452b02SPatrick Sanan Notes: 1618acfcf0e5SJed Brown In many cases you probably want to use PetscOptionsGetBool() instead of calling this, to allowing toggling values. 161990d69ab7SBarry Smith 1620e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1621f3e3d7dfSBarry Smith PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1622e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1623e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1624acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1625a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1626e5c89e4eSSatish Balay @*/ 1627c5929fdfSBarry Smith PetscErrorCode PetscOptionsHasName(PetscOptions options,const char pre[],const char name[],PetscBool *set) 1628e5c89e4eSSatish Balay { 16292d747510SLisandro Dalcin const char *value; 1630ace3abfcSBarry Smith PetscBool flag; 1631e5c89e4eSSatish Balay 1632e5c89e4eSSatish Balay PetscFunctionBegin; 16335f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&value,&flag)); 163496ef3cdfSSatish Balay if (set) *set = flag; 1635e5c89e4eSSatish Balay PetscFunctionReturn(0); 1636e5c89e4eSSatish Balay } 1637e5c89e4eSSatish Balay 1638e5c89e4eSSatish Balay /*@C 16392d747510SLisandro Dalcin PetscOptionsGetAll - Lists all the options the program was run with in a single string. 16402d747510SLisandro Dalcin 16412d747510SLisandro Dalcin Not Collective 16422d747510SLisandro Dalcin 1643fd292e60Sprj- Input Parameter: 16442d747510SLisandro Dalcin . options - the options database, use NULL for the default global database 16452d747510SLisandro Dalcin 16462d747510SLisandro Dalcin Output Parameter: 16472d747510SLisandro Dalcin . copts - pointer where string pointer is stored 16482d747510SLisandro Dalcin 16492d747510SLisandro Dalcin Notes: 16501c9f3c13SBarry Smith The array and each entry in the array should be freed with PetscFree() 16511c9f3c13SBarry Smith Each process may have different values depending on how the options were inserted into the database 16522d747510SLisandro Dalcin 16532d747510SLisandro Dalcin Level: advanced 16542d747510SLisandro Dalcin 16551c9f3c13SBarry Smith .seealso: PetscOptionsAllUsed(), PetscOptionsView(), PetscOptionsPush(), PetscOptionsPop() 16562d747510SLisandro Dalcin @*/ 16572d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetAll(PetscOptions options,char *copts[]) 16582d747510SLisandro Dalcin { 16592d747510SLisandro Dalcin PetscInt i; 16602d747510SLisandro Dalcin size_t len = 1,lent = 0; 16612d747510SLisandro Dalcin char *coptions = NULL; 16622d747510SLisandro Dalcin 16632d747510SLisandro Dalcin PetscFunctionBegin; 16642d747510SLisandro Dalcin PetscValidPointer(copts,2); 16652d747510SLisandro Dalcin options = options ? options : defaultoptions; 16662d747510SLisandro Dalcin /* count the length of the required string */ 16672d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16685f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(options->names[i],&lent)); 16692d747510SLisandro Dalcin len += 2 + lent; 16702d747510SLisandro Dalcin if (options->values[i]) { 16715f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(options->values[i],&lent)); 16722d747510SLisandro Dalcin len += 1 + lent; 16732d747510SLisandro Dalcin } 16742d747510SLisandro Dalcin } 16755f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMalloc1(len,&coptions)); 16762d747510SLisandro Dalcin coptions[0] = 0; 16772d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16785f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(coptions,"-")); 16795f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(coptions,options->names[i])); 16805f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(coptions," ")); 16812d747510SLisandro Dalcin if (options->values[i]) { 16825f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(coptions,options->values[i])); 16835f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(coptions," ")); 16842d747510SLisandro Dalcin } 16852d747510SLisandro Dalcin } 16862d747510SLisandro Dalcin *copts = coptions; 16872d747510SLisandro Dalcin PetscFunctionReturn(0); 16882d747510SLisandro Dalcin } 16892d747510SLisandro Dalcin 16902d747510SLisandro Dalcin /*@C 16912d747510SLisandro Dalcin PetscOptionsUsed - Indicates if PETSc has used a particular option set in the database 16922d747510SLisandro Dalcin 16932d747510SLisandro Dalcin Not Collective 16942d747510SLisandro Dalcin 1695d8d19677SJose E. Roman Input Parameters: 16962d747510SLisandro Dalcin + options - options database, use NULL for default global database 16972d747510SLisandro Dalcin - name - string name of option 16982d747510SLisandro Dalcin 16992d747510SLisandro Dalcin Output Parameter: 17002d747510SLisandro Dalcin . used - PETSC_TRUE if the option was used, otherwise false, including if option was not found in options database 17012d747510SLisandro Dalcin 17022d747510SLisandro Dalcin Level: advanced 17032d747510SLisandro Dalcin 17049666a313SBarry Smith Notes: 17059666a313SBarry Smith The value returned may be different on each process and depends on which options have been processed 17061c9f3c13SBarry Smith on the given process 17071c9f3c13SBarry Smith 17082d747510SLisandro Dalcin .seealso: PetscOptionsView(), PetscOptionsLeft(), PetscOptionsAllUsed() 17092d747510SLisandro Dalcin @*/ 17102d747510SLisandro Dalcin PetscErrorCode PetscOptionsUsed(PetscOptions options,const char *name,PetscBool *used) 17112d747510SLisandro Dalcin { 17122d747510SLisandro Dalcin PetscInt i; 17132d747510SLisandro Dalcin 17142d747510SLisandro Dalcin PetscFunctionBegin; 17152d747510SLisandro Dalcin PetscValidCharPointer(name,2); 1716dadcf809SJacob Faibussowitsch PetscValidBoolPointer(used,3); 17172d747510SLisandro Dalcin options = options ? options : defaultoptions; 17182d747510SLisandro Dalcin *used = PETSC_FALSE; 17192d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 17205f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(options->names[i],name,used)); 17212d747510SLisandro Dalcin if (*used) { 17222d747510SLisandro Dalcin *used = options->used[i]; 17232d747510SLisandro Dalcin break; 17242d747510SLisandro Dalcin } 17252d747510SLisandro Dalcin } 17262d747510SLisandro Dalcin PetscFunctionReturn(0); 17272d747510SLisandro Dalcin } 17282d747510SLisandro Dalcin 1729487a658cSBarry Smith /*@ 17302d747510SLisandro Dalcin PetscOptionsAllUsed - Returns a count of the number of options in the 17312d747510SLisandro Dalcin database that have never been selected. 17322d747510SLisandro Dalcin 17332d747510SLisandro Dalcin Not Collective 17342d747510SLisandro Dalcin 17352d747510SLisandro Dalcin Input Parameter: 17362d747510SLisandro Dalcin . options - options database, use NULL for default global database 17372d747510SLisandro Dalcin 17382d747510SLisandro Dalcin Output Parameter: 17392d747510SLisandro Dalcin . N - count of options not used 17402d747510SLisandro Dalcin 17412d747510SLisandro Dalcin Level: advanced 17422d747510SLisandro Dalcin 17439666a313SBarry Smith Notes: 17449666a313SBarry Smith The value returned may be different on each process and depends on which options have been processed 17451c9f3c13SBarry Smith on the given process 17461c9f3c13SBarry Smith 17472d747510SLisandro Dalcin .seealso: PetscOptionsView() 17482d747510SLisandro Dalcin @*/ 17492d747510SLisandro Dalcin PetscErrorCode PetscOptionsAllUsed(PetscOptions options,PetscInt *N) 17502d747510SLisandro Dalcin { 17512d747510SLisandro Dalcin PetscInt i,n = 0; 17522d747510SLisandro Dalcin 17532d747510SLisandro Dalcin PetscFunctionBegin; 17542d747510SLisandro Dalcin PetscValidIntPointer(N,2); 17552d747510SLisandro Dalcin options = options ? options : defaultoptions; 17562d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 17572d747510SLisandro Dalcin if (!options->used[i]) n++; 17582d747510SLisandro Dalcin } 17592d747510SLisandro Dalcin *N = n; 17602d747510SLisandro Dalcin PetscFunctionReturn(0); 17612d747510SLisandro Dalcin } 17622d747510SLisandro Dalcin 1763487a658cSBarry Smith /*@ 17642d747510SLisandro Dalcin PetscOptionsLeft - Prints to screen any options that were set and never used. 17652d747510SLisandro Dalcin 17662d747510SLisandro Dalcin Not Collective 17672d747510SLisandro Dalcin 17682d747510SLisandro Dalcin Input Parameter: 17692d747510SLisandro Dalcin . options - options database; use NULL for default global database 17702d747510SLisandro Dalcin 17712d747510SLisandro Dalcin Options Database Key: 17723c6db4c4SPierre Jolivet . -options_left - activates PetscOptionsAllUsed() within PetscFinalize() 17732d747510SLisandro Dalcin 17743de2bfdfSBarry Smith Notes: 17753de2bfdfSBarry Smith This is rarely used directly, it is called by PetscFinalize() in debug more or if -options_left 17761c9f3c13SBarry Smith is passed otherwise to help users determine possible mistakes in their usage of options. This 17771c9f3c13SBarry Smith only prints values on process zero of PETSC_COMM_WORLD. Other processes depending the objects 17781c9f3c13SBarry Smith used may have different options that are left unused. 17793de2bfdfSBarry Smith 17802d747510SLisandro Dalcin Level: advanced 17812d747510SLisandro Dalcin 17822d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed() 17832d747510SLisandro Dalcin @*/ 17842d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeft(PetscOptions options) 17852d747510SLisandro Dalcin { 17862d747510SLisandro Dalcin PetscInt i; 17873de2bfdfSBarry Smith PetscInt cnt = 0; 17883de2bfdfSBarry Smith PetscOptions toptions; 17892d747510SLisandro Dalcin 17902d747510SLisandro Dalcin PetscFunctionBegin; 17913de2bfdfSBarry Smith toptions = options ? options : defaultoptions; 17923de2bfdfSBarry Smith for (i=0; i<toptions->N; i++) { 17933de2bfdfSBarry Smith if (!toptions->used[i]) { 17943de2bfdfSBarry Smith if (toptions->values[i]) { 17955f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s value: %s\n",toptions->names[i],toptions->values[i])); 17962d747510SLisandro Dalcin } else { 17975f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s (no value)\n",toptions->names[i])); 17982d747510SLisandro Dalcin } 17992d747510SLisandro Dalcin } 18002d747510SLisandro Dalcin } 18013de2bfdfSBarry Smith if (!options) { 18023de2bfdfSBarry Smith toptions = defaultoptions; 18033de2bfdfSBarry Smith while (toptions->previous) { 18043de2bfdfSBarry Smith cnt++; 18053de2bfdfSBarry Smith toptions = toptions->previous; 18063de2bfdfSBarry Smith } 18073de2bfdfSBarry Smith if (cnt) { 18085f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(PETSC_COMM_WORLD,"Option left: You may have forgotten some calls to PetscOptionsPop(),\n PetscOptionsPop() has been called %" PetscInt_FMT " less times than PetscOptionsPush()\n",cnt)); 18093de2bfdfSBarry Smith } 18103de2bfdfSBarry Smith } 18112d747510SLisandro Dalcin PetscFunctionReturn(0); 18122d747510SLisandro Dalcin } 18132d747510SLisandro Dalcin 18142d747510SLisandro Dalcin /*@C 18152d747510SLisandro Dalcin PetscOptionsLeftGet - Returns all options that were set and never used. 18162d747510SLisandro Dalcin 18172d747510SLisandro Dalcin Not Collective 18182d747510SLisandro Dalcin 18192d747510SLisandro Dalcin Input Parameter: 18202d747510SLisandro Dalcin . options - options database, use NULL for default global database 18212d747510SLisandro Dalcin 1822d8d19677SJose E. Roman Output Parameters: 1823a2b725a8SWilliam Gropp + N - count of options not used 18242d747510SLisandro Dalcin . names - names of options not used 1825a2b725a8SWilliam Gropp - values - values of options not used 18262d747510SLisandro Dalcin 18272d747510SLisandro Dalcin Level: advanced 18282d747510SLisandro Dalcin 18292d747510SLisandro Dalcin Notes: 18302d747510SLisandro Dalcin Users should call PetscOptionsLeftRestore() to free the memory allocated in this routine 18311c9f3c13SBarry Smith Notes: The value returned may be different on each process and depends on which options have been processed 18321c9f3c13SBarry Smith on the given process 18332d747510SLisandro Dalcin 18342d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft() 18352d747510SLisandro Dalcin @*/ 18362d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftGet(PetscOptions options,PetscInt *N,char **names[],char **values[]) 18372d747510SLisandro Dalcin { 18382d747510SLisandro Dalcin PetscInt i,n; 18392d747510SLisandro Dalcin 18402d747510SLisandro Dalcin PetscFunctionBegin; 18412d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 18422d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 18432d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 18442d747510SLisandro Dalcin options = options ? options : defaultoptions; 18452d747510SLisandro Dalcin 18462d747510SLisandro Dalcin /* The number of unused PETSc options */ 18472d747510SLisandro Dalcin n = 0; 18482d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 18492d747510SLisandro Dalcin if (!options->used[i]) n++; 18502d747510SLisandro Dalcin } 18512d747510SLisandro Dalcin if (N) { *N = n; } 18525f80ce2aSJacob Faibussowitsch if (names) CHKERRQ(PetscMalloc1(n,names)); 18535f80ce2aSJacob Faibussowitsch if (values) CHKERRQ(PetscMalloc1(n,values)); 18542d747510SLisandro Dalcin 18552d747510SLisandro Dalcin n = 0; 18562d747510SLisandro Dalcin if (names || values) { 18572d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 18582d747510SLisandro Dalcin if (!options->used[i]) { 18592d747510SLisandro Dalcin if (names) (*names)[n] = options->names[i]; 18602d747510SLisandro Dalcin if (values) (*values)[n] = options->values[i]; 18612d747510SLisandro Dalcin n++; 18622d747510SLisandro Dalcin } 18632d747510SLisandro Dalcin } 18642d747510SLisandro Dalcin } 18652d747510SLisandro Dalcin PetscFunctionReturn(0); 18662d747510SLisandro Dalcin } 18672d747510SLisandro Dalcin 18682d747510SLisandro Dalcin /*@C 18692d747510SLisandro Dalcin PetscOptionsLeftRestore - Free memory for the unused PETSc options obtained using PetscOptionsLeftGet. 18702d747510SLisandro Dalcin 18712d747510SLisandro Dalcin Not Collective 18722d747510SLisandro Dalcin 1873d8d19677SJose E. Roman Input Parameters: 1874a2b725a8SWilliam Gropp + options - options database, use NULL for default global database 18752d747510SLisandro Dalcin . names - names of options not used 1876a2b725a8SWilliam Gropp - values - values of options not used 18772d747510SLisandro Dalcin 18782d747510SLisandro Dalcin Level: advanced 18792d747510SLisandro Dalcin 18802d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft(), PetscOptionsLeftGet() 18812d747510SLisandro Dalcin @*/ 18822d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftRestore(PetscOptions options,PetscInt *N,char **names[],char **values[]) 18832d747510SLisandro Dalcin { 18842d747510SLisandro Dalcin PetscFunctionBegin; 18852d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 18862d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 18872d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 18882d747510SLisandro Dalcin if (N) { *N = 0; } 18895f80ce2aSJacob Faibussowitsch if (names) CHKERRQ(PetscFree(*names)); 18905f80ce2aSJacob Faibussowitsch if (values) CHKERRQ(PetscFree(*values)); 18912d747510SLisandro Dalcin PetscFunctionReturn(0); 18922d747510SLisandro Dalcin } 18932d747510SLisandro Dalcin 18942d747510SLisandro Dalcin /*@C 18959060e2f9SVaclav Hapla PetscOptionsMonitorDefault - Print all options set value events using the supplied PetscViewer. 18962d747510SLisandro Dalcin 18971c9f3c13SBarry Smith Logically Collective on ctx 18982d747510SLisandro Dalcin 18992d747510SLisandro Dalcin Input Parameters: 19002d747510SLisandro Dalcin + name - option name string 19012d747510SLisandro Dalcin . value - option value string 19029060e2f9SVaclav Hapla - ctx - an ASCII viewer or NULL 19032d747510SLisandro Dalcin 19042d747510SLisandro Dalcin Level: intermediate 19052d747510SLisandro Dalcin 19069666a313SBarry Smith Notes: 19079060e2f9SVaclav Hapla If ctx=NULL, PetscPrintf() is used. 19089666a313SBarry Smith The first MPI rank in the PetscViewer viewer actually prints the values, other 19091c9f3c13SBarry Smith processes may have different values set 19101c9f3c13SBarry Smith 19112d747510SLisandro Dalcin .seealso: PetscOptionsMonitorSet() 19122d747510SLisandro Dalcin @*/ 19132d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorDefault(const char name[],const char value[],void *ctx) 19142d747510SLisandro Dalcin { 19152d747510SLisandro Dalcin PetscFunctionBegin; 19169060e2f9SVaclav Hapla if (ctx) { 19179060e2f9SVaclav Hapla PetscViewer viewer = (PetscViewer)ctx; 19182d747510SLisandro Dalcin if (!value) { 19195f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"Removing option: %s\n",name)); 19202d747510SLisandro Dalcin } else if (!value[0]) { 19215f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"Setting option: %s (no value)\n",name)); 19222d747510SLisandro Dalcin } else { 19235f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerASCIIPrintf(viewer,"Setting option: %s = %s\n",name,value)); 19242d747510SLisandro Dalcin } 19259060e2f9SVaclav Hapla } else { 19269060e2f9SVaclav Hapla MPI_Comm comm = PETSC_COMM_WORLD; 19279060e2f9SVaclav Hapla if (!value) { 19285f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(comm,"Removing option: %s\n",name)); 19299060e2f9SVaclav Hapla } else if (!value[0]) { 19305f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(comm,"Setting option: %s (no value)\n",name)); 19319060e2f9SVaclav Hapla } else { 19325f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(comm,"Setting option: %s = %s\n",name,value)); 19339060e2f9SVaclav Hapla } 19349060e2f9SVaclav Hapla } 19352d747510SLisandro Dalcin PetscFunctionReturn(0); 19362d747510SLisandro Dalcin } 19372d747510SLisandro Dalcin 19382d747510SLisandro Dalcin /*@C 19392d747510SLisandro Dalcin PetscOptionsMonitorSet - Sets an ADDITIONAL function to be called at every method that 19402d747510SLisandro Dalcin modified the PETSc options database. 19412d747510SLisandro Dalcin 19422d747510SLisandro Dalcin Not Collective 19432d747510SLisandro Dalcin 19442d747510SLisandro Dalcin Input Parameters: 19452d747510SLisandro Dalcin + monitor - pointer to function (if this is NULL, it turns off monitoring 19462d747510SLisandro Dalcin . mctx - [optional] context for private data for the 19472d747510SLisandro Dalcin monitor routine (use NULL if no context is desired) 19482d747510SLisandro Dalcin - monitordestroy - [optional] routine that frees monitor context 19492d747510SLisandro Dalcin (may be NULL) 19502d747510SLisandro Dalcin 19512d747510SLisandro Dalcin Calling Sequence of monitor: 19522d747510SLisandro Dalcin $ monitor (const char name[], const char value[], void *mctx) 19532d747510SLisandro Dalcin 19542d747510SLisandro Dalcin + name - option name string 19552d747510SLisandro Dalcin . value - option value string 19562d747510SLisandro Dalcin - mctx - optional monitoring context, as set by PetscOptionsMonitorSet() 19572d747510SLisandro Dalcin 19582d747510SLisandro Dalcin Options Database Keys: 1959c5b5d8d5SVaclav Hapla See PetscInitialize() for options related to option database monitoring. 19602d747510SLisandro Dalcin 19612d747510SLisandro Dalcin Notes: 19622d747510SLisandro Dalcin The default is to do nothing. To print the name and value of options 19632d747510SLisandro Dalcin being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine, 19642d747510SLisandro Dalcin with a null monitoring context. 19652d747510SLisandro Dalcin 19662d747510SLisandro Dalcin Several different monitoring routines may be set by calling 19672d747510SLisandro Dalcin PetscOptionsMonitorSet() multiple times; all will be called in the 19682d747510SLisandro Dalcin order in which they were set. 19692d747510SLisandro Dalcin 19709060e2f9SVaclav Hapla Level: intermediate 19712d747510SLisandro Dalcin 1972c5b5d8d5SVaclav Hapla .seealso: PetscOptionsMonitorDefault(), PetscInitialize() 19732d747510SLisandro Dalcin @*/ 19742d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 19752d747510SLisandro Dalcin { 19762d747510SLisandro Dalcin PetscOptions options = defaultoptions; 19772d747510SLisandro Dalcin 19782d747510SLisandro Dalcin PetscFunctionBegin; 1979c5b5d8d5SVaclav Hapla if (options->monitorCancel) PetscFunctionReturn(0); 19802c71b3e2SJacob Faibussowitsch PetscCheckFalse(options->numbermonitors >= MAXOPTIONSMONITORS,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptions monitors set"); 19812d747510SLisandro Dalcin options->monitor[options->numbermonitors] = monitor; 19822d747510SLisandro Dalcin options->monitordestroy[options->numbermonitors] = monitordestroy; 19832d747510SLisandro Dalcin options->monitorcontext[options->numbermonitors++] = (void*)mctx; 19842d747510SLisandro Dalcin PetscFunctionReturn(0); 19852d747510SLisandro Dalcin } 19862d747510SLisandro Dalcin 19872d747510SLisandro Dalcin /* 19882d747510SLisandro Dalcin PetscOptionsStringToBool - Converts string to PetscBool, handles cases like "yes", "no", "true", "false", "0", "1", "off", "on". 198963fe8743SVaclav Hapla Empty string is considered as true. 19902d747510SLisandro Dalcin */ 19912d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToBool(const char value[],PetscBool *a) 19922d747510SLisandro Dalcin { 19932d747510SLisandro Dalcin PetscBool istrue,isfalse; 19942d747510SLisandro Dalcin size_t len; 19952d747510SLisandro Dalcin 19962d747510SLisandro Dalcin PetscFunctionBegin; 199763fe8743SVaclav Hapla /* PetscStrlen() returns 0 for NULL or "" */ 19985f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(value,&len)); 199963fe8743SVaclav Hapla if (!len) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 20005f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"TRUE",&istrue)); 20012d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 20025f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"YES",&istrue)); 20032d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 20045f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"1",&istrue)); 20052d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 20065f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"on",&istrue)); 20072d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 20085f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"FALSE",&isfalse)); 20092d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20105f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"NO",&isfalse)); 20112d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20125f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"0",&isfalse)); 20132d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20145f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(value,"off",&isfalse)); 20152d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 201698921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown logical value: %s",value); 20172d747510SLisandro Dalcin } 20182d747510SLisandro Dalcin 20192d747510SLisandro Dalcin /* 20202d747510SLisandro Dalcin PetscOptionsStringToInt - Converts a string to an integer value. Handles special cases such as "default" and "decide" 20212d747510SLisandro Dalcin */ 20222d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToInt(const char name[],PetscInt *a) 20232d747510SLisandro Dalcin { 20242d747510SLisandro Dalcin size_t len; 20252d747510SLisandro Dalcin PetscBool decide,tdefault,mouse; 20262d747510SLisandro Dalcin 20272d747510SLisandro Dalcin PetscFunctionBegin; 20285f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(name,&len)); 20295f80ce2aSJacob Faibussowitsch PetscCheck(len,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 20302d747510SLisandro Dalcin 20315f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"PETSC_DEFAULT",&tdefault)); 20322d747510SLisandro Dalcin if (!tdefault) { 20335f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"DEFAULT",&tdefault)); 20342d747510SLisandro Dalcin } 20355f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"PETSC_DECIDE",&decide)); 20362d747510SLisandro Dalcin if (!decide) { 20375f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"DECIDE",&decide)); 20382d747510SLisandro Dalcin } 20395f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"mouse",&mouse)); 20402d747510SLisandro Dalcin 20412d747510SLisandro Dalcin if (tdefault) *a = PETSC_DEFAULT; 20422d747510SLisandro Dalcin else if (decide) *a = PETSC_DECIDE; 20432d747510SLisandro Dalcin else if (mouse) *a = -1; 20442d747510SLisandro Dalcin else { 20452d747510SLisandro Dalcin char *endptr; 20462d747510SLisandro Dalcin long strtolval; 20472d747510SLisandro Dalcin 20482d747510SLisandro Dalcin strtolval = strtol(name,&endptr,10); 20492c71b3e2SJacob Faibussowitsch PetscCheckFalse((size_t) (endptr - name) != len,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no integer value (do not include . in it)",name); 20502d747510SLisandro Dalcin 20512d747510SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE_ATOLL) 20522d747510SLisandro Dalcin (void) strtolval; 20532d747510SLisandro Dalcin *a = atoll(name); 20542d747510SLisandro Dalcin #elif defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE___INT64) 20552d747510SLisandro Dalcin (void) strtolval; 20562d747510SLisandro Dalcin *a = _atoi64(name); 20572d747510SLisandro Dalcin #else 20582d747510SLisandro Dalcin *a = (PetscInt)strtolval; 20592d747510SLisandro Dalcin #endif 20602d747510SLisandro Dalcin } 20612d747510SLisandro Dalcin PetscFunctionReturn(0); 20622d747510SLisandro Dalcin } 20632d747510SLisandro Dalcin 20642d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 20652d747510SLisandro Dalcin #include <quadmath.h> 20662d747510SLisandro Dalcin #endif 20672d747510SLisandro Dalcin 20682d747510SLisandro Dalcin static PetscErrorCode PetscStrtod(const char name[],PetscReal *a,char **endptr) 20692d747510SLisandro Dalcin { 20702d747510SLisandro Dalcin PetscFunctionBegin; 20712d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 20722d747510SLisandro Dalcin *a = strtoflt128(name,endptr); 20732d747510SLisandro Dalcin #else 20742d747510SLisandro Dalcin *a = (PetscReal)strtod(name,endptr); 20752d747510SLisandro Dalcin #endif 20762d747510SLisandro Dalcin PetscFunctionReturn(0); 20772d747510SLisandro Dalcin } 20782d747510SLisandro Dalcin 20792d747510SLisandro Dalcin static PetscErrorCode PetscStrtoz(const char name[],PetscScalar *a,char **endptr,PetscBool *isImaginary) 20802d747510SLisandro Dalcin { 20812d747510SLisandro Dalcin PetscBool hasi = PETSC_FALSE; 20822d747510SLisandro Dalcin char *ptr; 20832d747510SLisandro Dalcin PetscReal strtoval; 20842d747510SLisandro Dalcin 20852d747510SLisandro Dalcin PetscFunctionBegin; 20865f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrtod(name,&strtoval,&ptr)); 20872d747510SLisandro Dalcin if (ptr == name) { 20882d747510SLisandro Dalcin strtoval = 1.; 20892d747510SLisandro Dalcin hasi = PETSC_TRUE; 20902d747510SLisandro Dalcin if (name[0] == 'i') { 20912d747510SLisandro Dalcin ptr++; 20922d747510SLisandro Dalcin } else if (name[0] == '+' && name[1] == 'i') { 20932d747510SLisandro Dalcin ptr += 2; 20942d747510SLisandro Dalcin } else if (name[0] == '-' && name[1] == 'i') { 20952d747510SLisandro Dalcin strtoval = -1.; 20962d747510SLisandro Dalcin ptr += 2; 20972d747510SLisandro Dalcin } 20982d747510SLisandro Dalcin } else if (*ptr == 'i') { 20992d747510SLisandro Dalcin hasi = PETSC_TRUE; 21002d747510SLisandro Dalcin ptr++; 21012d747510SLisandro Dalcin } 21022d747510SLisandro Dalcin *endptr = ptr; 21032d747510SLisandro Dalcin *isImaginary = hasi; 21042d747510SLisandro Dalcin if (hasi) { 21052d747510SLisandro Dalcin #if !defined(PETSC_USE_COMPLEX) 210698921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s contains imaginary but complex not supported ",name); 21072d747510SLisandro Dalcin #else 21082d747510SLisandro Dalcin *a = PetscCMPLX(0.,strtoval); 21092d747510SLisandro Dalcin #endif 21102d747510SLisandro Dalcin } else { 21112d747510SLisandro Dalcin *a = strtoval; 21122d747510SLisandro Dalcin } 21132d747510SLisandro Dalcin PetscFunctionReturn(0); 21142d747510SLisandro Dalcin } 21152d747510SLisandro Dalcin 21162d747510SLisandro Dalcin /* 21172d747510SLisandro Dalcin Converts a string to PetscReal value. Handles special cases like "default" and "decide" 21182d747510SLisandro Dalcin */ 21192d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToReal(const char name[],PetscReal *a) 21202d747510SLisandro Dalcin { 21212d747510SLisandro Dalcin size_t len; 21222d747510SLisandro Dalcin PetscBool match; 21232d747510SLisandro Dalcin char *endptr; 21242d747510SLisandro Dalcin 21252d747510SLisandro Dalcin PetscFunctionBegin; 21265f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(name,&len)); 212728b400f6SJacob Faibussowitsch PetscCheck(len,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"String of length zero has no numerical value"); 21282d747510SLisandro Dalcin 21295f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"PETSC_DEFAULT",&match)); 2130*39a651e2SJacob Faibussowitsch if (!match) CHKERRQ(PetscStrcasecmp(name,"DEFAULT",&match)); 21312d747510SLisandro Dalcin if (match) {*a = PETSC_DEFAULT; PetscFunctionReturn(0);} 21322d747510SLisandro Dalcin 21335f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcasecmp(name,"PETSC_DECIDE",&match)); 2134*39a651e2SJacob Faibussowitsch if (!match) CHKERRQ(PetscStrcasecmp(name,"DECIDE",&match)); 21352d747510SLisandro Dalcin if (match) {*a = PETSC_DECIDE; PetscFunctionReturn(0);} 21362d747510SLisandro Dalcin 21375f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrtod(name,a,&endptr)); 2138*39a651e2SJacob Faibussowitsch PetscCheck((size_t) (endptr - name) == len,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value",name); 21392d747510SLisandro Dalcin PetscFunctionReturn(0); 21402d747510SLisandro Dalcin } 21412d747510SLisandro Dalcin 21422d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToScalar(const char name[],PetscScalar *a) 21432d747510SLisandro Dalcin { 21442d747510SLisandro Dalcin PetscBool imag1; 21452d747510SLisandro Dalcin size_t len; 21462d747510SLisandro Dalcin PetscScalar val = 0.; 21472d747510SLisandro Dalcin char *ptr = NULL; 21482d747510SLisandro Dalcin 21492d747510SLisandro Dalcin PetscFunctionBegin; 21505f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(name,&len)); 215128b400f6SJacob Faibussowitsch PetscCheck(len,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 21525f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrtoz(name,&val,&ptr,&imag1)); 21532d747510SLisandro Dalcin #if defined(PETSC_USE_COMPLEX) 21542d747510SLisandro Dalcin if ((size_t) (ptr - name) < len) { 21552d747510SLisandro Dalcin PetscBool imag2; 21562d747510SLisandro Dalcin PetscScalar val2; 21572d747510SLisandro Dalcin 21585f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrtoz(ptr,&val2,&ptr,&imag2)); 2159*39a651e2SJacob Faibussowitsch if (imag1) PetscCheck(imag2,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s: must specify imaginary component second",name); 21602d747510SLisandro Dalcin val = PetscCMPLX(PetscRealPart(val),PetscImaginaryPart(val2)); 21612d747510SLisandro Dalcin } 21622d747510SLisandro Dalcin #endif 2163*39a651e2SJacob Faibussowitsch PetscCheck((size_t) (ptr - name) == len,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value ",name); 21642d747510SLisandro Dalcin *a = val; 21652d747510SLisandro Dalcin PetscFunctionReturn(0); 21662d747510SLisandro Dalcin } 21672d747510SLisandro Dalcin 21682d747510SLisandro Dalcin /*@C 21692d747510SLisandro Dalcin PetscOptionsGetBool - Gets the Logical (true or false) value for a particular 21702d747510SLisandro Dalcin option in the database. 2171e5c89e4eSSatish Balay 2172e5c89e4eSSatish Balay Not Collective 2173e5c89e4eSSatish Balay 2174e5c89e4eSSatish Balay Input Parameters: 21755c9cc608SHong Zhang + options - options database, use NULL for default global database 2176c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2177e5c89e4eSSatish Balay - name - the option one is seeking 2178e5c89e4eSSatish Balay 2179d8d19677SJose E. Roman Output Parameters: 21802d747510SLisandro Dalcin + ivalue - the logical value to return 218196ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2182e5c89e4eSSatish Balay 2183e5c89e4eSSatish Balay Level: beginner 2184e5c89e4eSSatish Balay 218595452b02SPatrick Sanan Notes: 21862d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 21872d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 21882d747510SLisandro Dalcin 21892d747510SLisandro Dalcin If the option is given, but no value is provided, then ivalue and set are both given the value PETSC_TRUE. That is -requested_bool 21902d747510SLisandro Dalcin is equivalent to -requested_bool true 21912d747510SLisandro Dalcin 21922d747510SLisandro Dalcin If the user does not supply the option at all ivalue is NOT changed. Thus 21932efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 21942efd9cb1SBarry Smith 2195e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 21962d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetInt(), PetscOptionsBool(), 2197e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2198e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2199acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2200a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2201e5c89e4eSSatish Balay @*/ 22022d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBool(PetscOptions options,const char pre[],const char name[],PetscBool *ivalue,PetscBool *set) 2203e5c89e4eSSatish Balay { 22042d747510SLisandro Dalcin const char *value; 2205ace3abfcSBarry Smith PetscBool flag; 2206e5c89e4eSSatish Balay 2207e5c89e4eSSatish Balay PetscFunctionBegin; 22082d747510SLisandro Dalcin PetscValidCharPointer(name,3); 2209064a246eSJacob Faibussowitsch if (ivalue) PetscValidBoolPointer(ivalue,4); 22105f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&value,&flag)); 2211e5c89e4eSSatish Balay if (flag) { 221296ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 22135f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToBool(value, &flag)); 22142d747510SLisandro Dalcin if (ivalue) *ivalue = flag; 2215e5c89e4eSSatish Balay } else { 221696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2217e5c89e4eSSatish Balay } 2218e5c89e4eSSatish Balay PetscFunctionReturn(0); 2219e5c89e4eSSatish Balay } 2220e5c89e4eSSatish Balay 2221e5c89e4eSSatish Balay /*@C 2222e5c89e4eSSatish Balay PetscOptionsGetEList - Puts a list of option values that a single one may be selected from 2223e5c89e4eSSatish Balay 2224e5c89e4eSSatish Balay Not Collective 2225e5c89e4eSSatish Balay 2226e5c89e4eSSatish Balay Input Parameters: 22275c9cc608SHong Zhang + options - options database, use NULL for default global database 2228c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2229e5c89e4eSSatish Balay . opt - option name 2230a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 2231a2b725a8SWilliam Gropp - ntext - number of choices 2232e5c89e4eSSatish Balay 2233d8d19677SJose E. Roman Output Parameters: 22342efd9cb1SBarry Smith + value - the index of the value to return (defaults to zero if the option name is given but no choice is listed) 2235e5c89e4eSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2236e5c89e4eSSatish Balay 2237e5c89e4eSSatish Balay Level: intermediate 2238e5c89e4eSSatish Balay 223995452b02SPatrick Sanan Notes: 224095452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 22412efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 22422efd9cb1SBarry Smith 2243a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 2244e5c89e4eSSatish Balay 2245e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2246acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2247e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2248e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2249acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2250a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2251e5c89e4eSSatish Balay @*/ 2252c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEList(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscInt ntext,PetscInt *value,PetscBool *set) 2253e5c89e4eSSatish Balay { 225458b0ac4eSStefano Zampini size_t alen,len = 0, tlen = 0; 2255e5c89e4eSSatish Balay char *svalue; 2256ace3abfcSBarry Smith PetscBool aset,flg = PETSC_FALSE; 2257e5c89e4eSSatish Balay PetscInt i; 2258e5c89e4eSSatish Balay 2259e5c89e4eSSatish Balay PetscFunctionBegin; 22602d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2261e5c89e4eSSatish Balay for (i=0; i<ntext; i++) { 22625f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(list[i],&alen)); 2263e5c89e4eSSatish Balay if (alen > len) len = alen; 226458b0ac4eSStefano Zampini tlen += len + 1; 2265e5c89e4eSSatish Balay } 2266e5c89e4eSSatish Balay len += 5; /* a little extra space for user mistypes */ 22675f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMalloc1(len,&svalue)); 22685f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsGetString(options,pre,opt,svalue,len,&aset)); 2269e5c89e4eSSatish Balay if (aset) { 22705f80ce2aSJacob Faibussowitsch CHKERRQ(PetscEListFind(ntext,list,svalue,value,&flg)); 227158b0ac4eSStefano Zampini if (!flg) { 227258b0ac4eSStefano Zampini char *avail,*pavl; 227358b0ac4eSStefano Zampini 22745f80ce2aSJacob Faibussowitsch CHKERRQ(PetscMalloc1(tlen,&avail)); 227558b0ac4eSStefano Zampini pavl = avail; 227658b0ac4eSStefano Zampini for (i=0; i<ntext; i++) { 22775f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(list[i],&alen)); 22785f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcpy(pavl,list[i])); 227958b0ac4eSStefano Zampini pavl += alen; 22805f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcpy(pavl," ")); 228158b0ac4eSStefano Zampini pavl += 1; 228258b0ac4eSStefano Zampini } 22835f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrtolower(avail)); 228498921bdaSJacob Faibussowitsch SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown option %s for -%s%s. Available options: %s",svalue,pre ? pre : "",opt+1,avail); 228558b0ac4eSStefano Zampini } 2286fbedd5e0SJed Brown if (set) *set = PETSC_TRUE; 2287a297a907SKarl Rupp } else if (set) *set = PETSC_FALSE; 22885f80ce2aSJacob Faibussowitsch CHKERRQ(PetscFree(svalue)); 2289e5c89e4eSSatish Balay PetscFunctionReturn(0); 2290e5c89e4eSSatish Balay } 2291e5c89e4eSSatish Balay 2292e5c89e4eSSatish Balay /*@C 2293e5c89e4eSSatish Balay PetscOptionsGetEnum - Gets the enum value for a particular option in the database. 2294e5c89e4eSSatish Balay 2295e5c89e4eSSatish Balay Not Collective 2296e5c89e4eSSatish Balay 2297e5c89e4eSSatish Balay Input Parameters: 22985c9cc608SHong Zhang + options - options database, use NULL for default global database 2299c5929fdfSBarry Smith . pre - option prefix or NULL 2300e5c89e4eSSatish Balay . opt - option name 23016b867d5aSJose E. Roman - list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 2302e5c89e4eSSatish Balay 2303d8d19677SJose E. Roman Output Parameters: 2304e5c89e4eSSatish Balay + value - the value to return 230596ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2306e5c89e4eSSatish Balay 2307e5c89e4eSSatish Balay Level: beginner 2308e5c89e4eSSatish Balay 230995452b02SPatrick Sanan Notes: 231095452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 23112efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2312e5c89e4eSSatish Balay 23132efd9cb1SBarry Smith List is usually something like PCASMTypes or some other predefined list of enum names 2314e5c89e4eSSatish Balay 2315e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 2316acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 2317acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2318e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2319e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2320acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2321a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 2322e5c89e4eSSatish Balay @*/ 2323c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set) 2324e5c89e4eSSatish Balay { 232569a24498SJed Brown PetscInt ntext = 0,tval; 2326ace3abfcSBarry Smith PetscBool fset; 2327e5c89e4eSSatish Balay 2328e5c89e4eSSatish Balay PetscFunctionBegin; 23292d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2330e5c89e4eSSatish Balay while (list[ntext++]) { 23312c71b3e2SJacob Faibussowitsch PetscCheckFalse(ntext > 50,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 2332e5c89e4eSSatish Balay } 23332c71b3e2SJacob Faibussowitsch PetscCheckFalse(ntext < 3,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 2334e5c89e4eSSatish Balay ntext -= 3; 23355f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsGetEList(options,pre,opt,list,ntext,&tval,&fset)); 233669a24498SJed Brown /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 2337809ceb46SBarry Smith if (fset) *value = (PetscEnum)tval; 2338809ceb46SBarry Smith if (set) *set = fset; 2339e5c89e4eSSatish Balay PetscFunctionReturn(0); 2340e5c89e4eSSatish Balay } 2341e5c89e4eSSatish Balay 2342e5c89e4eSSatish Balay /*@C 23432d747510SLisandro Dalcin PetscOptionsGetInt - Gets the integer value for a particular option in the database. 2344e5c89e4eSSatish Balay 2345e5c89e4eSSatish Balay Not Collective 2346e5c89e4eSSatish Balay 2347e5c89e4eSSatish Balay Input Parameters: 23485c9cc608SHong Zhang + options - options database, use NULL for default global database 2349c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2350e5c89e4eSSatish Balay - name - the option one is seeking 2351e5c89e4eSSatish Balay 2352d8d19677SJose E. Roman Output Parameters: 23532d747510SLisandro Dalcin + ivalue - the integer value to return 235496ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2355e5c89e4eSSatish Balay 2356e5c89e4eSSatish Balay Level: beginner 2357e5c89e4eSSatish Balay 2358e5c89e4eSSatish Balay Notes: 23592d747510SLisandro Dalcin If the user does not supply the option ivalue is NOT changed. Thus 23602efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 23615c07ccb8SBarry Smith 2362e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 23632d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 23642d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2365e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2366e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2367acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2368a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2369e5c89e4eSSatish Balay @*/ 23702d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetInt(PetscOptions options,const char pre[],const char name[],PetscInt *ivalue,PetscBool *set) 2371e5c89e4eSSatish Balay { 23722d747510SLisandro Dalcin const char *value; 23732d747510SLisandro Dalcin PetscBool flag; 2374e5c89e4eSSatish Balay 2375e5c89e4eSSatish Balay PetscFunctionBegin; 23762d747510SLisandro Dalcin PetscValidCharPointer(name,3); 23772d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 23785f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&value,&flag)); 2379e5c89e4eSSatish Balay if (flag) { 238034a9cc2cSBarry Smith if (!value) { 23812d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 238234a9cc2cSBarry Smith } else { 23832d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 23845f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToInt(value,ivalue)); 2385e5c89e4eSSatish Balay } 2386e5c89e4eSSatish Balay } else { 238796ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2388e5c89e4eSSatish Balay } 2389e5c89e4eSSatish Balay PetscFunctionReturn(0); 2390e5c89e4eSSatish Balay } 2391e5c89e4eSSatish Balay 2392e2446a98SMatthew Knepley /*@C 2393e5c89e4eSSatish Balay PetscOptionsGetReal - Gets the double precision value for a particular 2394e5c89e4eSSatish Balay option in the database. 2395e5c89e4eSSatish Balay 2396e5c89e4eSSatish Balay Not Collective 2397e5c89e4eSSatish Balay 2398e5c89e4eSSatish Balay Input Parameters: 23995c9cc608SHong Zhang + options - options database, use NULL for default global database 2400c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2401e5c89e4eSSatish Balay - name - the option one is seeking 2402e5c89e4eSSatish Balay 2403d8d19677SJose E. Roman Output Parameters: 2404e5c89e4eSSatish Balay + dvalue - the double value to return 240596ef3cdfSSatish Balay - set - PETSC_TRUE if found, PETSC_FALSE if not found 2406e5c89e4eSSatish Balay 240795452b02SPatrick Sanan Notes: 240895452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 24092efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2410e4974155SBarry Smith 2411e5c89e4eSSatish Balay Level: beginner 2412e5c89e4eSSatish Balay 2413e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2414acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 2415e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2416e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2417acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2418a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2419e5c89e4eSSatish Balay @*/ 2420c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetReal(PetscOptions options,const char pre[],const char name[],PetscReal *dvalue,PetscBool *set) 2421e5c89e4eSSatish Balay { 24222d747510SLisandro Dalcin const char *value; 2423ace3abfcSBarry Smith PetscBool flag; 2424e5c89e4eSSatish Balay 2425e5c89e4eSSatish Balay PetscFunctionBegin; 24262d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24272d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 24285f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&value,&flag)); 2429e5c89e4eSSatish Balay if (flag) { 2430a297a907SKarl Rupp if (!value) { 2431a297a907SKarl Rupp if (set) *set = PETSC_FALSE; 2432a297a907SKarl Rupp } else { 2433a297a907SKarl Rupp if (set) *set = PETSC_TRUE; 24345f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToReal(value,dvalue)); 2435a297a907SKarl Rupp } 2436e5c89e4eSSatish Balay } else { 243796ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2438e5c89e4eSSatish Balay } 2439e5c89e4eSSatish Balay PetscFunctionReturn(0); 2440e5c89e4eSSatish Balay } 2441e5c89e4eSSatish Balay 2442e5c89e4eSSatish Balay /*@C 2443e5c89e4eSSatish Balay PetscOptionsGetScalar - Gets the scalar value for a particular 2444e5c89e4eSSatish Balay option in the database. 2445e5c89e4eSSatish Balay 2446e5c89e4eSSatish Balay Not Collective 2447e5c89e4eSSatish Balay 2448e5c89e4eSSatish Balay Input Parameters: 24495c9cc608SHong Zhang + options - options database, use NULL for default global database 2450c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2451e5c89e4eSSatish Balay - name - the option one is seeking 2452e5c89e4eSSatish Balay 2453d8d19677SJose E. Roman Output Parameters: 2454e5c89e4eSSatish Balay + dvalue - the double value to return 245596ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2456e5c89e4eSSatish Balay 2457e5c89e4eSSatish Balay Level: beginner 2458e5c89e4eSSatish Balay 2459e5c89e4eSSatish Balay Usage: 2460eb4ae41dSBarry Smith A complex number 2+3i must be specified with NO spaces 2461e5c89e4eSSatish Balay 246295452b02SPatrick Sanan Notes: 246395452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 24642efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2465e4974155SBarry Smith 2466e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2467acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2468e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2469e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2470acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2471a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2472e5c89e4eSSatish Balay @*/ 2473c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetScalar(PetscOptions options,const char pre[],const char name[],PetscScalar *dvalue,PetscBool *set) 2474e5c89e4eSSatish Balay { 24752d747510SLisandro Dalcin const char *value; 2476ace3abfcSBarry Smith PetscBool flag; 2477e5c89e4eSSatish Balay 2478e5c89e4eSSatish Balay PetscFunctionBegin; 24792d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24802d747510SLisandro Dalcin PetscValidScalarPointer(dvalue,4); 24815f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&value,&flag)); 2482e5c89e4eSSatish Balay if (flag) { 2483e5c89e4eSSatish Balay if (!value) { 248496ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2485e5c89e4eSSatish Balay } else { 2486e5c89e4eSSatish Balay #if !defined(PETSC_USE_COMPLEX) 24875f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToReal(value,dvalue)); 2488e5c89e4eSSatish Balay #else 24895f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToScalar(value,dvalue)); 2490e5c89e4eSSatish Balay #endif 249196ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2492e5c89e4eSSatish Balay } 2493e5c89e4eSSatish Balay } else { /* flag */ 249496ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2495e5c89e4eSSatish Balay } 2496e5c89e4eSSatish Balay PetscFunctionReturn(0); 2497e5c89e4eSSatish Balay } 2498e5c89e4eSSatish Balay 2499e5c89e4eSSatish Balay /*@C 2500e5c89e4eSSatish Balay PetscOptionsGetString - Gets the string value for a particular option in 2501e5c89e4eSSatish Balay the database. 2502e5c89e4eSSatish Balay 2503e5c89e4eSSatish Balay Not Collective 2504e5c89e4eSSatish Balay 2505e5c89e4eSSatish Balay Input Parameters: 25065c9cc608SHong Zhang + options - options database, use NULL for default global database 2507c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2508e5c89e4eSSatish Balay . name - the option one is seeking 2509bcbf2dc5SJed Brown - len - maximum length of the string including null termination 2510e5c89e4eSSatish Balay 2511e5c89e4eSSatish Balay Output Parameters: 2512e5c89e4eSSatish Balay + string - location to copy string 251396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2514e5c89e4eSSatish Balay 2515e5c89e4eSSatish Balay Level: beginner 2516e5c89e4eSSatish Balay 2517e5c89e4eSSatish Balay Fortran Note: 2518e5c89e4eSSatish Balay The Fortran interface is slightly different from the C/C++ 2519e5c89e4eSSatish Balay interface (len is not used). Sample usage in Fortran follows 2520e5c89e4eSSatish Balay .vb 2521e5c89e4eSSatish Balay character *20 string 252293e6ba5cSBarry Smith PetscErrorCode ierr 252393e6ba5cSBarry Smith PetscBool set 25241b266c99SBarry Smith call PetscOptionsGetString(PETSC_NULL_OPTIONS,PETSC_NULL_CHARACTER,'-s',string,set,ierr) 2525e5c89e4eSSatish Balay .ve 2526e5c89e4eSSatish Balay 252795452b02SPatrick Sanan Notes: 252895452b02SPatrick Sanan if the option is given but no string is provided then an empty string is returned and set is given the value of PETSC_TRUE 2529e4974155SBarry Smith 25302efd9cb1SBarry Smith If the user does not use the option then the string is not changed. Thus 25312efd9cb1SBarry Smith you should ALWAYS initialize the string if you access it without first checking if the set flag is true. 25322efd9cb1SBarry Smith 2533f3dea69dSBarry Smith Note: 2534f3dea69dSBarry Smith Even if the user provided no string (for example -optionname -someotheroption) the flag is set to PETSC_TRUE (and the string is fulled with nulls). 2535f3dea69dSBarry Smith 2536e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2537acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2538e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2539e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2540acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2541a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2542e5c89e4eSSatish Balay @*/ 2543c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetString(PetscOptions options,const char pre[],const char name[],char string[],size_t len,PetscBool *set) 2544e5c89e4eSSatish Balay { 25452d747510SLisandro Dalcin const char *value; 2546ace3abfcSBarry Smith PetscBool flag; 2547e5c89e4eSSatish Balay 2548e5c89e4eSSatish Balay PetscFunctionBegin; 25492d747510SLisandro Dalcin PetscValidCharPointer(name,3); 25502d747510SLisandro Dalcin PetscValidCharPointer(string,4); 25515f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&value,&flag)); 2552e5c89e4eSSatish Balay if (!flag) { 255396ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2554e5c89e4eSSatish Balay } else { 255596ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2556*39a651e2SJacob Faibussowitsch if (value) CHKERRQ(PetscStrncpy(string,value,len)); 2557*39a651e2SJacob Faibussowitsch else CHKERRQ(PetscArrayzero(string,len)); 2558e5c89e4eSSatish Balay } 2559e5c89e4eSSatish Balay PetscFunctionReturn(0); 2560e5c89e4eSSatish Balay } 2561e5c89e4eSSatish Balay 2562c5929fdfSBarry Smith char *PetscOptionsGetStringMatlab(PetscOptions options,const char pre[],const char name[]) 256314ce751eSBarry Smith { 25642d747510SLisandro Dalcin const char *value; 256514ce751eSBarry Smith PetscBool flag; 256614ce751eSBarry Smith 256714ce751eSBarry Smith PetscFunctionBegin; 2568*39a651e2SJacob Faibussowitsch if (PetscOptionsFindPair(options,pre,name,&value,&flag)) PetscFunctionReturn(NULL); 25692d747510SLisandro Dalcin if (flag) PetscFunctionReturn((char*)value); 2570*39a651e2SJacob Faibussowitsch PetscFunctionReturn(NULL); 257114ce751eSBarry Smith } 257214ce751eSBarry Smith 25732d747510SLisandro Dalcin /*@C 25742d747510SLisandro Dalcin PetscOptionsGetBoolArray - Gets an array of Logical (true or false) values for a particular 2575f1a722f8SMatthew G. Knepley option in the database. The values must be separated with commas with no intervening spaces. 25762d747510SLisandro Dalcin 25772d747510SLisandro Dalcin Not Collective 25782d747510SLisandro Dalcin 25792d747510SLisandro Dalcin Input Parameters: 25802d747510SLisandro Dalcin + options - options database, use NULL for default global database 25812d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 25826b867d5aSJose E. Roman - name - the option one is seeking 25836b867d5aSJose E. Roman 2584d8d19677SJose E. Roman Output Parameters: 25852d747510SLisandro Dalcin + dvalue - the integer values to return 2586f1a722f8SMatthew G. Knepley . nmax - On input maximum number of values to retrieve, on output the actual number of values retrieved 25872d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 25882d747510SLisandro Dalcin 25892d747510SLisandro Dalcin Level: beginner 25902d747510SLisandro Dalcin 25912d747510SLisandro Dalcin Notes: 2592f1a722f8SMatthew G. Knepley TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE. FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 25932d747510SLisandro Dalcin 25942d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 25952d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 25962d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 25972d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 25982d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 25992d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 26002d747510SLisandro Dalcin @*/ 26012d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBoolArray(PetscOptions options,const char pre[],const char name[],PetscBool dvalue[],PetscInt *nmax,PetscBool *set) 26022d747510SLisandro Dalcin { 26032d747510SLisandro Dalcin const char *svalue; 26042d747510SLisandro Dalcin char *value; 26052d747510SLisandro Dalcin PetscInt n = 0; 26062d747510SLisandro Dalcin PetscBool flag; 26072d747510SLisandro Dalcin PetscToken token; 26082d747510SLisandro Dalcin 26092d747510SLisandro Dalcin PetscFunctionBegin; 26102d747510SLisandro Dalcin PetscValidCharPointer(name,3); 2611064a246eSJacob Faibussowitsch PetscValidBoolPointer(dvalue,4); 26122d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 26132d747510SLisandro Dalcin 26145f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&svalue,&flag)); 26152d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26162d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26175f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(svalue,',',&token)); 26185f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 26192d747510SLisandro Dalcin while (value && n < *nmax) { 26205f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToBool(value,dvalue)); 26215f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 26222d747510SLisandro Dalcin dvalue++; 26232d747510SLisandro Dalcin n++; 26242d747510SLisandro Dalcin } 26255f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 26262d747510SLisandro Dalcin *nmax = n; 26272d747510SLisandro Dalcin PetscFunctionReturn(0); 26282d747510SLisandro Dalcin } 26292d747510SLisandro Dalcin 26302d747510SLisandro Dalcin /*@C 26312d747510SLisandro Dalcin PetscOptionsGetEnumArray - Gets an array of enum values for a particular option in the database. 26322d747510SLisandro Dalcin 26332d747510SLisandro Dalcin Not Collective 26342d747510SLisandro Dalcin 26352d747510SLisandro Dalcin Input Parameters: 26362d747510SLisandro Dalcin + options - options database, use NULL for default global database 26372d747510SLisandro Dalcin . pre - option prefix or NULL 26382d747510SLisandro Dalcin . name - option name 26396b867d5aSJose E. Roman - list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 26406b867d5aSJose E. Roman 26412d747510SLisandro Dalcin Output Parameters: 26422d747510SLisandro Dalcin + ivalue - the enum values to return 2643f1a722f8SMatthew G. Knepley . nmax - On input maximum number of values to retrieve, on output the actual number of values retrieved 26442d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26452d747510SLisandro Dalcin 26462d747510SLisandro Dalcin Level: beginner 26472d747510SLisandro Dalcin 26482d747510SLisandro Dalcin Notes: 26492d747510SLisandro Dalcin The array must be passed as a comma separated list. 26502d747510SLisandro Dalcin 26512d747510SLisandro Dalcin There must be no intervening spaces between the values. 26522d747510SLisandro Dalcin 26532d747510SLisandro Dalcin list is usually something like PCASMTypes or some other predefined list of enum names. 26542d747510SLisandro Dalcin 26552d747510SLisandro Dalcin .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 26562d747510SLisandro Dalcin PetscOptionsGetEnum(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 26572d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), 26582d747510SLisandro Dalcin PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), 26592d747510SLisandro Dalcin PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26602d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 26612d747510SLisandro Dalcin @*/ 26622d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetEnumArray(PetscOptions options,const char pre[],const char name[],const char *const *list,PetscEnum ivalue[],PetscInt *nmax,PetscBool *set) 26632d747510SLisandro Dalcin { 26642d747510SLisandro Dalcin const char *svalue; 26652d747510SLisandro Dalcin char *value; 26662d747510SLisandro Dalcin PetscInt n = 0; 26672d747510SLisandro Dalcin PetscEnum evalue; 26682d747510SLisandro Dalcin PetscBool flag; 26692d747510SLisandro Dalcin PetscToken token; 26702d747510SLisandro Dalcin 26712d747510SLisandro Dalcin PetscFunctionBegin; 26722d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26732d747510SLisandro Dalcin PetscValidPointer(list,4); 26742d747510SLisandro Dalcin PetscValidPointer(ivalue,5); 26752d747510SLisandro Dalcin PetscValidIntPointer(nmax,6); 26762d747510SLisandro Dalcin 26775f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&svalue,&flag)); 26782d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26792d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26805f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(svalue,',',&token)); 26815f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 26822d747510SLisandro Dalcin while (value && n < *nmax) { 26835f80ce2aSJacob Faibussowitsch CHKERRQ(PetscEnumFind(list,value,&evalue,&flag)); 268428b400f6SJacob Faibussowitsch PetscCheck(flag,PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown enum value '%s' for -%s%s",svalue,pre ? pre : "",name+1); 26852d747510SLisandro Dalcin ivalue[n++] = evalue; 26865f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 26872d747510SLisandro Dalcin } 26885f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 26892d747510SLisandro Dalcin *nmax = n; 26902d747510SLisandro Dalcin PetscFunctionReturn(0); 26912d747510SLisandro Dalcin } 26922d747510SLisandro Dalcin 26932d747510SLisandro Dalcin /*@C 2694f1a722f8SMatthew G. Knepley PetscOptionsGetIntArray - Gets an array of integer values for a particular option in the database. 26952d747510SLisandro Dalcin 26962d747510SLisandro Dalcin Not Collective 26972d747510SLisandro Dalcin 26982d747510SLisandro Dalcin Input Parameters: 26992d747510SLisandro Dalcin + options - options database, use NULL for default global database 27002d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 27016b867d5aSJose E. Roman - name - the option one is seeking 27026b867d5aSJose E. Roman 2703d8d19677SJose E. Roman Output Parameters: 27042d747510SLisandro Dalcin + ivalue - the integer values to return 2705f1a722f8SMatthew G. Knepley . nmax - On input maximum number of values to retrieve, on output the actual number of values retrieved 27062d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 27072d747510SLisandro Dalcin 27082d747510SLisandro Dalcin Level: beginner 27092d747510SLisandro Dalcin 27102d747510SLisandro Dalcin Notes: 27112d747510SLisandro Dalcin The array can be passed as 2712f1a722f8SMatthew G. Knepley .vb 27132d747510SLisandro Dalcin a comma separated list: 0,1,2,3,4,5,6,7 27142d747510SLisandro Dalcin a range (start-end+1): 0-8 27152d747510SLisandro Dalcin a range with given increment (start-end+1:inc): 0-7:2 27162d747510SLisandro Dalcin a combination of values and ranges separated by commas: 0,1-8,8-15:2 2717f1a722f8SMatthew G. Knepley .ve 27182d747510SLisandro Dalcin 27192d747510SLisandro Dalcin There must be no intervening spaces between the values. 27202d747510SLisandro Dalcin 27212d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 27222d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 27232d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 27242d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 27252d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 27262d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 27272d747510SLisandro Dalcin @*/ 27282d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetIntArray(PetscOptions options,const char pre[],const char name[],PetscInt ivalue[],PetscInt *nmax,PetscBool *set) 27292d747510SLisandro Dalcin { 27302d747510SLisandro Dalcin const char *svalue; 27312d747510SLisandro Dalcin char *value; 27322d747510SLisandro Dalcin PetscInt n = 0,i,j,start,end,inc,nvalues; 27332d747510SLisandro Dalcin size_t len; 27342d747510SLisandro Dalcin PetscBool flag,foundrange; 27352d747510SLisandro Dalcin PetscToken token; 27362d747510SLisandro Dalcin 27372d747510SLisandro Dalcin PetscFunctionBegin; 27382d747510SLisandro Dalcin PetscValidCharPointer(name,3); 27392d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 27402d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 27412d747510SLisandro Dalcin 27425f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&svalue,&flag)); 27432d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 27442d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 27455f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(svalue,',',&token)); 27465f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 27472d747510SLisandro Dalcin while (value && n < *nmax) { 27482d747510SLisandro Dalcin /* look for form d-D where d and D are integers */ 27492d747510SLisandro Dalcin foundrange = PETSC_FALSE; 27505f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrlen(value,&len)); 27512d747510SLisandro Dalcin if (value[0] == '-') i=2; 27522d747510SLisandro Dalcin else i=1; 27532d747510SLisandro Dalcin for (;i<(int)len; i++) { 27542d747510SLisandro Dalcin if (value[i] == '-') { 27552c71b3e2SJacob Faibussowitsch PetscCheckFalse(i == (int)len-1,PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %" PetscInt_FMT "-th array entry %s",n,value); 27562d747510SLisandro Dalcin value[i] = 0; 27572d747510SLisandro Dalcin 27585f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToInt(value,&start)); 27592d747510SLisandro Dalcin inc = 1; 27602d747510SLisandro Dalcin j = i+1; 27612d747510SLisandro Dalcin for (;j<(int)len; j++) { 27622d747510SLisandro Dalcin if (value[j] == ':') { 27632d747510SLisandro Dalcin value[j] = 0; 27642d747510SLisandro Dalcin 27655f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToInt(value+j+1,&inc)); 27662c71b3e2SJacob Faibussowitsch PetscCheckFalse(inc <= 0,PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %" PetscInt_FMT "-th array entry,%s cannot have negative increment",n,value+j+1); 27672d747510SLisandro Dalcin break; 27682d747510SLisandro Dalcin } 27692d747510SLisandro Dalcin } 27705f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToInt(value+i+1,&end)); 27712c71b3e2SJacob Faibussowitsch PetscCheckFalse(end <= start,PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %" PetscInt_FMT "-th array entry, %s-%s cannot have decreasing list",n,value,value+i+1); 27722d747510SLisandro Dalcin nvalues = (end-start)/inc + (end-start)%inc; 27732c71b3e2SJacob Faibussowitsch PetscCheckFalse(n + nvalues > *nmax,PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %" PetscInt_FMT "-th array entry, not enough space left in array (%" PetscInt_FMT ") to contain entire range from %" PetscInt_FMT " to %" PetscInt_FMT,n,*nmax-n,start,end); 27742d747510SLisandro Dalcin for (;start<end; start+=inc) { 27752d747510SLisandro Dalcin *ivalue = start; ivalue++;n++; 27762d747510SLisandro Dalcin } 27772d747510SLisandro Dalcin foundrange = PETSC_TRUE; 27782d747510SLisandro Dalcin break; 27792d747510SLisandro Dalcin } 27802d747510SLisandro Dalcin } 27812d747510SLisandro Dalcin if (!foundrange) { 27825f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToInt(value,ivalue)); 27832d747510SLisandro Dalcin ivalue++; 27842d747510SLisandro Dalcin n++; 27852d747510SLisandro Dalcin } 27865f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 27872d747510SLisandro Dalcin } 27885f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 27892d747510SLisandro Dalcin *nmax = n; 27902d747510SLisandro Dalcin PetscFunctionReturn(0); 27912d747510SLisandro Dalcin } 27922d747510SLisandro Dalcin 27932d747510SLisandro Dalcin /*@C 27942d747510SLisandro Dalcin PetscOptionsGetRealArray - Gets an array of double precision values for a 2795f1a722f8SMatthew G. Knepley particular option in the database. The values must be separated with commas with no intervening spaces. 27962d747510SLisandro Dalcin 27972d747510SLisandro Dalcin Not Collective 27982d747510SLisandro Dalcin 27992d747510SLisandro Dalcin Input Parameters: 28002d747510SLisandro Dalcin + options - options database, use NULL for default global database 28012d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 28026b867d5aSJose E. Roman - name - the option one is seeking 28036b867d5aSJose E. Roman 28042d747510SLisandro Dalcin Output Parameters: 28052d747510SLisandro Dalcin + dvalue - the double values to return 2806f1a722f8SMatthew G. Knepley . nmax - On input maximum number of values to retrieve, on output the actual number of values retrieved 28072d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 28082d747510SLisandro Dalcin 28092d747510SLisandro Dalcin Level: beginner 28102d747510SLisandro Dalcin 28112d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 28122d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 28132d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 28142d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 28152d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 28162d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 28172d747510SLisandro Dalcin @*/ 28182d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetRealArray(PetscOptions options,const char pre[],const char name[],PetscReal dvalue[],PetscInt *nmax,PetscBool *set) 28192d747510SLisandro Dalcin { 28202d747510SLisandro Dalcin const char *svalue; 28212d747510SLisandro Dalcin char *value; 28222d747510SLisandro Dalcin PetscInt n = 0; 28232d747510SLisandro Dalcin PetscBool flag; 28242d747510SLisandro Dalcin PetscToken token; 28252d747510SLisandro Dalcin 28262d747510SLisandro Dalcin PetscFunctionBegin; 28272d747510SLisandro Dalcin PetscValidCharPointer(name,3); 28282d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 28292d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 28302d747510SLisandro Dalcin 28315f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&svalue,&flag)); 28322d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 28332d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 28345f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(svalue,',',&token)); 28355f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 28362d747510SLisandro Dalcin while (value && n < *nmax) { 28375f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToReal(value,dvalue++)); 28385f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 28392d747510SLisandro Dalcin n++; 28402d747510SLisandro Dalcin } 28415f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 28422d747510SLisandro Dalcin *nmax = n; 28432d747510SLisandro Dalcin PetscFunctionReturn(0); 28442d747510SLisandro Dalcin } 28452d747510SLisandro Dalcin 28462d747510SLisandro Dalcin /*@C 28472d747510SLisandro Dalcin PetscOptionsGetScalarArray - Gets an array of scalars for a 2848f1a722f8SMatthew G. Knepley particular option in the database. The values must be separated with commas with no intervening spaces. 28492d747510SLisandro Dalcin 28502d747510SLisandro Dalcin Not Collective 28512d747510SLisandro Dalcin 28522d747510SLisandro Dalcin Input Parameters: 28532d747510SLisandro Dalcin + options - options database, use NULL for default global database 28542d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 28556b867d5aSJose E. Roman - name - the option one is seeking 28566b867d5aSJose E. Roman 28572d747510SLisandro Dalcin Output Parameters: 28582d747510SLisandro Dalcin + dvalue - the scalar values to return 2859f1a722f8SMatthew G. Knepley . nmax - On input maximum number of values to retrieve, on output the actual number of values retrieved 28602d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 28612d747510SLisandro Dalcin 28622d747510SLisandro Dalcin Level: beginner 28632d747510SLisandro Dalcin 28642d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 28652d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 28662d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 28672d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 28682d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 28692d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 28702d747510SLisandro Dalcin @*/ 28712d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set) 28722d747510SLisandro Dalcin { 28732d747510SLisandro Dalcin const char *svalue; 28742d747510SLisandro Dalcin char *value; 28752d747510SLisandro Dalcin PetscInt n = 0; 28762d747510SLisandro Dalcin PetscBool flag; 28772d747510SLisandro Dalcin PetscToken token; 28782d747510SLisandro Dalcin 28792d747510SLisandro Dalcin PetscFunctionBegin; 28802d747510SLisandro Dalcin PetscValidCharPointer(name,3); 2881064a246eSJacob Faibussowitsch PetscValidScalarPointer(dvalue,4); 28822d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 28832d747510SLisandro Dalcin 28845f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&svalue,&flag)); 28852d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 28862d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 28875f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(svalue,',',&token)); 28885f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 28892d747510SLisandro Dalcin while (value && n < *nmax) { 28905f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsStringToScalar(value,dvalue++)); 28915f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 28922d747510SLisandro Dalcin n++; 28932d747510SLisandro Dalcin } 28945f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 28952d747510SLisandro Dalcin *nmax = n; 28962d747510SLisandro Dalcin PetscFunctionReturn(0); 28972d747510SLisandro Dalcin } 289814ce751eSBarry Smith 2899e5c89e4eSSatish Balay /*@C 2900e5c89e4eSSatish Balay PetscOptionsGetStringArray - Gets an array of string values for a particular 2901f1a722f8SMatthew G. Knepley option in the database. The values must be separated with commas with no intervening spaces. 2902e5c89e4eSSatish Balay 2903e5c89e4eSSatish Balay Not Collective 2904e5c89e4eSSatish Balay 2905e5c89e4eSSatish Balay Input Parameters: 29065c9cc608SHong Zhang + options - options database, use NULL for default global database 2907c5929fdfSBarry Smith . pre - string to prepend to name or NULL 29086b867d5aSJose E. Roman - name - the option one is seeking 29096b867d5aSJose E. Roman 2910e7b76fa7SPatrick Sanan Output Parameters: 2911e5c89e4eSSatish Balay + strings - location to copy strings 2912f1a722f8SMatthew G. Knepley . nmax - On input maximum number of strings, on output the actual number of strings found 291396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2914e5c89e4eSSatish Balay 2915e5c89e4eSSatish Balay Level: beginner 2916e5c89e4eSSatish Balay 2917e5c89e4eSSatish Balay Notes: 2918e7b76fa7SPatrick Sanan The nmax parameter is used for both input and output. 2919e7b76fa7SPatrick Sanan 2920e5c89e4eSSatish Balay The user should pass in an array of pointers to char, to hold all the 2921e5c89e4eSSatish Balay strings returned by this function. 2922e5c89e4eSSatish Balay 2923e5c89e4eSSatish Balay The user is responsible for deallocating the strings that are 2924e5c89e4eSSatish Balay returned. The Fortran interface for this routine is not supported. 2925e5c89e4eSSatish Balay 2926e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2927acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2928e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2929e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2930acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2931a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2932e5c89e4eSSatish Balay @*/ 2933c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetStringArray(PetscOptions options,const char pre[],const char name[],char *strings[],PetscInt *nmax,PetscBool *set) 2934e5c89e4eSSatish Balay { 29352d747510SLisandro Dalcin const char *svalue; 2936e5c89e4eSSatish Balay char *value; 29372d747510SLisandro Dalcin PetscInt n = 0; 2938ace3abfcSBarry Smith PetscBool flag; 29399c9d3cfdSBarry Smith PetscToken token; 2940e5c89e4eSSatish Balay 2941e5c89e4eSSatish Balay PetscFunctionBegin; 29422d747510SLisandro Dalcin PetscValidCharPointer(name,3); 29432d747510SLisandro Dalcin PetscValidPointer(strings,4); 29442d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 2945e5c89e4eSSatish Balay 29465f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,pre,name,&svalue,&flag)); 29472d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 29482d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 29495f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenCreate(svalue,',',&token)); 29505f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 29512d747510SLisandro Dalcin while (value && n < *nmax) { 29525f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrallocpy(value,&strings[n])); 29535f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenFind(token,&value)); 2954e5c89e4eSSatish Balay n++; 2955e5c89e4eSSatish Balay } 29565f80ce2aSJacob Faibussowitsch CHKERRQ(PetscTokenDestroy(&token)); 2957e5c89e4eSSatish Balay *nmax = n; 2958e5c89e4eSSatish Balay PetscFunctionReturn(0); 2959e5c89e4eSSatish Balay } 296006824ed3SPatrick Sanan 296106824ed3SPatrick Sanan /*@C 296206824ed3SPatrick Sanan PetscOptionsDeprecated - mark an option as deprecated, optionally replacing it with a new one 296306824ed3SPatrick Sanan 296406824ed3SPatrick Sanan Prints a deprecation warning, unless an option is supplied to suppress. 296506824ed3SPatrick Sanan 29661c9f3c13SBarry Smith Logically Collective 296706824ed3SPatrick Sanan 296806824ed3SPatrick Sanan Input Parameters: 29699503aa97SPatrick Sanan + pre - string to prepend to name or NULL 297006824ed3SPatrick Sanan . oldname - the old, deprecated option 297106824ed3SPatrick Sanan . newname - the new option, or NULL if option is purely removed 29729f3a6782SPatrick Sanan . version - a string describing the version of first deprecation, e.g. "3.9" 29739f3a6782SPatrick Sanan - info - additional information string, or NULL. 297406824ed3SPatrick Sanan 297506824ed3SPatrick Sanan Options Database Keys: 297606824ed3SPatrick Sanan . -options_suppress_deprecated_warnings - do not print deprecation warnings 297706824ed3SPatrick Sanan 297806824ed3SPatrick Sanan Notes: 29791c9f3c13SBarry Smith Must be called between PetscOptionsBegin() (or PetscObjectOptionsBegin()) and PetscOptionsEnd(). 29801c9f3c13SBarry Smith Only the proces of rank zero that owns the PetscOptionsItems are argument (managed by PetscOptionsBegin() or 29811c9f3c13SBarry Smith PetscObjectOptionsBegin() prints the information 2982b40114eaSPatrick Sanan If newname is provided, the old option is replaced. Otherwise, it remains 2983b40114eaSPatrick Sanan in the options database. 29849f3a6782SPatrick Sanan If an option is not replaced, the info argument should be used to advise the user 29859f3a6782SPatrick Sanan on how to proceed. 29869f3a6782SPatrick Sanan There is a limit on the length of the warning printed, so very long strings 29879f3a6782SPatrick Sanan provided as info may be truncated. 298806824ed3SPatrick Sanan 298906824ed3SPatrick Sanan Level: developer 299006824ed3SPatrick Sanan 299106824ed3SPatrick Sanan .seealso: PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsScalar(), PetscOptionsBool(), PetscOptionsString(), PetscOptionsSetValue() 299206824ed3SPatrick Sanan 299306824ed3SPatrick Sanan @*/ 29949f3a6782SPatrick Sanan PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems *PetscOptionsObject,const char oldname[],const char newname[],const char version[],const char info[]) 299506824ed3SPatrick Sanan { 299606824ed3SPatrick Sanan PetscBool found,quiet; 299706824ed3SPatrick Sanan const char *value; 299806824ed3SPatrick Sanan const char * const quietopt="-options_suppress_deprecated_warnings"; 29999f3a6782SPatrick Sanan char msg[4096]; 3000b0bdc838SStefano Zampini char *prefix = NULL; 3001b0bdc838SStefano Zampini PetscOptions options = NULL; 3002b0bdc838SStefano Zampini MPI_Comm comm = PETSC_COMM_SELF; 300306824ed3SPatrick Sanan 300406824ed3SPatrick Sanan PetscFunctionBegin; 300506824ed3SPatrick Sanan PetscValidCharPointer(oldname,2); 300606824ed3SPatrick Sanan PetscValidCharPointer(version,4); 3007b0bdc838SStefano Zampini if (PetscOptionsObject) { 3008b0bdc838SStefano Zampini prefix = PetscOptionsObject->prefix; 3009b0bdc838SStefano Zampini options = PetscOptionsObject->options; 3010b0bdc838SStefano Zampini comm = PetscOptionsObject->comm; 3011b0bdc838SStefano Zampini } 30125f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsFindPair(options,prefix,oldname,&value,&found)); 301306824ed3SPatrick Sanan if (found) { 301406824ed3SPatrick Sanan if (newname) { 3015b0bdc838SStefano Zampini if (prefix) { 30165f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPrefixPush(options,prefix)); 3017d255429eSPatrick Sanan } 30185f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsSetValue(options,newname,value)); 3019b0bdc838SStefano Zampini if (prefix) { 30205f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsPrefixPop(options)); 3021d255429eSPatrick Sanan } 30225f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsClearValue(options,oldname)); 3023b40114eaSPatrick Sanan } 302406824ed3SPatrick Sanan quiet = PETSC_FALSE; 30255f80ce2aSJacob Faibussowitsch CHKERRQ(PetscOptionsGetBool(options,NULL,quietopt,&quiet,NULL)); 302606824ed3SPatrick Sanan if (!quiet) { 30275f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ")); 30285f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg,oldname)); 30295f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg," is deprecated as of version ")); 30305f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg,version)); 30315f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg," and will be removed in a future release.")); 303206824ed3SPatrick Sanan if (newname) { 30335f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg," Please use the option ")); 30345f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg,newname)); 30355f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg," instead.")); 303606824ed3SPatrick Sanan } 30379f3a6782SPatrick Sanan if (info) { 30385f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg," ")); 30395f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg,info)); 30409f3a6782SPatrick Sanan } 30415f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg," (Silence this warning with ")); 30425f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg,quietopt)); 30435f80ce2aSJacob Faibussowitsch CHKERRQ(PetscStrcat(msg,")\n")); 30445f80ce2aSJacob Faibussowitsch CHKERRQ(PetscPrintf(comm,"%s",msg)); 304506824ed3SPatrick Sanan } 304606824ed3SPatrick Sanan } 304706824ed3SPatrick Sanan PetscFunctionReturn(0); 304806824ed3SPatrick Sanan } 3049