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_STRING_H) 192d747510SLisandro Dalcin #include <string.h> /* strcasecmp */ 20ef279fd6SBarry Smith #endif 21ef279fd6SBarry Smith #if defined(PETSC_HAVE_STRINGS_H) 22ef279fd6SBarry Smith # include <strings.h> /* strcasecmp */ 23ef279fd6SBarry Smith #endif 243bcbd388SSean Farley #if defined(PETSC_HAVE_YAML) 253bcbd388SSean Farley #include <yaml.h> 263bcbd388SSean Farley #endif 27e5c89e4eSSatish Balay 282d747510SLisandro Dalcin #if defined(PETSC_HAVE_STRCASECMP) 292d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) strcasecmp(a,b) 302d747510SLisandro Dalcin #elif defined(PETSC_HAVE_STRICMP) 312d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) stricmp(a,b) 322d747510SLisandro Dalcin #else 332d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) Error_strcasecmp_not_found 342d747510SLisandro Dalcin #endif 352d747510SLisandro Dalcin 362d747510SLisandro Dalcin #include <petsc/private/hashtable.h> 372d747510SLisandro Dalcin 382d747510SLisandro Dalcin /* This assumes ASCII encoding and ignores locale settings */ 392d747510SLisandro Dalcin /* Using tolower() is about 2X slower in microbenchmarks */ 402d747510SLisandro Dalcin PETSC_STATIC_INLINE int PetscToLower(int c) 412d747510SLisandro Dalcin { 422d747510SLisandro Dalcin return ((c >= 'A') & (c <= 'Z')) ? c + 'a' - 'A' : c; 432d747510SLisandro Dalcin } 442d747510SLisandro Dalcin 452d747510SLisandro Dalcin /* Bob Jenkins's one at a time hash function (case-insensitive) */ 462d747510SLisandro Dalcin PETSC_STATIC_INLINE unsigned int PetscOptHash(const char key[]) 472d747510SLisandro Dalcin { 482d747510SLisandro Dalcin unsigned int hash = 0; 492d747510SLisandro Dalcin while (*key) { 502d747510SLisandro Dalcin hash += PetscToLower(*key++); 512d747510SLisandro Dalcin hash += hash << 10; 522d747510SLisandro Dalcin hash ^= hash >> 6; 532d747510SLisandro Dalcin } 542d747510SLisandro Dalcin hash += hash << 3; 552d747510SLisandro Dalcin hash ^= hash >> 11; 562d747510SLisandro Dalcin hash += hash << 15; 572d747510SLisandro Dalcin return hash; 582d747510SLisandro Dalcin } 592d747510SLisandro Dalcin 602d747510SLisandro Dalcin PETSC_STATIC_INLINE int PetscOptEqual(const char a[],const char b[]) 612d747510SLisandro Dalcin { 622d747510SLisandro Dalcin return !PetscOptNameCmp(a,b); 632d747510SLisandro Dalcin } 642d747510SLisandro Dalcin 652d747510SLisandro Dalcin KHASH_INIT(HO, kh_cstr_t, int, 1, PetscOptHash, PetscOptEqual) 662d747510SLisandro Dalcin 67e5c89e4eSSatish Balay /* 683fc1eb6aSBarry Smith This table holds all the options set by the user. For simplicity, we use a static size database 69e5c89e4eSSatish Balay */ 702d747510SLisandro Dalcin #define MAXOPTNAME 512 71e5c89e4eSSatish Balay #define MAXOPTIONS 512 72e5c89e4eSSatish Balay #define MAXALIASES 25 7374e0666dSJed Brown #define MAXPREFIXES 25 742d747510SLisandro Dalcin #define MAXOPTIONSMONITORS 5 75e5c89e4eSSatish Balay 764416b707SBarry Smith struct _n_PetscOptions { 77*b4205f0bSBarry Smith PetscOptions next,previous; 782d747510SLisandro Dalcin int N; /* number of options */ 792d747510SLisandro Dalcin char *names[MAXOPTIONS]; /* option names */ 802d747510SLisandro Dalcin char *values[MAXOPTIONS]; /* option values */ 812d747510SLisandro Dalcin PetscBool used[MAXOPTIONS]; /* flag option use */ 82081c24baSBoyana Norris 832d747510SLisandro Dalcin /* Hash table */ 842d747510SLisandro Dalcin khash_t(HO) *ht; 852d747510SLisandro Dalcin 862d747510SLisandro Dalcin /* Prefixes */ 872d747510SLisandro Dalcin int prefixind; 882d747510SLisandro Dalcin int prefixstack[MAXPREFIXES]; 892d747510SLisandro Dalcin char prefix[MAXOPTNAME]; 902d747510SLisandro Dalcin 912d747510SLisandro Dalcin /* Aliases */ 922d747510SLisandro Dalcin int Naliases; /* number or aliases */ 932d747510SLisandro Dalcin char *aliases1[MAXALIASES]; /* aliased */ 942d747510SLisandro Dalcin char *aliases2[MAXALIASES]; /* aliasee */ 952d747510SLisandro Dalcin 962d747510SLisandro Dalcin /* Help */ 972d747510SLisandro Dalcin PetscBool help; /* flag whether "-help" is in the database */ 982d747510SLisandro Dalcin 992d747510SLisandro Dalcin /* Monitors */ 100081c24baSBoyana Norris PetscErrorCode (*monitor[MAXOPTIONSMONITORS])(const char[],const char[],void*); /* returns control to user after */ 101c2efdce3SBarry Smith PetscErrorCode (*monitordestroy[MAXOPTIONSMONITORS])(void**); /* */ 102081c24baSBoyana Norris void *monitorcontext[MAXOPTIONSMONITORS]; /* to pass arbitrary user data into monitor */ 103081c24baSBoyana Norris PetscInt numbermonitors; /* to, for instance, detect options being set */ 1044416b707SBarry Smith }; 105e5c89e4eSSatish Balay 106*b4205f0bSBarry Smith static PetscOptions defaultoptions = NULL; /* the options database routines query this object for options */ 107*b4205f0bSBarry Smith static PetscOptions initialoptions = NULL; /* this contains the options set by PetscInitialize() */ 1082d747510SLisandro Dalcin 109081c24baSBoyana Norris /* 110081c24baSBoyana Norris Options events monitor 111081c24baSBoyana Norris */ 1122d747510SLisandro Dalcin static PetscErrorCode PetscOptionsMonitor(PetscOptions options,const char name[],const char value[]) 113e5c89e4eSSatish Balay { 1142d747510SLisandro Dalcin PetscInt i; 115e5c89e4eSSatish Balay PetscErrorCode ierr; 116e5c89e4eSSatish Balay 1172d747510SLisandro Dalcin if (!PetscInitializeCalled) return 0; 118e5c89e4eSSatish Balay PetscFunctionBegin; 1192d747510SLisandro Dalcin for (i=0; i<options->numbermonitors; i++) { 1202d747510SLisandro Dalcin ierr = (*options->monitor[i])(name,value,options->monitorcontext[i]);CHKERRQ(ierr); 121e5c89e4eSSatish Balay } 122e5c89e4eSSatish Balay PetscFunctionReturn(0); 123e5c89e4eSSatish Balay } 124e5c89e4eSSatish Balay 1252d747510SLisandro Dalcin /*@ 1262d747510SLisandro Dalcin PetscOptionsCreate - Creates an empty options database. 127e5c89e4eSSatish Balay 128e5c89e4eSSatish Balay Output Parameter: 1292d747510SLisandro Dalcin . options - Options database object 130e5c89e4eSSatish Balay 131e5c89e4eSSatish Balay Level: advanced 132e5c89e4eSSatish Balay 133*b4205f0bSBarry Smith .seealso: PetscOptionsDestroy(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 134e5c89e4eSSatish Balay @*/ 1352d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreate(PetscOptions *options) 1362d747510SLisandro Dalcin { 1372d747510SLisandro Dalcin if (!options) return PETSC_ERR_ARG_NULL; 1382d747510SLisandro Dalcin *options = (PetscOptions)calloc(1,sizeof(**options)); 1392d747510SLisandro Dalcin if (!*options) return PETSC_ERR_MEM; 1402d747510SLisandro Dalcin return 0; 1412d747510SLisandro Dalcin } 1422d747510SLisandro Dalcin 1432d747510SLisandro Dalcin /*@ 1442d747510SLisandro Dalcin PetscOptionsDestroy - Destroys an option database. 1452d747510SLisandro Dalcin 1462d747510SLisandro Dalcin Input Parameter: 1472d747510SLisandro Dalcin . options - the PetscOptions object 1482d747510SLisandro Dalcin 1492d747510SLisandro Dalcin Level: developer 1502d747510SLisandro Dalcin 151*b4205f0bSBarry Smith .seealso: PetscOptionsInsert(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 1522d747510SLisandro Dalcin @*/ 1532d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroy(PetscOptions *options) 154e5c89e4eSSatish Balay { 155e5c89e4eSSatish Balay PetscErrorCode ierr; 156e5c89e4eSSatish Balay 1572d747510SLisandro Dalcin if (!*options) return 0; 1582d747510SLisandro Dalcin ierr = PetscOptionsClear(*options);if (ierr) return ierr; 1592d747510SLisandro Dalcin /* XXX what about monitors ? */ 1602800570dSLisandro Dalcin free(*options); 1612d747510SLisandro Dalcin *options = NULL; 162e5c89e4eSSatish Balay PetscFunctionReturn(0); 163e5c89e4eSSatish Balay } 164e5c89e4eSSatish Balay 1652d747510SLisandro Dalcin /* 1662d747510SLisandro Dalcin PetscOptionsCreateDefault - Creates the default global options database 1672d747510SLisandro Dalcin */ 1682d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreateDefault(void) 169e5c89e4eSSatish Balay { 170e5c89e4eSSatish Balay PetscErrorCode ierr; 171e5c89e4eSSatish Balay 1722d747510SLisandro Dalcin if (!defaultoptions) { 1732d747510SLisandro Dalcin ierr = PetscOptionsCreate(&defaultoptions);if (ierr) return ierr; 174*b4205f0bSBarry Smith initialoptions = defaultoptions; 1752d747510SLisandro Dalcin } 1762d747510SLisandro Dalcin return 0; 1772d747510SLisandro Dalcin } 1782d747510SLisandro Dalcin 179*b4205f0bSBarry Smith /*@ 180*b4205f0bSBarry Smith PetscOptionsPush - Push a new PetscOptions object as the default provider of options 181*b4205f0bSBarry Smith 182*b4205f0bSBarry Smith Logically Collective 183*b4205f0bSBarry Smith 184*b4205f0bSBarry Smith Input Parameter: 185*b4205f0bSBarry Smith . opt - the options obtained with PetscOptionsCreate() 186*b4205f0bSBarry Smith 187*b4205f0bSBarry Smith Notes: 188*b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 189*b4205f0bSBarry Smith Allows using different parts of a code to use different options databases 190*b4205f0bSBarry Smith 191*b4205f0bSBarry Smith .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionDestroy(), PetscOptionsInsert(), PetscOptionsSetValue() 192*b4205f0bSBarry Smith 193*b4205f0bSBarry Smith @*/ 194*b4205f0bSBarry Smith PetscErrorCode PetscOptionsPush(PetscOptions opt) 195*b4205f0bSBarry Smith { 196*b4205f0bSBarry Smith PetscErrorCode ierr; 197*b4205f0bSBarry Smith 198*b4205f0bSBarry Smith PetscFunctionBegin; 199*b4205f0bSBarry Smith if (!defaultoptions) { 200*b4205f0bSBarry Smith ierr = PetscOptionsCreateDefault();CHKERRQ(ierr); 201*b4205f0bSBarry Smith } 202*b4205f0bSBarry Smith defaultoptions->next = opt; 203*b4205f0bSBarry Smith opt->previous = defaultoptions; 204*b4205f0bSBarry Smith defaultoptions = opt; 205*b4205f0bSBarry Smith PetscFunctionReturn(0); 206*b4205f0bSBarry Smith } 207*b4205f0bSBarry Smith 208*b4205f0bSBarry Smith /*@ 209*b4205f0bSBarry Smith PetscOptionsPop - Pop the most recent PetscOptionsPush() to return to the previous default options 210*b4205f0bSBarry Smith 211*b4205f0bSBarry Smith Logically Collective 212*b4205f0bSBarry Smith 213*b4205f0bSBarry Smith Notes: 214*b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 215*b4205f0bSBarry Smith Allows using different parts of a code to use different options databases 216*b4205f0bSBarry Smith 217*b4205f0bSBarry Smith .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionDestroy(), PetscOptionsInsert(), PetscOptionsSetValue() 218*b4205f0bSBarry Smith 219*b4205f0bSBarry Smith @*/ 220*b4205f0bSBarry Smith PetscErrorCode PetscOptionsPop(void) 221*b4205f0bSBarry Smith { 222*b4205f0bSBarry Smith PetscFunctionBegin; 223*b4205f0bSBarry Smith if (!defaultoptions) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Missing default options"); 224*b4205f0bSBarry Smith if (!defaultoptions->previous) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"PetscOptionsPop() called too many times"); 225*b4205f0bSBarry Smith defaultoptions = defaultoptions->previous; 226*b4205f0bSBarry Smith PetscFunctionReturn(0); 227*b4205f0bSBarry Smith } 228*b4205f0bSBarry Smith 2292d747510SLisandro Dalcin /* 2302d747510SLisandro Dalcin PetscOptionsDestroyDefault - Destroys the default global options database 2312d747510SLisandro Dalcin */ 2322d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroyDefault(void) 2332d747510SLisandro Dalcin { 2342d747510SLisandro Dalcin PetscErrorCode ierr; 2352d747510SLisandro Dalcin 2362d747510SLisandro Dalcin ierr = PetscOptionsDestroy(&defaultoptions);if (ierr) return ierr; 2372d747510SLisandro Dalcin return 0; 238e5c89e4eSSatish Balay } 239e5c89e4eSSatish Balay 24094ef8ddeSSatish Balay /*@C 2417cd08cecSJed Brown PetscOptionsValidKey - PETSc Options database keys must begin with one or two dashes (-) followed by a letter. 2423fc1eb6aSBarry Smith 2433fc1eb6aSBarry Smith Input Parameter: 2442d747510SLisandro Dalcin . key - string to check if valid 2453fc1eb6aSBarry Smith 2463fc1eb6aSBarry Smith Output Parameter: 2472d747510SLisandro Dalcin . valid - PETSC_TRUE if a valid key 2483fc1eb6aSBarry Smith 249f6680f47SSatish Balay Level: intermediate 2503fc1eb6aSBarry Smith @*/ 2512d747510SLisandro Dalcin PetscErrorCode PetscOptionsValidKey(const char key[],PetscBool *valid) 25296fc60bcSBarry Smith { 253f603b5e9SToby Isaac char *ptr; 2547c5db45bSBarry Smith 25596fc60bcSBarry Smith PetscFunctionBegin; 2562d747510SLisandro Dalcin if (key) PetscValidCharPointer(key,1); 2572d747510SLisandro Dalcin PetscValidPointer(valid,2); 2582d747510SLisandro Dalcin *valid = PETSC_FALSE; 2592d747510SLisandro Dalcin if (!key) PetscFunctionReturn(0); 2602d747510SLisandro Dalcin if (key[0] != '-') PetscFunctionReturn(0); 2612d747510SLisandro Dalcin if (key[1] == '-') key++; 2622d747510SLisandro Dalcin if (!isalpha((int)(key[1]))) PetscFunctionReturn(0); 2632d747510SLisandro Dalcin (void) strtod(key,&ptr); 2642d747510SLisandro Dalcin if (ptr != key && !(*ptr == '_' || isalnum(*ptr))) PetscFunctionReturn(0); 2652d747510SLisandro Dalcin *valid = PETSC_TRUE; 26696fc60bcSBarry Smith PetscFunctionReturn(0); 26796fc60bcSBarry Smith } 26896fc60bcSBarry Smith 269e5c89e4eSSatish Balay /*@C 270e5c89e4eSSatish Balay PetscOptionsInsertString - Inserts options into the database from a string 271e5c89e4eSSatish Balay 2722d747510SLisandro Dalcin Not Collective, but only processes that call this routine will set the options 27301508a89SJed Brown included in the string 274e5c89e4eSSatish Balay 275e5c89e4eSSatish Balay Input Parameter: 276a8c7a070SBarry Smith . in_str - string that contains options separated by blanks 277e5c89e4eSSatish Balay 278e5c89e4eSSatish Balay 279e5c89e4eSSatish Balay Level: intermediate 280e5c89e4eSSatish Balay 281e5c89e4eSSatish Balay Contributed by Boyana Norris 282e5c89e4eSSatish Balay 28388c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 284acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 285e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 286e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 287acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 288a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsInsertFile() 289e5c89e4eSSatish Balay @*/ 290c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertString(PetscOptions options,const char in_str[]) 291e5c89e4eSSatish Balay { 29296fc60bcSBarry Smith char *first,*second; 293e5c89e4eSSatish Balay PetscErrorCode ierr; 2949c9d3cfdSBarry Smith PetscToken token; 295bf9c6086SStefano Zampini PetscBool key,ispush,ispop,isopts; 296e5c89e4eSSatish Balay 297e5c89e4eSSatish Balay PetscFunctionBegin; 29896fc60bcSBarry Smith ierr = PetscTokenCreate(in_str,' ',&token);CHKERRQ(ierr); 299e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 30096fc60bcSBarry Smith while (first) { 3019db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_push",&ispush);CHKERRQ(ierr); 3029db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_pop",&ispop);CHKERRQ(ierr); 303bf9c6086SStefano Zampini ierr = PetscStrcasecmp(first,"-options_file",&isopts);CHKERRQ(ierr); 30496fc60bcSBarry Smith ierr = PetscOptionsValidKey(first,&key);CHKERRQ(ierr); 3059db968c8SJed Brown if (ispush) { 3069db968c8SJed Brown ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 307c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,second);CHKERRQ(ierr); 3089db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 3099db968c8SJed Brown } else if (ispop) { 310c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 3119db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 312bf9c6086SStefano Zampini } else if (isopts) { 313bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 314bf9c6086SStefano Zampini ierr = PetscOptionsInsertFile(PETSC_COMM_SELF,options,second,PETSC_TRUE);CHKERRQ(ierr); 315bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 3169db968c8SJed Brown } else if (key) { 317e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 31896fc60bcSBarry Smith ierr = PetscOptionsValidKey(second,&key);CHKERRQ(ierr); 31996fc60bcSBarry Smith if (!key) { 320c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,second);CHKERRQ(ierr); 32196fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 32296fc60bcSBarry Smith } else { 323c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,NULL);CHKERRQ(ierr); 32496fc60bcSBarry Smith first = second; 32596fc60bcSBarry Smith } 32696fc60bcSBarry Smith } else { 32796fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 328e5c89e4eSSatish Balay } 329e5c89e4eSSatish Balay } 3308c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 331e5c89e4eSSatish Balay PetscFunctionReturn(0); 332e5c89e4eSSatish Balay } 333e5c89e4eSSatish Balay 3343fc1eb6aSBarry Smith /* 3353fc1eb6aSBarry Smith Returns a line (ended by a \n, \r or null character of any length. Result should be freed with free() 3363fc1eb6aSBarry Smith */ 3375fa91da5SBarry Smith static char *Petscgetline(FILE * f) 3385fa91da5SBarry Smith { 3395fa91da5SBarry Smith size_t size = 0; 3405fa91da5SBarry Smith size_t len = 0; 3415fa91da5SBarry Smith size_t last = 0; 3420298fd71SBarry Smith char *buf = NULL; 3435fa91da5SBarry Smith 3445fa91da5SBarry Smith if (feof(f)) return 0; 3455fa91da5SBarry Smith do { 3465fa91da5SBarry Smith size += 1024; /* BUFSIZ is defined as "the optimal read size for this platform" */ 3476e0c8459SSatish Balay buf = (char*)realloc((void*)buf,size); /* realloc(NULL,n) is the same as malloc(n) */ 3485fa91da5SBarry Smith /* Actually do the read. Note that fgets puts a terminal '\0' on the 3495fa91da5SBarry Smith end of the string, so we make sure we overwrite this */ 350e86f3e45SDave May if (!fgets(buf+len,1024,f)) buf[len]=0; 3515fa91da5SBarry Smith PetscStrlen(buf,&len); 3525fa91da5SBarry Smith last = len - 1; 3535fa91da5SBarry Smith } while (!feof(f) && buf[last] != '\n' && buf[last] != '\r'); 35408ac41f7SSatish Balay if (len) return buf; 3555fa91da5SBarry Smith free(buf); 3565fa91da5SBarry Smith return 0; 3575fa91da5SBarry Smith } 3585fa91da5SBarry Smith 359e5c89e4eSSatish Balay /*@C 360e5c89e4eSSatish Balay PetscOptionsInsertFile - Inserts options into the database from a file. 361e5c89e4eSSatish Balay 362d083f849SBarry Smith Collective 363e5c89e4eSSatish Balay 364e5c89e4eSSatish Balay Input Parameter: 3659b754dc9SBarry Smith + comm - the processes that will share the options (usually PETSC_COMM_WORLD) 366c5929fdfSBarry Smith . options - options database, use NULL for default global database 367e5c89e4eSSatish Balay . file - name of file 3689b754dc9SBarry Smith - require - if PETSC_TRUE will generate an error if the file does not exist 369e5c89e4eSSatish Balay 370e5c89e4eSSatish Balay 37195452b02SPatrick Sanan Notes: 37295452b02SPatrick Sanan Use # for lines that are comments and which should be ignored. 3737c43ebc8SBarry Smith 374f0feba65SBarry Smith Usually, instead of using this command, one should list the file name in the call to PetscInitialize(), this insures that certain options 375609bdbeeSBarry Smith 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 376f0feba65SBarry Smith calls to XXXSetFromOptions() it should not be used for options listed under PetscInitialize(). 377f0feba65SBarry Smith 3783bcbd388SSean Farley Level: developer 379e5c89e4eSSatish Balay 38088c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 381acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 382e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 383e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 384acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 385a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 386e5c89e4eSSatish Balay 387e5c89e4eSSatish Balay @*/ 388c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertFile(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require) 389e5c89e4eSSatish Balay { 3903a018368SJed Brown char *string,fname[PETSC_MAX_PATH_LEN],*first,*second,*third,*vstring = 0,*astring = 0,*packed = 0; 391e5c89e4eSSatish Balay PetscErrorCode ierr; 39213e3f751SJed Brown size_t i,len,bytes; 393e5c89e4eSSatish Balay FILE *fd; 3949c9d3cfdSBarry Smith PetscToken token; 395ed9cf6e9SBarry Smith int err; 3967c43ebc8SBarry Smith char cmt[1]={'#'},*cmatch; 3973a018368SJed Brown PetscMPIInt rank,cnt=0,acnt=0,counts[2]; 398ad38b122SPatrick Sanan PetscBool isdir; 399e5c89e4eSSatish Balay 400e5c89e4eSSatish Balay PetscFunctionBegin; 40105c7dedfSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 40205c7dedfSBarry Smith if (!rank) { 40366af5158SSatish Balay cnt = 0; 40466af5158SSatish Balay acnt = 0; 40505c7dedfSBarry Smith 406e5c89e4eSSatish Balay ierr = PetscFixFilename(file,fname);CHKERRQ(ierr); 407e5c89e4eSSatish Balay fd = fopen(fname,"r"); 408ad38b122SPatrick Sanan ierr = PetscTestDirectory(fname,'r',&isdir);CHKERRQ(ierr); 409ad38b122SPatrick Sanan if (isdir && require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Specified options file %s is a directory",fname); 410ad38b122SPatrick Sanan if (fd && !isdir) { 4113a018368SJed Brown PetscSegBuffer vseg,aseg; 4123a018368SJed Brown ierr = PetscSegBufferCreate(1,4000,&vseg);CHKERRQ(ierr); 4133a018368SJed Brown ierr = PetscSegBufferCreate(1,2000,&aseg);CHKERRQ(ierr); 4143a018368SJed Brown 4159b754dc9SBarry Smith /* the following line will not work when opening initial files (like .petscrc) since info is not yet set */ 4169b754dc9SBarry Smith ierr = PetscInfo1(0,"Opened options file %s\n",file);CHKERRQ(ierr); 417e24ecc5dSJed Brown 4185fa91da5SBarry Smith while ((string = Petscgetline(fd))) { 4194704e885SBarry Smith /* eliminate comments from each line */ 4207c43ebc8SBarry Smith for (i=0; i<1; i++) { 421a2ea699eSBarry Smith ierr = PetscStrchr(string,cmt[i],&cmatch);CHKERRQ(ierr); 42290f79514SSatish Balay if (cmatch) *cmatch = 0; 42390f79514SSatish Balay } 424e5c89e4eSSatish Balay ierr = PetscStrlen(string,&len);CHKERRQ(ierr); 4255981331cSSatish Balay /* replace tabs, ^M, \n with " " */ 426e5c89e4eSSatish Balay for (i=0; i<len; i++) { 4275981331cSSatish Balay if (string[i] == '\t' || string[i] == '\r' || string[i] == '\n') { 428e5c89e4eSSatish Balay string[i] = ' '; 429e5c89e4eSSatish Balay } 430e5c89e4eSSatish Balay } 43190f79514SSatish Balay ierr = PetscTokenCreate(string,' ',&token);CHKERRQ(ierr); 432e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 43390f79514SSatish Balay if (!first) { 43402b0d46eSSatish Balay goto destroy; 43590f79514SSatish Balay } else if (!first[0]) { /* if first token is empty spaces, redo first token */ 43690f79514SSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 43790f79514SSatish Balay } 438e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 4392662f744SSatish Balay if (!first) { 4402662f744SSatish Balay goto destroy; 4412662f744SSatish Balay } else if (first[0] == '-') { 442e24ecc5dSJed Brown ierr = PetscStrlen(first,&len);CHKERRQ(ierr); 44313e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+1,&vstring);CHKERRQ(ierr); 444e24ecc5dSJed Brown ierr = PetscMemcpy(vstring,first,len);CHKERRQ(ierr); 445e24ecc5dSJed Brown vstring[len] = ' '; 44609192fe3SBarry Smith if (second) { 447e24ecc5dSJed Brown ierr = PetscStrlen(second,&len);CHKERRQ(ierr); 44813e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+3,&vstring);CHKERRQ(ierr); 449e24ecc5dSJed Brown vstring[0] = '"'; 450e24ecc5dSJed Brown ierr = PetscMemcpy(vstring+1,second,len);CHKERRQ(ierr); 451e24ecc5dSJed Brown vstring[len+1] = '"'; 452e24ecc5dSJed Brown vstring[len+2] = ' '; 45309192fe3SBarry Smith } 45490f79514SSatish Balay } else { 455ace3abfcSBarry Smith PetscBool match; 456e5c89e4eSSatish Balay 457e5c89e4eSSatish Balay ierr = PetscStrcasecmp(first,"alias",&match);CHKERRQ(ierr); 458e5c89e4eSSatish Balay if (match) { 459e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&third);CHKERRQ(ierr); 460e32f2f54SBarry Smith if (!third) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file:alias missing (%s)",second); 461e24ecc5dSJed Brown ierr = PetscStrlen(second,&len);CHKERRQ(ierr); 46213e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 463e24ecc5dSJed Brown ierr = PetscMemcpy(astring,second,len);CHKERRQ(ierr); 464e24ecc5dSJed Brown astring[len] = ' '; 465e24ecc5dSJed Brown 466e24ecc5dSJed Brown ierr = PetscStrlen(third,&len);CHKERRQ(ierr); 46713e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 468e24ecc5dSJed Brown ierr = PetscMemcpy(astring,third,len);CHKERRQ(ierr); 469e24ecc5dSJed Brown astring[len] = ' '; 470f23aa3ddSBarry Smith } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown statement in options file: (%s)",string); 471e5c89e4eSSatish Balay } 47202b0d46eSSatish Balay destroy: 4734b40f50bSBarry Smith free(string); 4748c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 475e5c89e4eSSatish Balay } 476ed9cf6e9SBarry Smith err = fclose(fd); 477e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 478e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(aseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 479e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&acnt);CHKERRQ(ierr); 480e24ecc5dSJed Brown ierr = PetscSegBufferGet(aseg,1,&astring);CHKERRQ(ierr); 481e24ecc5dSJed Brown astring[0] = 0; 482e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(vseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 483e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&cnt);CHKERRQ(ierr); 484e24ecc5dSJed Brown ierr = PetscSegBufferGet(vseg,1,&vstring);CHKERRQ(ierr); 485e24ecc5dSJed Brown vstring[0] = 0; 486854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 4873a018368SJed Brown ierr = PetscSegBufferExtractTo(aseg,packed);CHKERRQ(ierr); 4883a018368SJed Brown ierr = PetscSegBufferExtractTo(vseg,packed+acnt+1);CHKERRQ(ierr); 4893a018368SJed Brown ierr = PetscSegBufferDestroy(&aseg);CHKERRQ(ierr); 4903a018368SJed Brown ierr = PetscSegBufferDestroy(&vseg);CHKERRQ(ierr); 491f23aa3ddSBarry Smith } else if (require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Unable to open Options File %s",fname); 4929b754dc9SBarry Smith } 49305c7dedfSBarry Smith 4943a018368SJed Brown counts[0] = acnt; 4953a018368SJed Brown counts[1] = cnt; 4963a018368SJed Brown ierr = MPI_Bcast(counts,2,MPI_INT,0,comm);CHKERRQ(ierr); 4973a018368SJed Brown acnt = counts[0]; 4983a018368SJed Brown cnt = counts[1]; 4993a018368SJed Brown if (rank) { 500854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 5013a018368SJed Brown } 5023a018368SJed Brown if (acnt || cnt) { 5033a018368SJed Brown ierr = MPI_Bcast(packed,2+acnt+cnt,MPI_CHAR,0,comm);CHKERRQ(ierr); 5043a018368SJed Brown astring = packed; 5053a018368SJed Brown vstring = packed + acnt + 1; 5063a018368SJed Brown } 5073a018368SJed Brown 5089b754dc9SBarry Smith if (acnt) { 5099b754dc9SBarry Smith PetscToken token; 5109b754dc9SBarry Smith char *first,*second; 5119b754dc9SBarry Smith 5129b754dc9SBarry Smith ierr = PetscTokenCreate(astring,' ',&token);CHKERRQ(ierr); 5139b754dc9SBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 5149b754dc9SBarry Smith while (first) { 5159b754dc9SBarry Smith ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 516c5929fdfSBarry Smith ierr = PetscOptionsSetAlias(options,first,second);CHKERRQ(ierr); 5179b754dc9SBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 5189b754dc9SBarry Smith } 5198c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 5209b754dc9SBarry Smith } 5219b754dc9SBarry Smith 5229b754dc9SBarry Smith if (cnt) { 523c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,vstring);CHKERRQ(ierr); 524e5c89e4eSSatish Balay } 5253a018368SJed Brown ierr = PetscFree(packed);CHKERRQ(ierr); 526e5c89e4eSSatish Balay PetscFunctionReturn(0); 527e5c89e4eSSatish Balay } 528e5c89e4eSSatish Balay 5292d747510SLisandro Dalcin static PetscErrorCode PetscOptionsInsertArgs(PetscOptions options,int argc,char *args[]) 53085079163SJed Brown { 53185079163SJed Brown PetscErrorCode ierr; 53285079163SJed Brown int left = argc - 1; 53385079163SJed Brown char **eargs = args + 1; 53485079163SJed Brown 53585079163SJed Brown PetscFunctionBegin; 53685079163SJed Brown while (left) { 537093de6efSBarry Smith PetscBool isoptions_file,isprefixpush,isprefixpop,isp4,tisp4,isp4yourname,isp4rmrank,key; 53885079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-options_file",&isoptions_file);CHKERRQ(ierr); 5399db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_push",&isprefixpush);CHKERRQ(ierr); 5409db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_pop",&isprefixpop);CHKERRQ(ierr); 54185079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4pg",&isp4);CHKERRQ(ierr); 54285079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4yourname",&isp4yourname);CHKERRQ(ierr); 54385079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4rmrank",&isp4rmrank);CHKERRQ(ierr); 54485079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4wd",&tisp4);CHKERRQ(ierr); 545ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 54685079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-np",&tisp4);CHKERRQ(ierr); 547ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 54885079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4amslave",&tisp4);CHKERRQ(ierr); 549093de6efSBarry Smith ierr = PetscOptionsValidKey(eargs[0],&key);CHKERRQ(ierr); 55085079163SJed Brown 551093de6efSBarry Smith if (!key) { 55285079163SJed Brown eargs++; left--; 55385079163SJed Brown } else if (isoptions_file) { 55485079163SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 55585079163SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 556c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,eargs[1],PETSC_TRUE);CHKERRQ(ierr); 55785079163SJed Brown eargs += 2; left -= 2; 5589db968c8SJed Brown } else if (isprefixpush) { 5599db968c8SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option"); 5609db968c8SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option (prefixes cannot start with '-')"); 561c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,eargs[1]);CHKERRQ(ierr); 5629db968c8SJed Brown eargs += 2; left -= 2; 5639db968c8SJed Brown } else if (isprefixpop) { 564c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 5659db968c8SJed Brown eargs++; left--; 56685079163SJed Brown 56785079163SJed Brown /* 56885079163SJed Brown These are "bad" options that MPICH, etc put on the command line 56985079163SJed Brown we strip them out here. 57085079163SJed Brown */ 57185079163SJed Brown } else if (tisp4 || isp4rmrank) { 57285079163SJed Brown eargs += 1; left -= 1; 57385079163SJed Brown } else if (isp4 || isp4yourname) { 57485079163SJed Brown eargs += 2; left -= 2; 5757935c3d8SJed Brown } else { 5767935c3d8SJed Brown PetscBool nextiskey = PETSC_FALSE; 5777935c3d8SJed Brown if (left >= 2) {ierr = PetscOptionsValidKey(eargs[1],&nextiskey);CHKERRQ(ierr);} 57898b6bf53SJed Brown if (left < 2 || nextiskey) { 579c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],NULL);CHKERRQ(ierr); 58085079163SJed Brown eargs++; left--; 58185079163SJed Brown } else { 582c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],eargs[1]);CHKERRQ(ierr); 58385079163SJed Brown eargs += 2; left -= 2; 58485079163SJed Brown } 58585079163SJed Brown } 5867935c3d8SJed Brown } 58785079163SJed Brown PetscFunctionReturn(0); 58885079163SJed Brown } 58985079163SJed Brown 59085079163SJed Brown 591e5c89e4eSSatish Balay /*@C 592e5c89e4eSSatish Balay PetscOptionsInsert - Inserts into the options database from the command line, 593e5c89e4eSSatish Balay the environmental variable and a file. 594e5c89e4eSSatish Balay 595e5c89e4eSSatish Balay Input Parameters: 596c5929fdfSBarry Smith + options - options database or NULL for the default global database 597c5929fdfSBarry Smith . argc - count of number of command line arguments 598e5c89e4eSSatish Balay . args - the command line arguments 599e5c89e4eSSatish Balay - file - optional filename, defaults to ~username/.petscrc 600e5c89e4eSSatish Balay 601e5c89e4eSSatish Balay Note: 602e5c89e4eSSatish Balay Since PetscOptionsInsert() is automatically called by PetscInitialize(), 603e5c89e4eSSatish Balay the user does not typically need to call this routine. PetscOptionsInsert() 604e5c89e4eSSatish Balay can be called several times, adding additional entries into the database. 605e5c89e4eSSatish Balay 606081c24baSBoyana Norris Options Database Keys: 607081c24baSBoyana Norris + -options_monitor <optional filename> - print options names and values as they are set 608ec873e40SMatthew G Knepley . -options_file <filename> - read options from a file 609081c24baSBoyana Norris 610e5c89e4eSSatish Balay Level: advanced 611e5c89e4eSSatish Balay 6122d747510SLisandro Dalcin .seealso: PetscOptionsDestroy(), PetscOptionsView(), PetscOptionsInsertString(), PetscOptionsInsertFile(), 61396fc60bcSBarry Smith PetscInitialize() 614e5c89e4eSSatish Balay @*/ 615c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsert(PetscOptions options,int *argc,char ***args,const char file[]) 616e5c89e4eSSatish Balay { 617e5c89e4eSSatish Balay PetscErrorCode ierr; 618e5c89e4eSSatish Balay PetscMPIInt rank; 6192d747510SLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 620ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 621e5c89e4eSSatish Balay 6228dea33a6SBarry Smith 623e5c89e4eSSatish Balay PetscFunctionBegin; 624e5c89e4eSSatish Balay ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 625e5c89e4eSSatish Balay 6264b09e917SBarry Smith if (file && file[0]) { 6272d747510SLisandro Dalcin ierr = PetscStrreplace(PETSC_COMM_WORLD,file,filename,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 6282d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_TRUE);CHKERRQ(ierr); 629321366bcSBarry Smith } 63085079163SJed Brown /* 63185079163SJed Brown We want to be able to give -skip_petscrc on the command line, but need to parse it first. Since the command line 63285079163SJed Brown should take precedence, we insert it twice. It would be sufficient to just scan for -skip_petscrc. 63385079163SJed Brown */ 6342d747510SLisandro Dalcin if (argc && args && *argc) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);} 635c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-skip_petscrc",&flag,NULL);CHKERRQ(ierr); 636321366bcSBarry Smith if (!flag) { 6372d747510SLisandro Dalcin ierr = PetscGetHomeDirectory(filename,PETSC_MAX_PATH_LEN-16);CHKERRQ(ierr); 6381ea3218fSSatish Balay /* PetscOptionsInsertFile() does a fopen() on rank0 only - so only rank0 HomeDir value is relavent */ 6392d747510SLisandro Dalcin if (filename[0]) { ierr = PetscStrcat(filename,"/.petscrc");CHKERRQ(ierr); } 6402d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_FALSE);CHKERRQ(ierr); 641c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,".petscrc",PETSC_FALSE);CHKERRQ(ierr); 642c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,"petscrc",PETSC_FALSE);CHKERRQ(ierr); 643e5c89e4eSSatish Balay } 644e5c89e4eSSatish Balay 6452d747510SLisandro Dalcin /* insert environment options */ 646e5c89e4eSSatish Balay { 6472d747510SLisandro Dalcin char *eoptions = NULL; 648e5c89e4eSSatish Balay size_t len = 0; 649e5c89e4eSSatish Balay if (!rank) { 650e5c89e4eSSatish Balay eoptions = (char*)getenv("PETSC_OPTIONS"); 651e5c89e4eSSatish Balay ierr = PetscStrlen(eoptions,&len);CHKERRQ(ierr); 65276434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 653e5c89e4eSSatish Balay } else { 65476434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 655e5c89e4eSSatish Balay if (len) { 656854ce69bSBarry Smith ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr); 657e5c89e4eSSatish Balay } 658e5c89e4eSSatish Balay } 659e5c89e4eSSatish Balay if (len) { 660e5c89e4eSSatish Balay ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 66196fc60bcSBarry Smith if (rank) eoptions[len] = 0; 662c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,eoptions);CHKERRQ(ierr); 663e5c89e4eSSatish Balay if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);} 664e5c89e4eSSatish Balay } 665e5c89e4eSSatish Balay } 666e5c89e4eSSatish Balay 6673bcbd388SSean Farley #if defined(PETSC_HAVE_YAML) 66856a31166SBarry Smith { 6693bcbd388SSean Farley char yaml_file[PETSC_MAX_PATH_LEN]; 67056a31166SBarry Smith PetscBool yaml_flg; 671c5929fdfSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-options_file_yaml",yaml_file,PETSC_MAX_PATH_LEN,&yaml_flg);CHKERRQ(ierr); 67256a31166SBarry Smith if (yaml_flg) { 67356a31166SBarry Smith ierr = PetscOptionsInsertFileYAML(PETSC_COMM_WORLD,yaml_file,PETSC_TRUE);CHKERRQ(ierr); 67456a31166SBarry Smith } 67556a31166SBarry Smith } 6763bcbd388SSean Farley #endif 6773bcbd388SSean Farley 67885079163SJed Brown /* insert command line options again because they take precedence over arguments in petscrc/environment */ 6792d747510SLisandro Dalcin if (argc && args && *argc) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);} 680e5c89e4eSSatish Balay PetscFunctionReturn(0); 681e5c89e4eSSatish Balay } 682e5c89e4eSSatish Balay 683e5c89e4eSSatish Balay /*@C 68488c29154SBarry Smith PetscOptionsView - Prints the options that have been loaded. This is 685e5c89e4eSSatish Balay useful for debugging purposes. 686e5c89e4eSSatish Balay 687c139c21fSBarry Smith Logically Collective on PetscViewer 688e5c89e4eSSatish Balay 689e5c89e4eSSatish Balay Input Parameter: 6905c9cc608SHong Zhang - options - options database, use NULL for default global database 6915c9cc608SHong Zhang + viewer - must be an PETSCVIEWERASCII viewer 692e5c89e4eSSatish Balay 693e5c89e4eSSatish Balay Options Database Key: 69426a7e8d4SBarry Smith . -options_view - Activates PetscOptionsView() within PetscFinalize() 695e5c89e4eSSatish Balay 696e5c89e4eSSatish Balay Level: advanced 697e5c89e4eSSatish Balay 698e5c89e4eSSatish Balay .seealso: PetscOptionsAllUsed() 699e5c89e4eSSatish Balay @*/ 700c5929fdfSBarry Smith PetscErrorCode PetscOptionsView(PetscOptions options,PetscViewer viewer) 701e5c89e4eSSatish Balay { 702e5c89e4eSSatish Balay PetscErrorCode ierr; 703431c96f7SBarry Smith PetscInt i; 70488c29154SBarry Smith PetscBool isascii; 705e5c89e4eSSatish Balay 706e5c89e4eSSatish Balay PetscFunctionBegin; 7072d747510SLisandro Dalcin if (viewer) PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 708c5929fdfSBarry Smith options = options ? options : defaultoptions; 70988c29154SBarry Smith if (!viewer) viewer = PETSC_VIEWER_STDOUT_WORLD; 710251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 711ce94432eSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Only supports ASCII viewer"); 71288c29154SBarry Smith 7132d747510SLisandro Dalcin if (!options->N) { 71488c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#No PETSc Option Table entries\n");CHKERRQ(ierr); 7152d747510SLisandro Dalcin PetscFunctionReturn(0); 71630694fe9SBarry Smith } 7172d747510SLisandro Dalcin 7182d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"#PETSc Option Table entries:\n");CHKERRQ(ierr); 719e5c89e4eSSatish Balay for (i=0; i<options->N; i++) { 720e5c89e4eSSatish Balay if (options->values[i]) { 72188c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s %s\n",options->names[i],options->values[i]);CHKERRQ(ierr); 722e5c89e4eSSatish Balay } else { 72388c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s\n",options->names[i]);CHKERRQ(ierr); 724e5c89e4eSSatish Balay } 725e5c89e4eSSatish Balay } 72688c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#End of PETSc Option Table entries\n");CHKERRQ(ierr); 727e5c89e4eSSatish Balay PetscFunctionReturn(0); 728e5c89e4eSSatish Balay } 729e5c89e4eSSatish Balay 730e11779c2SBarry Smith /* 731e11779c2SBarry Smith Called by error handlers to print options used in run 732e11779c2SBarry Smith */ 73395c0884eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsViewError(void) 734e11779c2SBarry Smith { 735e11779c2SBarry Smith PetscInt i; 7364416b707SBarry Smith PetscOptions options = defaultoptions; 737e11779c2SBarry Smith 738e11779c2SBarry Smith PetscFunctionBegin; 739e11779c2SBarry Smith if (options->N) { 740e11779c2SBarry Smith (*PetscErrorPrintf)("PETSc Option Table entries:\n"); 741e11779c2SBarry Smith } else { 742e11779c2SBarry Smith (*PetscErrorPrintf)("No PETSc Option Table entries\n"); 743e11779c2SBarry Smith } 744e11779c2SBarry Smith for (i=0; i<options->N; i++) { 745e11779c2SBarry Smith if (options->values[i]) { 746e11779c2SBarry Smith (*PetscErrorPrintf)("-%s %s\n",options->names[i],options->values[i]); 747e11779c2SBarry Smith } else { 748e11779c2SBarry Smith (*PetscErrorPrintf)("-%s\n",options->names[i]); 749e11779c2SBarry Smith } 750e11779c2SBarry Smith } 751e11779c2SBarry Smith PetscFunctionReturn(0); 752e11779c2SBarry Smith } 753e11779c2SBarry Smith 754e5c89e4eSSatish Balay /*@C 75574e0666dSJed Brown PetscOptionsPrefixPush - Designate a prefix to be used by all options insertions to follow. 75674e0666dSJed Brown 75774e0666dSJed Brown Not Collective, but prefix will only be applied on calling ranks 75874e0666dSJed Brown 7599db968c8SJed Brown Input Parameter: 760c5929fdfSBarry Smith + options - options database, or NULL for the default global database 761c5929fdfSBarry Smith - prefix - The string to append to the existing prefix 7629db968c8SJed Brown 7639db968c8SJed Brown Options Database Keys: 7649db968c8SJed Brown + -prefix_push <some_prefix_> - push the given prefix 7659db968c8SJed Brown - -prefix_pop - pop the last prefix 7669db968c8SJed Brown 7679db968c8SJed Brown Notes: 7689db968c8SJed Brown It is common to use this in conjunction with -options_file as in 7699db968c8SJed Brown 7709db968c8SJed Brown $ -prefix_push system1_ -options_file system1rc -prefix_pop -prefix_push system2_ -options_file system2rc -prefix_pop 7719db968c8SJed Brown 7729db968c8SJed Brown where the files no longer require all options to be prefixed with -system2_. 77374e0666dSJed Brown 77474e0666dSJed Brown Level: advanced 77574e0666dSJed Brown 77674e0666dSJed Brown .seealso: PetscOptionsPrefixPop() 77774e0666dSJed Brown @*/ 778c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPush(PetscOptions options,const char prefix[]) 77974e0666dSJed Brown { 78074e0666dSJed Brown PetscErrorCode ierr; 78174e0666dSJed Brown size_t n; 78274e0666dSJed Brown PetscInt start; 7832d747510SLisandro Dalcin char key[MAXOPTNAME+1]; 7842d747510SLisandro Dalcin PetscBool valid; 78574e0666dSJed Brown 78674e0666dSJed Brown PetscFunctionBegin; 7879db968c8SJed Brown PetscValidCharPointer(prefix,1); 788c5929fdfSBarry Smith options = options ? options : defaultoptions; 78974e0666dSJed Brown if (options->prefixind >= MAXPREFIXES) SETERRQ1(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); 7902d747510SLisandro Dalcin key[0] = '-'; /* keys must start with '-' */ 7912d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,prefix,sizeof(key)-1);CHKERRQ(ierr); 7922d747510SLisandro Dalcin ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 7932d747510SLisandro Dalcin if (!valid) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Given prefix \"%s\" not valid (the first character must be a letter, do not include leading '-')",prefix); 79474e0666dSJed Brown start = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 79574e0666dSJed Brown ierr = PetscStrlen(prefix,&n);CHKERRQ(ierr); 79674e0666dSJed Brown if (n+1 > sizeof(options->prefix)-start) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum prefix length %d exceeded",sizeof(options->prefix)); 79774e0666dSJed Brown ierr = PetscMemcpy(options->prefix+start,prefix,n+1);CHKERRQ(ierr); 79874e0666dSJed Brown options->prefixstack[options->prefixind++] = start+n; 79974e0666dSJed Brown PetscFunctionReturn(0); 80074e0666dSJed Brown } 80174e0666dSJed Brown 802c5929fdfSBarry Smith /*@C 80374e0666dSJed Brown PetscOptionsPrefixPop - Remove the latest options prefix, see PetscOptionsPrefixPush() for details 80474e0666dSJed Brown 80574e0666dSJed Brown Not Collective, but prefix will only be popped on calling ranks 80674e0666dSJed Brown 807c5929fdfSBarry Smith Input Parameters: 808c5929fdfSBarry Smith . options - options database, or NULL for the default global database 809c5929fdfSBarry Smith 81074e0666dSJed Brown Level: advanced 81174e0666dSJed Brown 81274e0666dSJed Brown .seealso: PetscOptionsPrefixPush() 81374e0666dSJed Brown @*/ 814c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPop(PetscOptions options) 81574e0666dSJed Brown { 81674e0666dSJed Brown PetscInt offset; 81774e0666dSJed Brown 81874e0666dSJed Brown PetscFunctionBegin; 819c5929fdfSBarry Smith options = options ? options : defaultoptions; 82074e0666dSJed Brown if (options->prefixind < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"More prefixes popped than pushed"); 82174e0666dSJed Brown options->prefixind--; 82274e0666dSJed Brown offset = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 82374e0666dSJed Brown options->prefix[offset] = 0; 82474e0666dSJed Brown PetscFunctionReturn(0); 82574e0666dSJed Brown } 82674e0666dSJed Brown 827a542b6e8SBarry Smith /*@C 828a542b6e8SBarry Smith PetscOptionsClear - Removes all options form the database leaving it empty. 829a542b6e8SBarry Smith 830c5929fdfSBarry Smith Input Parameters: 831c5929fdfSBarry Smith . options - options database, use NULL for the default global database 832c5929fdfSBarry Smith 833a542b6e8SBarry Smith Level: developer 834a542b6e8SBarry Smith 835a542b6e8SBarry Smith .seealso: PetscOptionsInsert() 836a542b6e8SBarry Smith @*/ 837c5929fdfSBarry Smith PetscErrorCode PetscOptionsClear(PetscOptions options) 838a542b6e8SBarry Smith { 839a542b6e8SBarry Smith PetscInt i; 840a542b6e8SBarry Smith 841c5929fdfSBarry Smith options = options ? options : defaultoptions; 8422d747510SLisandro Dalcin if (!options) return 0; 8432d747510SLisandro Dalcin 844a542b6e8SBarry Smith for (i=0; i<options->N; i++) { 845a542b6e8SBarry Smith if (options->names[i]) free(options->names[i]); 846a542b6e8SBarry Smith if (options->values[i]) free(options->values[i]); 847a542b6e8SBarry Smith } 8482d747510SLisandro Dalcin options->N = 0; 8492d747510SLisandro Dalcin 850a542b6e8SBarry Smith for (i=0; i<options->Naliases; i++) { 851a542b6e8SBarry Smith free(options->aliases1[i]); 852a542b6e8SBarry Smith free(options->aliases2[i]); 853a542b6e8SBarry Smith } 854a542b6e8SBarry Smith options->Naliases = 0; 855a542b6e8SBarry Smith 8562d747510SLisandro Dalcin /* destroy hash table */ 8572d747510SLisandro Dalcin kh_destroy(HO,options->ht); 8582d747510SLisandro Dalcin options->ht = NULL; 8590eb63584SBarry Smith 8602d747510SLisandro Dalcin options->prefixind = 0; 8612d747510SLisandro Dalcin options->prefix[0] = 0; 8622d747510SLisandro Dalcin options->help = PETSC_FALSE; 8634416b707SBarry Smith return 0; 8644416b707SBarry Smith } 8654416b707SBarry Smith 8662d747510SLisandro Dalcin /*@C 8672d747510SLisandro Dalcin PetscOptionsSetAlias - Makes a key and alias for another key 8682d747510SLisandro Dalcin 8692d747510SLisandro Dalcin Not Collective, but setting values on certain processors could cause problems 8702d747510SLisandro Dalcin for parallel objects looking for options. 8712d747510SLisandro Dalcin 8722d747510SLisandro Dalcin Input Parameters: 8732d747510SLisandro Dalcin + options - options database, or NULL for default global database 8742d747510SLisandro Dalcin . newname - the alias 8752d747510SLisandro Dalcin - oldname - the name that alias will refer to 8762d747510SLisandro Dalcin 8772d747510SLisandro Dalcin Level: advanced 8782d747510SLisandro Dalcin 8792d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 8802d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 8812d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 8822d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 8832d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 8842d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 8852d747510SLisandro Dalcin @*/ 8862d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetAlias(PetscOptions options,const char newname[],const char oldname[]) 8872d747510SLisandro Dalcin { 8882d747510SLisandro Dalcin PetscInt n; 8892d747510SLisandro Dalcin size_t len; 8902d747510SLisandro Dalcin PetscErrorCode ierr; 8912d747510SLisandro Dalcin 8922d747510SLisandro Dalcin PetscFunctionBegin; 8932d747510SLisandro Dalcin PetscValidCharPointer(newname,2); 8942d747510SLisandro Dalcin PetscValidCharPointer(oldname,3); 8952d747510SLisandro Dalcin options = options ? options : defaultoptions; 8962d747510SLisandro Dalcin if (newname[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"aliased must start with '-': Instead %s",newname); 8972d747510SLisandro Dalcin if (oldname[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"aliasee must start with '-': Instead %s",oldname); 8982d747510SLisandro Dalcin 8992d747510SLisandro Dalcin n = options->Naliases; 9002d747510SLisandro Dalcin if (n >= MAXALIASES) SETERRQ1(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); 9012d747510SLisandro Dalcin 9022d747510SLisandro Dalcin newname++; oldname++; 9032d747510SLisandro Dalcin ierr = PetscStrlen(newname,&len);CHKERRQ(ierr); 9042d747510SLisandro Dalcin options->aliases1[n] = (char*)malloc((len+1)*sizeof(char)); 9052d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases1[n],newname);CHKERRQ(ierr); 9062d747510SLisandro Dalcin ierr = PetscStrlen(oldname,&len);CHKERRQ(ierr); 9072d747510SLisandro Dalcin options->aliases2[n] = (char*)malloc((len+1)*sizeof(char)); 9082d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases2[n],oldname);CHKERRQ(ierr); 9092d747510SLisandro Dalcin options->Naliases++; 9102d747510SLisandro Dalcin PetscFunctionReturn(0); 9112d747510SLisandro Dalcin } 9124416b707SBarry Smith 913e5c89e4eSSatish Balay /*@C 914e5c89e4eSSatish Balay PetscOptionsSetValue - Sets an option name-value pair in the options 915e5c89e4eSSatish Balay database, overriding whatever is already present. 916e5c89e4eSSatish Balay 9172d747510SLisandro Dalcin Not Collective, but setting values on certain processors could cause problems 918e5c89e4eSSatish Balay for parallel objects looking for options. 919e5c89e4eSSatish Balay 920e5c89e4eSSatish Balay Input Parameters: 921c5929fdfSBarry Smith + options - options database, use NULL for the default global database 922c5929fdfSBarry Smith . name - name of option, this SHOULD have the - prepended 9232d747510SLisandro Dalcin - value - the option value (not used for all options, so can be NULL) 924e5c89e4eSSatish Balay 925e5c89e4eSSatish Balay Level: intermediate 926e5c89e4eSSatish Balay 927e5c89e4eSSatish Balay Note: 928d49172ceSBarry Smith This function can be called BEFORE PetscInitialize() 929d49172ceSBarry Smith 9302d747510SLisandro Dalcin Developers Note: Uses malloc() directly because PETSc may not be initialized yet. 931b0250c70SBarry Smith 9322d747510SLisandro Dalcin .seealso: PetscOptionsInsert(), PetscOptionsClearValue() 933e5c89e4eSSatish Balay @*/ 9342d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetValue(PetscOptions options,const char name[],const char value[]) 935e5c89e4eSSatish Balay { 936e5c89e4eSSatish Balay size_t len; 9372d747510SLisandro Dalcin int N,n,i; 938e5c89e4eSSatish Balay char **names; 9392d747510SLisandro Dalcin char fullname[MAXOPTNAME] = ""; 9402d747510SLisandro Dalcin PetscErrorCode ierr; 941e5c89e4eSSatish Balay 9422d747510SLisandro Dalcin if (!options && !defaultoptions) { 9432d747510SLisandro Dalcin ierr = PetscOptionsCreateDefault();if (ierr) return ierr; 944c5929fdfSBarry Smith } 9452d747510SLisandro Dalcin options = options ? options : defaultoptions; 9462d747510SLisandro Dalcin 9472d747510SLisandro Dalcin if (name[0] != '-') return PETSC_ERR_ARG_OUTOFRANGE; 948e5c89e4eSSatish Balay 949d49172ceSBarry Smith /* this is so that -h and -help are equivalent (p4 does not like -help)*/ 9502d747510SLisandro Dalcin if (!strcmp(name,"-h")) name = "-help"; 9512d747510SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_TRUE; 952e5c89e4eSSatish Balay 9532d747510SLisandro Dalcin name++; /* skip starting dash */ 9542d747510SLisandro Dalcin 95574e0666dSJed Brown if (options->prefixind > 0) { 956d49172ceSBarry Smith strncpy(fullname,options->prefix,sizeof(fullname)); 9572d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 95889ae1891SBarry Smith strncat(fullname,name,sizeof(fullname)-strlen(fullname)-1); 9592d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 96074e0666dSJed Brown name = fullname; 96174e0666dSJed Brown } 96274e0666dSJed Brown 96374e0666dSJed Brown /* check against aliases */ 964e5c89e4eSSatish Balay N = options->Naliases; 965e5c89e4eSSatish Balay for (i=0; i<N; i++) { 9662d747510SLisandro Dalcin int result = PetscOptNameCmp(options->aliases1[i],name); 9672d747510SLisandro Dalcin if (!result) { name = options->aliases2[i]; break; } 968e5c89e4eSSatish Balay } 969e5c89e4eSSatish Balay 9702d747510SLisandro Dalcin /* slow search */ 9712d747510SLisandro Dalcin N = n = options->N; 972e5c89e4eSSatish Balay names = options->names; 973e5c89e4eSSatish Balay for (i=0; i<N; i++) { 9742d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 9752d747510SLisandro Dalcin if (!result) { 9762d747510SLisandro Dalcin n = i; goto setvalue; 9772d747510SLisandro Dalcin } else if (result > 0) { 9782d747510SLisandro Dalcin n = i; break; 979e5c89e4eSSatish Balay } 980e5c89e4eSSatish Balay } 9812d747510SLisandro Dalcin if (N >= MAXOPTIONS) return PETSC_ERR_MEM; 9822d747510SLisandro Dalcin /* shift remaining values up 1 */ 983e5c89e4eSSatish Balay for (i=N; i>n; i--) { 9845e8c5e88SLisandro Dalcin options->names[i] = options->names[i-1]; 985e5c89e4eSSatish Balay options->values[i] = options->values[i-1]; 986e5c89e4eSSatish Balay options->used[i] = options->used[i-1]; 987e5c89e4eSSatish Balay } 9882d747510SLisandro Dalcin options->names[n] = NULL; 9892d747510SLisandro Dalcin options->values[n] = NULL; 9902d747510SLisandro Dalcin options->used[n] = PETSC_FALSE; 9912d747510SLisandro Dalcin options->N++; 9922d747510SLisandro Dalcin 9932d747510SLisandro Dalcin /* destroy hash table */ 9942d747510SLisandro Dalcin kh_destroy(HO,options->ht); 9952d747510SLisandro Dalcin options->ht = NULL; 9962d747510SLisandro Dalcin 9972d747510SLisandro Dalcin /* set new name */ 99870d8d27cSBarry Smith len = strlen(name); 9995e8c5e88SLisandro Dalcin options->names[n] = (char*)malloc((len+1)*sizeof(char)); 1000d49172ceSBarry Smith if (!options->names[n]) return PETSC_ERR_MEM; 1001d49172ceSBarry Smith strcpy(options->names[n],name); 10022d747510SLisandro Dalcin 10032d747510SLisandro Dalcin setvalue: 10042d747510SLisandro Dalcin /* set new value */ 10052d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1006d49172ceSBarry Smith len = value ? strlen(value) : 0; 10075e8c5e88SLisandro Dalcin if (len) { 1008e5c89e4eSSatish Balay options->values[n] = (char*)malloc((len+1)*sizeof(char)); 1009d49172ceSBarry Smith if (!options->values[n]) return PETSC_ERR_MEM; 1010d49172ceSBarry Smith strcpy(options->values[n],value); 10112d747510SLisandro Dalcin } else { 10122d747510SLisandro Dalcin options->values[n] = NULL; 10132d747510SLisandro Dalcin } 10142d747510SLisandro Dalcin 10152d747510SLisandro Dalcin ierr = PetscOptionsMonitor(options,name,value?value:"");if (ierr) return ierr; 1016d49172ceSBarry Smith return 0; 1017e5c89e4eSSatish Balay } 1018e5c89e4eSSatish Balay 1019e5c89e4eSSatish Balay /*@C 1020e5c89e4eSSatish Balay PetscOptionsClearValue - Clears an option name-value pair in the options 1021e5c89e4eSSatish Balay database, overriding whatever is already present. 1022e5c89e4eSSatish Balay 1023e5c89e4eSSatish Balay Not Collective, but setting values on certain processors could cause problems 1024e5c89e4eSSatish Balay for parallel objects looking for options. 1025e5c89e4eSSatish Balay 1026e5c89e4eSSatish Balay Input Parameter: 1027c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1028e5c89e4eSSatish Balay . name - name of option, this SHOULD have the - prepended 1029e5c89e4eSSatish Balay 1030e5c89e4eSSatish Balay Level: intermediate 1031e5c89e4eSSatish Balay 1032e5c89e4eSSatish Balay .seealso: PetscOptionsInsert() 1033e5c89e4eSSatish Balay @*/ 10342d747510SLisandro Dalcin PetscErrorCode PetscOptionsClearValue(PetscOptions options,const char name[]) 1035e5c89e4eSSatish Balay { 10362d747510SLisandro Dalcin int N,n,i; 10372d747510SLisandro Dalcin char **names; 1038e5c89e4eSSatish Balay PetscErrorCode ierr; 1039e5c89e4eSSatish Balay 1040e5c89e4eSSatish Balay PetscFunctionBegin; 1041c5929fdfSBarry Smith options = options ? options : defaultoptions; 10422d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1043e5c89e4eSSatish Balay 10442d747510SLisandro Dalcin /* this is so that -h and -help are equivalent (p4 does not like -help)*/ 10452d747510SLisandro Dalcin if (!strcmp(name,"-h")) name = "-help"; 10462d747510SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_FALSE; 10472d747510SLisandro Dalcin 10482d747510SLisandro Dalcin name++; /* skip starting dash */ 10492d747510SLisandro Dalcin 10502d747510SLisandro Dalcin /* slow search */ 10512d747510SLisandro Dalcin N = n = options->N; 1052e5c89e4eSSatish Balay names = options->names; 1053e5c89e4eSSatish Balay for (i=0; i<N; i++) { 10542d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 10552d747510SLisandro Dalcin if (!result) { 10562d747510SLisandro Dalcin n = i; break; 10572d747510SLisandro Dalcin } else if (result > 0) { 10582d747510SLisandro Dalcin n = N; break; 1059e5c89e4eSSatish Balay } 10602d747510SLisandro Dalcin } 10612d747510SLisandro Dalcin if (n == N) PetscFunctionReturn(0); /* it was not present */ 1062e5c89e4eSSatish Balay 10632d747510SLisandro Dalcin /* remove name and value */ 10642d747510SLisandro Dalcin if (options->names[n]) free(options->names[n]); 10652d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1066e5c89e4eSSatish Balay /* shift remaining values down 1 */ 1067e5c89e4eSSatish Balay for (i=n; i<N-1; i++) { 10685e8c5e88SLisandro Dalcin options->names[i] = options->names[i+1]; 1069e5c89e4eSSatish Balay options->values[i] = options->values[i+1]; 1070e5c89e4eSSatish Balay options->used[i] = options->used[i+1]; 1071e5c89e4eSSatish Balay } 1072e5c89e4eSSatish Balay options->N--; 10732d747510SLisandro Dalcin 10742d747510SLisandro Dalcin /* destroy hash table */ 10752d747510SLisandro Dalcin kh_destroy(HO,options->ht); 10762d747510SLisandro Dalcin options->ht = NULL; 10772d747510SLisandro Dalcin 10782d747510SLisandro Dalcin ierr = PetscOptionsMonitor(options,name,NULL);CHKERRQ(ierr); 1079e5c89e4eSSatish Balay PetscFunctionReturn(0); 1080e5c89e4eSSatish Balay } 1081e5c89e4eSSatish Balay 1082e5c89e4eSSatish Balay /*@C 10832d747510SLisandro Dalcin PetscOptionsFindPair - Gets an option name-value pair from the options database. 1084e5c89e4eSSatish Balay 10852d747510SLisandro Dalcin Not Collective 1086e5c89e4eSSatish Balay 1087e5c89e4eSSatish Balay Input Parameters: 10882d747510SLisandro Dalcin + options - options database, use NULL for the default global database 10892d747510SLisandro Dalcin . pre - the string to prepend to the name or NULL, this SHOULD NOT have the "-" prepended 10902d747510SLisandro Dalcin - name - name of option, this SHOULD have the "-" prepended 1091e5c89e4eSSatish Balay 10922d747510SLisandro Dalcin Output Parameters: 10932d747510SLisandro Dalcin + value - the option value (optional, not used for all options) 10942d747510SLisandro Dalcin - set - whether the option is set (optional) 1095e5c89e4eSSatish Balay 10962d747510SLisandro Dalcin Level: developer 10972d747510SLisandro Dalcin 10982d747510SLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsClearValue() 1099e5c89e4eSSatish Balay @*/ 11002d747510SLisandro Dalcin PetscErrorCode PetscOptionsFindPair(PetscOptions options,const char pre[],const char name[],const char *value[],PetscBool *set) 1101e5c89e4eSSatish Balay { 11022d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1103daabea38SBarry Smith PetscBool usehashtable = PETSC_TRUE; 11042d747510SLisandro Dalcin PetscBool matchnumbers = PETSC_TRUE; 1105e5c89e4eSSatish Balay PetscErrorCode ierr; 1106e5c89e4eSSatish Balay 1107e5c89e4eSSatish Balay PetscFunctionBegin; 1108c5929fdfSBarry Smith options = options ? options : defaultoptions; 11092d747510SLisandro Dalcin if (pre && PetscUnlikely(pre[0] == '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 11102d747510SLisandro Dalcin if (PetscUnlikely(name[0] != '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1111e5c89e4eSSatish Balay 11122d747510SLisandro Dalcin name++; /* skip starting dash */ 1113e5c89e4eSSatish Balay 11147cd08cecSJed Brown /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 11152d747510SLisandro Dalcin if (pre && pre[0]) { 11162d747510SLisandro Dalcin char *ptr = buf; 11172d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 11182d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,buf+sizeof(buf)-ptr);CHKERRQ(ierr); 11192d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 11202d747510SLisandro Dalcin name = buf; 11217cd08cecSJed Brown } 11222d747510SLisandro Dalcin 11232f828895SJed Brown #if defined(PETSC_USE_DEBUG) 11242f828895SJed Brown { 11252f828895SJed Brown PetscBool valid; 11262d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 11272d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 11282f828895SJed Brown ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 11292f828895SJed Brown if (!valid) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid option '%s' obtained from pre='%s' and name='%s'",key,pre?pre:"",name); 11302f828895SJed Brown } 11312f828895SJed Brown #endif 1132e5c89e4eSSatish Balay 11332d747510SLisandro Dalcin if (!options->ht && usehashtable) { 11342d747510SLisandro Dalcin int i,ret; 11352d747510SLisandro Dalcin khiter_t it; 11362d747510SLisandro Dalcin khash_t(HO) *ht; 11372d747510SLisandro Dalcin ht = kh_init(HO); 11382d747510SLisandro Dalcin if (PetscUnlikely(!ht)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 11392d747510SLisandro Dalcin ret = kh_resize(HO,ht,options->N*2); /* twice the required size to reduce risk of collisions */ 11402d747510SLisandro Dalcin if (PetscUnlikely(ret)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 11412d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 11422d747510SLisandro Dalcin it = kh_put(HO,ht,options->names[i],&ret); 11432d747510SLisandro Dalcin if (PetscUnlikely(ret != 1)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 11442d747510SLisandro Dalcin kh_val(ht,it) = i; 11452d747510SLisandro Dalcin } 11462d747510SLisandro Dalcin options->ht = ht; 11472d747510SLisandro Dalcin } 11482d747510SLisandro Dalcin 11492d747510SLisandro Dalcin if (usehashtable) 11502d747510SLisandro Dalcin { /* fast search */ 11512d747510SLisandro Dalcin khash_t(HO) *ht = options->ht; 11522d747510SLisandro Dalcin khiter_t it = kh_get(HO,ht,name); 11532d747510SLisandro Dalcin if (it != kh_end(ht)) { 11542d747510SLisandro Dalcin int i = kh_val(ht,it); 1155e5c89e4eSSatish Balay options->used[i] = PETSC_TRUE; 11562d747510SLisandro Dalcin if (value) *value = options->values[i]; 11572d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 11582d747510SLisandro Dalcin PetscFunctionReturn(0); 11592d747510SLisandro Dalcin } 11602d747510SLisandro Dalcin } else 11612d747510SLisandro Dalcin { /* slow search */ 11622d747510SLisandro Dalcin int i, N = options->N; 11632d747510SLisandro Dalcin for (i=0; i<N; i++) { 1164daabea38SBarry Smith int result = PetscOptNameCmp(options->names[i],name); 11652d747510SLisandro Dalcin if (!result) { 11662d747510SLisandro Dalcin options->used[i] = PETSC_TRUE; 11672d747510SLisandro Dalcin if (value) *value = options->values[i]; 11682d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 11692d747510SLisandro Dalcin PetscFunctionReturn(0); 11702d747510SLisandro Dalcin } else if (result > 0) { 1171e5c89e4eSSatish Balay break; 1172e5c89e4eSSatish Balay } 1173e5c89e4eSSatish Balay } 11742d747510SLisandro Dalcin } 11752d747510SLisandro Dalcin 11762d747510SLisandro Dalcin /* 11772d747510SLisandro Dalcin The following block slows down all lookups in the most frequent path (most lookups are unsuccessful). 11782d747510SLisandro Dalcin Maybe this special lookup mode should be enabled on request with a push/pop API. 11792d747510SLisandro Dalcin The feature of matching _%d_ used sparingly in the codebase. 11802d747510SLisandro Dalcin */ 11812d747510SLisandro Dalcin if (matchnumbers) { 11822d747510SLisandro Dalcin int i,j,cnt = 0,locs[16],loce[16]; 1183e5c89e4eSSatish Balay /* determine the location and number of all _%d_ in the key */ 11842d747510SLisandro Dalcin for (i=0; name[i]; i++) { 11852d747510SLisandro Dalcin if (name[i] == '_') { 11862d747510SLisandro Dalcin for (j=i+1; name[j]; j++) { 11872d747510SLisandro Dalcin if (name[j] >= '0' && name[j] <= '9') continue; 11882d747510SLisandro Dalcin if (name[j] == '_' && j > i+1) { /* found a number */ 1189e5c89e4eSSatish Balay locs[cnt] = i+1; 1190e5c89e4eSSatish Balay loce[cnt++] = j+1; 1191e5c89e4eSSatish Balay } 11922d747510SLisandro Dalcin i = j-1; 1193e5c89e4eSSatish Balay break; 1194e5c89e4eSSatish Balay } 1195e5c89e4eSSatish Balay } 1196e5c89e4eSSatish Balay } 1197e5c89e4eSSatish Balay for (i=0; i<cnt; i++) { 11982d747510SLisandro Dalcin PetscBool found; 11992d747510SLisandro Dalcin char opt[MAXOPTNAME+1] = "-", tmp[MAXOPTNAME]; 12002d747510SLisandro Dalcin ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[i]+1),sizeof(tmp)));CHKERRQ(ierr); 12012d747510SLisandro Dalcin ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 12022d747510SLisandro Dalcin ierr = PetscStrlcat(opt,name+loce[i],sizeof(opt));CHKERRQ(ierr); 12032d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,NULL,opt,value,&found);CHKERRQ(ierr); 12042d747510SLisandro Dalcin if (found) {if (set) *set = PETSC_TRUE; PetscFunctionReturn(0);} 1205e5c89e4eSSatish Balay } 1206e5c89e4eSSatish Balay } 12072d747510SLisandro Dalcin 12082d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1209e5c89e4eSSatish Balay PetscFunctionReturn(0); 1210e5c89e4eSSatish Balay } 1211e5c89e4eSSatish Balay 1212d6ced9c0SMatthew G. Knepley /* Check whether any option begins with pre+name */ 12132d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions options,const char pre[], const char name[],const char *value[],PetscBool *set) 1214514bf10dSMatthew G Knepley { 12152d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1216d6ced9c0SMatthew G. Knepley int numCnt = 0, locs[16],loce[16]; 1217514bf10dSMatthew G Knepley PetscErrorCode ierr; 1218514bf10dSMatthew G Knepley 1219514bf10dSMatthew G Knepley PetscFunctionBegin; 1220c5929fdfSBarry Smith options = options ? options : defaultoptions; 12212d747510SLisandro Dalcin if (pre && pre[0] == '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 12222d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1223514bf10dSMatthew G Knepley 12242d747510SLisandro Dalcin name++; /* skip starting dash */ 1225514bf10dSMatthew G Knepley 1226514bf10dSMatthew G Knepley /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 12272d747510SLisandro Dalcin if (pre && pre[0]) { 12282d747510SLisandro Dalcin char *ptr = buf; 12292d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 12302d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,sizeof(buf)+(size_t)(ptr-buf));CHKERRQ(ierr); 12312d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 12322d747510SLisandro Dalcin name = buf; 1233514bf10dSMatthew G Knepley } 12342d747510SLisandro Dalcin 1235514bf10dSMatthew G Knepley #if defined(PETSC_USE_DEBUG) 1236514bf10dSMatthew G Knepley { 1237514bf10dSMatthew G Knepley PetscBool valid; 12382d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 12392d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 1240514bf10dSMatthew G Knepley ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 1241514bf10dSMatthew G Knepley if (!valid) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid option '%s' obtained from pre='%s' and name='%s'",key,pre?pre:"",name); 1242514bf10dSMatthew G Knepley } 1243514bf10dSMatthew G Knepley #endif 1244514bf10dSMatthew G Knepley 1245d6ced9c0SMatthew G. Knepley /* determine the location and number of all _%d_ in the key */ 1246d6ced9c0SMatthew G. Knepley { 1247d6ced9c0SMatthew G. Knepley int i,j; 1248d6ced9c0SMatthew G. Knepley for (i=0; name[i]; i++) { 1249d6ced9c0SMatthew G. Knepley if (name[i] == '_') { 1250d6ced9c0SMatthew G. Knepley for (j=i+1; name[j]; j++) { 1251d6ced9c0SMatthew G. Knepley if (name[j] >= '0' && name[j] <= '9') continue; 1252d6ced9c0SMatthew G. Knepley if (name[j] == '_' && j > i+1) { /* found a number */ 1253d6ced9c0SMatthew G. Knepley locs[numCnt] = i+1; 1254d6ced9c0SMatthew G. Knepley loce[numCnt++] = j+1; 1255d6ced9c0SMatthew G. Knepley } 1256d6ced9c0SMatthew G. Knepley i = j-1; 1257d6ced9c0SMatthew G. Knepley break; 1258d6ced9c0SMatthew G. Knepley } 1259d6ced9c0SMatthew G. Knepley } 1260d6ced9c0SMatthew G. Knepley } 1261d6ced9c0SMatthew G. Knepley } 1262d6ced9c0SMatthew G. Knepley 12632d747510SLisandro Dalcin { /* slow search */ 1264d6ced9c0SMatthew G. Knepley int c, i; 12652d747510SLisandro Dalcin size_t len; 12662d747510SLisandro Dalcin PetscBool match; 1267d6ced9c0SMatthew G. Knepley 1268d6ced9c0SMatthew G. Knepley for (c = -1; c < numCnt; ++c) { 1269d6ced9c0SMatthew G. Knepley char opt[MAXOPTNAME+1] = "", tmp[MAXOPTNAME]; 1270d6ced9c0SMatthew G. Knepley 1271d6ced9c0SMatthew G. Knepley if (c < 0) { 1272d6ced9c0SMatthew G. Knepley ierr = PetscStrcpy(opt,name);CHKERRQ(ierr); 1273d6ced9c0SMatthew G. Knepley } else { 1274d6ced9c0SMatthew G. Knepley ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[c]+1),sizeof(tmp)));CHKERRQ(ierr); 1275d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 1276d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,name+loce[c],sizeof(opt));CHKERRQ(ierr); 1277d6ced9c0SMatthew G. Knepley } 1278d6ced9c0SMatthew G. Knepley ierr = PetscStrlen(opt,&len);CHKERRQ(ierr); 12792d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 1280d6ced9c0SMatthew G. Knepley ierr = PetscStrncmp(options->names[i],opt,len,&match);CHKERRQ(ierr); 1281514bf10dSMatthew G Knepley if (match) { 1282514bf10dSMatthew G Knepley options->used[i] = PETSC_TRUE; 12832d747510SLisandro Dalcin if (value) *value = options->values[i]; 12842d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 12852d747510SLisandro Dalcin PetscFunctionReturn(0); 1286514bf10dSMatthew G Knepley } 1287514bf10dSMatthew G Knepley } 12882d747510SLisandro Dalcin } 1289d6ced9c0SMatthew G. Knepley } 12902d747510SLisandro Dalcin 12912d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1292514bf10dSMatthew G Knepley PetscFunctionReturn(0); 1293514bf10dSMatthew G Knepley } 1294514bf10dSMatthew G Knepley 1295e5c89e4eSSatish Balay /*@C 1296e5c89e4eSSatish Balay PetscOptionsReject - Generates an error if a certain option is given. 1297e5c89e4eSSatish Balay 1298e5c89e4eSSatish Balay Not Collective, but setting values on certain processors could cause problems 1299e5c89e4eSSatish Balay for parallel objects looking for options. 1300e5c89e4eSSatish Balay 1301e5c89e4eSSatish Balay Input Parameters: 13025c9cc608SHong Zhang + options - options database, use NULL for default global database 13032d747510SLisandro Dalcin . pre - the option prefix (may be NULL) 13042d747510SLisandro Dalcin . name - the option name one is seeking 13050298fd71SBarry Smith - mess - error message (may be NULL) 1306e5c89e4eSSatish Balay 1307e5c89e4eSSatish Balay Level: advanced 1308e5c89e4eSSatish Balay 1309e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 1310acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1311e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1312e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1313acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1314a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1315e5c89e4eSSatish Balay @*/ 13162d747510SLisandro Dalcin PetscErrorCode PetscOptionsReject(PetscOptions options,const char pre[],const char name[],const char mess[]) 1317e5c89e4eSSatish Balay { 1318e5c89e4eSSatish Balay PetscErrorCode ierr; 1319ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 1320e5c89e4eSSatish Balay 1321e5c89e4eSSatish Balay PetscFunctionBegin; 13222d747510SLisandro Dalcin ierr = PetscOptionsHasName(options,pre,name,&flag);CHKERRQ(ierr); 1323e5c89e4eSSatish Balay if (flag) { 13242d747510SLisandro Dalcin if (mess && mess[0]) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s with %s",pre?pre:"",name+1,mess); 13252d747510SLisandro Dalcin else SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s",pre?pre:"",name+1); 1326e5c89e4eSSatish Balay } 1327e5c89e4eSSatish Balay PetscFunctionReturn(0); 1328e5c89e4eSSatish Balay } 1329e5c89e4eSSatish Balay 1330e5c89e4eSSatish Balay /*@C 13312d747510SLisandro Dalcin PetscOptionsHasHelp - Determines whether the "-help" option is in the database. 13322d747510SLisandro Dalcin 13332d747510SLisandro Dalcin Not Collective 13342d747510SLisandro Dalcin 13352d747510SLisandro Dalcin Input Parameters: 13362d747510SLisandro Dalcin . options - options database, use NULL for default global database 13372d747510SLisandro Dalcin 13382d747510SLisandro Dalcin Output Parameters: 13392d747510SLisandro Dalcin . set - PETSC_TRUE if found else PETSC_FALSE. 13402d747510SLisandro Dalcin 13412d747510SLisandro Dalcin Level: advanced 13422d747510SLisandro Dalcin 13432d747510SLisandro Dalcin .seealso: PetscOptionsHasName() 13442d747510SLisandro Dalcin @*/ 13452d747510SLisandro Dalcin PetscErrorCode PetscOptionsHasHelp(PetscOptions options,PetscBool *set) 13462d747510SLisandro Dalcin { 13472d747510SLisandro Dalcin PetscFunctionBegin; 13482d747510SLisandro Dalcin PetscValidPointer(set,2); 13492d747510SLisandro Dalcin options = options ? options : defaultoptions; 13502d747510SLisandro Dalcin *set = options->help; 13512d747510SLisandro Dalcin PetscFunctionReturn(0); 13522d747510SLisandro Dalcin } 13532d747510SLisandro Dalcin 13542d747510SLisandro Dalcin /*@C 135590d69ab7SBarry Smith PetscOptionsHasName - Determines whether a certain option is given in the database. This returns true whether the option is a number, string or boolean, even 135690d69ab7SBarry Smith its value is set to false. 1357e5c89e4eSSatish Balay 1358e5c89e4eSSatish Balay Not Collective 1359e5c89e4eSSatish Balay 1360e5c89e4eSSatish Balay Input Parameters: 13615c9cc608SHong Zhang + options - options database, use NULL for default global database 13623de71b31SHong Zhang . pre - string to prepend to the name or NULL 13633de71b31SHong Zhang - name - the option one is seeking 1364e5c89e4eSSatish Balay 1365e5c89e4eSSatish Balay Output Parameters: 136696ef3cdfSSatish Balay . set - PETSC_TRUE if found else PETSC_FALSE. 1367e5c89e4eSSatish Balay 1368e5c89e4eSSatish Balay Level: beginner 1369e5c89e4eSSatish Balay 137095452b02SPatrick Sanan Notes: 13712d747510SLisandro Dalcin Name cannot be simply "-h". 1372431c96f7SBarry Smith 1373acfcf0e5SJed Brown In many cases you probably want to use PetscOptionsGetBool() instead of calling this, to allowing toggling values. 137490d69ab7SBarry Smith 1375e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1376f3e3d7dfSBarry Smith PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1377e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1378e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1379acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1380a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1381e5c89e4eSSatish Balay @*/ 1382c5929fdfSBarry Smith PetscErrorCode PetscOptionsHasName(PetscOptions options,const char pre[],const char name[],PetscBool *set) 1383e5c89e4eSSatish Balay { 13842d747510SLisandro Dalcin const char *value; 1385e5c89e4eSSatish Balay PetscErrorCode ierr; 1386ace3abfcSBarry Smith PetscBool flag; 1387e5c89e4eSSatish Balay 1388e5c89e4eSSatish Balay PetscFunctionBegin; 13892d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 139096ef3cdfSSatish Balay if (set) *set = flag; 1391e5c89e4eSSatish Balay PetscFunctionReturn(0); 1392e5c89e4eSSatish Balay } 1393e5c89e4eSSatish Balay 1394e5c89e4eSSatish Balay /*@C 13952d747510SLisandro Dalcin PetscOptionsGetAll - Lists all the options the program was run with in a single string. 13962d747510SLisandro Dalcin 13972d747510SLisandro Dalcin Not Collective 13982d747510SLisandro Dalcin 13992d747510SLisandro Dalcin Input Paramter: 14002d747510SLisandro Dalcin . options - the options database, use NULL for the default global database 14012d747510SLisandro Dalcin 14022d747510SLisandro Dalcin Output Parameter: 14032d747510SLisandro Dalcin . copts - pointer where string pointer is stored 14042d747510SLisandro Dalcin 14052d747510SLisandro Dalcin Notes: 14062d747510SLisandro Dalcin the array and each entry in the array should be freed with PetscFree() 14072d747510SLisandro Dalcin 14082d747510SLisandro Dalcin Level: advanced 14092d747510SLisandro Dalcin 14102d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsView() 14112d747510SLisandro Dalcin @*/ 14122d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetAll(PetscOptions options,char *copts[]) 14132d747510SLisandro Dalcin { 14142d747510SLisandro Dalcin PetscErrorCode ierr; 14152d747510SLisandro Dalcin PetscInt i; 14162d747510SLisandro Dalcin size_t len = 1,lent = 0; 14172d747510SLisandro Dalcin char *coptions = NULL; 14182d747510SLisandro Dalcin 14192d747510SLisandro Dalcin PetscFunctionBegin; 14202d747510SLisandro Dalcin PetscValidPointer(copts,2); 14212d747510SLisandro Dalcin options = options ? options : defaultoptions; 14222d747510SLisandro Dalcin /* count the length of the required string */ 14232d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 14242d747510SLisandro Dalcin ierr = PetscStrlen(options->names[i],&lent);CHKERRQ(ierr); 14252d747510SLisandro Dalcin len += 2 + lent; 14262d747510SLisandro Dalcin if (options->values[i]) { 14272d747510SLisandro Dalcin ierr = PetscStrlen(options->values[i],&lent);CHKERRQ(ierr); 14282d747510SLisandro Dalcin len += 1 + lent; 14292d747510SLisandro Dalcin } 14302d747510SLisandro Dalcin } 14312d747510SLisandro Dalcin ierr = PetscMalloc1(len,&coptions);CHKERRQ(ierr); 14322d747510SLisandro Dalcin coptions[0] = 0; 14332d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 14342d747510SLisandro Dalcin ierr = PetscStrcat(coptions,"-");CHKERRQ(ierr); 14352d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->names[i]);CHKERRQ(ierr); 14362d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 14372d747510SLisandro Dalcin if (options->values[i]) { 14382d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->values[i]);CHKERRQ(ierr); 14392d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 14402d747510SLisandro Dalcin } 14412d747510SLisandro Dalcin } 14422d747510SLisandro Dalcin *copts = coptions; 14432d747510SLisandro Dalcin PetscFunctionReturn(0); 14442d747510SLisandro Dalcin } 14452d747510SLisandro Dalcin 14462d747510SLisandro Dalcin /*@C 14472d747510SLisandro Dalcin PetscOptionsUsed - Indicates if PETSc has used a particular option set in the database 14482d747510SLisandro Dalcin 14492d747510SLisandro Dalcin Not Collective 14502d747510SLisandro Dalcin 14512d747510SLisandro Dalcin Input Parameter: 14522d747510SLisandro Dalcin + options - options database, use NULL for default global database 14532d747510SLisandro Dalcin - name - string name of option 14542d747510SLisandro Dalcin 14552d747510SLisandro Dalcin Output Parameter: 14562d747510SLisandro Dalcin . used - PETSC_TRUE if the option was used, otherwise false, including if option was not found in options database 14572d747510SLisandro Dalcin 14582d747510SLisandro Dalcin Level: advanced 14592d747510SLisandro Dalcin 14602d747510SLisandro Dalcin .seealso: PetscOptionsView(), PetscOptionsLeft(), PetscOptionsAllUsed() 14612d747510SLisandro Dalcin @*/ 14622d747510SLisandro Dalcin PetscErrorCode PetscOptionsUsed(PetscOptions options,const char *name,PetscBool *used) 14632d747510SLisandro Dalcin { 14642d747510SLisandro Dalcin PetscInt i; 14652d747510SLisandro Dalcin PetscErrorCode ierr; 14662d747510SLisandro Dalcin 14672d747510SLisandro Dalcin PetscFunctionBegin; 14682d747510SLisandro Dalcin PetscValidCharPointer(name,2); 14692d747510SLisandro Dalcin PetscValidPointer(used,3); 14702d747510SLisandro Dalcin options = options ? options : defaultoptions; 14712d747510SLisandro Dalcin *used = PETSC_FALSE; 14722d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 14732d747510SLisandro Dalcin ierr = PetscStrcmp(options->names[i],name,used);CHKERRQ(ierr); 14742d747510SLisandro Dalcin if (*used) { 14752d747510SLisandro Dalcin *used = options->used[i]; 14762d747510SLisandro Dalcin break; 14772d747510SLisandro Dalcin } 14782d747510SLisandro Dalcin } 14792d747510SLisandro Dalcin PetscFunctionReturn(0); 14802d747510SLisandro Dalcin } 14812d747510SLisandro Dalcin 1482487a658cSBarry Smith /*@ 14832d747510SLisandro Dalcin PetscOptionsAllUsed - Returns a count of the number of options in the 14842d747510SLisandro Dalcin database that have never been selected. 14852d747510SLisandro Dalcin 14862d747510SLisandro Dalcin Not Collective 14872d747510SLisandro Dalcin 14882d747510SLisandro Dalcin Input Parameter: 14892d747510SLisandro Dalcin . options - options database, use NULL for default global database 14902d747510SLisandro Dalcin 14912d747510SLisandro Dalcin Output Parameter: 14922d747510SLisandro Dalcin . N - count of options not used 14932d747510SLisandro Dalcin 14942d747510SLisandro Dalcin Level: advanced 14952d747510SLisandro Dalcin 14962d747510SLisandro Dalcin .seealso: PetscOptionsView() 14972d747510SLisandro Dalcin @*/ 14982d747510SLisandro Dalcin PetscErrorCode PetscOptionsAllUsed(PetscOptions options,PetscInt *N) 14992d747510SLisandro Dalcin { 15002d747510SLisandro Dalcin PetscInt i,n = 0; 15012d747510SLisandro Dalcin 15022d747510SLisandro Dalcin PetscFunctionBegin; 15032d747510SLisandro Dalcin PetscValidIntPointer(N,2); 15042d747510SLisandro Dalcin options = options ? options : defaultoptions; 15052d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15062d747510SLisandro Dalcin if (!options->used[i]) n++; 15072d747510SLisandro Dalcin } 15082d747510SLisandro Dalcin *N = n; 15092d747510SLisandro Dalcin PetscFunctionReturn(0); 15102d747510SLisandro Dalcin } 15112d747510SLisandro Dalcin 1512487a658cSBarry Smith /*@ 15132d747510SLisandro Dalcin PetscOptionsLeft - Prints to screen any options that were set and never used. 15142d747510SLisandro Dalcin 15152d747510SLisandro Dalcin Not Collective 15162d747510SLisandro Dalcin 15172d747510SLisandro Dalcin Input Parameter: 15182d747510SLisandro Dalcin . options - options database; use NULL for default global database 15192d747510SLisandro Dalcin 15202d747510SLisandro Dalcin Options Database Key: 15212d747510SLisandro Dalcin . -options_left - Activates OptionsAllUsed() within PetscFinalize() 15222d747510SLisandro Dalcin 15232d747510SLisandro Dalcin Level: advanced 15242d747510SLisandro Dalcin 15252d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed() 15262d747510SLisandro Dalcin @*/ 15272d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeft(PetscOptions options) 15282d747510SLisandro Dalcin { 15292d747510SLisandro Dalcin PetscErrorCode ierr; 15302d747510SLisandro Dalcin PetscInt i; 15312d747510SLisandro Dalcin 15322d747510SLisandro Dalcin PetscFunctionBegin; 15332d747510SLisandro Dalcin options = options ? options : defaultoptions; 15342d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15352d747510SLisandro Dalcin if (!options->used[i]) { 15362d747510SLisandro Dalcin if (options->values[i]) { 15372d747510SLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s value: %s\n",options->names[i],options->values[i]);CHKERRQ(ierr); 15382d747510SLisandro Dalcin } else { 15392d747510SLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s (no value)\n",options->names[i]);CHKERRQ(ierr); 15402d747510SLisandro Dalcin } 15412d747510SLisandro Dalcin } 15422d747510SLisandro Dalcin } 15432d747510SLisandro Dalcin PetscFunctionReturn(0); 15442d747510SLisandro Dalcin } 15452d747510SLisandro Dalcin 15462d747510SLisandro Dalcin /*@C 15472d747510SLisandro Dalcin PetscOptionsLeftGet - Returns all options that were set and never used. 15482d747510SLisandro Dalcin 15492d747510SLisandro Dalcin Not Collective 15502d747510SLisandro Dalcin 15512d747510SLisandro Dalcin Input Parameter: 15522d747510SLisandro Dalcin . options - options database, use NULL for default global database 15532d747510SLisandro Dalcin 15542d747510SLisandro Dalcin Output Parameter: 15552d747510SLisandro Dalcin . N - count of options not used 15562d747510SLisandro Dalcin . names - names of options not used 15572d747510SLisandro Dalcin . values - values of options not used 15582d747510SLisandro Dalcin 15592d747510SLisandro Dalcin Level: advanced 15602d747510SLisandro Dalcin 15612d747510SLisandro Dalcin Notes: 15622d747510SLisandro Dalcin Users should call PetscOptionsLeftRestore() to free the memory allocated in this routine 15632d747510SLisandro Dalcin 15642d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft() 15652d747510SLisandro Dalcin @*/ 15662d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftGet(PetscOptions options,PetscInt *N,char **names[],char **values[]) 15672d747510SLisandro Dalcin { 15682d747510SLisandro Dalcin PetscErrorCode ierr; 15692d747510SLisandro Dalcin PetscInt i,n; 15702d747510SLisandro Dalcin 15712d747510SLisandro Dalcin PetscFunctionBegin; 15722d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 15732d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 15742d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 15752d747510SLisandro Dalcin options = options ? options : defaultoptions; 15762d747510SLisandro Dalcin 15772d747510SLisandro Dalcin /* The number of unused PETSc options */ 15782d747510SLisandro Dalcin n = 0; 15792d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15802d747510SLisandro Dalcin if (!options->used[i]) n++; 15812d747510SLisandro Dalcin } 15822d747510SLisandro Dalcin if (N) { *N = n; } 15832d747510SLisandro Dalcin if (names) { ierr = PetscMalloc1(n,names);CHKERRQ(ierr); } 15842d747510SLisandro Dalcin if (values) { ierr = PetscMalloc1(n,values);CHKERRQ(ierr); } 15852d747510SLisandro Dalcin 15862d747510SLisandro Dalcin n = 0; 15872d747510SLisandro Dalcin if (names || values) { 15882d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15892d747510SLisandro Dalcin if (!options->used[i]) { 15902d747510SLisandro Dalcin if (names) (*names)[n] = options->names[i]; 15912d747510SLisandro Dalcin if (values) (*values)[n] = options->values[i]; 15922d747510SLisandro Dalcin n++; 15932d747510SLisandro Dalcin } 15942d747510SLisandro Dalcin } 15952d747510SLisandro Dalcin } 15962d747510SLisandro Dalcin PetscFunctionReturn(0); 15972d747510SLisandro Dalcin } 15982d747510SLisandro Dalcin 15992d747510SLisandro Dalcin /*@C 16002d747510SLisandro Dalcin PetscOptionsLeftRestore - Free memory for the unused PETSc options obtained using PetscOptionsLeftGet. 16012d747510SLisandro Dalcin 16022d747510SLisandro Dalcin Not Collective 16032d747510SLisandro Dalcin 16042d747510SLisandro Dalcin Input Parameter: 16052d747510SLisandro Dalcin . options - options database, use NULL for default global database 16062d747510SLisandro Dalcin . names - names of options not used 16072d747510SLisandro Dalcin . values - values of options not used 16082d747510SLisandro Dalcin 16092d747510SLisandro Dalcin Level: advanced 16102d747510SLisandro Dalcin 16112d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft(), PetscOptionsLeftGet() 16122d747510SLisandro Dalcin @*/ 16132d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftRestore(PetscOptions options,PetscInt *N,char **names[],char **values[]) 16142d747510SLisandro Dalcin { 16152d747510SLisandro Dalcin PetscErrorCode ierr; 16162d747510SLisandro Dalcin 16172d747510SLisandro Dalcin PetscFunctionBegin; 16182d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 16192d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 16202d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 16212d747510SLisandro Dalcin if (N) { *N = 0; } 16222d747510SLisandro Dalcin if (names) { ierr = PetscFree(*names);CHKERRQ(ierr); } 16232d747510SLisandro Dalcin if (values) { ierr = PetscFree(*values);CHKERRQ(ierr); } 16242d747510SLisandro Dalcin PetscFunctionReturn(0); 16252d747510SLisandro Dalcin } 16262d747510SLisandro Dalcin 16272d747510SLisandro Dalcin /*@C 16282d747510SLisandro Dalcin PetscOptionsSetFromOptions - Sets options related to the handling of options in PETSc 16292d747510SLisandro Dalcin 16302d747510SLisandro Dalcin Collective on PETSC_COMM_WORLD 16312d747510SLisandro Dalcin 16322d747510SLisandro Dalcin Input Parameter: 16332d747510SLisandro Dalcin . options - options database, use NULL for default global database 16342d747510SLisandro Dalcin 16352d747510SLisandro Dalcin Options Database Keys: 16362d747510SLisandro Dalcin + -options_monitor <optional filename> - prints the names and values of all runtime options as they are set. The monitor functionality is not 16372d747510SLisandro Dalcin available for options set through a file, environment variable, or on 16382d747510SLisandro Dalcin the command line. Only options set after PetscInitialize() completes will 16392d747510SLisandro Dalcin be monitored. 16402d747510SLisandro Dalcin . -options_monitor_cancel - cancel all options database monitors 16412d747510SLisandro Dalcin 16422d747510SLisandro Dalcin Notes: 16432d747510SLisandro Dalcin To see all options, run your program with the -help option or consult Users-Manual: sec_gettingstarted 16442d747510SLisandro Dalcin 16452d747510SLisandro Dalcin Level: intermediate 16462d747510SLisandro Dalcin 16472d747510SLisandro Dalcin @*/ 16482d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetFromOptions(PetscOptions options) 16492d747510SLisandro Dalcin { 16502d747510SLisandro Dalcin PetscBool flgc = PETSC_FALSE,flgm; 16512d747510SLisandro Dalcin PetscErrorCode ierr; 16522d747510SLisandro Dalcin char monfilename[PETSC_MAX_PATH_LEN]; 16532d747510SLisandro Dalcin PetscViewer monviewer; 16542d747510SLisandro Dalcin 16552d747510SLisandro Dalcin PetscFunctionBegin; 16562d747510SLisandro Dalcin /* 16572d747510SLisandro Dalcin The options argument is currently ignored since we currently maintain only a single options database 16582d747510SLisandro Dalcin 16592d747510SLisandro Dalcin options = options ? options : defaultoptions; 16602d747510SLisandro Dalcin */ 16612d747510SLisandro Dalcin ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"Options for handling options","PetscOptions");CHKERRQ(ierr); 16622d747510SLisandro Dalcin ierr = PetscOptionsString("-options_monitor","Monitor options database","PetscOptionsMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flgm);CHKERRQ(ierr); 16632d747510SLisandro Dalcin ierr = PetscOptionsBool("-options_monitor_cancel","Cancel all options database monitors","PetscOptionsMonitorCancel",flgc,&flgc,NULL);CHKERRQ(ierr); 16642d747510SLisandro Dalcin ierr = PetscOptionsEnd();CHKERRQ(ierr); 16652d747510SLisandro Dalcin if (flgm) { 16662d747510SLisandro Dalcin ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,monfilename,&monviewer);CHKERRQ(ierr); 16672d747510SLisandro Dalcin ierr = PetscOptionsMonitorSet(PetscOptionsMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 16682d747510SLisandro Dalcin } 16692d747510SLisandro Dalcin if (flgc) { ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr); } 16702d747510SLisandro Dalcin PetscFunctionReturn(0); 16712d747510SLisandro Dalcin } 16722d747510SLisandro Dalcin 16732d747510SLisandro Dalcin /*@C 16742d747510SLisandro Dalcin PetscOptionsMonitorDefault - Print all options set value events. 16752d747510SLisandro Dalcin 16762d747510SLisandro Dalcin Logically Collective on PETSC_COMM_WORLD 16772d747510SLisandro Dalcin 16782d747510SLisandro Dalcin Input Parameters: 16792d747510SLisandro Dalcin + name - option name string 16802d747510SLisandro Dalcin . value - option value string 16812d747510SLisandro Dalcin - ctx - an ASCII viewer 16822d747510SLisandro Dalcin 16832d747510SLisandro Dalcin Level: intermediate 16842d747510SLisandro Dalcin 16852d747510SLisandro Dalcin .seealso: PetscOptionsMonitorSet() 16862d747510SLisandro Dalcin @*/ 16872d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorDefault(const char name[],const char value[],void *ctx) 16882d747510SLisandro Dalcin { 16892d747510SLisandro Dalcin PetscErrorCode ierr; 16902d747510SLisandro Dalcin PetscViewer viewer = (PetscViewer)ctx; 16912d747510SLisandro Dalcin 16922d747510SLisandro Dalcin PetscFunctionBegin; 16932d747510SLisandro Dalcin if (!value) { 16942d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Removing option: %s\n",name,value);CHKERRQ(ierr); 16952d747510SLisandro Dalcin } else if (!value[0]) { 16962d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s (no value)\n",name);CHKERRQ(ierr); 16972d747510SLisandro Dalcin } else { 16982d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr); 16992d747510SLisandro Dalcin } 17002d747510SLisandro Dalcin PetscFunctionReturn(0); 17012d747510SLisandro Dalcin } 17022d747510SLisandro Dalcin 17032d747510SLisandro Dalcin /*@C 17042d747510SLisandro Dalcin PetscOptionsMonitorSet - Sets an ADDITIONAL function to be called at every method that 17052d747510SLisandro Dalcin modified the PETSc options database. 17062d747510SLisandro Dalcin 17072d747510SLisandro Dalcin Not Collective 17082d747510SLisandro Dalcin 17092d747510SLisandro Dalcin Input Parameters: 17102d747510SLisandro Dalcin + monitor - pointer to function (if this is NULL, it turns off monitoring 17112d747510SLisandro Dalcin . mctx - [optional] context for private data for the 17122d747510SLisandro Dalcin monitor routine (use NULL if no context is desired) 17132d747510SLisandro Dalcin - monitordestroy - [optional] routine that frees monitor context 17142d747510SLisandro Dalcin (may be NULL) 17152d747510SLisandro Dalcin 17162d747510SLisandro Dalcin Calling Sequence of monitor: 17172d747510SLisandro Dalcin $ monitor (const char name[], const char value[], void *mctx) 17182d747510SLisandro Dalcin 17192d747510SLisandro Dalcin + name - option name string 17202d747510SLisandro Dalcin . value - option value string 17212d747510SLisandro Dalcin - mctx - optional monitoring context, as set by PetscOptionsMonitorSet() 17222d747510SLisandro Dalcin 17232d747510SLisandro Dalcin Options Database Keys: 17242d747510SLisandro Dalcin + -options_monitor - sets PetscOptionsMonitorDefault() 17252d747510SLisandro Dalcin - -options_monitor_cancel - cancels all monitors that have 17262d747510SLisandro Dalcin been hardwired into a code by 17272d747510SLisandro Dalcin calls to PetscOptionsMonitorSet(), but 17282d747510SLisandro Dalcin does not cancel those set via 17292d747510SLisandro Dalcin the options database. 17302d747510SLisandro Dalcin 17312d747510SLisandro Dalcin Notes: 17322d747510SLisandro Dalcin The default is to do nothing. To print the name and value of options 17332d747510SLisandro Dalcin being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine, 17342d747510SLisandro Dalcin with a null monitoring context. 17352d747510SLisandro Dalcin 17362d747510SLisandro Dalcin Several different monitoring routines may be set by calling 17372d747510SLisandro Dalcin PetscOptionsMonitorSet() multiple times; all will be called in the 17382d747510SLisandro Dalcin order in which they were set. 17392d747510SLisandro Dalcin 17402d747510SLisandro Dalcin Level: beginner 17412d747510SLisandro Dalcin 17422d747510SLisandro Dalcin .seealso: PetscOptionsMonitorDefault(), PetscOptionsMonitorCancel() 17432d747510SLisandro Dalcin @*/ 17442d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 17452d747510SLisandro Dalcin { 17462d747510SLisandro Dalcin PetscOptions options = defaultoptions; 17472d747510SLisandro Dalcin 17482d747510SLisandro Dalcin PetscFunctionBegin; 17492d747510SLisandro Dalcin if (options->numbermonitors >= MAXOPTIONSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptions monitors set"); 17502d747510SLisandro Dalcin options->monitor[options->numbermonitors] = monitor; 17512d747510SLisandro Dalcin options->monitordestroy[options->numbermonitors] = monitordestroy; 17522d747510SLisandro Dalcin options->monitorcontext[options->numbermonitors++] = (void*)mctx; 17532d747510SLisandro Dalcin PetscFunctionReturn(0); 17542d747510SLisandro Dalcin } 17552d747510SLisandro Dalcin 17562d747510SLisandro Dalcin /*@ 17572d747510SLisandro Dalcin PetscOptionsMonitorCancel - Clears all monitors for a PetscOptions object. 17582d747510SLisandro Dalcin 17592d747510SLisandro Dalcin Not Collective 17602d747510SLisandro Dalcin 17612d747510SLisandro Dalcin Options Database Key: 17622d747510SLisandro Dalcin . -options_monitor_cancel - Cancels all monitors that have 17632d747510SLisandro Dalcin been hardwired into a code by calls to PetscOptionsMonitorSet(), 17642d747510SLisandro Dalcin but does not cancel those set via the options database. 17652d747510SLisandro Dalcin 17662d747510SLisandro Dalcin Level: intermediate 17672d747510SLisandro Dalcin 17682d747510SLisandro Dalcin .seealso: PetscOptionsMonitorDefault(), PetscOptionsMonitorSet() 17692d747510SLisandro Dalcin @*/ 17702d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorCancel(void) 17712d747510SLisandro Dalcin { 17722d747510SLisandro Dalcin PetscErrorCode ierr; 17732d747510SLisandro Dalcin PetscInt i; 17742d747510SLisandro Dalcin PetscOptions options = defaultoptions; 17752d747510SLisandro Dalcin 17762d747510SLisandro Dalcin PetscFunctionBegin; 17772d747510SLisandro Dalcin for (i=0; i<options->numbermonitors; i++) { 17782d747510SLisandro Dalcin if (options->monitordestroy[i]) { 17792d747510SLisandro Dalcin ierr = (*options->monitordestroy[i])(&options->monitorcontext[i]);CHKERRQ(ierr); 17802d747510SLisandro Dalcin } 17812d747510SLisandro Dalcin } 17822d747510SLisandro Dalcin options->numbermonitors = 0; 17832d747510SLisandro Dalcin PetscFunctionReturn(0); 17842d747510SLisandro Dalcin } 17852d747510SLisandro Dalcin 17862d747510SLisandro Dalcin /* 17872d747510SLisandro Dalcin PetscOptionsStringToBool - Converts string to PetscBool , handles cases like "yes", "no", "true", "false", "0", "1", "off", "on". 17882d747510SLisandro Dalcin */ 17892d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToBool(const char value[],PetscBool *a) 17902d747510SLisandro Dalcin { 17912d747510SLisandro Dalcin PetscBool istrue,isfalse; 17922d747510SLisandro Dalcin size_t len; 17932d747510SLisandro Dalcin PetscErrorCode ierr; 17942d747510SLisandro Dalcin 17952d747510SLisandro Dalcin PetscFunctionBegin; 17962d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 17972d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Character string of length zero has no logical value"); 17982d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"TRUE",&istrue);CHKERRQ(ierr); 17992d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 18002d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"YES",&istrue);CHKERRQ(ierr); 18012d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 18022d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"1",&istrue);CHKERRQ(ierr); 18032d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 18042d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"on",&istrue);CHKERRQ(ierr); 18052d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 18062d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"FALSE",&isfalse);CHKERRQ(ierr); 18072d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 18082d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"NO",&isfalse);CHKERRQ(ierr); 18092d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 18102d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"0",&isfalse);CHKERRQ(ierr); 18112d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 18122d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"off",&isfalse);CHKERRQ(ierr); 18132d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 18142d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown logical value: %s",value); 18152d747510SLisandro Dalcin } 18162d747510SLisandro Dalcin 18172d747510SLisandro Dalcin /* 18182d747510SLisandro Dalcin PetscOptionsStringToInt - Converts a string to an integer value. Handles special cases such as "default" and "decide" 18192d747510SLisandro Dalcin */ 18202d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToInt(const char name[],PetscInt *a) 18212d747510SLisandro Dalcin { 18222d747510SLisandro Dalcin PetscErrorCode ierr; 18232d747510SLisandro Dalcin size_t len; 18242d747510SLisandro Dalcin PetscBool decide,tdefault,mouse; 18252d747510SLisandro Dalcin 18262d747510SLisandro Dalcin PetscFunctionBegin; 18272d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 18282d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 18292d747510SLisandro Dalcin 18302d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&tdefault);CHKERRQ(ierr); 18312d747510SLisandro Dalcin if (!tdefault) { 18322d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&tdefault);CHKERRQ(ierr); 18332d747510SLisandro Dalcin } 18342d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&decide);CHKERRQ(ierr); 18352d747510SLisandro Dalcin if (!decide) { 18362d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&decide);CHKERRQ(ierr); 18372d747510SLisandro Dalcin } 18382d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"mouse",&mouse);CHKERRQ(ierr); 18392d747510SLisandro Dalcin 18402d747510SLisandro Dalcin if (tdefault) *a = PETSC_DEFAULT; 18412d747510SLisandro Dalcin else if (decide) *a = PETSC_DECIDE; 18422d747510SLisandro Dalcin else if (mouse) *a = -1; 18432d747510SLisandro Dalcin else { 18442d747510SLisandro Dalcin char *endptr; 18452d747510SLisandro Dalcin long strtolval; 18462d747510SLisandro Dalcin 18472d747510SLisandro Dalcin strtolval = strtol(name,&endptr,10); 18482d747510SLisandro Dalcin if ((size_t) (endptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no integer value (do not include . in it)",name); 18492d747510SLisandro Dalcin 18502d747510SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE_ATOLL) 18512d747510SLisandro Dalcin (void) strtolval; 18522d747510SLisandro Dalcin *a = atoll(name); 18532d747510SLisandro Dalcin #elif defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE___INT64) 18542d747510SLisandro Dalcin (void) strtolval; 18552d747510SLisandro Dalcin *a = _atoi64(name); 18562d747510SLisandro Dalcin #else 18572d747510SLisandro Dalcin *a = (PetscInt)strtolval; 18582d747510SLisandro Dalcin #endif 18592d747510SLisandro Dalcin } 18602d747510SLisandro Dalcin PetscFunctionReturn(0); 18612d747510SLisandro Dalcin } 18622d747510SLisandro Dalcin 18632d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 18642d747510SLisandro Dalcin #include <quadmath.h> 18652d747510SLisandro Dalcin #endif 18662d747510SLisandro Dalcin 18672d747510SLisandro Dalcin static PetscErrorCode PetscStrtod(const char name[],PetscReal *a,char **endptr) 18682d747510SLisandro Dalcin { 18692d747510SLisandro Dalcin PetscFunctionBegin; 18702d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 18712d747510SLisandro Dalcin *a = strtoflt128(name,endptr); 18722d747510SLisandro Dalcin #else 18732d747510SLisandro Dalcin *a = (PetscReal)strtod(name,endptr); 18742d747510SLisandro Dalcin #endif 18752d747510SLisandro Dalcin PetscFunctionReturn(0); 18762d747510SLisandro Dalcin } 18772d747510SLisandro Dalcin 18782d747510SLisandro Dalcin static PetscErrorCode PetscStrtoz(const char name[],PetscScalar *a,char **endptr,PetscBool *isImaginary) 18792d747510SLisandro Dalcin { 18802d747510SLisandro Dalcin PetscBool hasi = PETSC_FALSE; 18812d747510SLisandro Dalcin char *ptr; 18822d747510SLisandro Dalcin PetscReal strtoval; 18832d747510SLisandro Dalcin PetscErrorCode ierr; 18842d747510SLisandro Dalcin 18852d747510SLisandro Dalcin PetscFunctionBegin; 18862d747510SLisandro Dalcin ierr = PetscStrtod(name,&strtoval,&ptr);CHKERRQ(ierr); 18872d747510SLisandro Dalcin if (ptr == name) { 18882d747510SLisandro Dalcin strtoval = 1.; 18892d747510SLisandro Dalcin hasi = PETSC_TRUE; 18902d747510SLisandro Dalcin if (name[0] == 'i') { 18912d747510SLisandro Dalcin ptr++; 18922d747510SLisandro Dalcin } else if (name[0] == '+' && name[1] == 'i') { 18932d747510SLisandro Dalcin ptr += 2; 18942d747510SLisandro Dalcin } else if (name[0] == '-' && name[1] == 'i') { 18952d747510SLisandro Dalcin strtoval = -1.; 18962d747510SLisandro Dalcin ptr += 2; 18972d747510SLisandro Dalcin } 18982d747510SLisandro Dalcin } else if (*ptr == 'i') { 18992d747510SLisandro Dalcin hasi = PETSC_TRUE; 19002d747510SLisandro Dalcin ptr++; 19012d747510SLisandro Dalcin } 19022d747510SLisandro Dalcin *endptr = ptr; 19032d747510SLisandro Dalcin *isImaginary = hasi; 19042d747510SLisandro Dalcin if (hasi) { 19052d747510SLisandro Dalcin #if !defined(PETSC_USE_COMPLEX) 19062d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s contains imaginary but complex not supported ",name); 19072d747510SLisandro Dalcin #else 19082d747510SLisandro Dalcin *a = PetscCMPLX(0.,strtoval); 19092d747510SLisandro Dalcin #endif 19102d747510SLisandro Dalcin } else { 19112d747510SLisandro Dalcin *a = strtoval; 19122d747510SLisandro Dalcin } 19132d747510SLisandro Dalcin PetscFunctionReturn(0); 19142d747510SLisandro Dalcin } 19152d747510SLisandro Dalcin 19162d747510SLisandro Dalcin /* 19172d747510SLisandro Dalcin Converts a string to PetscReal value. Handles special cases like "default" and "decide" 19182d747510SLisandro Dalcin */ 19192d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToReal(const char name[],PetscReal *a) 19202d747510SLisandro Dalcin { 19212d747510SLisandro Dalcin size_t len; 19222d747510SLisandro Dalcin PetscBool match; 19232d747510SLisandro Dalcin char *endptr; 19242d747510SLisandro Dalcin PetscErrorCode ierr; 19252d747510SLisandro Dalcin 19262d747510SLisandro Dalcin PetscFunctionBegin; 19272d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 19282d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"String of length zero has no numerical value"); 19292d747510SLisandro Dalcin 19302d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&match);CHKERRQ(ierr); 19312d747510SLisandro Dalcin if (!match) { 19322d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&match);CHKERRQ(ierr); 19332d747510SLisandro Dalcin } 19342d747510SLisandro Dalcin if (match) {*a = PETSC_DEFAULT; PetscFunctionReturn(0);} 19352d747510SLisandro Dalcin 19362d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&match);CHKERRQ(ierr); 19372d747510SLisandro Dalcin if (!match) { 19382d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&match);CHKERRQ(ierr); 19392d747510SLisandro Dalcin } 19402d747510SLisandro Dalcin if (match) {*a = PETSC_DECIDE; PetscFunctionReturn(0);} 19412d747510SLisandro Dalcin 19422d747510SLisandro Dalcin ierr = PetscStrtod(name,a,&endptr);CHKERRQ(ierr); 19432d747510SLisandro Dalcin if ((size_t) (endptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value",name); 19442d747510SLisandro Dalcin PetscFunctionReturn(0); 19452d747510SLisandro Dalcin } 19462d747510SLisandro Dalcin 19472d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToScalar(const char name[],PetscScalar *a) 19482d747510SLisandro Dalcin { 19492d747510SLisandro Dalcin PetscBool imag1; 19502d747510SLisandro Dalcin size_t len; 19512d747510SLisandro Dalcin PetscScalar val = 0.; 19522d747510SLisandro Dalcin char *ptr = NULL; 19532d747510SLisandro Dalcin PetscErrorCode ierr; 19542d747510SLisandro Dalcin 19552d747510SLisandro Dalcin PetscFunctionBegin; 19562d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 19572d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 19582d747510SLisandro Dalcin ierr = PetscStrtoz(name,&val,&ptr,&imag1);CHKERRQ(ierr); 19592d747510SLisandro Dalcin #if defined(PETSC_USE_COMPLEX) 19602d747510SLisandro Dalcin if ((size_t) (ptr - name) < len) { 19612d747510SLisandro Dalcin PetscBool imag2; 19622d747510SLisandro Dalcin PetscScalar val2; 19632d747510SLisandro Dalcin 19642d747510SLisandro Dalcin ierr = PetscStrtoz(ptr,&val2,&ptr,&imag2);CHKERRQ(ierr); 19652d747510SLisandro Dalcin if (imag1 || !imag2) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s: must specify imaginary component second",name); 19662d747510SLisandro Dalcin val = PetscCMPLX(PetscRealPart(val),PetscImaginaryPart(val2)); 19672d747510SLisandro Dalcin } 19682d747510SLisandro Dalcin #endif 19692d747510SLisandro Dalcin if ((size_t) (ptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value ",name); 19702d747510SLisandro Dalcin *a = val; 19712d747510SLisandro Dalcin PetscFunctionReturn(0); 19722d747510SLisandro Dalcin } 19732d747510SLisandro Dalcin 19742d747510SLisandro Dalcin /*@C 19752d747510SLisandro Dalcin PetscOptionsGetBool - Gets the Logical (true or false) value for a particular 19762d747510SLisandro Dalcin option in the database. 1977e5c89e4eSSatish Balay 1978e5c89e4eSSatish Balay Not Collective 1979e5c89e4eSSatish Balay 1980e5c89e4eSSatish Balay Input Parameters: 19815c9cc608SHong Zhang + options - options database, use NULL for default global database 1982c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 1983e5c89e4eSSatish Balay - name - the option one is seeking 1984e5c89e4eSSatish Balay 1985e5c89e4eSSatish Balay Output Parameter: 19862d747510SLisandro Dalcin + ivalue - the logical value to return 198796ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 1988e5c89e4eSSatish Balay 1989e5c89e4eSSatish Balay Level: beginner 1990e5c89e4eSSatish Balay 199195452b02SPatrick Sanan Notes: 19922d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 19932d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 19942d747510SLisandro Dalcin 19952d747510SLisandro 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 19962d747510SLisandro Dalcin is equivalent to -requested_bool true 19972d747510SLisandro Dalcin 19982d747510SLisandro Dalcin If the user does not supply the option at all ivalue is NOT changed. Thus 19992efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 20002efd9cb1SBarry Smith 2001e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 20022d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetInt(), PetscOptionsBool(), 2003e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2004e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2005acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2006a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2007e5c89e4eSSatish Balay @*/ 20082d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBool(PetscOptions options,const char pre[],const char name[],PetscBool *ivalue,PetscBool *set) 2009e5c89e4eSSatish Balay { 20102d747510SLisandro Dalcin const char *value; 2011ace3abfcSBarry Smith PetscBool flag; 20122d747510SLisandro Dalcin PetscErrorCode ierr; 2013e5c89e4eSSatish Balay 2014e5c89e4eSSatish Balay PetscFunctionBegin; 20152d747510SLisandro Dalcin PetscValidCharPointer(name,3); 20162d747510SLisandro Dalcin if (ivalue) PetscValidIntPointer(ivalue,4); 20172d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2018e5c89e4eSSatish Balay if (flag) { 201996ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 20202d747510SLisandro Dalcin if (!value) { 20212d747510SLisandro Dalcin if (ivalue) *ivalue = PETSC_TRUE; 20222d747510SLisandro Dalcin } else { 20232d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value, &flag);CHKERRQ(ierr); 20242d747510SLisandro Dalcin if (ivalue) *ivalue = flag; 2025e5c89e4eSSatish Balay } 2026e5c89e4eSSatish Balay } else { 202796ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2028e5c89e4eSSatish Balay } 2029e5c89e4eSSatish Balay PetscFunctionReturn(0); 2030e5c89e4eSSatish Balay } 2031e5c89e4eSSatish Balay 2032e5c89e4eSSatish Balay /*@C 2033e5c89e4eSSatish Balay PetscOptionsGetEList - Puts a list of option values that a single one may be selected from 2034e5c89e4eSSatish Balay 2035e5c89e4eSSatish Balay Not Collective 2036e5c89e4eSSatish Balay 2037e5c89e4eSSatish Balay Input Parameters: 20385c9cc608SHong Zhang + options - options database, use NULL for default global database 2039c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2040e5c89e4eSSatish Balay . opt - option name 2041a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 2042e5c89e4eSSatish Balay . ntext - number of choices 2043e5c89e4eSSatish Balay 2044e5c89e4eSSatish Balay Output Parameter: 20452efd9cb1SBarry Smith + value - the index of the value to return (defaults to zero if the option name is given but no choice is listed) 2046e5c89e4eSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2047e5c89e4eSSatish Balay 2048e5c89e4eSSatish Balay Level: intermediate 2049e5c89e4eSSatish Balay 205095452b02SPatrick Sanan Notes: 205195452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 20522efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 20532efd9cb1SBarry Smith 2054a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 2055e5c89e4eSSatish Balay 2056e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2057acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2058e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2059e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2060acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2061a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2062e5c89e4eSSatish Balay @*/ 2063c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEList(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscInt ntext,PetscInt *value,PetscBool *set) 2064e5c89e4eSSatish Balay { 2065e5c89e4eSSatish Balay PetscErrorCode ierr; 2066e5c89e4eSSatish Balay size_t alen,len = 0; 2067e5c89e4eSSatish Balay char *svalue; 2068ace3abfcSBarry Smith PetscBool aset,flg = PETSC_FALSE; 2069e5c89e4eSSatish Balay PetscInt i; 2070e5c89e4eSSatish Balay 2071e5c89e4eSSatish Balay PetscFunctionBegin; 20722d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2073e5c89e4eSSatish Balay for (i=0; i<ntext; i++) { 2074e5c89e4eSSatish Balay ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr); 2075e5c89e4eSSatish Balay if (alen > len) len = alen; 2076e5c89e4eSSatish Balay } 2077e5c89e4eSSatish Balay len += 5; /* a little extra space for user mistypes */ 2078785e854fSJed Brown ierr = PetscMalloc1(len,&svalue);CHKERRQ(ierr); 2079c5929fdfSBarry Smith ierr = PetscOptionsGetString(options,pre,opt,svalue,len,&aset);CHKERRQ(ierr); 2080e5c89e4eSSatish Balay if (aset) { 2081fbedd5e0SJed Brown ierr = PetscEListFind(ntext,list,svalue,value,&flg);CHKERRQ(ierr); 2082e32f2f54SBarry Smith if (!flg) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown option %s for -%s%s",svalue,pre ? pre : "",opt+1); 2083fbedd5e0SJed Brown if (set) *set = PETSC_TRUE; 2084a297a907SKarl Rupp } else if (set) *set = PETSC_FALSE; 2085e5c89e4eSSatish Balay ierr = PetscFree(svalue);CHKERRQ(ierr); 2086e5c89e4eSSatish Balay PetscFunctionReturn(0); 2087e5c89e4eSSatish Balay } 2088e5c89e4eSSatish Balay 2089e5c89e4eSSatish Balay /*@C 2090e5c89e4eSSatish Balay PetscOptionsGetEnum - Gets the enum value for a particular option in the database. 2091e5c89e4eSSatish Balay 2092e5c89e4eSSatish Balay Not Collective 2093e5c89e4eSSatish Balay 2094e5c89e4eSSatish Balay Input Parameters: 20955c9cc608SHong Zhang + options - options database, use NULL for default global database 2096c5929fdfSBarry Smith . pre - option prefix or NULL 2097e5c89e4eSSatish Balay . opt - option name 2098e5c89e4eSSatish Balay . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 2099e5c89e4eSSatish Balay - defaultv - the default (current) value 2100e5c89e4eSSatish Balay 2101e5c89e4eSSatish Balay Output Parameter: 2102e5c89e4eSSatish Balay + value - the value to return 210396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2104e5c89e4eSSatish Balay 2105e5c89e4eSSatish Balay Level: beginner 2106e5c89e4eSSatish Balay 210795452b02SPatrick Sanan Notes: 210895452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 21092efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2110e5c89e4eSSatish Balay 21112efd9cb1SBarry Smith List is usually something like PCASMTypes or some other predefined list of enum names 2112e5c89e4eSSatish Balay 2113e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 2114acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 2115acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2116e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2117e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2118acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2119a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 2120e5c89e4eSSatish Balay @*/ 2121c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set) 2122e5c89e4eSSatish Balay { 2123e5c89e4eSSatish Balay PetscErrorCode ierr; 212469a24498SJed Brown PetscInt ntext = 0,tval; 2125ace3abfcSBarry Smith PetscBool fset; 2126e5c89e4eSSatish Balay 2127e5c89e4eSSatish Balay PetscFunctionBegin; 21282d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2129e5c89e4eSSatish Balay while (list[ntext++]) { 2130e32f2f54SBarry Smith if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 2131e5c89e4eSSatish Balay } 2132e32f2f54SBarry Smith if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 2133e5c89e4eSSatish Balay ntext -= 3; 2134c5929fdfSBarry Smith ierr = PetscOptionsGetEList(options,pre,opt,list,ntext,&tval,&fset);CHKERRQ(ierr); 213569a24498SJed Brown /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 2136809ceb46SBarry Smith if (fset) *value = (PetscEnum)tval; 2137809ceb46SBarry Smith if (set) *set = fset; 2138e5c89e4eSSatish Balay PetscFunctionReturn(0); 2139e5c89e4eSSatish Balay } 2140e5c89e4eSSatish Balay 2141e5c89e4eSSatish Balay /*@C 21422d747510SLisandro Dalcin PetscOptionsGetInt - Gets the integer value for a particular option in the database. 2143e5c89e4eSSatish Balay 2144e5c89e4eSSatish Balay Not Collective 2145e5c89e4eSSatish Balay 2146e5c89e4eSSatish Balay Input Parameters: 21475c9cc608SHong Zhang + options - options database, use NULL for default global database 2148c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2149e5c89e4eSSatish Balay - name - the option one is seeking 2150e5c89e4eSSatish Balay 2151e5c89e4eSSatish Balay Output Parameter: 21522d747510SLisandro Dalcin + ivalue - the integer value to return 215396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2154e5c89e4eSSatish Balay 2155e5c89e4eSSatish Balay Level: beginner 2156e5c89e4eSSatish Balay 2157e5c89e4eSSatish Balay Notes: 21582d747510SLisandro Dalcin If the user does not supply the option ivalue is NOT changed. Thus 21592efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 21605c07ccb8SBarry Smith 2161e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 21622d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 21632d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2164e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2165e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2166acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2167a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2168e5c89e4eSSatish Balay @*/ 21692d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetInt(PetscOptions options,const char pre[],const char name[],PetscInt *ivalue,PetscBool *set) 2170e5c89e4eSSatish Balay { 21712d747510SLisandro Dalcin const char *value; 2172e5c89e4eSSatish Balay PetscErrorCode ierr; 21732d747510SLisandro Dalcin PetscBool flag; 2174e5c89e4eSSatish Balay 2175e5c89e4eSSatish Balay PetscFunctionBegin; 21762d747510SLisandro Dalcin PetscValidCharPointer(name,3); 21772d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 21782d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2179e5c89e4eSSatish Balay if (flag) { 218034a9cc2cSBarry Smith if (!value) { 21812d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 218234a9cc2cSBarry Smith } else { 21832d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 21842d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 2185e5c89e4eSSatish Balay } 2186e5c89e4eSSatish Balay } else { 218796ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2188e5c89e4eSSatish Balay } 2189e5c89e4eSSatish Balay PetscFunctionReturn(0); 2190e5c89e4eSSatish Balay } 2191e5c89e4eSSatish Balay 2192e2446a98SMatthew Knepley /*@C 2193e5c89e4eSSatish Balay PetscOptionsGetReal - Gets the double precision value for a particular 2194e5c89e4eSSatish Balay option in the database. 2195e5c89e4eSSatish Balay 2196e5c89e4eSSatish Balay Not Collective 2197e5c89e4eSSatish Balay 2198e5c89e4eSSatish Balay Input Parameters: 21995c9cc608SHong Zhang + options - options database, use NULL for default global database 2200c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2201e5c89e4eSSatish Balay - name - the option one is seeking 2202e5c89e4eSSatish Balay 2203e5c89e4eSSatish Balay Output Parameter: 2204e5c89e4eSSatish Balay + dvalue - the double value to return 220596ef3cdfSSatish Balay - set - PETSC_TRUE if found, PETSC_FALSE if not found 2206e5c89e4eSSatish Balay 220795452b02SPatrick Sanan Notes: 220895452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 22092efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2210e4974155SBarry Smith 2211e5c89e4eSSatish Balay Level: beginner 2212e5c89e4eSSatish Balay 2213e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2214acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 2215e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2216e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2217acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2218a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2219e5c89e4eSSatish Balay @*/ 2220c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetReal(PetscOptions options,const char pre[],const char name[],PetscReal *dvalue,PetscBool *set) 2221e5c89e4eSSatish Balay { 22222d747510SLisandro Dalcin const char *value; 2223ace3abfcSBarry Smith PetscBool flag; 22242d747510SLisandro Dalcin PetscErrorCode ierr; 2225e5c89e4eSSatish Balay 2226e5c89e4eSSatish Balay PetscFunctionBegin; 22272d747510SLisandro Dalcin PetscValidCharPointer(name,3); 22282d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 22292d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2230e5c89e4eSSatish Balay if (flag) { 2231a297a907SKarl Rupp if (!value) { 2232a297a907SKarl Rupp if (set) *set = PETSC_FALSE; 2233a297a907SKarl Rupp } else { 2234a297a907SKarl Rupp if (set) *set = PETSC_TRUE; 2235a297a907SKarl Rupp ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2236a297a907SKarl Rupp } 2237e5c89e4eSSatish Balay } else { 223896ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2239e5c89e4eSSatish Balay } 2240e5c89e4eSSatish Balay PetscFunctionReturn(0); 2241e5c89e4eSSatish Balay } 2242e5c89e4eSSatish Balay 2243e5c89e4eSSatish Balay /*@C 2244e5c89e4eSSatish Balay PetscOptionsGetScalar - Gets the scalar value for a particular 2245e5c89e4eSSatish Balay option in the database. 2246e5c89e4eSSatish Balay 2247e5c89e4eSSatish Balay Not Collective 2248e5c89e4eSSatish Balay 2249e5c89e4eSSatish Balay Input Parameters: 22505c9cc608SHong Zhang + options - options database, use NULL for default global database 2251c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2252e5c89e4eSSatish Balay - name - the option one is seeking 2253e5c89e4eSSatish Balay 2254e5c89e4eSSatish Balay Output Parameter: 2255e5c89e4eSSatish Balay + dvalue - the double value to return 225696ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2257e5c89e4eSSatish Balay 2258e5c89e4eSSatish Balay Level: beginner 2259e5c89e4eSSatish Balay 2260e5c89e4eSSatish Balay Usage: 2261eb4ae41dSBarry Smith A complex number 2+3i must be specified with NO spaces 2262e5c89e4eSSatish Balay 226395452b02SPatrick Sanan Notes: 226495452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 22652efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2266e4974155SBarry Smith 2267e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2268acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2269e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2270e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2271acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2272a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2273e5c89e4eSSatish Balay @*/ 2274c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetScalar(PetscOptions options,const char pre[],const char name[],PetscScalar *dvalue,PetscBool *set) 2275e5c89e4eSSatish Balay { 22762d747510SLisandro Dalcin const char *value; 2277ace3abfcSBarry Smith PetscBool flag; 2278e5c89e4eSSatish Balay PetscErrorCode ierr; 2279e5c89e4eSSatish Balay 2280e5c89e4eSSatish Balay PetscFunctionBegin; 22812d747510SLisandro Dalcin PetscValidCharPointer(name,3); 22822d747510SLisandro Dalcin PetscValidScalarPointer(dvalue,4); 22832d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2284e5c89e4eSSatish Balay if (flag) { 2285e5c89e4eSSatish Balay if (!value) { 228696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2287e5c89e4eSSatish Balay } else { 2288e5c89e4eSSatish Balay #if !defined(PETSC_USE_COMPLEX) 2289cfbddea1SSatish Balay ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2290e5c89e4eSSatish Balay #else 2291eb4ae41dSBarry Smith ierr = PetscOptionsStringToScalar(value,dvalue);CHKERRQ(ierr); 2292e5c89e4eSSatish Balay #endif 229396ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2294e5c89e4eSSatish Balay } 2295e5c89e4eSSatish Balay } else { /* flag */ 229696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2297e5c89e4eSSatish Balay } 2298e5c89e4eSSatish Balay PetscFunctionReturn(0); 2299e5c89e4eSSatish Balay } 2300e5c89e4eSSatish Balay 2301e5c89e4eSSatish Balay /*@C 2302e5c89e4eSSatish Balay PetscOptionsGetString - Gets the string value for a particular option in 2303e5c89e4eSSatish Balay the database. 2304e5c89e4eSSatish Balay 2305e5c89e4eSSatish Balay Not Collective 2306e5c89e4eSSatish Balay 2307e5c89e4eSSatish Balay Input Parameters: 23085c9cc608SHong Zhang + options - options database, use NULL for default global database 2309c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2310e5c89e4eSSatish Balay . name - the option one is seeking 2311bcbf2dc5SJed Brown - len - maximum length of the string including null termination 2312e5c89e4eSSatish Balay 2313e5c89e4eSSatish Balay Output Parameters: 2314e5c89e4eSSatish Balay + string - location to copy string 231596ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2316e5c89e4eSSatish Balay 2317e5c89e4eSSatish Balay Level: beginner 2318e5c89e4eSSatish Balay 2319e5c89e4eSSatish Balay Fortran Note: 2320e5c89e4eSSatish Balay The Fortran interface is slightly different from the C/C++ 2321e5c89e4eSSatish Balay interface (len is not used). Sample usage in Fortran follows 2322e5c89e4eSSatish Balay .vb 2323e5c89e4eSSatish Balay character *20 string 232493e6ba5cSBarry Smith PetscErrorCode ierr 232593e6ba5cSBarry Smith PetscBool set 23261b266c99SBarry Smith call PetscOptionsGetString(PETSC_NULL_OPTIONS,PETSC_NULL_CHARACTER,'-s',string,set,ierr) 2327e5c89e4eSSatish Balay .ve 2328e5c89e4eSSatish Balay 232995452b02SPatrick Sanan Notes: 233095452b02SPatrick 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 2331e4974155SBarry Smith 23322efd9cb1SBarry Smith If the user does not use the option then the string is not changed. Thus 23332efd9cb1SBarry Smith you should ALWAYS initialize the string if you access it without first checking if the set flag is true. 23342efd9cb1SBarry Smith 2335f3dea69dSBarry Smith Note: 2336f3dea69dSBarry 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). 2337f3dea69dSBarry Smith 2338e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2339acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2340e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2341e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2342acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2343a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2344e5c89e4eSSatish Balay @*/ 2345c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetString(PetscOptions options,const char pre[],const char name[],char string[],size_t len,PetscBool *set) 2346e5c89e4eSSatish Balay { 23472d747510SLisandro Dalcin const char *value; 2348ace3abfcSBarry Smith PetscBool flag; 23492d747510SLisandro Dalcin PetscErrorCode ierr; 2350e5c89e4eSSatish Balay 2351e5c89e4eSSatish Balay PetscFunctionBegin; 23522d747510SLisandro Dalcin PetscValidCharPointer(name,3); 23532d747510SLisandro Dalcin PetscValidCharPointer(string,4); 23542d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2355e5c89e4eSSatish Balay if (!flag) { 235696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2357e5c89e4eSSatish Balay } else { 235896ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2359e5c89e4eSSatish Balay if (value) { 2360e5c89e4eSSatish Balay ierr = PetscStrncpy(string,value,len);CHKERRQ(ierr); 2361e5c89e4eSSatish Balay } else { 2362e5c89e4eSSatish Balay ierr = PetscMemzero(string,len);CHKERRQ(ierr); 2363e5c89e4eSSatish Balay } 2364e5c89e4eSSatish Balay } 2365e5c89e4eSSatish Balay PetscFunctionReturn(0); 2366e5c89e4eSSatish Balay } 2367e5c89e4eSSatish Balay 2368c5929fdfSBarry Smith char *PetscOptionsGetStringMatlab(PetscOptions options,const char pre[],const char name[]) 236914ce751eSBarry Smith { 23702d747510SLisandro Dalcin const char *value; 237114ce751eSBarry Smith PetscBool flag; 23722d747510SLisandro Dalcin PetscErrorCode ierr; 237314ce751eSBarry Smith 237414ce751eSBarry Smith PetscFunctionBegin; 23752d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);if (ierr) PetscFunctionReturn(0); 23762d747510SLisandro Dalcin if (flag) PetscFunctionReturn((char*)value); 237714ce751eSBarry Smith else PetscFunctionReturn(0); 237814ce751eSBarry Smith } 237914ce751eSBarry Smith 23802d747510SLisandro Dalcin /*@C 23812d747510SLisandro Dalcin PetscOptionsGetBoolArray - Gets an array of Logical (true or false) values for a particular 23822d747510SLisandro Dalcin option in the database. The values must be separated with commas with 23832d747510SLisandro Dalcin no intervening spaces. 23842d747510SLisandro Dalcin 23852d747510SLisandro Dalcin Not Collective 23862d747510SLisandro Dalcin 23872d747510SLisandro Dalcin Input Parameters: 23882d747510SLisandro Dalcin + options - options database, use NULL for default global database 23892d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 23902d747510SLisandro Dalcin . name - the option one is seeking 23912d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 23922d747510SLisandro Dalcin 23932d747510SLisandro Dalcin Output Parameter: 23942d747510SLisandro Dalcin + dvalue - the integer values to return 23952d747510SLisandro Dalcin . nmax - actual number of values retreived 23962d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 23972d747510SLisandro Dalcin 23982d747510SLisandro Dalcin Level: beginner 23992d747510SLisandro Dalcin 24002d747510SLisandro Dalcin Notes: 24012d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 24022d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 24032d747510SLisandro Dalcin 24042d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 24052d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 24062d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 24072d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 24082d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 24092d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 24102d747510SLisandro Dalcin @*/ 24112d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBoolArray(PetscOptions options,const char pre[],const char name[],PetscBool dvalue[],PetscInt *nmax,PetscBool *set) 24122d747510SLisandro Dalcin { 24132d747510SLisandro Dalcin const char *svalue; 24142d747510SLisandro Dalcin char *value; 24152d747510SLisandro Dalcin PetscErrorCode ierr; 24162d747510SLisandro Dalcin PetscInt n = 0; 24172d747510SLisandro Dalcin PetscBool flag; 24182d747510SLisandro Dalcin PetscToken token; 24192d747510SLisandro Dalcin 24202d747510SLisandro Dalcin PetscFunctionBegin; 24212d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24222d747510SLisandro Dalcin PetscValidIntPointer(dvalue,4); 24232d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 24242d747510SLisandro Dalcin 24252d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 24262d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 24272d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 24282d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 24292d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 24302d747510SLisandro Dalcin while (value && n < *nmax) { 24312d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value,dvalue);CHKERRQ(ierr); 24322d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 24332d747510SLisandro Dalcin dvalue++; 24342d747510SLisandro Dalcin n++; 24352d747510SLisandro Dalcin } 24362d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 24372d747510SLisandro Dalcin *nmax = n; 24382d747510SLisandro Dalcin PetscFunctionReturn(0); 24392d747510SLisandro Dalcin } 24402d747510SLisandro Dalcin 24412d747510SLisandro Dalcin /*@C 24422d747510SLisandro Dalcin PetscOptionsGetEnumArray - Gets an array of enum values for a particular option in the database. 24432d747510SLisandro Dalcin 24442d747510SLisandro Dalcin Not Collective 24452d747510SLisandro Dalcin 24462d747510SLisandro Dalcin Input Parameters: 24472d747510SLisandro Dalcin + options - options database, use NULL for default global database 24482d747510SLisandro Dalcin . pre - option prefix or NULL 24492d747510SLisandro Dalcin . name - option name 24502d747510SLisandro Dalcin . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 24512d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 24522d747510SLisandro Dalcin 24532d747510SLisandro Dalcin Output Parameters: 24542d747510SLisandro Dalcin + ivalue - the enum values to return 24552d747510SLisandro Dalcin . nmax - actual number of values retreived 24562d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 24572d747510SLisandro Dalcin 24582d747510SLisandro Dalcin Level: beginner 24592d747510SLisandro Dalcin 24602d747510SLisandro Dalcin Notes: 24612d747510SLisandro Dalcin The array must be passed as a comma separated list. 24622d747510SLisandro Dalcin 24632d747510SLisandro Dalcin There must be no intervening spaces between the values. 24642d747510SLisandro Dalcin 24652d747510SLisandro Dalcin list is usually something like PCASMTypes or some other predefined list of enum names. 24662d747510SLisandro Dalcin 24672d747510SLisandro Dalcin .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 24682d747510SLisandro Dalcin PetscOptionsGetEnum(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 24692d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), 24702d747510SLisandro Dalcin PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), 24712d747510SLisandro Dalcin PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 24722d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 24732d747510SLisandro Dalcin @*/ 24742d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetEnumArray(PetscOptions options,const char pre[],const char name[],const char *const *list,PetscEnum ivalue[],PetscInt *nmax,PetscBool *set) 24752d747510SLisandro Dalcin { 24762d747510SLisandro Dalcin const char *svalue; 24772d747510SLisandro Dalcin char *value; 24782d747510SLisandro Dalcin PetscInt n = 0; 24792d747510SLisandro Dalcin PetscEnum evalue; 24802d747510SLisandro Dalcin PetscBool flag; 24812d747510SLisandro Dalcin PetscToken token; 24822d747510SLisandro Dalcin PetscErrorCode ierr; 24832d747510SLisandro Dalcin 24842d747510SLisandro Dalcin PetscFunctionBegin; 24852d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24862d747510SLisandro Dalcin PetscValidPointer(list,4); 24872d747510SLisandro Dalcin PetscValidPointer(ivalue,5); 24882d747510SLisandro Dalcin PetscValidIntPointer(nmax,6); 24892d747510SLisandro Dalcin 24902d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 24912d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 24922d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 24932d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 24942d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 24952d747510SLisandro Dalcin while (value && n < *nmax) { 24962d747510SLisandro Dalcin ierr = PetscEnumFind(list,value,&evalue,&flag);CHKERRQ(ierr); 24972d747510SLisandro Dalcin if (!flag) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown enum value '%s' for -%s%s",svalue,pre ? pre : "",name+1); 24982d747510SLisandro Dalcin ivalue[n++] = evalue; 24992d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 25002d747510SLisandro Dalcin } 25012d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 25022d747510SLisandro Dalcin *nmax = n; 25032d747510SLisandro Dalcin PetscFunctionReturn(0); 25042d747510SLisandro Dalcin } 25052d747510SLisandro Dalcin 25062d747510SLisandro Dalcin /*@C 25072d747510SLisandro Dalcin PetscOptionsGetIntArray - Gets an array of integer values for a particular 25082d747510SLisandro Dalcin option in the database. 25092d747510SLisandro Dalcin 25102d747510SLisandro Dalcin Not Collective 25112d747510SLisandro Dalcin 25122d747510SLisandro Dalcin Input Parameters: 25132d747510SLisandro Dalcin + options - options database, use NULL for default global database 25142d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 25152d747510SLisandro Dalcin . name - the option one is seeking 25162d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 25172d747510SLisandro Dalcin 25182d747510SLisandro Dalcin Output Parameter: 25192d747510SLisandro Dalcin + ivalue - the integer values to return 25202d747510SLisandro Dalcin . nmax - actual number of values retreived 25212d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 25222d747510SLisandro Dalcin 25232d747510SLisandro Dalcin Level: beginner 25242d747510SLisandro Dalcin 25252d747510SLisandro Dalcin Notes: 25262d747510SLisandro Dalcin The array can be passed as 25272d747510SLisandro Dalcin a comma separated list: 0,1,2,3,4,5,6,7 25282d747510SLisandro Dalcin a range (start-end+1): 0-8 25292d747510SLisandro Dalcin a range with given increment (start-end+1:inc): 0-7:2 25302d747510SLisandro Dalcin a combination of values and ranges separated by commas: 0,1-8,8-15:2 25312d747510SLisandro Dalcin 25322d747510SLisandro Dalcin There must be no intervening spaces between the values. 25332d747510SLisandro Dalcin 25342d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 25352d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 25362d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 25372d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 25382d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 25392d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 25402d747510SLisandro Dalcin @*/ 25412d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetIntArray(PetscOptions options,const char pre[],const char name[],PetscInt ivalue[],PetscInt *nmax,PetscBool *set) 25422d747510SLisandro Dalcin { 25432d747510SLisandro Dalcin const char *svalue; 25442d747510SLisandro Dalcin char *value; 25452d747510SLisandro Dalcin PetscErrorCode ierr; 25462d747510SLisandro Dalcin PetscInt n = 0,i,j,start,end,inc,nvalues; 25472d747510SLisandro Dalcin size_t len; 25482d747510SLisandro Dalcin PetscBool flag,foundrange; 25492d747510SLisandro Dalcin PetscToken token; 25502d747510SLisandro Dalcin 25512d747510SLisandro Dalcin PetscFunctionBegin; 25522d747510SLisandro Dalcin PetscValidCharPointer(name,3); 25532d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 25542d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 25552d747510SLisandro Dalcin 25562d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 25572d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 25582d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 25592d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 25602d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 25612d747510SLisandro Dalcin while (value && n < *nmax) { 25622d747510SLisandro Dalcin /* look for form d-D where d and D are integers */ 25632d747510SLisandro Dalcin foundrange = PETSC_FALSE; 25642d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 25652d747510SLisandro Dalcin if (value[0] == '-') i=2; 25662d747510SLisandro Dalcin else i=1; 25672d747510SLisandro Dalcin for (;i<(int)len; i++) { 25682d747510SLisandro Dalcin if (value[i] == '-') { 25692d747510SLisandro Dalcin if (i == (int)len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value); 25702d747510SLisandro Dalcin value[i] = 0; 25712d747510SLisandro Dalcin 25722d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,&start);CHKERRQ(ierr); 25732d747510SLisandro Dalcin inc = 1; 25742d747510SLisandro Dalcin j = i+1; 25752d747510SLisandro Dalcin for (;j<(int)len; j++) { 25762d747510SLisandro Dalcin if (value[j] == ':') { 25772d747510SLisandro Dalcin value[j] = 0; 25782d747510SLisandro Dalcin 25792d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+j+1,&inc);CHKERRQ(ierr); 25802d747510SLisandro Dalcin if (inc <= 0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry,%s cannot have negative increment",n,value+j+1); 25812d747510SLisandro Dalcin break; 25822d747510SLisandro Dalcin } 25832d747510SLisandro Dalcin } 25842d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+i+1,&end);CHKERRQ(ierr); 25852d747510SLisandro Dalcin if (end <= start) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry, %s-%s cannot have decreasing list",n,value,value+i+1); 25862d747510SLisandro Dalcin nvalues = (end-start)/inc + (end-start)%inc; 25872d747510SLisandro Dalcin if (n + nvalues > *nmax) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry, not enough space left in array (%D) to contain entire range from %D to %D",n,*nmax-n,start,end); 25882d747510SLisandro Dalcin for (;start<end; start+=inc) { 25892d747510SLisandro Dalcin *ivalue = start; ivalue++;n++; 25902d747510SLisandro Dalcin } 25912d747510SLisandro Dalcin foundrange = PETSC_TRUE; 25922d747510SLisandro Dalcin break; 25932d747510SLisandro Dalcin } 25942d747510SLisandro Dalcin } 25952d747510SLisandro Dalcin if (!foundrange) { 25962d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 25972d747510SLisandro Dalcin ivalue++; 25982d747510SLisandro Dalcin n++; 25992d747510SLisandro Dalcin } 26002d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26012d747510SLisandro Dalcin } 26022d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26032d747510SLisandro Dalcin *nmax = n; 26042d747510SLisandro Dalcin PetscFunctionReturn(0); 26052d747510SLisandro Dalcin } 26062d747510SLisandro Dalcin 26072d747510SLisandro Dalcin /*@C 26082d747510SLisandro Dalcin PetscOptionsGetRealArray - Gets an array of double precision values for a 26092d747510SLisandro Dalcin particular option in the database. The values must be separated with 26102d747510SLisandro Dalcin commas with no intervening spaces. 26112d747510SLisandro Dalcin 26122d747510SLisandro Dalcin Not Collective 26132d747510SLisandro Dalcin 26142d747510SLisandro Dalcin Input Parameters: 26152d747510SLisandro Dalcin + options - options database, use NULL for default global database 26162d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 26172d747510SLisandro Dalcin . name - the option one is seeking 26182d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 26192d747510SLisandro Dalcin 26202d747510SLisandro Dalcin Output Parameters: 26212d747510SLisandro Dalcin + dvalue - the double values to return 26222d747510SLisandro Dalcin . nmax - actual number of values retreived 26232d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26242d747510SLisandro Dalcin 26252d747510SLisandro Dalcin Level: beginner 26262d747510SLisandro Dalcin 26272d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 26282d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 26292d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 26302d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 26312d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26322d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 26332d747510SLisandro Dalcin @*/ 26342d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetRealArray(PetscOptions options,const char pre[],const char name[],PetscReal dvalue[],PetscInt *nmax,PetscBool *set) 26352d747510SLisandro Dalcin { 26362d747510SLisandro Dalcin const char *svalue; 26372d747510SLisandro Dalcin char *value; 26382d747510SLisandro Dalcin PetscErrorCode ierr; 26392d747510SLisandro Dalcin PetscInt n = 0; 26402d747510SLisandro Dalcin PetscBool flag; 26412d747510SLisandro Dalcin PetscToken token; 26422d747510SLisandro Dalcin 26432d747510SLisandro Dalcin PetscFunctionBegin; 26442d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26452d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 26462d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 26472d747510SLisandro Dalcin 26482d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 26492d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26502d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26512d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26522d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26532d747510SLisandro Dalcin while (value && n < *nmax) { 26542d747510SLisandro Dalcin ierr = PetscOptionsStringToReal(value,dvalue++);CHKERRQ(ierr); 26552d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26562d747510SLisandro Dalcin n++; 26572d747510SLisandro Dalcin } 26582d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26592d747510SLisandro Dalcin *nmax = n; 26602d747510SLisandro Dalcin PetscFunctionReturn(0); 26612d747510SLisandro Dalcin } 26622d747510SLisandro Dalcin 26632d747510SLisandro Dalcin /*@C 26642d747510SLisandro Dalcin PetscOptionsGetScalarArray - Gets an array of scalars for a 26652d747510SLisandro Dalcin particular option in the database. The values must be separated with 26662d747510SLisandro Dalcin commas with no intervening spaces. 26672d747510SLisandro Dalcin 26682d747510SLisandro Dalcin Not Collective 26692d747510SLisandro Dalcin 26702d747510SLisandro Dalcin Input Parameters: 26712d747510SLisandro Dalcin + options - options database, use NULL for default global database 26722d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 26732d747510SLisandro Dalcin . name - the option one is seeking 26742d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 26752d747510SLisandro Dalcin 26762d747510SLisandro Dalcin Output Parameters: 26772d747510SLisandro Dalcin + dvalue - the scalar values to return 26782d747510SLisandro Dalcin . nmax - actual number of values retreived 26792d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26802d747510SLisandro Dalcin 26812d747510SLisandro Dalcin Level: beginner 26822d747510SLisandro Dalcin 26832d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 26842d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 26852d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 26862d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 26872d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26882d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 26892d747510SLisandro Dalcin @*/ 26902d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set) 26912d747510SLisandro Dalcin { 26922d747510SLisandro Dalcin const char *svalue; 26932d747510SLisandro Dalcin char *value; 26942d747510SLisandro Dalcin PetscErrorCode ierr; 26952d747510SLisandro Dalcin PetscInt n = 0; 26962d747510SLisandro Dalcin PetscBool flag; 26972d747510SLisandro Dalcin PetscToken token; 26982d747510SLisandro Dalcin 26992d747510SLisandro Dalcin PetscFunctionBegin; 27002d747510SLisandro Dalcin PetscValidCharPointer(name,3); 27012d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 27022d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 27032d747510SLisandro Dalcin 27042d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 27052d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 27062d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 27072d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 27082d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27092d747510SLisandro Dalcin while (value && n < *nmax) { 27102d747510SLisandro Dalcin ierr = PetscOptionsStringToScalar(value,dvalue++);CHKERRQ(ierr); 27112d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27122d747510SLisandro Dalcin n++; 27132d747510SLisandro Dalcin } 27142d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 27152d747510SLisandro Dalcin *nmax = n; 27162d747510SLisandro Dalcin PetscFunctionReturn(0); 27172d747510SLisandro Dalcin } 271814ce751eSBarry Smith 2719e5c89e4eSSatish Balay /*@C 2720e5c89e4eSSatish Balay PetscOptionsGetStringArray - Gets an array of string values for a particular 2721e5c89e4eSSatish Balay option in the database. The values must be separated with commas with 2722e5c89e4eSSatish Balay no intervening spaces. 2723e5c89e4eSSatish Balay 2724e5c89e4eSSatish Balay Not Collective 2725e5c89e4eSSatish Balay 2726e5c89e4eSSatish Balay Input Parameters: 27275c9cc608SHong Zhang + options - options database, use NULL for default global database 2728c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2729e5c89e4eSSatish Balay . name - the option one is seeking 2730e5c89e4eSSatish Balay - nmax - maximum number of strings 2731e5c89e4eSSatish Balay 2732e5c89e4eSSatish Balay Output Parameter: 2733e5c89e4eSSatish Balay + strings - location to copy strings 273496ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2735e5c89e4eSSatish Balay 2736e5c89e4eSSatish Balay Level: beginner 2737e5c89e4eSSatish Balay 2738e5c89e4eSSatish Balay Notes: 2739e5c89e4eSSatish Balay The user should pass in an array of pointers to char, to hold all the 2740e5c89e4eSSatish Balay strings returned by this function. 2741e5c89e4eSSatish Balay 2742e5c89e4eSSatish Balay The user is responsible for deallocating the strings that are 2743e5c89e4eSSatish Balay returned. The Fortran interface for this routine is not supported. 2744e5c89e4eSSatish Balay 2745e5c89e4eSSatish Balay Contributed by Matthew Knepley. 2746e5c89e4eSSatish Balay 2747e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2748acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2749e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2750e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2751acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2752a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2753e5c89e4eSSatish Balay @*/ 2754c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetStringArray(PetscOptions options,const char pre[],const char name[],char *strings[],PetscInt *nmax,PetscBool *set) 2755e5c89e4eSSatish Balay { 27562d747510SLisandro Dalcin const char *svalue; 2757e5c89e4eSSatish Balay char *value; 2758e5c89e4eSSatish Balay PetscErrorCode ierr; 27592d747510SLisandro Dalcin PetscInt n = 0; 2760ace3abfcSBarry Smith PetscBool flag; 27619c9d3cfdSBarry Smith PetscToken token; 2762e5c89e4eSSatish Balay 2763e5c89e4eSSatish Balay PetscFunctionBegin; 27642d747510SLisandro Dalcin PetscValidCharPointer(name,3); 27652d747510SLisandro Dalcin PetscValidPointer(strings,4); 27662d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 2767e5c89e4eSSatish Balay 27682d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 27692d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 27702d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 27712d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 2772e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27732d747510SLisandro Dalcin while (value && n < *nmax) { 2774e5c89e4eSSatish Balay ierr = PetscStrallocpy(value,&strings[n]);CHKERRQ(ierr); 2775e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 2776e5c89e4eSSatish Balay n++; 2777e5c89e4eSSatish Balay } 27788c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 2779e5c89e4eSSatish Balay *nmax = n; 2780e5c89e4eSSatish Balay PetscFunctionReturn(0); 2781e5c89e4eSSatish Balay } 278206824ed3SPatrick Sanan 278306824ed3SPatrick Sanan /*@C 278406824ed3SPatrick Sanan PetscOptionsDeprecated - mark an option as deprecated, optionally replacing it with a new one 278506824ed3SPatrick Sanan 278606824ed3SPatrick Sanan Prints a deprecation warning, unless an option is supplied to suppress. 278706824ed3SPatrick Sanan 278806824ed3SPatrick Sanan Not Collective 278906824ed3SPatrick Sanan 279006824ed3SPatrick Sanan Input Parameters: 27919503aa97SPatrick Sanan + pre - string to prepend to name or NULL 279206824ed3SPatrick Sanan . oldname - the old, deprecated option 279306824ed3SPatrick Sanan . newname - the new option, or NULL if option is purely removed 27949f3a6782SPatrick Sanan . version - a string describing the version of first deprecation, e.g. "3.9" 27959f3a6782SPatrick Sanan - info - additional information string, or NULL. 279606824ed3SPatrick Sanan 279706824ed3SPatrick Sanan Options Database Keys: 279806824ed3SPatrick Sanan . -options_suppress_deprecated_warnings - do not print deprecation warnings 279906824ed3SPatrick Sanan 280006824ed3SPatrick Sanan Notes: 2801b40114eaSPatrick Sanan Must be called between PetscOptionsBegin() and PetscOptionsEnd(). 2802b40114eaSPatrick Sanan If newname is provided, the old option is replaced. Otherwise, it remains 2803b40114eaSPatrick Sanan in the options database. 28049f3a6782SPatrick Sanan If an option is not replaced, the info argument should be used to advise the user 28059f3a6782SPatrick Sanan on how to proceed. 28069f3a6782SPatrick Sanan There is a limit on the length of the warning printed, so very long strings 28079f3a6782SPatrick Sanan provided as info may be truncated. 280806824ed3SPatrick Sanan 280906824ed3SPatrick Sanan Level: developer 281006824ed3SPatrick Sanan 281106824ed3SPatrick Sanan .seealso: PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsScalar(), PetscOptionsBool(), PetscOptionsString(), PetscOptionsSetValue() 281206824ed3SPatrick Sanan 281306824ed3SPatrick Sanan @*/ 28149f3a6782SPatrick Sanan PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems *PetscOptionsObject,const char oldname[],const char newname[],const char version[],const char info[]) 281506824ed3SPatrick Sanan { 281606824ed3SPatrick Sanan PetscErrorCode ierr; 281706824ed3SPatrick Sanan PetscBool found,quiet; 281806824ed3SPatrick Sanan const char *value; 281906824ed3SPatrick Sanan const char * const quietopt="-options_suppress_deprecated_warnings"; 28209f3a6782SPatrick Sanan char msg[4096]; 282106824ed3SPatrick Sanan 282206824ed3SPatrick Sanan PetscFunctionBegin; 282306824ed3SPatrick Sanan PetscValidCharPointer(oldname,2); 282406824ed3SPatrick Sanan PetscValidCharPointer(version,4); 282506824ed3SPatrick Sanan 282606824ed3SPatrick Sanan ierr = PetscOptionsFindPair(PetscOptionsObject->options,PetscOptionsObject->prefix,oldname,&value,&found);CHKERRQ(ierr); 282706824ed3SPatrick Sanan if (found) { 282806824ed3SPatrick Sanan if (newname) { 2829d255429eSPatrick Sanan if (PetscOptionsObject->prefix) { 283006824ed3SPatrick Sanan ierr = PetscOptionsPrefixPush(PetscOptionsObject->options,PetscOptionsObject->prefix);CHKERRQ(ierr); 2831d255429eSPatrick Sanan } 283206824ed3SPatrick Sanan ierr = PetscOptionsSetValue(PetscOptionsObject->options,newname,value);CHKERRQ(ierr); 2833d255429eSPatrick Sanan if (PetscOptionsObject->prefix) { 283406824ed3SPatrick Sanan ierr = PetscOptionsPrefixPop(PetscOptionsObject->options);CHKERRQ(ierr); 2835d255429eSPatrick Sanan } 283606824ed3SPatrick Sanan ierr = PetscOptionsClearValue(PetscOptionsObject->options,oldname);CHKERRQ(ierr); 2837b40114eaSPatrick Sanan } 283806824ed3SPatrick Sanan quiet = PETSC_FALSE; 283906824ed3SPatrick Sanan ierr = PetscOptionsGetBool(PetscOptionsObject->options,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr); 284006824ed3SPatrick Sanan if (!quiet) { 28419f3a6782SPatrick Sanan ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr); 28421fa95f81SSatish Balay ierr = PetscStrcat(msg,oldname);CHKERRQ(ierr); 2843928bb9adSStefano Zampini ierr = PetscStrcat(msg," is deprecated as of version ");CHKERRQ(ierr); 28449f3a6782SPatrick Sanan ierr = PetscStrcat(msg,version);CHKERRQ(ierr); 28459f3a6782SPatrick Sanan ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr); 284606824ed3SPatrick Sanan if (newname) { 28479f3a6782SPatrick Sanan ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr); 28489f3a6782SPatrick Sanan ierr = PetscStrcat(msg,newname);CHKERRQ(ierr); 28499f3a6782SPatrick Sanan ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr); 285006824ed3SPatrick Sanan } 28519f3a6782SPatrick Sanan if (info) { 28529f3a6782SPatrick Sanan ierr = PetscStrcat(msg," ");CHKERRQ(ierr); 28539f3a6782SPatrick Sanan ierr = PetscStrcat(msg,info);CHKERRQ(ierr); 28549f3a6782SPatrick Sanan } 28559f3a6782SPatrick Sanan ierr = PetscStrcat(msg," (Silence this warning with ");CHKERRQ(ierr); 28569f3a6782SPatrick Sanan ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr); 28579f3a6782SPatrick Sanan ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr); 28589f3a6782SPatrick Sanan ierr = PetscPrintf(PetscOptionsObject->comm,msg);CHKERRQ(ierr); 285906824ed3SPatrick Sanan } 286006824ed3SPatrick Sanan } 286106824ed3SPatrick Sanan PetscFunctionReturn(0); 286206824ed3SPatrick Sanan } 2863