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 { 772d747510SLisandro Dalcin int N; /* number of options */ 782d747510SLisandro Dalcin char *names[MAXOPTIONS]; /* option names */ 792d747510SLisandro Dalcin char *values[MAXOPTIONS]; /* option values */ 802d747510SLisandro Dalcin PetscBool used[MAXOPTIONS]; /* flag option use */ 81081c24baSBoyana Norris 822d747510SLisandro Dalcin /* Hash table */ 832d747510SLisandro Dalcin khash_t(HO) *ht; 842d747510SLisandro Dalcin 852d747510SLisandro Dalcin /* Prefixes */ 862d747510SLisandro Dalcin int prefixind; 872d747510SLisandro Dalcin int prefixstack[MAXPREFIXES]; 882d747510SLisandro Dalcin char prefix[MAXOPTNAME]; 892d747510SLisandro Dalcin 902d747510SLisandro Dalcin /* Aliases */ 912d747510SLisandro Dalcin int Naliases; /* number or aliases */ 922d747510SLisandro Dalcin char *aliases1[MAXALIASES]; /* aliased */ 932d747510SLisandro Dalcin char *aliases2[MAXALIASES]; /* aliasee */ 942d747510SLisandro Dalcin 952d747510SLisandro Dalcin /* Help */ 962d747510SLisandro Dalcin PetscBool help; /* flag whether "-help" is in the database */ 972d747510SLisandro Dalcin 982d747510SLisandro Dalcin /* Monitors */ 99081c24baSBoyana Norris PetscErrorCode (*monitor[MAXOPTIONSMONITORS])(const char[],const char[],void*); /* returns control to user after */ 100c2efdce3SBarry Smith PetscErrorCode (*monitordestroy[MAXOPTIONSMONITORS])(void**); /* */ 101081c24baSBoyana Norris void *monitorcontext[MAXOPTIONSMONITORS]; /* to pass arbitrary user data into monitor */ 102081c24baSBoyana Norris PetscInt numbermonitors; /* to, for instance, detect options being set */ 1034416b707SBarry Smith }; 104e5c89e4eSSatish Balay 1054416b707SBarry Smith static PetscOptions defaultoptions = NULL; 106f8d0b74dSMatthew Knepley 1072d747510SLisandro Dalcin 108081c24baSBoyana Norris /* 109081c24baSBoyana Norris Options events monitor 110081c24baSBoyana Norris */ 1112d747510SLisandro Dalcin static PetscErrorCode PetscOptionsMonitor(PetscOptions options,const char name[],const char value[]) 112e5c89e4eSSatish Balay { 1132d747510SLisandro Dalcin PetscInt i; 114e5c89e4eSSatish Balay PetscErrorCode ierr; 115e5c89e4eSSatish Balay 1162d747510SLisandro Dalcin if (!PetscInitializeCalled) return 0; 117e5c89e4eSSatish Balay PetscFunctionBegin; 1182d747510SLisandro Dalcin for (i=0; i<options->numbermonitors; i++) { 1192d747510SLisandro Dalcin ierr = (*options->monitor[i])(name,value,options->monitorcontext[i]);CHKERRQ(ierr); 120e5c89e4eSSatish Balay } 121e5c89e4eSSatish Balay PetscFunctionReturn(0); 122e5c89e4eSSatish Balay } 123e5c89e4eSSatish Balay 1242d747510SLisandro Dalcin /*@ 1252d747510SLisandro Dalcin PetscOptionsCreate - Creates an empty options database. 126e5c89e4eSSatish Balay 127e5c89e4eSSatish Balay Output Parameter: 1282d747510SLisandro Dalcin . options - Options database object 129e5c89e4eSSatish Balay 130e5c89e4eSSatish Balay Level: advanced 131e5c89e4eSSatish Balay 1322d747510SLisandro Dalcin .seealso: PetscOptionsDestroy() 133e5c89e4eSSatish Balay @*/ 1342d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreate(PetscOptions *options) 1352d747510SLisandro Dalcin { 1362d747510SLisandro Dalcin if (!options) return PETSC_ERR_ARG_NULL; 1372d747510SLisandro Dalcin *options = (PetscOptions)calloc(1,sizeof(**options)); 1382d747510SLisandro Dalcin if (!*options) return PETSC_ERR_MEM; 1392d747510SLisandro Dalcin return 0; 1402d747510SLisandro Dalcin } 1412d747510SLisandro Dalcin 1422d747510SLisandro Dalcin /*@ 1432d747510SLisandro Dalcin PetscOptionsDestroy - Destroys an option database. 1442d747510SLisandro Dalcin 1452d747510SLisandro Dalcin Input Parameter: 1462d747510SLisandro Dalcin . options - the PetscOptions object 1472d747510SLisandro Dalcin 1482d747510SLisandro Dalcin Level: developer 1492d747510SLisandro Dalcin 1502d747510SLisandro Dalcin .seealso: PetscOptionsInsert() 1512d747510SLisandro Dalcin @*/ 1522d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroy(PetscOptions *options) 153e5c89e4eSSatish Balay { 154e5c89e4eSSatish Balay PetscErrorCode ierr; 155e5c89e4eSSatish Balay 1562d747510SLisandro Dalcin if (!*options) return 0; 1572d747510SLisandro Dalcin ierr = PetscOptionsClear(*options);if (ierr) return ierr; 1582d747510SLisandro Dalcin /* XXX what about monitors ? */ 1592800570dSLisandro Dalcin free(*options); 1602d747510SLisandro Dalcin *options = NULL; 161e5c89e4eSSatish Balay PetscFunctionReturn(0); 162e5c89e4eSSatish Balay } 163e5c89e4eSSatish Balay 1642d747510SLisandro Dalcin /* 1652d747510SLisandro Dalcin PetscOptionsCreateDefault - Creates the default global options database 1662d747510SLisandro Dalcin */ 1672d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreateDefault(void) 168e5c89e4eSSatish Balay { 169e5c89e4eSSatish Balay PetscErrorCode ierr; 170e5c89e4eSSatish Balay 1712d747510SLisandro Dalcin if (!defaultoptions) { 1722d747510SLisandro Dalcin ierr = PetscOptionsCreate(&defaultoptions);if (ierr) return ierr; 1732d747510SLisandro Dalcin } 1742d747510SLisandro Dalcin return 0; 1752d747510SLisandro Dalcin } 1762d747510SLisandro Dalcin 1772d747510SLisandro Dalcin /* 1782d747510SLisandro Dalcin PetscOptionsDestroyDefault - Destroys the default global options database 1792d747510SLisandro Dalcin */ 1802d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroyDefault(void) 1812d747510SLisandro Dalcin { 1822d747510SLisandro Dalcin PetscErrorCode ierr; 1832d747510SLisandro Dalcin 1842d747510SLisandro Dalcin ierr = PetscOptionsDestroy(&defaultoptions);if (ierr) return ierr; 1852d747510SLisandro Dalcin return 0; 186e5c89e4eSSatish Balay } 187e5c89e4eSSatish Balay 18894ef8ddeSSatish Balay /*@C 1897cd08cecSJed Brown PetscOptionsValidKey - PETSc Options database keys must begin with one or two dashes (-) followed by a letter. 1903fc1eb6aSBarry Smith 1913fc1eb6aSBarry Smith Input Parameter: 1922d747510SLisandro Dalcin . key - string to check if valid 1933fc1eb6aSBarry Smith 1943fc1eb6aSBarry Smith Output Parameter: 1952d747510SLisandro Dalcin . valid - PETSC_TRUE if a valid key 1963fc1eb6aSBarry Smith 197f6680f47SSatish Balay Level: intermediate 1983fc1eb6aSBarry Smith @*/ 1992d747510SLisandro Dalcin PetscErrorCode PetscOptionsValidKey(const char key[],PetscBool *valid) 20096fc60bcSBarry Smith { 201f603b5e9SToby Isaac char *ptr; 2027c5db45bSBarry Smith 20396fc60bcSBarry Smith PetscFunctionBegin; 2042d747510SLisandro Dalcin if (key) PetscValidCharPointer(key,1); 2052d747510SLisandro Dalcin PetscValidPointer(valid,2); 2062d747510SLisandro Dalcin *valid = PETSC_FALSE; 2072d747510SLisandro Dalcin if (!key) PetscFunctionReturn(0); 2082d747510SLisandro Dalcin if (key[0] != '-') PetscFunctionReturn(0); 2092d747510SLisandro Dalcin if (key[1] == '-') key++; 2102d747510SLisandro Dalcin if (!isalpha((int)(key[1]))) PetscFunctionReturn(0); 2112d747510SLisandro Dalcin (void) strtod(key,&ptr); 2122d747510SLisandro Dalcin if (ptr != key && !(*ptr == '_' || isalnum(*ptr))) PetscFunctionReturn(0); 2132d747510SLisandro Dalcin *valid = PETSC_TRUE; 21496fc60bcSBarry Smith PetscFunctionReturn(0); 21596fc60bcSBarry Smith } 21696fc60bcSBarry Smith 217e5c89e4eSSatish Balay /*@C 218e5c89e4eSSatish Balay PetscOptionsInsertString - Inserts options into the database from a string 219e5c89e4eSSatish Balay 2202d747510SLisandro Dalcin Not Collective, but only processes that call this routine will set the options 22101508a89SJed Brown included in the string 222e5c89e4eSSatish Balay 223e5c89e4eSSatish Balay Input Parameter: 224a8c7a070SBarry Smith . in_str - string that contains options separated by blanks 225e5c89e4eSSatish Balay 226e5c89e4eSSatish Balay 227e5c89e4eSSatish Balay Level: intermediate 228e5c89e4eSSatish Balay 229e5c89e4eSSatish Balay Contributed by Boyana Norris 230e5c89e4eSSatish Balay 23188c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 232acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 233e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 234e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 235acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 236a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsInsertFile() 237e5c89e4eSSatish Balay @*/ 238c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertString(PetscOptions options,const char in_str[]) 239e5c89e4eSSatish Balay { 24096fc60bcSBarry Smith char *first,*second; 241e5c89e4eSSatish Balay PetscErrorCode ierr; 2429c9d3cfdSBarry Smith PetscToken token; 243bf9c6086SStefano Zampini PetscBool key,ispush,ispop,isopts; 244e5c89e4eSSatish Balay 245e5c89e4eSSatish Balay PetscFunctionBegin; 24696fc60bcSBarry Smith ierr = PetscTokenCreate(in_str,' ',&token);CHKERRQ(ierr); 247e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 24896fc60bcSBarry Smith while (first) { 2499db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_push",&ispush);CHKERRQ(ierr); 2509db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_pop",&ispop);CHKERRQ(ierr); 251bf9c6086SStefano Zampini ierr = PetscStrcasecmp(first,"-options_file",&isopts);CHKERRQ(ierr); 25296fc60bcSBarry Smith ierr = PetscOptionsValidKey(first,&key);CHKERRQ(ierr); 2539db968c8SJed Brown if (ispush) { 2549db968c8SJed Brown ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 255c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,second);CHKERRQ(ierr); 2569db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 2579db968c8SJed Brown } else if (ispop) { 258c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 2599db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 260bf9c6086SStefano Zampini } else if (isopts) { 261bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 262bf9c6086SStefano Zampini ierr = PetscOptionsInsertFile(PETSC_COMM_SELF,options,second,PETSC_TRUE);CHKERRQ(ierr); 263bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 2649db968c8SJed Brown } else if (key) { 265e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 26696fc60bcSBarry Smith ierr = PetscOptionsValidKey(second,&key);CHKERRQ(ierr); 26796fc60bcSBarry Smith if (!key) { 268c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,second);CHKERRQ(ierr); 26996fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 27096fc60bcSBarry Smith } else { 271c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,NULL);CHKERRQ(ierr); 27296fc60bcSBarry Smith first = second; 27396fc60bcSBarry Smith } 27496fc60bcSBarry Smith } else { 27596fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 276e5c89e4eSSatish Balay } 277e5c89e4eSSatish Balay } 2788c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 279e5c89e4eSSatish Balay PetscFunctionReturn(0); 280e5c89e4eSSatish Balay } 281e5c89e4eSSatish Balay 2823fc1eb6aSBarry Smith /* 2833fc1eb6aSBarry Smith Returns a line (ended by a \n, \r or null character of any length. Result should be freed with free() 2843fc1eb6aSBarry Smith */ 2855fa91da5SBarry Smith static char *Petscgetline(FILE * f) 2865fa91da5SBarry Smith { 2875fa91da5SBarry Smith size_t size = 0; 2885fa91da5SBarry Smith size_t len = 0; 2895fa91da5SBarry Smith size_t last = 0; 2900298fd71SBarry Smith char *buf = NULL; 2915fa91da5SBarry Smith 2925fa91da5SBarry Smith if (feof(f)) return 0; 2935fa91da5SBarry Smith do { 2945fa91da5SBarry Smith size += 1024; /* BUFSIZ is defined as "the optimal read size for this platform" */ 2956e0c8459SSatish Balay buf = (char*)realloc((void*)buf,size); /* realloc(NULL,n) is the same as malloc(n) */ 2965fa91da5SBarry Smith /* Actually do the read. Note that fgets puts a terminal '\0' on the 2975fa91da5SBarry Smith end of the string, so we make sure we overwrite this */ 298e86f3e45SDave May if (!fgets(buf+len,1024,f)) buf[len]=0; 2995fa91da5SBarry Smith PetscStrlen(buf,&len); 3005fa91da5SBarry Smith last = len - 1; 3015fa91da5SBarry Smith } while (!feof(f) && buf[last] != '\n' && buf[last] != '\r'); 30208ac41f7SSatish Balay if (len) return buf; 3035fa91da5SBarry Smith free(buf); 3045fa91da5SBarry Smith return 0; 3055fa91da5SBarry Smith } 3065fa91da5SBarry Smith 307e5c89e4eSSatish Balay /*@C 308e5c89e4eSSatish Balay PetscOptionsInsertFile - Inserts options into the database from a file. 309e5c89e4eSSatish Balay 310*d083f849SBarry Smith Collective 311e5c89e4eSSatish Balay 312e5c89e4eSSatish Balay Input Parameter: 3139b754dc9SBarry Smith + comm - the processes that will share the options (usually PETSC_COMM_WORLD) 314c5929fdfSBarry Smith . options - options database, use NULL for default global database 315e5c89e4eSSatish Balay . file - name of file 3169b754dc9SBarry Smith - require - if PETSC_TRUE will generate an error if the file does not exist 317e5c89e4eSSatish Balay 318e5c89e4eSSatish Balay 31995452b02SPatrick Sanan Notes: 32095452b02SPatrick Sanan Use # for lines that are comments and which should be ignored. 3217c43ebc8SBarry Smith 322f0feba65SBarry Smith Usually, instead of using this command, one should list the file name in the call to PetscInitialize(), this insures that certain options 323609bdbeeSBarry 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 324f0feba65SBarry Smith calls to XXXSetFromOptions() it should not be used for options listed under PetscInitialize(). 325f0feba65SBarry Smith 3263bcbd388SSean Farley Level: developer 327e5c89e4eSSatish Balay 32888c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 329acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 330e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 331e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 332acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 333a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 334e5c89e4eSSatish Balay 335e5c89e4eSSatish Balay @*/ 336c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertFile(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require) 337e5c89e4eSSatish Balay { 3383a018368SJed Brown char *string,fname[PETSC_MAX_PATH_LEN],*first,*second,*third,*vstring = 0,*astring = 0,*packed = 0; 339e5c89e4eSSatish Balay PetscErrorCode ierr; 34013e3f751SJed Brown size_t i,len,bytes; 341e5c89e4eSSatish Balay FILE *fd; 3429c9d3cfdSBarry Smith PetscToken token; 343ed9cf6e9SBarry Smith int err; 3447c43ebc8SBarry Smith char cmt[1]={'#'},*cmatch; 3453a018368SJed Brown PetscMPIInt rank,cnt=0,acnt=0,counts[2]; 346ad38b122SPatrick Sanan PetscBool isdir; 347e5c89e4eSSatish Balay 348e5c89e4eSSatish Balay PetscFunctionBegin; 34905c7dedfSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 35005c7dedfSBarry Smith if (!rank) { 35166af5158SSatish Balay cnt = 0; 35266af5158SSatish Balay acnt = 0; 35305c7dedfSBarry Smith 354e5c89e4eSSatish Balay ierr = PetscFixFilename(file,fname);CHKERRQ(ierr); 355e5c89e4eSSatish Balay fd = fopen(fname,"r"); 356ad38b122SPatrick Sanan ierr = PetscTestDirectory(fname,'r',&isdir);CHKERRQ(ierr); 357ad38b122SPatrick Sanan if (isdir && require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Specified options file %s is a directory",fname); 358ad38b122SPatrick Sanan if (fd && !isdir) { 3593a018368SJed Brown PetscSegBuffer vseg,aseg; 3603a018368SJed Brown ierr = PetscSegBufferCreate(1,4000,&vseg);CHKERRQ(ierr); 3613a018368SJed Brown ierr = PetscSegBufferCreate(1,2000,&aseg);CHKERRQ(ierr); 3623a018368SJed Brown 3639b754dc9SBarry Smith /* the following line will not work when opening initial files (like .petscrc) since info is not yet set */ 3649b754dc9SBarry Smith ierr = PetscInfo1(0,"Opened options file %s\n",file);CHKERRQ(ierr); 365e24ecc5dSJed Brown 3665fa91da5SBarry Smith while ((string = Petscgetline(fd))) { 3674704e885SBarry Smith /* eliminate comments from each line */ 3687c43ebc8SBarry Smith for (i=0; i<1; i++) { 369a2ea699eSBarry Smith ierr = PetscStrchr(string,cmt[i],&cmatch);CHKERRQ(ierr); 37090f79514SSatish Balay if (cmatch) *cmatch = 0; 37190f79514SSatish Balay } 372e5c89e4eSSatish Balay ierr = PetscStrlen(string,&len);CHKERRQ(ierr); 3735981331cSSatish Balay /* replace tabs, ^M, \n with " " */ 374e5c89e4eSSatish Balay for (i=0; i<len; i++) { 3755981331cSSatish Balay if (string[i] == '\t' || string[i] == '\r' || string[i] == '\n') { 376e5c89e4eSSatish Balay string[i] = ' '; 377e5c89e4eSSatish Balay } 378e5c89e4eSSatish Balay } 37990f79514SSatish Balay ierr = PetscTokenCreate(string,' ',&token);CHKERRQ(ierr); 380e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 38190f79514SSatish Balay if (!first) { 38202b0d46eSSatish Balay goto destroy; 38390f79514SSatish Balay } else if (!first[0]) { /* if first token is empty spaces, redo first token */ 38490f79514SSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 38590f79514SSatish Balay } 386e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 3872662f744SSatish Balay if (!first) { 3882662f744SSatish Balay goto destroy; 3892662f744SSatish Balay } else if (first[0] == '-') { 390e24ecc5dSJed Brown ierr = PetscStrlen(first,&len);CHKERRQ(ierr); 39113e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+1,&vstring);CHKERRQ(ierr); 392e24ecc5dSJed Brown ierr = PetscMemcpy(vstring,first,len);CHKERRQ(ierr); 393e24ecc5dSJed Brown vstring[len] = ' '; 39409192fe3SBarry Smith if (second) { 395e24ecc5dSJed Brown ierr = PetscStrlen(second,&len);CHKERRQ(ierr); 39613e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+3,&vstring);CHKERRQ(ierr); 397e24ecc5dSJed Brown vstring[0] = '"'; 398e24ecc5dSJed Brown ierr = PetscMemcpy(vstring+1,second,len);CHKERRQ(ierr); 399e24ecc5dSJed Brown vstring[len+1] = '"'; 400e24ecc5dSJed Brown vstring[len+2] = ' '; 40109192fe3SBarry Smith } 40290f79514SSatish Balay } else { 403ace3abfcSBarry Smith PetscBool match; 404e5c89e4eSSatish Balay 405e5c89e4eSSatish Balay ierr = PetscStrcasecmp(first,"alias",&match);CHKERRQ(ierr); 406e5c89e4eSSatish Balay if (match) { 407e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&third);CHKERRQ(ierr); 408e32f2f54SBarry Smith if (!third) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file:alias missing (%s)",second); 409e24ecc5dSJed Brown ierr = PetscStrlen(second,&len);CHKERRQ(ierr); 41013e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 411e24ecc5dSJed Brown ierr = PetscMemcpy(astring,second,len);CHKERRQ(ierr); 412e24ecc5dSJed Brown astring[len] = ' '; 413e24ecc5dSJed Brown 414e24ecc5dSJed Brown ierr = PetscStrlen(third,&len);CHKERRQ(ierr); 41513e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 416e24ecc5dSJed Brown ierr = PetscMemcpy(astring,third,len);CHKERRQ(ierr); 417e24ecc5dSJed Brown astring[len] = ' '; 418f23aa3ddSBarry Smith } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown statement in options file: (%s)",string); 419e5c89e4eSSatish Balay } 42002b0d46eSSatish Balay destroy: 4214b40f50bSBarry Smith free(string); 4228c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 423e5c89e4eSSatish Balay } 424ed9cf6e9SBarry Smith err = fclose(fd); 425e32f2f54SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 426e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(aseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 427e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&acnt);CHKERRQ(ierr); 428e24ecc5dSJed Brown ierr = PetscSegBufferGet(aseg,1,&astring);CHKERRQ(ierr); 429e24ecc5dSJed Brown astring[0] = 0; 430e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(vseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 431e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&cnt);CHKERRQ(ierr); 432e24ecc5dSJed Brown ierr = PetscSegBufferGet(vseg,1,&vstring);CHKERRQ(ierr); 433e24ecc5dSJed Brown vstring[0] = 0; 434854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 4353a018368SJed Brown ierr = PetscSegBufferExtractTo(aseg,packed);CHKERRQ(ierr); 4363a018368SJed Brown ierr = PetscSegBufferExtractTo(vseg,packed+acnt+1);CHKERRQ(ierr); 4373a018368SJed Brown ierr = PetscSegBufferDestroy(&aseg);CHKERRQ(ierr); 4383a018368SJed Brown ierr = PetscSegBufferDestroy(&vseg);CHKERRQ(ierr); 439f23aa3ddSBarry Smith } else if (require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Unable to open Options File %s",fname); 4409b754dc9SBarry Smith } 44105c7dedfSBarry Smith 4423a018368SJed Brown counts[0] = acnt; 4433a018368SJed Brown counts[1] = cnt; 4443a018368SJed Brown ierr = MPI_Bcast(counts,2,MPI_INT,0,comm);CHKERRQ(ierr); 4453a018368SJed Brown acnt = counts[0]; 4463a018368SJed Brown cnt = counts[1]; 4473a018368SJed Brown if (rank) { 448854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 4493a018368SJed Brown } 4503a018368SJed Brown if (acnt || cnt) { 4513a018368SJed Brown ierr = MPI_Bcast(packed,2+acnt+cnt,MPI_CHAR,0,comm);CHKERRQ(ierr); 4523a018368SJed Brown astring = packed; 4533a018368SJed Brown vstring = packed + acnt + 1; 4543a018368SJed Brown } 4553a018368SJed Brown 4569b754dc9SBarry Smith if (acnt) { 4579b754dc9SBarry Smith PetscToken token; 4589b754dc9SBarry Smith char *first,*second; 4599b754dc9SBarry Smith 4609b754dc9SBarry Smith ierr = PetscTokenCreate(astring,' ',&token);CHKERRQ(ierr); 4619b754dc9SBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 4629b754dc9SBarry Smith while (first) { 4639b754dc9SBarry Smith ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 464c5929fdfSBarry Smith ierr = PetscOptionsSetAlias(options,first,second);CHKERRQ(ierr); 4659b754dc9SBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 4669b754dc9SBarry Smith } 4678c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 4689b754dc9SBarry Smith } 4699b754dc9SBarry Smith 4709b754dc9SBarry Smith if (cnt) { 471c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,vstring);CHKERRQ(ierr); 472e5c89e4eSSatish Balay } 4733a018368SJed Brown ierr = PetscFree(packed);CHKERRQ(ierr); 474e5c89e4eSSatish Balay PetscFunctionReturn(0); 475e5c89e4eSSatish Balay } 476e5c89e4eSSatish Balay 4772d747510SLisandro Dalcin static PetscErrorCode PetscOptionsInsertArgs(PetscOptions options,int argc,char *args[]) 47885079163SJed Brown { 47985079163SJed Brown PetscErrorCode ierr; 48085079163SJed Brown int left = argc - 1; 48185079163SJed Brown char **eargs = args + 1; 48285079163SJed Brown 48385079163SJed Brown PetscFunctionBegin; 48485079163SJed Brown while (left) { 485093de6efSBarry Smith PetscBool isoptions_file,isprefixpush,isprefixpop,isp4,tisp4,isp4yourname,isp4rmrank,key; 48685079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-options_file",&isoptions_file);CHKERRQ(ierr); 4879db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_push",&isprefixpush);CHKERRQ(ierr); 4889db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_pop",&isprefixpop);CHKERRQ(ierr); 48985079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4pg",&isp4);CHKERRQ(ierr); 49085079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4yourname",&isp4yourname);CHKERRQ(ierr); 49185079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4rmrank",&isp4rmrank);CHKERRQ(ierr); 49285079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4wd",&tisp4);CHKERRQ(ierr); 493ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 49485079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-np",&tisp4);CHKERRQ(ierr); 495ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 49685079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4amslave",&tisp4);CHKERRQ(ierr); 497093de6efSBarry Smith ierr = PetscOptionsValidKey(eargs[0],&key);CHKERRQ(ierr); 49885079163SJed Brown 499093de6efSBarry Smith if (!key) { 50085079163SJed Brown eargs++; left--; 50185079163SJed Brown } else if (isoptions_file) { 50285079163SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 50385079163SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 504c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,eargs[1],PETSC_TRUE);CHKERRQ(ierr); 50585079163SJed Brown eargs += 2; left -= 2; 5069db968c8SJed Brown } else if (isprefixpush) { 5079db968c8SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option"); 5089db968c8SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option (prefixes cannot start with '-')"); 509c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,eargs[1]);CHKERRQ(ierr); 5109db968c8SJed Brown eargs += 2; left -= 2; 5119db968c8SJed Brown } else if (isprefixpop) { 512c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 5139db968c8SJed Brown eargs++; left--; 51485079163SJed Brown 51585079163SJed Brown /* 51685079163SJed Brown These are "bad" options that MPICH, etc put on the command line 51785079163SJed Brown we strip them out here. 51885079163SJed Brown */ 51985079163SJed Brown } else if (tisp4 || isp4rmrank) { 52085079163SJed Brown eargs += 1; left -= 1; 52185079163SJed Brown } else if (isp4 || isp4yourname) { 52285079163SJed Brown eargs += 2; left -= 2; 5237935c3d8SJed Brown } else { 5247935c3d8SJed Brown PetscBool nextiskey = PETSC_FALSE; 5257935c3d8SJed Brown if (left >= 2) {ierr = PetscOptionsValidKey(eargs[1],&nextiskey);CHKERRQ(ierr);} 52698b6bf53SJed Brown if (left < 2 || nextiskey) { 527c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],NULL);CHKERRQ(ierr); 52885079163SJed Brown eargs++; left--; 52985079163SJed Brown } else { 530c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],eargs[1]);CHKERRQ(ierr); 53185079163SJed Brown eargs += 2; left -= 2; 53285079163SJed Brown } 53385079163SJed Brown } 5347935c3d8SJed Brown } 53585079163SJed Brown PetscFunctionReturn(0); 53685079163SJed Brown } 53785079163SJed Brown 53885079163SJed Brown 539e5c89e4eSSatish Balay /*@C 540e5c89e4eSSatish Balay PetscOptionsInsert - Inserts into the options database from the command line, 541e5c89e4eSSatish Balay the environmental variable and a file. 542e5c89e4eSSatish Balay 543e5c89e4eSSatish Balay Input Parameters: 544c5929fdfSBarry Smith + options - options database or NULL for the default global database 545c5929fdfSBarry Smith . argc - count of number of command line arguments 546e5c89e4eSSatish Balay . args - the command line arguments 547e5c89e4eSSatish Balay - file - optional filename, defaults to ~username/.petscrc 548e5c89e4eSSatish Balay 549e5c89e4eSSatish Balay Note: 550e5c89e4eSSatish Balay Since PetscOptionsInsert() is automatically called by PetscInitialize(), 551e5c89e4eSSatish Balay the user does not typically need to call this routine. PetscOptionsInsert() 552e5c89e4eSSatish Balay can be called several times, adding additional entries into the database. 553e5c89e4eSSatish Balay 554081c24baSBoyana Norris Options Database Keys: 555081c24baSBoyana Norris + -options_monitor <optional filename> - print options names and values as they are set 556ec873e40SMatthew G Knepley . -options_file <filename> - read options from a file 557081c24baSBoyana Norris 558e5c89e4eSSatish Balay Level: advanced 559e5c89e4eSSatish Balay 5602d747510SLisandro Dalcin .seealso: PetscOptionsDestroy(), PetscOptionsView(), PetscOptionsInsertString(), PetscOptionsInsertFile(), 56196fc60bcSBarry Smith PetscInitialize() 562e5c89e4eSSatish Balay @*/ 563c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsert(PetscOptions options,int *argc,char ***args,const char file[]) 564e5c89e4eSSatish Balay { 565e5c89e4eSSatish Balay PetscErrorCode ierr; 566e5c89e4eSSatish Balay PetscMPIInt rank; 5672d747510SLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 568ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 569e5c89e4eSSatish Balay 5708dea33a6SBarry Smith 571e5c89e4eSSatish Balay PetscFunctionBegin; 572e5c89e4eSSatish Balay ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 573e5c89e4eSSatish Balay 5744b09e917SBarry Smith if (file && file[0]) { 5752d747510SLisandro Dalcin ierr = PetscStrreplace(PETSC_COMM_WORLD,file,filename,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 5762d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_TRUE);CHKERRQ(ierr); 577321366bcSBarry Smith } 57885079163SJed Brown /* 57985079163SJed Brown We want to be able to give -skip_petscrc on the command line, but need to parse it first. Since the command line 58085079163SJed Brown should take precedence, we insert it twice. It would be sufficient to just scan for -skip_petscrc. 58185079163SJed Brown */ 5822d747510SLisandro Dalcin if (argc && args && *argc) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);} 583c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-skip_petscrc",&flag,NULL);CHKERRQ(ierr); 584321366bcSBarry Smith if (!flag) { 5852d747510SLisandro Dalcin ierr = PetscGetHomeDirectory(filename,PETSC_MAX_PATH_LEN-16);CHKERRQ(ierr); 5861ea3218fSSatish Balay /* PetscOptionsInsertFile() does a fopen() on rank0 only - so only rank0 HomeDir value is relavent */ 5872d747510SLisandro Dalcin if (filename[0]) { ierr = PetscStrcat(filename,"/.petscrc");CHKERRQ(ierr); } 5882d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_FALSE);CHKERRQ(ierr); 589c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,".petscrc",PETSC_FALSE);CHKERRQ(ierr); 590c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,"petscrc",PETSC_FALSE);CHKERRQ(ierr); 591e5c89e4eSSatish Balay } 592e5c89e4eSSatish Balay 5932d747510SLisandro Dalcin /* insert environment options */ 594e5c89e4eSSatish Balay { 5952d747510SLisandro Dalcin char *eoptions = NULL; 596e5c89e4eSSatish Balay size_t len = 0; 597e5c89e4eSSatish Balay if (!rank) { 598e5c89e4eSSatish Balay eoptions = (char*)getenv("PETSC_OPTIONS"); 599e5c89e4eSSatish Balay ierr = PetscStrlen(eoptions,&len);CHKERRQ(ierr); 60076434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 601e5c89e4eSSatish Balay } else { 60276434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 603e5c89e4eSSatish Balay if (len) { 604854ce69bSBarry Smith ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr); 605e5c89e4eSSatish Balay } 606e5c89e4eSSatish Balay } 607e5c89e4eSSatish Balay if (len) { 608e5c89e4eSSatish Balay ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 60996fc60bcSBarry Smith if (rank) eoptions[len] = 0; 610c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,eoptions);CHKERRQ(ierr); 611e5c89e4eSSatish Balay if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);} 612e5c89e4eSSatish Balay } 613e5c89e4eSSatish Balay } 614e5c89e4eSSatish Balay 6153bcbd388SSean Farley #if defined(PETSC_HAVE_YAML) 61656a31166SBarry Smith { 6173bcbd388SSean Farley char yaml_file[PETSC_MAX_PATH_LEN]; 61856a31166SBarry Smith PetscBool yaml_flg; 619c5929fdfSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-options_file_yaml",yaml_file,PETSC_MAX_PATH_LEN,&yaml_flg);CHKERRQ(ierr); 62056a31166SBarry Smith if (yaml_flg) { 62156a31166SBarry Smith ierr = PetscOptionsInsertFileYAML(PETSC_COMM_WORLD,yaml_file,PETSC_TRUE);CHKERRQ(ierr); 62256a31166SBarry Smith } 62356a31166SBarry Smith } 6243bcbd388SSean Farley #endif 6253bcbd388SSean Farley 62685079163SJed Brown /* insert command line options again because they take precedence over arguments in petscrc/environment */ 6272d747510SLisandro Dalcin if (argc && args && *argc) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);} 628e5c89e4eSSatish Balay PetscFunctionReturn(0); 629e5c89e4eSSatish Balay } 630e5c89e4eSSatish Balay 631e5c89e4eSSatish Balay /*@C 63288c29154SBarry Smith PetscOptionsView - Prints the options that have been loaded. This is 633e5c89e4eSSatish Balay useful for debugging purposes. 634e5c89e4eSSatish Balay 635c139c21fSBarry Smith Logically Collective on PetscViewer 636e5c89e4eSSatish Balay 637e5c89e4eSSatish Balay Input Parameter: 6385c9cc608SHong Zhang - options - options database, use NULL for default global database 6395c9cc608SHong Zhang + viewer - must be an PETSCVIEWERASCII viewer 640e5c89e4eSSatish Balay 641e5c89e4eSSatish Balay Options Database Key: 64226a7e8d4SBarry Smith . -options_view - Activates PetscOptionsView() within PetscFinalize() 643e5c89e4eSSatish Balay 644e5c89e4eSSatish Balay Level: advanced 645e5c89e4eSSatish Balay 646e5c89e4eSSatish Balay .seealso: PetscOptionsAllUsed() 647e5c89e4eSSatish Balay @*/ 648c5929fdfSBarry Smith PetscErrorCode PetscOptionsView(PetscOptions options,PetscViewer viewer) 649e5c89e4eSSatish Balay { 650e5c89e4eSSatish Balay PetscErrorCode ierr; 651431c96f7SBarry Smith PetscInt i; 65288c29154SBarry Smith PetscBool isascii; 653e5c89e4eSSatish Balay 654e5c89e4eSSatish Balay PetscFunctionBegin; 6552d747510SLisandro Dalcin if (viewer) PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 656c5929fdfSBarry Smith options = options ? options : defaultoptions; 65788c29154SBarry Smith if (!viewer) viewer = PETSC_VIEWER_STDOUT_WORLD; 658251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 659ce94432eSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Only supports ASCII viewer"); 66088c29154SBarry Smith 6612d747510SLisandro Dalcin if (!options->N) { 66288c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#No PETSc Option Table entries\n");CHKERRQ(ierr); 6632d747510SLisandro Dalcin PetscFunctionReturn(0); 66430694fe9SBarry Smith } 6652d747510SLisandro Dalcin 6662d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"#PETSc Option Table entries:\n");CHKERRQ(ierr); 667e5c89e4eSSatish Balay for (i=0; i<options->N; i++) { 668e5c89e4eSSatish Balay if (options->values[i]) { 66988c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s %s\n",options->names[i],options->values[i]);CHKERRQ(ierr); 670e5c89e4eSSatish Balay } else { 67188c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s\n",options->names[i]);CHKERRQ(ierr); 672e5c89e4eSSatish Balay } 673e5c89e4eSSatish Balay } 67488c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#End of PETSc Option Table entries\n");CHKERRQ(ierr); 675e5c89e4eSSatish Balay PetscFunctionReturn(0); 676e5c89e4eSSatish Balay } 677e5c89e4eSSatish Balay 678e11779c2SBarry Smith /* 679e11779c2SBarry Smith Called by error handlers to print options used in run 680e11779c2SBarry Smith */ 68195c0884eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsViewError(void) 682e11779c2SBarry Smith { 683e11779c2SBarry Smith PetscInt i; 6844416b707SBarry Smith PetscOptions options = defaultoptions; 685e11779c2SBarry Smith 686e11779c2SBarry Smith PetscFunctionBegin; 687e11779c2SBarry Smith if (options->N) { 688e11779c2SBarry Smith (*PetscErrorPrintf)("PETSc Option Table entries:\n"); 689e11779c2SBarry Smith } else { 690e11779c2SBarry Smith (*PetscErrorPrintf)("No PETSc Option Table entries\n"); 691e11779c2SBarry Smith } 692e11779c2SBarry Smith for (i=0; i<options->N; i++) { 693e11779c2SBarry Smith if (options->values[i]) { 694e11779c2SBarry Smith (*PetscErrorPrintf)("-%s %s\n",options->names[i],options->values[i]); 695e11779c2SBarry Smith } else { 696e11779c2SBarry Smith (*PetscErrorPrintf)("-%s\n",options->names[i]); 697e11779c2SBarry Smith } 698e11779c2SBarry Smith } 699e11779c2SBarry Smith PetscFunctionReturn(0); 700e11779c2SBarry Smith } 701e11779c2SBarry Smith 702e5c89e4eSSatish Balay /*@C 70374e0666dSJed Brown PetscOptionsPrefixPush - Designate a prefix to be used by all options insertions to follow. 70474e0666dSJed Brown 70574e0666dSJed Brown Not Collective, but prefix will only be applied on calling ranks 70674e0666dSJed Brown 7079db968c8SJed Brown Input Parameter: 708c5929fdfSBarry Smith + options - options database, or NULL for the default global database 709c5929fdfSBarry Smith - prefix - The string to append to the existing prefix 7109db968c8SJed Brown 7119db968c8SJed Brown Options Database Keys: 7129db968c8SJed Brown + -prefix_push <some_prefix_> - push the given prefix 7139db968c8SJed Brown - -prefix_pop - pop the last prefix 7149db968c8SJed Brown 7159db968c8SJed Brown Notes: 7169db968c8SJed Brown It is common to use this in conjunction with -options_file as in 7179db968c8SJed Brown 7189db968c8SJed Brown $ -prefix_push system1_ -options_file system1rc -prefix_pop -prefix_push system2_ -options_file system2rc -prefix_pop 7199db968c8SJed Brown 7209db968c8SJed Brown where the files no longer require all options to be prefixed with -system2_. 72174e0666dSJed Brown 72274e0666dSJed Brown Level: advanced 72374e0666dSJed Brown 72474e0666dSJed Brown .seealso: PetscOptionsPrefixPop() 72574e0666dSJed Brown @*/ 726c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPush(PetscOptions options,const char prefix[]) 72774e0666dSJed Brown { 72874e0666dSJed Brown PetscErrorCode ierr; 72974e0666dSJed Brown size_t n; 73074e0666dSJed Brown PetscInt start; 7312d747510SLisandro Dalcin char key[MAXOPTNAME+1]; 7322d747510SLisandro Dalcin PetscBool valid; 73374e0666dSJed Brown 73474e0666dSJed Brown PetscFunctionBegin; 7359db968c8SJed Brown PetscValidCharPointer(prefix,1); 736c5929fdfSBarry Smith options = options ? options : defaultoptions; 73774e0666dSJed 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); 7382d747510SLisandro Dalcin key[0] = '-'; /* keys must start with '-' */ 7392d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,prefix,sizeof(key)-1);CHKERRQ(ierr); 7402d747510SLisandro Dalcin ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 7412d747510SLisandro 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); 74274e0666dSJed Brown start = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 74374e0666dSJed Brown ierr = PetscStrlen(prefix,&n);CHKERRQ(ierr); 74474e0666dSJed Brown if (n+1 > sizeof(options->prefix)-start) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum prefix length %d exceeded",sizeof(options->prefix)); 74574e0666dSJed Brown ierr = PetscMemcpy(options->prefix+start,prefix,n+1);CHKERRQ(ierr); 74674e0666dSJed Brown options->prefixstack[options->prefixind++] = start+n; 74774e0666dSJed Brown PetscFunctionReturn(0); 74874e0666dSJed Brown } 74974e0666dSJed Brown 750c5929fdfSBarry Smith /*@C 75174e0666dSJed Brown PetscOptionsPrefixPop - Remove the latest options prefix, see PetscOptionsPrefixPush() for details 75274e0666dSJed Brown 75374e0666dSJed Brown Not Collective, but prefix will only be popped on calling ranks 75474e0666dSJed Brown 755c5929fdfSBarry Smith Input Parameters: 756c5929fdfSBarry Smith . options - options database, or NULL for the default global database 757c5929fdfSBarry Smith 75874e0666dSJed Brown Level: advanced 75974e0666dSJed Brown 76074e0666dSJed Brown .seealso: PetscOptionsPrefixPush() 76174e0666dSJed Brown @*/ 762c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPop(PetscOptions options) 76374e0666dSJed Brown { 76474e0666dSJed Brown PetscInt offset; 76574e0666dSJed Brown 76674e0666dSJed Brown PetscFunctionBegin; 767c5929fdfSBarry Smith options = options ? options : defaultoptions; 76874e0666dSJed Brown if (options->prefixind < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"More prefixes popped than pushed"); 76974e0666dSJed Brown options->prefixind--; 77074e0666dSJed Brown offset = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 77174e0666dSJed Brown options->prefix[offset] = 0; 77274e0666dSJed Brown PetscFunctionReturn(0); 77374e0666dSJed Brown } 77474e0666dSJed Brown 775a542b6e8SBarry Smith /*@C 776a542b6e8SBarry Smith PetscOptionsClear - Removes all options form the database leaving it empty. 777a542b6e8SBarry Smith 778c5929fdfSBarry Smith Input Parameters: 779c5929fdfSBarry Smith . options - options database, use NULL for the default global database 780c5929fdfSBarry Smith 781a542b6e8SBarry Smith Level: developer 782a542b6e8SBarry Smith 783a542b6e8SBarry Smith .seealso: PetscOptionsInsert() 784a542b6e8SBarry Smith @*/ 785c5929fdfSBarry Smith PetscErrorCode PetscOptionsClear(PetscOptions options) 786a542b6e8SBarry Smith { 787a542b6e8SBarry Smith PetscInt i; 788a542b6e8SBarry Smith 789c5929fdfSBarry Smith options = options ? options : defaultoptions; 7902d747510SLisandro Dalcin if (!options) return 0; 7912d747510SLisandro Dalcin 792a542b6e8SBarry Smith for (i=0; i<options->N; i++) { 793a542b6e8SBarry Smith if (options->names[i]) free(options->names[i]); 794a542b6e8SBarry Smith if (options->values[i]) free(options->values[i]); 795a542b6e8SBarry Smith } 7962d747510SLisandro Dalcin options->N = 0; 7972d747510SLisandro Dalcin 798a542b6e8SBarry Smith for (i=0; i<options->Naliases; i++) { 799a542b6e8SBarry Smith free(options->aliases1[i]); 800a542b6e8SBarry Smith free(options->aliases2[i]); 801a542b6e8SBarry Smith } 802a542b6e8SBarry Smith options->Naliases = 0; 803a542b6e8SBarry Smith 8042d747510SLisandro Dalcin /* destroy hash table */ 8052d747510SLisandro Dalcin kh_destroy(HO,options->ht); 8062d747510SLisandro Dalcin options->ht = NULL; 8070eb63584SBarry Smith 8082d747510SLisandro Dalcin options->prefixind = 0; 8092d747510SLisandro Dalcin options->prefix[0] = 0; 8102d747510SLisandro Dalcin options->help = PETSC_FALSE; 8114416b707SBarry Smith return 0; 8124416b707SBarry Smith } 8134416b707SBarry Smith 8142d747510SLisandro Dalcin /*@C 8152d747510SLisandro Dalcin PetscOptionsSetAlias - Makes a key and alias for another key 8162d747510SLisandro Dalcin 8172d747510SLisandro Dalcin Not Collective, but setting values on certain processors could cause problems 8182d747510SLisandro Dalcin for parallel objects looking for options. 8192d747510SLisandro Dalcin 8202d747510SLisandro Dalcin Input Parameters: 8212d747510SLisandro Dalcin + options - options database, or NULL for default global database 8222d747510SLisandro Dalcin . newname - the alias 8232d747510SLisandro Dalcin - oldname - the name that alias will refer to 8242d747510SLisandro Dalcin 8252d747510SLisandro Dalcin Level: advanced 8262d747510SLisandro Dalcin 8272d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 8282d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 8292d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 8302d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 8312d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 8322d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 8332d747510SLisandro Dalcin @*/ 8342d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetAlias(PetscOptions options,const char newname[],const char oldname[]) 8352d747510SLisandro Dalcin { 8362d747510SLisandro Dalcin PetscInt n; 8372d747510SLisandro Dalcin size_t len; 8382d747510SLisandro Dalcin PetscErrorCode ierr; 8392d747510SLisandro Dalcin 8402d747510SLisandro Dalcin PetscFunctionBegin; 8412d747510SLisandro Dalcin PetscValidCharPointer(newname,2); 8422d747510SLisandro Dalcin PetscValidCharPointer(oldname,3); 8432d747510SLisandro Dalcin options = options ? options : defaultoptions; 8442d747510SLisandro Dalcin if (newname[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"aliased must start with '-': Instead %s",newname); 8452d747510SLisandro Dalcin if (oldname[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"aliasee must start with '-': Instead %s",oldname); 8462d747510SLisandro Dalcin 8472d747510SLisandro Dalcin n = options->Naliases; 8482d747510SLisandro 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); 8492d747510SLisandro Dalcin 8502d747510SLisandro Dalcin newname++; oldname++; 8512d747510SLisandro Dalcin ierr = PetscStrlen(newname,&len);CHKERRQ(ierr); 8522d747510SLisandro Dalcin options->aliases1[n] = (char*)malloc((len+1)*sizeof(char)); 8532d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases1[n],newname);CHKERRQ(ierr); 8542d747510SLisandro Dalcin ierr = PetscStrlen(oldname,&len);CHKERRQ(ierr); 8552d747510SLisandro Dalcin options->aliases2[n] = (char*)malloc((len+1)*sizeof(char)); 8562d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases2[n],oldname);CHKERRQ(ierr); 8572d747510SLisandro Dalcin options->Naliases++; 8582d747510SLisandro Dalcin PetscFunctionReturn(0); 8592d747510SLisandro Dalcin } 8604416b707SBarry Smith 861e5c89e4eSSatish Balay /*@C 862e5c89e4eSSatish Balay PetscOptionsSetValue - Sets an option name-value pair in the options 863e5c89e4eSSatish Balay database, overriding whatever is already present. 864e5c89e4eSSatish Balay 8652d747510SLisandro Dalcin Not Collective, but setting values on certain processors could cause problems 866e5c89e4eSSatish Balay for parallel objects looking for options. 867e5c89e4eSSatish Balay 868e5c89e4eSSatish Balay Input Parameters: 869c5929fdfSBarry Smith + options - options database, use NULL for the default global database 870c5929fdfSBarry Smith . name - name of option, this SHOULD have the - prepended 8712d747510SLisandro Dalcin - value - the option value (not used for all options, so can be NULL) 872e5c89e4eSSatish Balay 873e5c89e4eSSatish Balay Level: intermediate 874e5c89e4eSSatish Balay 875e5c89e4eSSatish Balay Note: 876d49172ceSBarry Smith This function can be called BEFORE PetscInitialize() 877d49172ceSBarry Smith 8782d747510SLisandro Dalcin Developers Note: Uses malloc() directly because PETSc may not be initialized yet. 879b0250c70SBarry Smith 8802d747510SLisandro Dalcin .seealso: PetscOptionsInsert(), PetscOptionsClearValue() 881e5c89e4eSSatish Balay @*/ 8822d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetValue(PetscOptions options,const char name[],const char value[]) 883e5c89e4eSSatish Balay { 884e5c89e4eSSatish Balay size_t len; 8852d747510SLisandro Dalcin int N,n,i; 886e5c89e4eSSatish Balay char **names; 8872d747510SLisandro Dalcin char fullname[MAXOPTNAME] = ""; 8882d747510SLisandro Dalcin PetscErrorCode ierr; 889e5c89e4eSSatish Balay 8902d747510SLisandro Dalcin if (!options && !defaultoptions) { 8912d747510SLisandro Dalcin ierr = PetscOptionsCreateDefault();if (ierr) return ierr; 892c5929fdfSBarry Smith } 8932d747510SLisandro Dalcin options = options ? options : defaultoptions; 8942d747510SLisandro Dalcin 8952d747510SLisandro Dalcin if (name[0] != '-') return PETSC_ERR_ARG_OUTOFRANGE; 896e5c89e4eSSatish Balay 897d49172ceSBarry Smith /* this is so that -h and -help are equivalent (p4 does not like -help)*/ 8982d747510SLisandro Dalcin if (!strcmp(name,"-h")) name = "-help"; 8992d747510SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_TRUE; 900e5c89e4eSSatish Balay 9012d747510SLisandro Dalcin name++; /* skip starting dash */ 9022d747510SLisandro Dalcin 90374e0666dSJed Brown if (options->prefixind > 0) { 904d49172ceSBarry Smith strncpy(fullname,options->prefix,sizeof(fullname)); 9052d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 90689ae1891SBarry Smith strncat(fullname,name,sizeof(fullname)-strlen(fullname)-1); 9072d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 90874e0666dSJed Brown name = fullname; 90974e0666dSJed Brown } 91074e0666dSJed Brown 91174e0666dSJed Brown /* check against aliases */ 912e5c89e4eSSatish Balay N = options->Naliases; 913e5c89e4eSSatish Balay for (i=0; i<N; i++) { 9142d747510SLisandro Dalcin int result = PetscOptNameCmp(options->aliases1[i],name); 9152d747510SLisandro Dalcin if (!result) { name = options->aliases2[i]; break; } 916e5c89e4eSSatish Balay } 917e5c89e4eSSatish Balay 9182d747510SLisandro Dalcin /* slow search */ 9192d747510SLisandro Dalcin N = n = options->N; 920e5c89e4eSSatish Balay names = options->names; 921e5c89e4eSSatish Balay for (i=0; i<N; i++) { 9222d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 9232d747510SLisandro Dalcin if (!result) { 9242d747510SLisandro Dalcin n = i; goto setvalue; 9252d747510SLisandro Dalcin } else if (result > 0) { 9262d747510SLisandro Dalcin n = i; break; 927e5c89e4eSSatish Balay } 928e5c89e4eSSatish Balay } 9292d747510SLisandro Dalcin if (N >= MAXOPTIONS) return PETSC_ERR_MEM; 9302d747510SLisandro Dalcin /* shift remaining values up 1 */ 931e5c89e4eSSatish Balay for (i=N; i>n; i--) { 9325e8c5e88SLisandro Dalcin options->names[i] = options->names[i-1]; 933e5c89e4eSSatish Balay options->values[i] = options->values[i-1]; 934e5c89e4eSSatish Balay options->used[i] = options->used[i-1]; 935e5c89e4eSSatish Balay } 9362d747510SLisandro Dalcin options->names[n] = NULL; 9372d747510SLisandro Dalcin options->values[n] = NULL; 9382d747510SLisandro Dalcin options->used[n] = PETSC_FALSE; 9392d747510SLisandro Dalcin options->N++; 9402d747510SLisandro Dalcin 9412d747510SLisandro Dalcin /* destroy hash table */ 9422d747510SLisandro Dalcin kh_destroy(HO,options->ht); 9432d747510SLisandro Dalcin options->ht = NULL; 9442d747510SLisandro Dalcin 9452d747510SLisandro Dalcin /* set new name */ 94670d8d27cSBarry Smith len = strlen(name); 9475e8c5e88SLisandro Dalcin options->names[n] = (char*)malloc((len+1)*sizeof(char)); 948d49172ceSBarry Smith if (!options->names[n]) return PETSC_ERR_MEM; 949d49172ceSBarry Smith strcpy(options->names[n],name); 9502d747510SLisandro Dalcin 9512d747510SLisandro Dalcin setvalue: 9522d747510SLisandro Dalcin /* set new value */ 9532d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 954d49172ceSBarry Smith len = value ? strlen(value) : 0; 9555e8c5e88SLisandro Dalcin if (len) { 956e5c89e4eSSatish Balay options->values[n] = (char*)malloc((len+1)*sizeof(char)); 957d49172ceSBarry Smith if (!options->values[n]) return PETSC_ERR_MEM; 958d49172ceSBarry Smith strcpy(options->values[n],value); 9592d747510SLisandro Dalcin } else { 9602d747510SLisandro Dalcin options->values[n] = NULL; 9612d747510SLisandro Dalcin } 9622d747510SLisandro Dalcin 9632d747510SLisandro Dalcin ierr = PetscOptionsMonitor(options,name,value?value:"");if (ierr) return ierr; 964d49172ceSBarry Smith return 0; 965e5c89e4eSSatish Balay } 966e5c89e4eSSatish Balay 967e5c89e4eSSatish Balay /*@C 968e5c89e4eSSatish Balay PetscOptionsClearValue - Clears an option name-value pair in the options 969e5c89e4eSSatish Balay database, overriding whatever is already present. 970e5c89e4eSSatish Balay 971e5c89e4eSSatish Balay Not Collective, but setting values on certain processors could cause problems 972e5c89e4eSSatish Balay for parallel objects looking for options. 973e5c89e4eSSatish Balay 974e5c89e4eSSatish Balay Input Parameter: 975c5929fdfSBarry Smith + options - options database, use NULL for the default global database 976e5c89e4eSSatish Balay . name - name of option, this SHOULD have the - prepended 977e5c89e4eSSatish Balay 978e5c89e4eSSatish Balay Level: intermediate 979e5c89e4eSSatish Balay 980e5c89e4eSSatish Balay .seealso: PetscOptionsInsert() 981e5c89e4eSSatish Balay @*/ 9822d747510SLisandro Dalcin PetscErrorCode PetscOptionsClearValue(PetscOptions options,const char name[]) 983e5c89e4eSSatish Balay { 9842d747510SLisandro Dalcin int N,n,i; 9852d747510SLisandro Dalcin char **names; 986e5c89e4eSSatish Balay PetscErrorCode ierr; 987e5c89e4eSSatish Balay 988e5c89e4eSSatish Balay PetscFunctionBegin; 989c5929fdfSBarry Smith options = options ? options : defaultoptions; 9902d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 991e5c89e4eSSatish Balay 9922d747510SLisandro Dalcin /* this is so that -h and -help are equivalent (p4 does not like -help)*/ 9932d747510SLisandro Dalcin if (!strcmp(name,"-h")) name = "-help"; 9942d747510SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_FALSE; 9952d747510SLisandro Dalcin 9962d747510SLisandro Dalcin name++; /* skip starting dash */ 9972d747510SLisandro Dalcin 9982d747510SLisandro Dalcin /* slow search */ 9992d747510SLisandro Dalcin N = n = options->N; 1000e5c89e4eSSatish Balay names = options->names; 1001e5c89e4eSSatish Balay for (i=0; i<N; i++) { 10022d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 10032d747510SLisandro Dalcin if (!result) { 10042d747510SLisandro Dalcin n = i; break; 10052d747510SLisandro Dalcin } else if (result > 0) { 10062d747510SLisandro Dalcin n = N; break; 1007e5c89e4eSSatish Balay } 10082d747510SLisandro Dalcin } 10092d747510SLisandro Dalcin if (n == N) PetscFunctionReturn(0); /* it was not present */ 1010e5c89e4eSSatish Balay 10112d747510SLisandro Dalcin /* remove name and value */ 10122d747510SLisandro Dalcin if (options->names[n]) free(options->names[n]); 10132d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1014e5c89e4eSSatish Balay /* shift remaining values down 1 */ 1015e5c89e4eSSatish Balay for (i=n; i<N-1; i++) { 10165e8c5e88SLisandro Dalcin options->names[i] = options->names[i+1]; 1017e5c89e4eSSatish Balay options->values[i] = options->values[i+1]; 1018e5c89e4eSSatish Balay options->used[i] = options->used[i+1]; 1019e5c89e4eSSatish Balay } 1020e5c89e4eSSatish Balay options->N--; 10212d747510SLisandro Dalcin 10222d747510SLisandro Dalcin /* destroy hash table */ 10232d747510SLisandro Dalcin kh_destroy(HO,options->ht); 10242d747510SLisandro Dalcin options->ht = NULL; 10252d747510SLisandro Dalcin 10262d747510SLisandro Dalcin ierr = PetscOptionsMonitor(options,name,NULL);CHKERRQ(ierr); 1027e5c89e4eSSatish Balay PetscFunctionReturn(0); 1028e5c89e4eSSatish Balay } 1029e5c89e4eSSatish Balay 1030e5c89e4eSSatish Balay /*@C 10312d747510SLisandro Dalcin PetscOptionsFindPair - Gets an option name-value pair from the options database. 1032e5c89e4eSSatish Balay 10332d747510SLisandro Dalcin Not Collective 1034e5c89e4eSSatish Balay 1035e5c89e4eSSatish Balay Input Parameters: 10362d747510SLisandro Dalcin + options - options database, use NULL for the default global database 10372d747510SLisandro Dalcin . pre - the string to prepend to the name or NULL, this SHOULD NOT have the "-" prepended 10382d747510SLisandro Dalcin - name - name of option, this SHOULD have the "-" prepended 1039e5c89e4eSSatish Balay 10402d747510SLisandro Dalcin Output Parameters: 10412d747510SLisandro Dalcin + value - the option value (optional, not used for all options) 10422d747510SLisandro Dalcin - set - whether the option is set (optional) 1043e5c89e4eSSatish Balay 10442d747510SLisandro Dalcin Level: developer 10452d747510SLisandro Dalcin 10462d747510SLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsClearValue() 1047e5c89e4eSSatish Balay @*/ 10482d747510SLisandro Dalcin PetscErrorCode PetscOptionsFindPair(PetscOptions options,const char pre[],const char name[],const char *value[],PetscBool *set) 1049e5c89e4eSSatish Balay { 10502d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1051daabea38SBarry Smith PetscBool usehashtable = PETSC_TRUE; 10522d747510SLisandro Dalcin PetscBool matchnumbers = PETSC_TRUE; 1053e5c89e4eSSatish Balay PetscErrorCode ierr; 1054e5c89e4eSSatish Balay 1055e5c89e4eSSatish Balay PetscFunctionBegin; 1056c5929fdfSBarry Smith options = options ? options : defaultoptions; 10572d747510SLisandro Dalcin if (pre && PetscUnlikely(pre[0] == '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 10582d747510SLisandro Dalcin if (PetscUnlikely(name[0] != '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1059e5c89e4eSSatish Balay 10602d747510SLisandro Dalcin name++; /* skip starting dash */ 1061e5c89e4eSSatish Balay 10627cd08cecSJed Brown /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 10632d747510SLisandro Dalcin if (pre && pre[0]) { 10642d747510SLisandro Dalcin char *ptr = buf; 10652d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 10662d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,buf+sizeof(buf)-ptr);CHKERRQ(ierr); 10672d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 10682d747510SLisandro Dalcin name = buf; 10697cd08cecSJed Brown } 10702d747510SLisandro Dalcin 10712f828895SJed Brown #if defined(PETSC_USE_DEBUG) 10722f828895SJed Brown { 10732f828895SJed Brown PetscBool valid; 10742d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 10752d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 10762f828895SJed Brown ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 10772f828895SJed 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); 10782f828895SJed Brown } 10792f828895SJed Brown #endif 1080e5c89e4eSSatish Balay 10812d747510SLisandro Dalcin if (!options->ht && usehashtable) { 10822d747510SLisandro Dalcin int i,ret; 10832d747510SLisandro Dalcin khiter_t it; 10842d747510SLisandro Dalcin khash_t(HO) *ht; 10852d747510SLisandro Dalcin ht = kh_init(HO); 10862d747510SLisandro Dalcin if (PetscUnlikely(!ht)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 10872d747510SLisandro Dalcin ret = kh_resize(HO,ht,options->N*2); /* twice the required size to reduce risk of collisions */ 10882d747510SLisandro Dalcin if (PetscUnlikely(ret)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 10892d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 10902d747510SLisandro Dalcin it = kh_put(HO,ht,options->names[i],&ret); 10912d747510SLisandro Dalcin if (PetscUnlikely(ret != 1)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 10922d747510SLisandro Dalcin kh_val(ht,it) = i; 10932d747510SLisandro Dalcin } 10942d747510SLisandro Dalcin options->ht = ht; 10952d747510SLisandro Dalcin } 10962d747510SLisandro Dalcin 10972d747510SLisandro Dalcin if (usehashtable) 10982d747510SLisandro Dalcin { /* fast search */ 10992d747510SLisandro Dalcin khash_t(HO) *ht = options->ht; 11002d747510SLisandro Dalcin khiter_t it = kh_get(HO,ht,name); 11012d747510SLisandro Dalcin if (it != kh_end(ht)) { 11022d747510SLisandro Dalcin int i = kh_val(ht,it); 1103e5c89e4eSSatish Balay options->used[i] = PETSC_TRUE; 11042d747510SLisandro Dalcin if (value) *value = options->values[i]; 11052d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 11062d747510SLisandro Dalcin PetscFunctionReturn(0); 11072d747510SLisandro Dalcin } 11082d747510SLisandro Dalcin } else 11092d747510SLisandro Dalcin { /* slow search */ 11102d747510SLisandro Dalcin int i, N = options->N; 11112d747510SLisandro Dalcin for (i=0; i<N; i++) { 1112daabea38SBarry Smith int result = PetscOptNameCmp(options->names[i],name); 11132d747510SLisandro Dalcin if (!result) { 11142d747510SLisandro Dalcin options->used[i] = PETSC_TRUE; 11152d747510SLisandro Dalcin if (value) *value = options->values[i]; 11162d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 11172d747510SLisandro Dalcin PetscFunctionReturn(0); 11182d747510SLisandro Dalcin } else if (result > 0) { 1119e5c89e4eSSatish Balay break; 1120e5c89e4eSSatish Balay } 1121e5c89e4eSSatish Balay } 11222d747510SLisandro Dalcin } 11232d747510SLisandro Dalcin 11242d747510SLisandro Dalcin /* 11252d747510SLisandro Dalcin The following block slows down all lookups in the most frequent path (most lookups are unsuccessful). 11262d747510SLisandro Dalcin Maybe this special lookup mode should be enabled on request with a push/pop API. 11272d747510SLisandro Dalcin The feature of matching _%d_ used sparingly in the codebase. 11282d747510SLisandro Dalcin */ 11292d747510SLisandro Dalcin if (matchnumbers) { 11302d747510SLisandro Dalcin int i,j,cnt = 0,locs[16],loce[16]; 1131e5c89e4eSSatish Balay /* determine the location and number of all _%d_ in the key */ 11322d747510SLisandro Dalcin for (i=0; name[i]; i++) { 11332d747510SLisandro Dalcin if (name[i] == '_') { 11342d747510SLisandro Dalcin for (j=i+1; name[j]; j++) { 11352d747510SLisandro Dalcin if (name[j] >= '0' && name[j] <= '9') continue; 11362d747510SLisandro Dalcin if (name[j] == '_' && j > i+1) { /* found a number */ 1137e5c89e4eSSatish Balay locs[cnt] = i+1; 1138e5c89e4eSSatish Balay loce[cnt++] = j+1; 1139e5c89e4eSSatish Balay } 11402d747510SLisandro Dalcin i = j-1; 1141e5c89e4eSSatish Balay break; 1142e5c89e4eSSatish Balay } 1143e5c89e4eSSatish Balay } 1144e5c89e4eSSatish Balay } 1145e5c89e4eSSatish Balay for (i=0; i<cnt; i++) { 11462d747510SLisandro Dalcin PetscBool found; 11472d747510SLisandro Dalcin char opt[MAXOPTNAME+1] = "-", tmp[MAXOPTNAME]; 11482d747510SLisandro Dalcin ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[i]+1),sizeof(tmp)));CHKERRQ(ierr); 11492d747510SLisandro Dalcin ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 11502d747510SLisandro Dalcin ierr = PetscStrlcat(opt,name+loce[i],sizeof(opt));CHKERRQ(ierr); 11512d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,NULL,opt,value,&found);CHKERRQ(ierr); 11522d747510SLisandro Dalcin if (found) {if (set) *set = PETSC_TRUE; PetscFunctionReturn(0);} 1153e5c89e4eSSatish Balay } 1154e5c89e4eSSatish Balay } 11552d747510SLisandro Dalcin 11562d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1157e5c89e4eSSatish Balay PetscFunctionReturn(0); 1158e5c89e4eSSatish Balay } 1159e5c89e4eSSatish Balay 1160d6ced9c0SMatthew G. Knepley /* Check whether any option begins with pre+name */ 11612d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions options,const char pre[], const char name[],const char *value[],PetscBool *set) 1162514bf10dSMatthew G Knepley { 11632d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1164d6ced9c0SMatthew G. Knepley int numCnt = 0, locs[16],loce[16]; 1165514bf10dSMatthew G Knepley PetscErrorCode ierr; 1166514bf10dSMatthew G Knepley 1167514bf10dSMatthew G Knepley PetscFunctionBegin; 1168c5929fdfSBarry Smith options = options ? options : defaultoptions; 11692d747510SLisandro Dalcin if (pre && pre[0] == '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 11702d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1171514bf10dSMatthew G Knepley 11722d747510SLisandro Dalcin name++; /* skip starting dash */ 1173514bf10dSMatthew G Knepley 1174514bf10dSMatthew G Knepley /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 11752d747510SLisandro Dalcin if (pre && pre[0]) { 11762d747510SLisandro Dalcin char *ptr = buf; 11772d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 11782d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,sizeof(buf)+(size_t)(ptr-buf));CHKERRQ(ierr); 11792d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 11802d747510SLisandro Dalcin name = buf; 1181514bf10dSMatthew G Knepley } 11822d747510SLisandro Dalcin 1183514bf10dSMatthew G Knepley #if defined(PETSC_USE_DEBUG) 1184514bf10dSMatthew G Knepley { 1185514bf10dSMatthew G Knepley PetscBool valid; 11862d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 11872d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 1188514bf10dSMatthew G Knepley ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 1189514bf10dSMatthew 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); 1190514bf10dSMatthew G Knepley } 1191514bf10dSMatthew G Knepley #endif 1192514bf10dSMatthew G Knepley 1193d6ced9c0SMatthew G. Knepley /* determine the location and number of all _%d_ in the key */ 1194d6ced9c0SMatthew G. Knepley { 1195d6ced9c0SMatthew G. Knepley int i,j; 1196d6ced9c0SMatthew G. Knepley for (i=0; name[i]; i++) { 1197d6ced9c0SMatthew G. Knepley if (name[i] == '_') { 1198d6ced9c0SMatthew G. Knepley for (j=i+1; name[j]; j++) { 1199d6ced9c0SMatthew G. Knepley if (name[j] >= '0' && name[j] <= '9') continue; 1200d6ced9c0SMatthew G. Knepley if (name[j] == '_' && j > i+1) { /* found a number */ 1201d6ced9c0SMatthew G. Knepley locs[numCnt] = i+1; 1202d6ced9c0SMatthew G. Knepley loce[numCnt++] = j+1; 1203d6ced9c0SMatthew G. Knepley } 1204d6ced9c0SMatthew G. Knepley i = j-1; 1205d6ced9c0SMatthew G. Knepley break; 1206d6ced9c0SMatthew G. Knepley } 1207d6ced9c0SMatthew G. Knepley } 1208d6ced9c0SMatthew G. Knepley } 1209d6ced9c0SMatthew G. Knepley } 1210d6ced9c0SMatthew G. Knepley 12112d747510SLisandro Dalcin { /* slow search */ 1212d6ced9c0SMatthew G. Knepley int c, i; 12132d747510SLisandro Dalcin size_t len; 12142d747510SLisandro Dalcin PetscBool match; 1215d6ced9c0SMatthew G. Knepley 1216d6ced9c0SMatthew G. Knepley for (c = -1; c < numCnt; ++c) { 1217d6ced9c0SMatthew G. Knepley char opt[MAXOPTNAME+1] = "", tmp[MAXOPTNAME]; 1218d6ced9c0SMatthew G. Knepley 1219d6ced9c0SMatthew G. Knepley if (c < 0) { 1220d6ced9c0SMatthew G. Knepley ierr = PetscStrcpy(opt,name);CHKERRQ(ierr); 1221d6ced9c0SMatthew G. Knepley } else { 1222d6ced9c0SMatthew G. Knepley ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[c]+1),sizeof(tmp)));CHKERRQ(ierr); 1223d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 1224d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,name+loce[c],sizeof(opt));CHKERRQ(ierr); 1225d6ced9c0SMatthew G. Knepley } 1226d6ced9c0SMatthew G. Knepley ierr = PetscStrlen(opt,&len);CHKERRQ(ierr); 12272d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 1228d6ced9c0SMatthew G. Knepley ierr = PetscStrncmp(options->names[i],opt,len,&match);CHKERRQ(ierr); 1229514bf10dSMatthew G Knepley if (match) { 1230514bf10dSMatthew G Knepley options->used[i] = PETSC_TRUE; 12312d747510SLisandro Dalcin if (value) *value = options->values[i]; 12322d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 12332d747510SLisandro Dalcin PetscFunctionReturn(0); 1234514bf10dSMatthew G Knepley } 1235514bf10dSMatthew G Knepley } 12362d747510SLisandro Dalcin } 1237d6ced9c0SMatthew G. Knepley } 12382d747510SLisandro Dalcin 12392d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1240514bf10dSMatthew G Knepley PetscFunctionReturn(0); 1241514bf10dSMatthew G Knepley } 1242514bf10dSMatthew G Knepley 1243e5c89e4eSSatish Balay /*@C 1244e5c89e4eSSatish Balay PetscOptionsReject - Generates an error if a certain option is given. 1245e5c89e4eSSatish Balay 1246e5c89e4eSSatish Balay Not Collective, but setting values on certain processors could cause problems 1247e5c89e4eSSatish Balay for parallel objects looking for options. 1248e5c89e4eSSatish Balay 1249e5c89e4eSSatish Balay Input Parameters: 12505c9cc608SHong Zhang + options - options database, use NULL for default global database 12512d747510SLisandro Dalcin . pre - the option prefix (may be NULL) 12522d747510SLisandro Dalcin . name - the option name one is seeking 12530298fd71SBarry Smith - mess - error message (may be NULL) 1254e5c89e4eSSatish Balay 1255e5c89e4eSSatish Balay Level: advanced 1256e5c89e4eSSatish Balay 1257e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 1258acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1259e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1260e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1261acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1262a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1263e5c89e4eSSatish Balay @*/ 12642d747510SLisandro Dalcin PetscErrorCode PetscOptionsReject(PetscOptions options,const char pre[],const char name[],const char mess[]) 1265e5c89e4eSSatish Balay { 1266e5c89e4eSSatish Balay PetscErrorCode ierr; 1267ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 1268e5c89e4eSSatish Balay 1269e5c89e4eSSatish Balay PetscFunctionBegin; 12702d747510SLisandro Dalcin ierr = PetscOptionsHasName(options,pre,name,&flag);CHKERRQ(ierr); 1271e5c89e4eSSatish Balay if (flag) { 12722d747510SLisandro 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); 12732d747510SLisandro Dalcin else SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s",pre?pre:"",name+1); 1274e5c89e4eSSatish Balay } 1275e5c89e4eSSatish Balay PetscFunctionReturn(0); 1276e5c89e4eSSatish Balay } 1277e5c89e4eSSatish Balay 1278e5c89e4eSSatish Balay /*@C 12792d747510SLisandro Dalcin PetscOptionsHasHelp - Determines whether the "-help" option is in the database. 12802d747510SLisandro Dalcin 12812d747510SLisandro Dalcin Not Collective 12822d747510SLisandro Dalcin 12832d747510SLisandro Dalcin Input Parameters: 12842d747510SLisandro Dalcin . options - options database, use NULL for default global database 12852d747510SLisandro Dalcin 12862d747510SLisandro Dalcin Output Parameters: 12872d747510SLisandro Dalcin . set - PETSC_TRUE if found else PETSC_FALSE. 12882d747510SLisandro Dalcin 12892d747510SLisandro Dalcin Level: advanced 12902d747510SLisandro Dalcin 12912d747510SLisandro Dalcin .seealso: PetscOptionsHasName() 12922d747510SLisandro Dalcin @*/ 12932d747510SLisandro Dalcin PetscErrorCode PetscOptionsHasHelp(PetscOptions options,PetscBool *set) 12942d747510SLisandro Dalcin { 12952d747510SLisandro Dalcin PetscFunctionBegin; 12962d747510SLisandro Dalcin PetscValidPointer(set,2); 12972d747510SLisandro Dalcin options = options ? options : defaultoptions; 12982d747510SLisandro Dalcin *set = options->help; 12992d747510SLisandro Dalcin PetscFunctionReturn(0); 13002d747510SLisandro Dalcin } 13012d747510SLisandro Dalcin 13022d747510SLisandro Dalcin /*@C 130390d69ab7SBarry 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 130490d69ab7SBarry Smith its value is set to false. 1305e5c89e4eSSatish Balay 1306e5c89e4eSSatish Balay Not Collective 1307e5c89e4eSSatish Balay 1308e5c89e4eSSatish Balay Input Parameters: 13095c9cc608SHong Zhang + options - options database, use NULL for default global database 13103de71b31SHong Zhang . pre - string to prepend to the name or NULL 13113de71b31SHong Zhang - name - the option one is seeking 1312e5c89e4eSSatish Balay 1313e5c89e4eSSatish Balay Output Parameters: 131496ef3cdfSSatish Balay . set - PETSC_TRUE if found else PETSC_FALSE. 1315e5c89e4eSSatish Balay 1316e5c89e4eSSatish Balay Level: beginner 1317e5c89e4eSSatish Balay 131895452b02SPatrick Sanan Notes: 13192d747510SLisandro Dalcin Name cannot be simply "-h". 1320431c96f7SBarry Smith 1321acfcf0e5SJed Brown In many cases you probably want to use PetscOptionsGetBool() instead of calling this, to allowing toggling values. 132290d69ab7SBarry Smith 1323e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1324f3e3d7dfSBarry Smith PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1325e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1326e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1327acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1328a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1329e5c89e4eSSatish Balay @*/ 1330c5929fdfSBarry Smith PetscErrorCode PetscOptionsHasName(PetscOptions options,const char pre[],const char name[],PetscBool *set) 1331e5c89e4eSSatish Balay { 13322d747510SLisandro Dalcin const char *value; 1333e5c89e4eSSatish Balay PetscErrorCode ierr; 1334ace3abfcSBarry Smith PetscBool flag; 1335e5c89e4eSSatish Balay 1336e5c89e4eSSatish Balay PetscFunctionBegin; 13372d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 133896ef3cdfSSatish Balay if (set) *set = flag; 1339e5c89e4eSSatish Balay PetscFunctionReturn(0); 1340e5c89e4eSSatish Balay } 1341e5c89e4eSSatish Balay 1342e5c89e4eSSatish Balay /*@C 13432d747510SLisandro Dalcin PetscOptionsGetAll - Lists all the options the program was run with in a single string. 13442d747510SLisandro Dalcin 13452d747510SLisandro Dalcin Not Collective 13462d747510SLisandro Dalcin 13472d747510SLisandro Dalcin Input Paramter: 13482d747510SLisandro Dalcin . options - the options database, use NULL for the default global database 13492d747510SLisandro Dalcin 13502d747510SLisandro Dalcin Output Parameter: 13512d747510SLisandro Dalcin . copts - pointer where string pointer is stored 13522d747510SLisandro Dalcin 13532d747510SLisandro Dalcin Notes: 13542d747510SLisandro Dalcin the array and each entry in the array should be freed with PetscFree() 13552d747510SLisandro Dalcin 13562d747510SLisandro Dalcin Level: advanced 13572d747510SLisandro Dalcin 13582d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsView() 13592d747510SLisandro Dalcin @*/ 13602d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetAll(PetscOptions options,char *copts[]) 13612d747510SLisandro Dalcin { 13622d747510SLisandro Dalcin PetscErrorCode ierr; 13632d747510SLisandro Dalcin PetscInt i; 13642d747510SLisandro Dalcin size_t len = 1,lent = 0; 13652d747510SLisandro Dalcin char *coptions = NULL; 13662d747510SLisandro Dalcin 13672d747510SLisandro Dalcin PetscFunctionBegin; 13682d747510SLisandro Dalcin PetscValidPointer(copts,2); 13692d747510SLisandro Dalcin options = options ? options : defaultoptions; 13702d747510SLisandro Dalcin /* count the length of the required string */ 13712d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 13722d747510SLisandro Dalcin ierr = PetscStrlen(options->names[i],&lent);CHKERRQ(ierr); 13732d747510SLisandro Dalcin len += 2 + lent; 13742d747510SLisandro Dalcin if (options->values[i]) { 13752d747510SLisandro Dalcin ierr = PetscStrlen(options->values[i],&lent);CHKERRQ(ierr); 13762d747510SLisandro Dalcin len += 1 + lent; 13772d747510SLisandro Dalcin } 13782d747510SLisandro Dalcin } 13792d747510SLisandro Dalcin ierr = PetscMalloc1(len,&coptions);CHKERRQ(ierr); 13802d747510SLisandro Dalcin coptions[0] = 0; 13812d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 13822d747510SLisandro Dalcin ierr = PetscStrcat(coptions,"-");CHKERRQ(ierr); 13832d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->names[i]);CHKERRQ(ierr); 13842d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 13852d747510SLisandro Dalcin if (options->values[i]) { 13862d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->values[i]);CHKERRQ(ierr); 13872d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 13882d747510SLisandro Dalcin } 13892d747510SLisandro Dalcin } 13902d747510SLisandro Dalcin *copts = coptions; 13912d747510SLisandro Dalcin PetscFunctionReturn(0); 13922d747510SLisandro Dalcin } 13932d747510SLisandro Dalcin 13942d747510SLisandro Dalcin /*@C 13952d747510SLisandro Dalcin PetscOptionsUsed - Indicates if PETSc has used a particular option set in the database 13962d747510SLisandro Dalcin 13972d747510SLisandro Dalcin Not Collective 13982d747510SLisandro Dalcin 13992d747510SLisandro Dalcin Input Parameter: 14002d747510SLisandro Dalcin + options - options database, use NULL for default global database 14012d747510SLisandro Dalcin - name - string name of option 14022d747510SLisandro Dalcin 14032d747510SLisandro Dalcin Output Parameter: 14042d747510SLisandro Dalcin . used - PETSC_TRUE if the option was used, otherwise false, including if option was not found in options database 14052d747510SLisandro Dalcin 14062d747510SLisandro Dalcin Level: advanced 14072d747510SLisandro Dalcin 14082d747510SLisandro Dalcin .seealso: PetscOptionsView(), PetscOptionsLeft(), PetscOptionsAllUsed() 14092d747510SLisandro Dalcin @*/ 14102d747510SLisandro Dalcin PetscErrorCode PetscOptionsUsed(PetscOptions options,const char *name,PetscBool *used) 14112d747510SLisandro Dalcin { 14122d747510SLisandro Dalcin PetscInt i; 14132d747510SLisandro Dalcin PetscErrorCode ierr; 14142d747510SLisandro Dalcin 14152d747510SLisandro Dalcin PetscFunctionBegin; 14162d747510SLisandro Dalcin PetscValidCharPointer(name,2); 14172d747510SLisandro Dalcin PetscValidPointer(used,3); 14182d747510SLisandro Dalcin options = options ? options : defaultoptions; 14192d747510SLisandro Dalcin *used = PETSC_FALSE; 14202d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 14212d747510SLisandro Dalcin ierr = PetscStrcmp(options->names[i],name,used);CHKERRQ(ierr); 14222d747510SLisandro Dalcin if (*used) { 14232d747510SLisandro Dalcin *used = options->used[i]; 14242d747510SLisandro Dalcin break; 14252d747510SLisandro Dalcin } 14262d747510SLisandro Dalcin } 14272d747510SLisandro Dalcin PetscFunctionReturn(0); 14282d747510SLisandro Dalcin } 14292d747510SLisandro Dalcin 1430487a658cSBarry Smith /*@ 14312d747510SLisandro Dalcin PetscOptionsAllUsed - Returns a count of the number of options in the 14322d747510SLisandro Dalcin database that have never been selected. 14332d747510SLisandro Dalcin 14342d747510SLisandro Dalcin Not Collective 14352d747510SLisandro Dalcin 14362d747510SLisandro Dalcin Input Parameter: 14372d747510SLisandro Dalcin . options - options database, use NULL for default global database 14382d747510SLisandro Dalcin 14392d747510SLisandro Dalcin Output Parameter: 14402d747510SLisandro Dalcin . N - count of options not used 14412d747510SLisandro Dalcin 14422d747510SLisandro Dalcin Level: advanced 14432d747510SLisandro Dalcin 14442d747510SLisandro Dalcin .seealso: PetscOptionsView() 14452d747510SLisandro Dalcin @*/ 14462d747510SLisandro Dalcin PetscErrorCode PetscOptionsAllUsed(PetscOptions options,PetscInt *N) 14472d747510SLisandro Dalcin { 14482d747510SLisandro Dalcin PetscInt i,n = 0; 14492d747510SLisandro Dalcin 14502d747510SLisandro Dalcin PetscFunctionBegin; 14512d747510SLisandro Dalcin PetscValidIntPointer(N,2); 14522d747510SLisandro Dalcin options = options ? options : defaultoptions; 14532d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 14542d747510SLisandro Dalcin if (!options->used[i]) n++; 14552d747510SLisandro Dalcin } 14562d747510SLisandro Dalcin *N = n; 14572d747510SLisandro Dalcin PetscFunctionReturn(0); 14582d747510SLisandro Dalcin } 14592d747510SLisandro Dalcin 1460487a658cSBarry Smith /*@ 14612d747510SLisandro Dalcin PetscOptionsLeft - Prints to screen any options that were set and never used. 14622d747510SLisandro Dalcin 14632d747510SLisandro Dalcin Not Collective 14642d747510SLisandro Dalcin 14652d747510SLisandro Dalcin Input Parameter: 14662d747510SLisandro Dalcin . options - options database; use NULL for default global database 14672d747510SLisandro Dalcin 14682d747510SLisandro Dalcin Options Database Key: 14692d747510SLisandro Dalcin . -options_left - Activates OptionsAllUsed() within PetscFinalize() 14702d747510SLisandro Dalcin 14712d747510SLisandro Dalcin Level: advanced 14722d747510SLisandro Dalcin 14732d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed() 14742d747510SLisandro Dalcin @*/ 14752d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeft(PetscOptions options) 14762d747510SLisandro Dalcin { 14772d747510SLisandro Dalcin PetscErrorCode ierr; 14782d747510SLisandro Dalcin PetscInt i; 14792d747510SLisandro Dalcin 14802d747510SLisandro Dalcin PetscFunctionBegin; 14812d747510SLisandro Dalcin options = options ? options : defaultoptions; 14822d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 14832d747510SLisandro Dalcin if (!options->used[i]) { 14842d747510SLisandro Dalcin if (options->values[i]) { 14852d747510SLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s value: %s\n",options->names[i],options->values[i]);CHKERRQ(ierr); 14862d747510SLisandro Dalcin } else { 14872d747510SLisandro Dalcin ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s (no value)\n",options->names[i]);CHKERRQ(ierr); 14882d747510SLisandro Dalcin } 14892d747510SLisandro Dalcin } 14902d747510SLisandro Dalcin } 14912d747510SLisandro Dalcin PetscFunctionReturn(0); 14922d747510SLisandro Dalcin } 14932d747510SLisandro Dalcin 14942d747510SLisandro Dalcin /*@C 14952d747510SLisandro Dalcin PetscOptionsLeftGet - Returns all options that were set and never used. 14962d747510SLisandro Dalcin 14972d747510SLisandro Dalcin Not Collective 14982d747510SLisandro Dalcin 14992d747510SLisandro Dalcin Input Parameter: 15002d747510SLisandro Dalcin . options - options database, use NULL for default global database 15012d747510SLisandro Dalcin 15022d747510SLisandro Dalcin Output Parameter: 15032d747510SLisandro Dalcin . N - count of options not used 15042d747510SLisandro Dalcin . names - names of options not used 15052d747510SLisandro Dalcin . values - values of options not used 15062d747510SLisandro Dalcin 15072d747510SLisandro Dalcin Level: advanced 15082d747510SLisandro Dalcin 15092d747510SLisandro Dalcin Notes: 15102d747510SLisandro Dalcin Users should call PetscOptionsLeftRestore() to free the memory allocated in this routine 15112d747510SLisandro Dalcin 15122d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft() 15132d747510SLisandro Dalcin @*/ 15142d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftGet(PetscOptions options,PetscInt *N,char **names[],char **values[]) 15152d747510SLisandro Dalcin { 15162d747510SLisandro Dalcin PetscErrorCode ierr; 15172d747510SLisandro Dalcin PetscInt i,n; 15182d747510SLisandro Dalcin 15192d747510SLisandro Dalcin PetscFunctionBegin; 15202d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 15212d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 15222d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 15232d747510SLisandro Dalcin options = options ? options : defaultoptions; 15242d747510SLisandro Dalcin 15252d747510SLisandro Dalcin /* The number of unused PETSc options */ 15262d747510SLisandro Dalcin n = 0; 15272d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15282d747510SLisandro Dalcin if (!options->used[i]) n++; 15292d747510SLisandro Dalcin } 15302d747510SLisandro Dalcin if (N) { *N = n; } 15312d747510SLisandro Dalcin if (names) { ierr = PetscMalloc1(n,names);CHKERRQ(ierr); } 15322d747510SLisandro Dalcin if (values) { ierr = PetscMalloc1(n,values);CHKERRQ(ierr); } 15332d747510SLisandro Dalcin 15342d747510SLisandro Dalcin n = 0; 15352d747510SLisandro Dalcin if (names || values) { 15362d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 15372d747510SLisandro Dalcin if (!options->used[i]) { 15382d747510SLisandro Dalcin if (names) (*names)[n] = options->names[i]; 15392d747510SLisandro Dalcin if (values) (*values)[n] = options->values[i]; 15402d747510SLisandro Dalcin n++; 15412d747510SLisandro Dalcin } 15422d747510SLisandro Dalcin } 15432d747510SLisandro Dalcin } 15442d747510SLisandro Dalcin PetscFunctionReturn(0); 15452d747510SLisandro Dalcin } 15462d747510SLisandro Dalcin 15472d747510SLisandro Dalcin /*@C 15482d747510SLisandro Dalcin PetscOptionsLeftRestore - Free memory for the unused PETSc options obtained using PetscOptionsLeftGet. 15492d747510SLisandro Dalcin 15502d747510SLisandro Dalcin Not Collective 15512d747510SLisandro Dalcin 15522d747510SLisandro Dalcin Input Parameter: 15532d747510SLisandro Dalcin . options - options database, use NULL for default global database 15542d747510SLisandro Dalcin . names - names of options not used 15552d747510SLisandro Dalcin . values - values of options not used 15562d747510SLisandro Dalcin 15572d747510SLisandro Dalcin Level: advanced 15582d747510SLisandro Dalcin 15592d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft(), PetscOptionsLeftGet() 15602d747510SLisandro Dalcin @*/ 15612d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftRestore(PetscOptions options,PetscInt *N,char **names[],char **values[]) 15622d747510SLisandro Dalcin { 15632d747510SLisandro Dalcin PetscErrorCode ierr; 15642d747510SLisandro Dalcin 15652d747510SLisandro Dalcin PetscFunctionBegin; 15662d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 15672d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 15682d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 15692d747510SLisandro Dalcin if (N) { *N = 0; } 15702d747510SLisandro Dalcin if (names) { ierr = PetscFree(*names);CHKERRQ(ierr); } 15712d747510SLisandro Dalcin if (values) { ierr = PetscFree(*values);CHKERRQ(ierr); } 15722d747510SLisandro Dalcin PetscFunctionReturn(0); 15732d747510SLisandro Dalcin } 15742d747510SLisandro Dalcin 15752d747510SLisandro Dalcin /*@C 15762d747510SLisandro Dalcin PetscOptionsSetFromOptions - Sets options related to the handling of options in PETSc 15772d747510SLisandro Dalcin 15782d747510SLisandro Dalcin Collective on PETSC_COMM_WORLD 15792d747510SLisandro Dalcin 15802d747510SLisandro Dalcin Input Parameter: 15812d747510SLisandro Dalcin . options - options database, use NULL for default global database 15822d747510SLisandro Dalcin 15832d747510SLisandro Dalcin Options Database Keys: 15842d747510SLisandro Dalcin + -options_monitor <optional filename> - prints the names and values of all runtime options as they are set. The monitor functionality is not 15852d747510SLisandro Dalcin available for options set through a file, environment variable, or on 15862d747510SLisandro Dalcin the command line. Only options set after PetscInitialize() completes will 15872d747510SLisandro Dalcin be monitored. 15882d747510SLisandro Dalcin . -options_monitor_cancel - cancel all options database monitors 15892d747510SLisandro Dalcin 15902d747510SLisandro Dalcin Notes: 15912d747510SLisandro Dalcin To see all options, run your program with the -help option or consult Users-Manual: sec_gettingstarted 15922d747510SLisandro Dalcin 15932d747510SLisandro Dalcin Level: intermediate 15942d747510SLisandro Dalcin 15952d747510SLisandro Dalcin @*/ 15962d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetFromOptions(PetscOptions options) 15972d747510SLisandro Dalcin { 15982d747510SLisandro Dalcin PetscBool flgc = PETSC_FALSE,flgm; 15992d747510SLisandro Dalcin PetscErrorCode ierr; 16002d747510SLisandro Dalcin char monfilename[PETSC_MAX_PATH_LEN]; 16012d747510SLisandro Dalcin PetscViewer monviewer; 16022d747510SLisandro Dalcin 16032d747510SLisandro Dalcin PetscFunctionBegin; 16042d747510SLisandro Dalcin /* 16052d747510SLisandro Dalcin The options argument is currently ignored since we currently maintain only a single options database 16062d747510SLisandro Dalcin 16072d747510SLisandro Dalcin options = options ? options : defaultoptions; 16082d747510SLisandro Dalcin */ 16092d747510SLisandro Dalcin ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"Options for handling options","PetscOptions");CHKERRQ(ierr); 16102d747510SLisandro Dalcin ierr = PetscOptionsString("-options_monitor","Monitor options database","PetscOptionsMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flgm);CHKERRQ(ierr); 16112d747510SLisandro Dalcin ierr = PetscOptionsBool("-options_monitor_cancel","Cancel all options database monitors","PetscOptionsMonitorCancel",flgc,&flgc,NULL);CHKERRQ(ierr); 16122d747510SLisandro Dalcin ierr = PetscOptionsEnd();CHKERRQ(ierr); 16132d747510SLisandro Dalcin if (flgm) { 16142d747510SLisandro Dalcin ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,monfilename,&monviewer);CHKERRQ(ierr); 16152d747510SLisandro Dalcin ierr = PetscOptionsMonitorSet(PetscOptionsMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 16162d747510SLisandro Dalcin } 16172d747510SLisandro Dalcin if (flgc) { ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr); } 16182d747510SLisandro Dalcin PetscFunctionReturn(0); 16192d747510SLisandro Dalcin } 16202d747510SLisandro Dalcin 16212d747510SLisandro Dalcin /*@C 16222d747510SLisandro Dalcin PetscOptionsMonitorDefault - Print all options set value events. 16232d747510SLisandro Dalcin 16242d747510SLisandro Dalcin Logically Collective on PETSC_COMM_WORLD 16252d747510SLisandro Dalcin 16262d747510SLisandro Dalcin Input Parameters: 16272d747510SLisandro Dalcin + name - option name string 16282d747510SLisandro Dalcin . value - option value string 16292d747510SLisandro Dalcin - ctx - an ASCII viewer 16302d747510SLisandro Dalcin 16312d747510SLisandro Dalcin Level: intermediate 16322d747510SLisandro Dalcin 16332d747510SLisandro Dalcin .seealso: PetscOptionsMonitorSet() 16342d747510SLisandro Dalcin @*/ 16352d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorDefault(const char name[],const char value[],void *ctx) 16362d747510SLisandro Dalcin { 16372d747510SLisandro Dalcin PetscErrorCode ierr; 16382d747510SLisandro Dalcin PetscViewer viewer = (PetscViewer)ctx; 16392d747510SLisandro Dalcin 16402d747510SLisandro Dalcin PetscFunctionBegin; 16412d747510SLisandro Dalcin if (!value) { 16422d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Removing option: %s\n",name,value);CHKERRQ(ierr); 16432d747510SLisandro Dalcin } else if (!value[0]) { 16442d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s (no value)\n",name);CHKERRQ(ierr); 16452d747510SLisandro Dalcin } else { 16462d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr); 16472d747510SLisandro Dalcin } 16482d747510SLisandro Dalcin PetscFunctionReturn(0); 16492d747510SLisandro Dalcin } 16502d747510SLisandro Dalcin 16512d747510SLisandro Dalcin /*@C 16522d747510SLisandro Dalcin PetscOptionsMonitorSet - Sets an ADDITIONAL function to be called at every method that 16532d747510SLisandro Dalcin modified the PETSc options database. 16542d747510SLisandro Dalcin 16552d747510SLisandro Dalcin Not Collective 16562d747510SLisandro Dalcin 16572d747510SLisandro Dalcin Input Parameters: 16582d747510SLisandro Dalcin + monitor - pointer to function (if this is NULL, it turns off monitoring 16592d747510SLisandro Dalcin . mctx - [optional] context for private data for the 16602d747510SLisandro Dalcin monitor routine (use NULL if no context is desired) 16612d747510SLisandro Dalcin - monitordestroy - [optional] routine that frees monitor context 16622d747510SLisandro Dalcin (may be NULL) 16632d747510SLisandro Dalcin 16642d747510SLisandro Dalcin Calling Sequence of monitor: 16652d747510SLisandro Dalcin $ monitor (const char name[], const char value[], void *mctx) 16662d747510SLisandro Dalcin 16672d747510SLisandro Dalcin + name - option name string 16682d747510SLisandro Dalcin . value - option value string 16692d747510SLisandro Dalcin - mctx - optional monitoring context, as set by PetscOptionsMonitorSet() 16702d747510SLisandro Dalcin 16712d747510SLisandro Dalcin Options Database Keys: 16722d747510SLisandro Dalcin + -options_monitor - sets PetscOptionsMonitorDefault() 16732d747510SLisandro Dalcin - -options_monitor_cancel - cancels all monitors that have 16742d747510SLisandro Dalcin been hardwired into a code by 16752d747510SLisandro Dalcin calls to PetscOptionsMonitorSet(), but 16762d747510SLisandro Dalcin does not cancel those set via 16772d747510SLisandro Dalcin the options database. 16782d747510SLisandro Dalcin 16792d747510SLisandro Dalcin Notes: 16802d747510SLisandro Dalcin The default is to do nothing. To print the name and value of options 16812d747510SLisandro Dalcin being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine, 16822d747510SLisandro Dalcin with a null monitoring context. 16832d747510SLisandro Dalcin 16842d747510SLisandro Dalcin Several different monitoring routines may be set by calling 16852d747510SLisandro Dalcin PetscOptionsMonitorSet() multiple times; all will be called in the 16862d747510SLisandro Dalcin order in which they were set. 16872d747510SLisandro Dalcin 16882d747510SLisandro Dalcin Level: beginner 16892d747510SLisandro Dalcin 16902d747510SLisandro Dalcin .seealso: PetscOptionsMonitorDefault(), PetscOptionsMonitorCancel() 16912d747510SLisandro Dalcin @*/ 16922d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 16932d747510SLisandro Dalcin { 16942d747510SLisandro Dalcin PetscOptions options = defaultoptions; 16952d747510SLisandro Dalcin 16962d747510SLisandro Dalcin PetscFunctionBegin; 16972d747510SLisandro Dalcin if (options->numbermonitors >= MAXOPTIONSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptions monitors set"); 16982d747510SLisandro Dalcin options->monitor[options->numbermonitors] = monitor; 16992d747510SLisandro Dalcin options->monitordestroy[options->numbermonitors] = monitordestroy; 17002d747510SLisandro Dalcin options->monitorcontext[options->numbermonitors++] = (void*)mctx; 17012d747510SLisandro Dalcin PetscFunctionReturn(0); 17022d747510SLisandro Dalcin } 17032d747510SLisandro Dalcin 17042d747510SLisandro Dalcin /*@ 17052d747510SLisandro Dalcin PetscOptionsMonitorCancel - Clears all monitors for a PetscOptions object. 17062d747510SLisandro Dalcin 17072d747510SLisandro Dalcin Not Collective 17082d747510SLisandro Dalcin 17092d747510SLisandro Dalcin Options Database Key: 17102d747510SLisandro Dalcin . -options_monitor_cancel - Cancels all monitors that have 17112d747510SLisandro Dalcin been hardwired into a code by calls to PetscOptionsMonitorSet(), 17122d747510SLisandro Dalcin but does not cancel those set via the options database. 17132d747510SLisandro Dalcin 17142d747510SLisandro Dalcin Level: intermediate 17152d747510SLisandro Dalcin 17162d747510SLisandro Dalcin .seealso: PetscOptionsMonitorDefault(), PetscOptionsMonitorSet() 17172d747510SLisandro Dalcin @*/ 17182d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorCancel(void) 17192d747510SLisandro Dalcin { 17202d747510SLisandro Dalcin PetscErrorCode ierr; 17212d747510SLisandro Dalcin PetscInt i; 17222d747510SLisandro Dalcin PetscOptions options = defaultoptions; 17232d747510SLisandro Dalcin 17242d747510SLisandro Dalcin PetscFunctionBegin; 17252d747510SLisandro Dalcin for (i=0; i<options->numbermonitors; i++) { 17262d747510SLisandro Dalcin if (options->monitordestroy[i]) { 17272d747510SLisandro Dalcin ierr = (*options->monitordestroy[i])(&options->monitorcontext[i]);CHKERRQ(ierr); 17282d747510SLisandro Dalcin } 17292d747510SLisandro Dalcin } 17302d747510SLisandro Dalcin options->numbermonitors = 0; 17312d747510SLisandro Dalcin PetscFunctionReturn(0); 17322d747510SLisandro Dalcin } 17332d747510SLisandro Dalcin 17342d747510SLisandro Dalcin /* 17352d747510SLisandro Dalcin PetscOptionsStringToBool - Converts string to PetscBool , handles cases like "yes", "no", "true", "false", "0", "1", "off", "on". 17362d747510SLisandro Dalcin */ 17372d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToBool(const char value[],PetscBool *a) 17382d747510SLisandro Dalcin { 17392d747510SLisandro Dalcin PetscBool istrue,isfalse; 17402d747510SLisandro Dalcin size_t len; 17412d747510SLisandro Dalcin PetscErrorCode ierr; 17422d747510SLisandro Dalcin 17432d747510SLisandro Dalcin PetscFunctionBegin; 17442d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 17452d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Character string of length zero has no logical value"); 17462d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"TRUE",&istrue);CHKERRQ(ierr); 17472d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 17482d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"YES",&istrue);CHKERRQ(ierr); 17492d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 17502d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"1",&istrue);CHKERRQ(ierr); 17512d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 17522d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"on",&istrue);CHKERRQ(ierr); 17532d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 17542d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"FALSE",&isfalse);CHKERRQ(ierr); 17552d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 17562d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"NO",&isfalse);CHKERRQ(ierr); 17572d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 17582d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"0",&isfalse);CHKERRQ(ierr); 17592d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 17602d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"off",&isfalse);CHKERRQ(ierr); 17612d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 17622d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown logical value: %s",value); 17632d747510SLisandro Dalcin } 17642d747510SLisandro Dalcin 17652d747510SLisandro Dalcin /* 17662d747510SLisandro Dalcin PetscOptionsStringToInt - Converts a string to an integer value. Handles special cases such as "default" and "decide" 17672d747510SLisandro Dalcin */ 17682d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToInt(const char name[],PetscInt *a) 17692d747510SLisandro Dalcin { 17702d747510SLisandro Dalcin PetscErrorCode ierr; 17712d747510SLisandro Dalcin size_t len; 17722d747510SLisandro Dalcin PetscBool decide,tdefault,mouse; 17732d747510SLisandro Dalcin 17742d747510SLisandro Dalcin PetscFunctionBegin; 17752d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 17762d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 17772d747510SLisandro Dalcin 17782d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&tdefault);CHKERRQ(ierr); 17792d747510SLisandro Dalcin if (!tdefault) { 17802d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&tdefault);CHKERRQ(ierr); 17812d747510SLisandro Dalcin } 17822d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&decide);CHKERRQ(ierr); 17832d747510SLisandro Dalcin if (!decide) { 17842d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&decide);CHKERRQ(ierr); 17852d747510SLisandro Dalcin } 17862d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"mouse",&mouse);CHKERRQ(ierr); 17872d747510SLisandro Dalcin 17882d747510SLisandro Dalcin if (tdefault) *a = PETSC_DEFAULT; 17892d747510SLisandro Dalcin else if (decide) *a = PETSC_DECIDE; 17902d747510SLisandro Dalcin else if (mouse) *a = -1; 17912d747510SLisandro Dalcin else { 17922d747510SLisandro Dalcin char *endptr; 17932d747510SLisandro Dalcin long strtolval; 17942d747510SLisandro Dalcin 17952d747510SLisandro Dalcin strtolval = strtol(name,&endptr,10); 17962d747510SLisandro 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); 17972d747510SLisandro Dalcin 17982d747510SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE_ATOLL) 17992d747510SLisandro Dalcin (void) strtolval; 18002d747510SLisandro Dalcin *a = atoll(name); 18012d747510SLisandro Dalcin #elif defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE___INT64) 18022d747510SLisandro Dalcin (void) strtolval; 18032d747510SLisandro Dalcin *a = _atoi64(name); 18042d747510SLisandro Dalcin #else 18052d747510SLisandro Dalcin *a = (PetscInt)strtolval; 18062d747510SLisandro Dalcin #endif 18072d747510SLisandro Dalcin } 18082d747510SLisandro Dalcin PetscFunctionReturn(0); 18092d747510SLisandro Dalcin } 18102d747510SLisandro Dalcin 18112d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 18122d747510SLisandro Dalcin #include <quadmath.h> 18132d747510SLisandro Dalcin #endif 18142d747510SLisandro Dalcin 18152d747510SLisandro Dalcin static PetscErrorCode PetscStrtod(const char name[],PetscReal *a,char **endptr) 18162d747510SLisandro Dalcin { 18172d747510SLisandro Dalcin PetscFunctionBegin; 18182d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 18192d747510SLisandro Dalcin *a = strtoflt128(name,endptr); 18202d747510SLisandro Dalcin #else 18212d747510SLisandro Dalcin *a = (PetscReal)strtod(name,endptr); 18222d747510SLisandro Dalcin #endif 18232d747510SLisandro Dalcin PetscFunctionReturn(0); 18242d747510SLisandro Dalcin } 18252d747510SLisandro Dalcin 18262d747510SLisandro Dalcin static PetscErrorCode PetscStrtoz(const char name[],PetscScalar *a,char **endptr,PetscBool *isImaginary) 18272d747510SLisandro Dalcin { 18282d747510SLisandro Dalcin PetscBool hasi = PETSC_FALSE; 18292d747510SLisandro Dalcin char *ptr; 18302d747510SLisandro Dalcin PetscReal strtoval; 18312d747510SLisandro Dalcin PetscErrorCode ierr; 18322d747510SLisandro Dalcin 18332d747510SLisandro Dalcin PetscFunctionBegin; 18342d747510SLisandro Dalcin ierr = PetscStrtod(name,&strtoval,&ptr);CHKERRQ(ierr); 18352d747510SLisandro Dalcin if (ptr == name) { 18362d747510SLisandro Dalcin strtoval = 1.; 18372d747510SLisandro Dalcin hasi = PETSC_TRUE; 18382d747510SLisandro Dalcin if (name[0] == 'i') { 18392d747510SLisandro Dalcin ptr++; 18402d747510SLisandro Dalcin } else if (name[0] == '+' && name[1] == 'i') { 18412d747510SLisandro Dalcin ptr += 2; 18422d747510SLisandro Dalcin } else if (name[0] == '-' && name[1] == 'i') { 18432d747510SLisandro Dalcin strtoval = -1.; 18442d747510SLisandro Dalcin ptr += 2; 18452d747510SLisandro Dalcin } 18462d747510SLisandro Dalcin } else if (*ptr == 'i') { 18472d747510SLisandro Dalcin hasi = PETSC_TRUE; 18482d747510SLisandro Dalcin ptr++; 18492d747510SLisandro Dalcin } 18502d747510SLisandro Dalcin *endptr = ptr; 18512d747510SLisandro Dalcin *isImaginary = hasi; 18522d747510SLisandro Dalcin if (hasi) { 18532d747510SLisandro Dalcin #if !defined(PETSC_USE_COMPLEX) 18542d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s contains imaginary but complex not supported ",name); 18552d747510SLisandro Dalcin #else 18562d747510SLisandro Dalcin *a = PetscCMPLX(0.,strtoval); 18572d747510SLisandro Dalcin #endif 18582d747510SLisandro Dalcin } else { 18592d747510SLisandro Dalcin *a = strtoval; 18602d747510SLisandro Dalcin } 18612d747510SLisandro Dalcin PetscFunctionReturn(0); 18622d747510SLisandro Dalcin } 18632d747510SLisandro Dalcin 18642d747510SLisandro Dalcin /* 18652d747510SLisandro Dalcin Converts a string to PetscReal value. Handles special cases like "default" and "decide" 18662d747510SLisandro Dalcin */ 18672d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToReal(const char name[],PetscReal *a) 18682d747510SLisandro Dalcin { 18692d747510SLisandro Dalcin size_t len; 18702d747510SLisandro Dalcin PetscBool match; 18712d747510SLisandro Dalcin char *endptr; 18722d747510SLisandro Dalcin PetscErrorCode ierr; 18732d747510SLisandro Dalcin 18742d747510SLisandro Dalcin PetscFunctionBegin; 18752d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 18762d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"String of length zero has no numerical value"); 18772d747510SLisandro Dalcin 18782d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&match);CHKERRQ(ierr); 18792d747510SLisandro Dalcin if (!match) { 18802d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&match);CHKERRQ(ierr); 18812d747510SLisandro Dalcin } 18822d747510SLisandro Dalcin if (match) {*a = PETSC_DEFAULT; PetscFunctionReturn(0);} 18832d747510SLisandro Dalcin 18842d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&match);CHKERRQ(ierr); 18852d747510SLisandro Dalcin if (!match) { 18862d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&match);CHKERRQ(ierr); 18872d747510SLisandro Dalcin } 18882d747510SLisandro Dalcin if (match) {*a = PETSC_DECIDE; PetscFunctionReturn(0);} 18892d747510SLisandro Dalcin 18902d747510SLisandro Dalcin ierr = PetscStrtod(name,a,&endptr);CHKERRQ(ierr); 18912d747510SLisandro Dalcin if ((size_t) (endptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value",name); 18922d747510SLisandro Dalcin PetscFunctionReturn(0); 18932d747510SLisandro Dalcin } 18942d747510SLisandro Dalcin 18952d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToScalar(const char name[],PetscScalar *a) 18962d747510SLisandro Dalcin { 18972d747510SLisandro Dalcin PetscBool imag1; 18982d747510SLisandro Dalcin size_t len; 18992d747510SLisandro Dalcin PetscScalar val = 0.; 19002d747510SLisandro Dalcin char *ptr = NULL; 19012d747510SLisandro Dalcin PetscErrorCode ierr; 19022d747510SLisandro Dalcin 19032d747510SLisandro Dalcin PetscFunctionBegin; 19042d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 19052d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 19062d747510SLisandro Dalcin ierr = PetscStrtoz(name,&val,&ptr,&imag1);CHKERRQ(ierr); 19072d747510SLisandro Dalcin #if defined(PETSC_USE_COMPLEX) 19082d747510SLisandro Dalcin if ((size_t) (ptr - name) < len) { 19092d747510SLisandro Dalcin PetscBool imag2; 19102d747510SLisandro Dalcin PetscScalar val2; 19112d747510SLisandro Dalcin 19122d747510SLisandro Dalcin ierr = PetscStrtoz(ptr,&val2,&ptr,&imag2);CHKERRQ(ierr); 19132d747510SLisandro Dalcin if (imag1 || !imag2) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s: must specify imaginary component second",name); 19142d747510SLisandro Dalcin val = PetscCMPLX(PetscRealPart(val),PetscImaginaryPart(val2)); 19152d747510SLisandro Dalcin } 19162d747510SLisandro Dalcin #endif 19172d747510SLisandro Dalcin if ((size_t) (ptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value ",name); 19182d747510SLisandro Dalcin *a = val; 19192d747510SLisandro Dalcin PetscFunctionReturn(0); 19202d747510SLisandro Dalcin } 19212d747510SLisandro Dalcin 19222d747510SLisandro Dalcin /*@C 19232d747510SLisandro Dalcin PetscOptionsGetBool - Gets the Logical (true or false) value for a particular 19242d747510SLisandro Dalcin option in the database. 1925e5c89e4eSSatish Balay 1926e5c89e4eSSatish Balay Not Collective 1927e5c89e4eSSatish Balay 1928e5c89e4eSSatish Balay Input Parameters: 19295c9cc608SHong Zhang + options - options database, use NULL for default global database 1930c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 1931e5c89e4eSSatish Balay - name - the option one is seeking 1932e5c89e4eSSatish Balay 1933e5c89e4eSSatish Balay Output Parameter: 19342d747510SLisandro Dalcin + ivalue - the logical value to return 193596ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 1936e5c89e4eSSatish Balay 1937e5c89e4eSSatish Balay Level: beginner 1938e5c89e4eSSatish Balay 193995452b02SPatrick Sanan Notes: 19402d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 19412d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 19422d747510SLisandro Dalcin 19432d747510SLisandro 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 19442d747510SLisandro Dalcin is equivalent to -requested_bool true 19452d747510SLisandro Dalcin 19462d747510SLisandro Dalcin If the user does not supply the option at all ivalue is NOT changed. Thus 19472efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 19482efd9cb1SBarry Smith 1949e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 19502d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetInt(), PetscOptionsBool(), 1951e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1952e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1953acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1954a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1955e5c89e4eSSatish Balay @*/ 19562d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBool(PetscOptions options,const char pre[],const char name[],PetscBool *ivalue,PetscBool *set) 1957e5c89e4eSSatish Balay { 19582d747510SLisandro Dalcin const char *value; 1959ace3abfcSBarry Smith PetscBool flag; 19602d747510SLisandro Dalcin PetscErrorCode ierr; 1961e5c89e4eSSatish Balay 1962e5c89e4eSSatish Balay PetscFunctionBegin; 19632d747510SLisandro Dalcin PetscValidCharPointer(name,3); 19642d747510SLisandro Dalcin if (ivalue) PetscValidIntPointer(ivalue,4); 19652d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 1966e5c89e4eSSatish Balay if (flag) { 196796ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 19682d747510SLisandro Dalcin if (!value) { 19692d747510SLisandro Dalcin if (ivalue) *ivalue = PETSC_TRUE; 19702d747510SLisandro Dalcin } else { 19712d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value, &flag);CHKERRQ(ierr); 19722d747510SLisandro Dalcin if (ivalue) *ivalue = flag; 1973e5c89e4eSSatish Balay } 1974e5c89e4eSSatish Balay } else { 197596ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 1976e5c89e4eSSatish Balay } 1977e5c89e4eSSatish Balay PetscFunctionReturn(0); 1978e5c89e4eSSatish Balay } 1979e5c89e4eSSatish Balay 1980e5c89e4eSSatish Balay /*@C 1981e5c89e4eSSatish Balay PetscOptionsGetEList - Puts a list of option values that a single one may be selected from 1982e5c89e4eSSatish Balay 1983e5c89e4eSSatish Balay Not Collective 1984e5c89e4eSSatish Balay 1985e5c89e4eSSatish Balay Input Parameters: 19865c9cc608SHong Zhang + options - options database, use NULL for default global database 1987c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 1988e5c89e4eSSatish Balay . opt - option name 1989a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 1990e5c89e4eSSatish Balay . ntext - number of choices 1991e5c89e4eSSatish Balay 1992e5c89e4eSSatish Balay Output Parameter: 19932efd9cb1SBarry Smith + value - the index of the value to return (defaults to zero if the option name is given but no choice is listed) 1994e5c89e4eSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 1995e5c89e4eSSatish Balay 1996e5c89e4eSSatish Balay Level: intermediate 1997e5c89e4eSSatish Balay 199895452b02SPatrick Sanan Notes: 199995452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 20002efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 20012efd9cb1SBarry Smith 2002a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 2003e5c89e4eSSatish Balay 2004e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2005acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2006e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2007e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2008acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2009a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2010e5c89e4eSSatish Balay @*/ 2011c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEList(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscInt ntext,PetscInt *value,PetscBool *set) 2012e5c89e4eSSatish Balay { 2013e5c89e4eSSatish Balay PetscErrorCode ierr; 2014e5c89e4eSSatish Balay size_t alen,len = 0; 2015e5c89e4eSSatish Balay char *svalue; 2016ace3abfcSBarry Smith PetscBool aset,flg = PETSC_FALSE; 2017e5c89e4eSSatish Balay PetscInt i; 2018e5c89e4eSSatish Balay 2019e5c89e4eSSatish Balay PetscFunctionBegin; 20202d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2021e5c89e4eSSatish Balay for (i=0; i<ntext; i++) { 2022e5c89e4eSSatish Balay ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr); 2023e5c89e4eSSatish Balay if (alen > len) len = alen; 2024e5c89e4eSSatish Balay } 2025e5c89e4eSSatish Balay len += 5; /* a little extra space for user mistypes */ 2026785e854fSJed Brown ierr = PetscMalloc1(len,&svalue);CHKERRQ(ierr); 2027c5929fdfSBarry Smith ierr = PetscOptionsGetString(options,pre,opt,svalue,len,&aset);CHKERRQ(ierr); 2028e5c89e4eSSatish Balay if (aset) { 2029fbedd5e0SJed Brown ierr = PetscEListFind(ntext,list,svalue,value,&flg);CHKERRQ(ierr); 2030e32f2f54SBarry Smith if (!flg) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown option %s for -%s%s",svalue,pre ? pre : "",opt+1); 2031fbedd5e0SJed Brown if (set) *set = PETSC_TRUE; 2032a297a907SKarl Rupp } else if (set) *set = PETSC_FALSE; 2033e5c89e4eSSatish Balay ierr = PetscFree(svalue);CHKERRQ(ierr); 2034e5c89e4eSSatish Balay PetscFunctionReturn(0); 2035e5c89e4eSSatish Balay } 2036e5c89e4eSSatish Balay 2037e5c89e4eSSatish Balay /*@C 2038e5c89e4eSSatish Balay PetscOptionsGetEnum - Gets the enum value for a particular option in the database. 2039e5c89e4eSSatish Balay 2040e5c89e4eSSatish Balay Not Collective 2041e5c89e4eSSatish Balay 2042e5c89e4eSSatish Balay Input Parameters: 20435c9cc608SHong Zhang + options - options database, use NULL for default global database 2044c5929fdfSBarry Smith . pre - option prefix or NULL 2045e5c89e4eSSatish Balay . opt - option name 2046e5c89e4eSSatish Balay . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 2047e5c89e4eSSatish Balay - defaultv - the default (current) value 2048e5c89e4eSSatish Balay 2049e5c89e4eSSatish Balay Output Parameter: 2050e5c89e4eSSatish Balay + value - the value to return 205196ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2052e5c89e4eSSatish Balay 2053e5c89e4eSSatish Balay Level: beginner 2054e5c89e4eSSatish Balay 205595452b02SPatrick Sanan Notes: 205695452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 20572efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2058e5c89e4eSSatish Balay 20592efd9cb1SBarry Smith List is usually something like PCASMTypes or some other predefined list of enum names 2060e5c89e4eSSatish Balay 2061e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 2062acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 2063acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2064e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2065e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2066acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2067a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 2068e5c89e4eSSatish Balay @*/ 2069c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set) 2070e5c89e4eSSatish Balay { 2071e5c89e4eSSatish Balay PetscErrorCode ierr; 207269a24498SJed Brown PetscInt ntext = 0,tval; 2073ace3abfcSBarry Smith PetscBool fset; 2074e5c89e4eSSatish Balay 2075e5c89e4eSSatish Balay PetscFunctionBegin; 20762d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2077e5c89e4eSSatish Balay while (list[ntext++]) { 2078e32f2f54SBarry Smith if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 2079e5c89e4eSSatish Balay } 2080e32f2f54SBarry Smith if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 2081e5c89e4eSSatish Balay ntext -= 3; 2082c5929fdfSBarry Smith ierr = PetscOptionsGetEList(options,pre,opt,list,ntext,&tval,&fset);CHKERRQ(ierr); 208369a24498SJed Brown /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 2084809ceb46SBarry Smith if (fset) *value = (PetscEnum)tval; 2085809ceb46SBarry Smith if (set) *set = fset; 2086e5c89e4eSSatish Balay PetscFunctionReturn(0); 2087e5c89e4eSSatish Balay } 2088e5c89e4eSSatish Balay 2089e5c89e4eSSatish Balay /*@C 20902d747510SLisandro Dalcin PetscOptionsGetInt - Gets the integer 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 - the string to prepend to the name or NULL 2097e5c89e4eSSatish Balay - name - the option one is seeking 2098e5c89e4eSSatish Balay 2099e5c89e4eSSatish Balay Output Parameter: 21002d747510SLisandro Dalcin + ivalue - the integer value to return 210196ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2102e5c89e4eSSatish Balay 2103e5c89e4eSSatish Balay Level: beginner 2104e5c89e4eSSatish Balay 2105e5c89e4eSSatish Balay Notes: 21062d747510SLisandro Dalcin If the user does not supply the option ivalue is NOT changed. Thus 21072efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 21085c07ccb8SBarry Smith 2109e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 21102d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 21112d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2112e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2113e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2114acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2115a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2116e5c89e4eSSatish Balay @*/ 21172d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetInt(PetscOptions options,const char pre[],const char name[],PetscInt *ivalue,PetscBool *set) 2118e5c89e4eSSatish Balay { 21192d747510SLisandro Dalcin const char *value; 2120e5c89e4eSSatish Balay PetscErrorCode ierr; 21212d747510SLisandro Dalcin PetscBool flag; 2122e5c89e4eSSatish Balay 2123e5c89e4eSSatish Balay PetscFunctionBegin; 21242d747510SLisandro Dalcin PetscValidCharPointer(name,3); 21252d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 21262d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2127e5c89e4eSSatish Balay if (flag) { 212834a9cc2cSBarry Smith if (!value) { 21292d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 213034a9cc2cSBarry Smith } else { 21312d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 21322d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 2133e5c89e4eSSatish Balay } 2134e5c89e4eSSatish Balay } else { 213596ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2136e5c89e4eSSatish Balay } 2137e5c89e4eSSatish Balay PetscFunctionReturn(0); 2138e5c89e4eSSatish Balay } 2139e5c89e4eSSatish Balay 2140e2446a98SMatthew Knepley /*@C 2141e5c89e4eSSatish Balay PetscOptionsGetReal - Gets the double precision value for a particular 2142e5c89e4eSSatish Balay 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 - string to prepend to each name or NULL 2149e5c89e4eSSatish Balay - name - the option one is seeking 2150e5c89e4eSSatish Balay 2151e5c89e4eSSatish Balay Output Parameter: 2152e5c89e4eSSatish Balay + dvalue - the double value to return 215396ef3cdfSSatish Balay - set - PETSC_TRUE if found, PETSC_FALSE if not found 2154e5c89e4eSSatish Balay 215595452b02SPatrick Sanan Notes: 215695452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 21572efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2158e4974155SBarry Smith 2159e5c89e4eSSatish Balay Level: beginner 2160e5c89e4eSSatish Balay 2161e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2162acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 2163e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2164e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2165acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2166a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2167e5c89e4eSSatish Balay @*/ 2168c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetReal(PetscOptions options,const char pre[],const char name[],PetscReal *dvalue,PetscBool *set) 2169e5c89e4eSSatish Balay { 21702d747510SLisandro Dalcin const char *value; 2171ace3abfcSBarry Smith PetscBool flag; 21722d747510SLisandro Dalcin PetscErrorCode ierr; 2173e5c89e4eSSatish Balay 2174e5c89e4eSSatish Balay PetscFunctionBegin; 21752d747510SLisandro Dalcin PetscValidCharPointer(name,3); 21762d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 21772d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2178e5c89e4eSSatish Balay if (flag) { 2179a297a907SKarl Rupp if (!value) { 2180a297a907SKarl Rupp if (set) *set = PETSC_FALSE; 2181a297a907SKarl Rupp } else { 2182a297a907SKarl Rupp if (set) *set = PETSC_TRUE; 2183a297a907SKarl Rupp ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2184a297a907SKarl Rupp } 2185e5c89e4eSSatish Balay } else { 218696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2187e5c89e4eSSatish Balay } 2188e5c89e4eSSatish Balay PetscFunctionReturn(0); 2189e5c89e4eSSatish Balay } 2190e5c89e4eSSatish Balay 2191e5c89e4eSSatish Balay /*@C 2192e5c89e4eSSatish Balay PetscOptionsGetScalar - Gets the scalar value for a particular 2193e5c89e4eSSatish Balay option in the database. 2194e5c89e4eSSatish Balay 2195e5c89e4eSSatish Balay Not Collective 2196e5c89e4eSSatish Balay 2197e5c89e4eSSatish Balay Input Parameters: 21985c9cc608SHong Zhang + options - options database, use NULL for default global database 2199c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2200e5c89e4eSSatish Balay - name - the option one is seeking 2201e5c89e4eSSatish Balay 2202e5c89e4eSSatish Balay Output Parameter: 2203e5c89e4eSSatish Balay + dvalue - the double value to return 220496ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2205e5c89e4eSSatish Balay 2206e5c89e4eSSatish Balay Level: beginner 2207e5c89e4eSSatish Balay 2208e5c89e4eSSatish Balay Usage: 2209eb4ae41dSBarry Smith A complex number 2+3i must be specified with NO spaces 2210e5c89e4eSSatish Balay 221195452b02SPatrick Sanan Notes: 221295452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 22132efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2214e4974155SBarry Smith 2215e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2216acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2217e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2218e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2219acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2220a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2221e5c89e4eSSatish Balay @*/ 2222c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetScalar(PetscOptions options,const char pre[],const char name[],PetscScalar *dvalue,PetscBool *set) 2223e5c89e4eSSatish Balay { 22242d747510SLisandro Dalcin const char *value; 2225ace3abfcSBarry Smith PetscBool flag; 2226e5c89e4eSSatish Balay PetscErrorCode ierr; 2227e5c89e4eSSatish Balay 2228e5c89e4eSSatish Balay PetscFunctionBegin; 22292d747510SLisandro Dalcin PetscValidCharPointer(name,3); 22302d747510SLisandro Dalcin PetscValidScalarPointer(dvalue,4); 22312d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2232e5c89e4eSSatish Balay if (flag) { 2233e5c89e4eSSatish Balay if (!value) { 223496ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2235e5c89e4eSSatish Balay } else { 2236e5c89e4eSSatish Balay #if !defined(PETSC_USE_COMPLEX) 2237cfbddea1SSatish Balay ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2238e5c89e4eSSatish Balay #else 2239eb4ae41dSBarry Smith ierr = PetscOptionsStringToScalar(value,dvalue);CHKERRQ(ierr); 2240e5c89e4eSSatish Balay #endif 224196ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2242e5c89e4eSSatish Balay } 2243e5c89e4eSSatish Balay } else { /* flag */ 224496ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2245e5c89e4eSSatish Balay } 2246e5c89e4eSSatish Balay PetscFunctionReturn(0); 2247e5c89e4eSSatish Balay } 2248e5c89e4eSSatish Balay 2249e5c89e4eSSatish Balay /*@C 2250e5c89e4eSSatish Balay PetscOptionsGetString - Gets the string value for a particular option in 2251e5c89e4eSSatish Balay the database. 2252e5c89e4eSSatish Balay 2253e5c89e4eSSatish Balay Not Collective 2254e5c89e4eSSatish Balay 2255e5c89e4eSSatish Balay Input Parameters: 22565c9cc608SHong Zhang + options - options database, use NULL for default global database 2257c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2258e5c89e4eSSatish Balay . name - the option one is seeking 2259bcbf2dc5SJed Brown - len - maximum length of the string including null termination 2260e5c89e4eSSatish Balay 2261e5c89e4eSSatish Balay Output Parameters: 2262e5c89e4eSSatish Balay + string - location to copy string 226396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2264e5c89e4eSSatish Balay 2265e5c89e4eSSatish Balay Level: beginner 2266e5c89e4eSSatish Balay 2267e5c89e4eSSatish Balay Fortran Note: 2268e5c89e4eSSatish Balay The Fortran interface is slightly different from the C/C++ 2269e5c89e4eSSatish Balay interface (len is not used). Sample usage in Fortran follows 2270e5c89e4eSSatish Balay .vb 2271e5c89e4eSSatish Balay character *20 string 227293e6ba5cSBarry Smith PetscErrorCode ierr 227393e6ba5cSBarry Smith PetscBool set 22741b266c99SBarry Smith call PetscOptionsGetString(PETSC_NULL_OPTIONS,PETSC_NULL_CHARACTER,'-s',string,set,ierr) 2275e5c89e4eSSatish Balay .ve 2276e5c89e4eSSatish Balay 227795452b02SPatrick Sanan Notes: 227895452b02SPatrick 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 2279e4974155SBarry Smith 22802efd9cb1SBarry Smith If the user does not use the option then the string is not changed. Thus 22812efd9cb1SBarry Smith you should ALWAYS initialize the string if you access it without first checking if the set flag is true. 22822efd9cb1SBarry Smith 2283f3dea69dSBarry Smith Note: 2284f3dea69dSBarry 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). 2285f3dea69dSBarry Smith 2286e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2287acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2288e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2289e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2290acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2291a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2292e5c89e4eSSatish Balay @*/ 2293c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetString(PetscOptions options,const char pre[],const char name[],char string[],size_t len,PetscBool *set) 2294e5c89e4eSSatish Balay { 22952d747510SLisandro Dalcin const char *value; 2296ace3abfcSBarry Smith PetscBool flag; 22972d747510SLisandro Dalcin PetscErrorCode ierr; 2298e5c89e4eSSatish Balay 2299e5c89e4eSSatish Balay PetscFunctionBegin; 23002d747510SLisandro Dalcin PetscValidCharPointer(name,3); 23012d747510SLisandro Dalcin PetscValidCharPointer(string,4); 23022d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2303e5c89e4eSSatish Balay if (!flag) { 230496ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2305e5c89e4eSSatish Balay } else { 230696ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2307e5c89e4eSSatish Balay if (value) { 2308e5c89e4eSSatish Balay ierr = PetscStrncpy(string,value,len);CHKERRQ(ierr); 2309e5c89e4eSSatish Balay } else { 2310e5c89e4eSSatish Balay ierr = PetscMemzero(string,len);CHKERRQ(ierr); 2311e5c89e4eSSatish Balay } 2312e5c89e4eSSatish Balay } 2313e5c89e4eSSatish Balay PetscFunctionReturn(0); 2314e5c89e4eSSatish Balay } 2315e5c89e4eSSatish Balay 2316c5929fdfSBarry Smith char *PetscOptionsGetStringMatlab(PetscOptions options,const char pre[],const char name[]) 231714ce751eSBarry Smith { 23182d747510SLisandro Dalcin const char *value; 231914ce751eSBarry Smith PetscBool flag; 23202d747510SLisandro Dalcin PetscErrorCode ierr; 232114ce751eSBarry Smith 232214ce751eSBarry Smith PetscFunctionBegin; 23232d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);if (ierr) PetscFunctionReturn(0); 23242d747510SLisandro Dalcin if (flag) PetscFunctionReturn((char*)value); 232514ce751eSBarry Smith else PetscFunctionReturn(0); 232614ce751eSBarry Smith } 232714ce751eSBarry Smith 23282d747510SLisandro Dalcin /*@C 23292d747510SLisandro Dalcin PetscOptionsGetBoolArray - Gets an array of Logical (true or false) values for a particular 23302d747510SLisandro Dalcin option in the database. The values must be separated with commas with 23312d747510SLisandro Dalcin no intervening spaces. 23322d747510SLisandro Dalcin 23332d747510SLisandro Dalcin Not Collective 23342d747510SLisandro Dalcin 23352d747510SLisandro Dalcin Input Parameters: 23362d747510SLisandro Dalcin + options - options database, use NULL for default global database 23372d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 23382d747510SLisandro Dalcin . name - the option one is seeking 23392d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 23402d747510SLisandro Dalcin 23412d747510SLisandro Dalcin Output Parameter: 23422d747510SLisandro Dalcin + dvalue - the integer values to return 23432d747510SLisandro Dalcin . nmax - actual number of values retreived 23442d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 23452d747510SLisandro Dalcin 23462d747510SLisandro Dalcin Level: beginner 23472d747510SLisandro Dalcin 23482d747510SLisandro Dalcin Notes: 23492d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 23502d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 23512d747510SLisandro Dalcin 23522d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 23532d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 23542d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 23552d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 23562d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 23572d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 23582d747510SLisandro Dalcin @*/ 23592d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBoolArray(PetscOptions options,const char pre[],const char name[],PetscBool dvalue[],PetscInt *nmax,PetscBool *set) 23602d747510SLisandro Dalcin { 23612d747510SLisandro Dalcin const char *svalue; 23622d747510SLisandro Dalcin char *value; 23632d747510SLisandro Dalcin PetscErrorCode ierr; 23642d747510SLisandro Dalcin PetscInt n = 0; 23652d747510SLisandro Dalcin PetscBool flag; 23662d747510SLisandro Dalcin PetscToken token; 23672d747510SLisandro Dalcin 23682d747510SLisandro Dalcin PetscFunctionBegin; 23692d747510SLisandro Dalcin PetscValidCharPointer(name,3); 23702d747510SLisandro Dalcin PetscValidIntPointer(dvalue,4); 23712d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 23722d747510SLisandro Dalcin 23732d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 23742d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 23752d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 23762d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 23772d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 23782d747510SLisandro Dalcin while (value && n < *nmax) { 23792d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value,dvalue);CHKERRQ(ierr); 23802d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 23812d747510SLisandro Dalcin dvalue++; 23822d747510SLisandro Dalcin n++; 23832d747510SLisandro Dalcin } 23842d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 23852d747510SLisandro Dalcin *nmax = n; 23862d747510SLisandro Dalcin PetscFunctionReturn(0); 23872d747510SLisandro Dalcin } 23882d747510SLisandro Dalcin 23892d747510SLisandro Dalcin /*@C 23902d747510SLisandro Dalcin PetscOptionsGetEnumArray - Gets an array of enum values for a particular option in the database. 23912d747510SLisandro Dalcin 23922d747510SLisandro Dalcin Not Collective 23932d747510SLisandro Dalcin 23942d747510SLisandro Dalcin Input Parameters: 23952d747510SLisandro Dalcin + options - options database, use NULL for default global database 23962d747510SLisandro Dalcin . pre - option prefix or NULL 23972d747510SLisandro Dalcin . name - option name 23982d747510SLisandro Dalcin . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 23992d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 24002d747510SLisandro Dalcin 24012d747510SLisandro Dalcin Output Parameters: 24022d747510SLisandro Dalcin + ivalue - the enum values to return 24032d747510SLisandro Dalcin . nmax - actual number of values retreived 24042d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 24052d747510SLisandro Dalcin 24062d747510SLisandro Dalcin Level: beginner 24072d747510SLisandro Dalcin 24082d747510SLisandro Dalcin Notes: 24092d747510SLisandro Dalcin The array must be passed as a comma separated list. 24102d747510SLisandro Dalcin 24112d747510SLisandro Dalcin There must be no intervening spaces between the values. 24122d747510SLisandro Dalcin 24132d747510SLisandro Dalcin list is usually something like PCASMTypes or some other predefined list of enum names. 24142d747510SLisandro Dalcin 24152d747510SLisandro Dalcin .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 24162d747510SLisandro Dalcin PetscOptionsGetEnum(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 24172d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), 24182d747510SLisandro Dalcin PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), 24192d747510SLisandro Dalcin PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 24202d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 24212d747510SLisandro Dalcin @*/ 24222d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetEnumArray(PetscOptions options,const char pre[],const char name[],const char *const *list,PetscEnum ivalue[],PetscInt *nmax,PetscBool *set) 24232d747510SLisandro Dalcin { 24242d747510SLisandro Dalcin const char *svalue; 24252d747510SLisandro Dalcin char *value; 24262d747510SLisandro Dalcin PetscInt n = 0; 24272d747510SLisandro Dalcin PetscEnum evalue; 24282d747510SLisandro Dalcin PetscBool flag; 24292d747510SLisandro Dalcin PetscToken token; 24302d747510SLisandro Dalcin PetscErrorCode ierr; 24312d747510SLisandro Dalcin 24322d747510SLisandro Dalcin PetscFunctionBegin; 24332d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24342d747510SLisandro Dalcin PetscValidPointer(list,4); 24352d747510SLisandro Dalcin PetscValidPointer(ivalue,5); 24362d747510SLisandro Dalcin PetscValidIntPointer(nmax,6); 24372d747510SLisandro Dalcin 24382d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 24392d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 24402d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 24412d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 24422d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 24432d747510SLisandro Dalcin while (value && n < *nmax) { 24442d747510SLisandro Dalcin ierr = PetscEnumFind(list,value,&evalue,&flag);CHKERRQ(ierr); 24452d747510SLisandro Dalcin if (!flag) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown enum value '%s' for -%s%s",svalue,pre ? pre : "",name+1); 24462d747510SLisandro Dalcin ivalue[n++] = evalue; 24472d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 24482d747510SLisandro Dalcin } 24492d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 24502d747510SLisandro Dalcin *nmax = n; 24512d747510SLisandro Dalcin PetscFunctionReturn(0); 24522d747510SLisandro Dalcin } 24532d747510SLisandro Dalcin 24542d747510SLisandro Dalcin /*@C 24552d747510SLisandro Dalcin PetscOptionsGetIntArray - Gets an array of integer values for a particular 24562d747510SLisandro Dalcin option in the database. 24572d747510SLisandro Dalcin 24582d747510SLisandro Dalcin Not Collective 24592d747510SLisandro Dalcin 24602d747510SLisandro Dalcin Input Parameters: 24612d747510SLisandro Dalcin + options - options database, use NULL for default global database 24622d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 24632d747510SLisandro Dalcin . name - the option one is seeking 24642d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 24652d747510SLisandro Dalcin 24662d747510SLisandro Dalcin Output Parameter: 24672d747510SLisandro Dalcin + ivalue - the integer values to return 24682d747510SLisandro Dalcin . nmax - actual number of values retreived 24692d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 24702d747510SLisandro Dalcin 24712d747510SLisandro Dalcin Level: beginner 24722d747510SLisandro Dalcin 24732d747510SLisandro Dalcin Notes: 24742d747510SLisandro Dalcin The array can be passed as 24752d747510SLisandro Dalcin a comma separated list: 0,1,2,3,4,5,6,7 24762d747510SLisandro Dalcin a range (start-end+1): 0-8 24772d747510SLisandro Dalcin a range with given increment (start-end+1:inc): 0-7:2 24782d747510SLisandro Dalcin a combination of values and ranges separated by commas: 0,1-8,8-15:2 24792d747510SLisandro Dalcin 24802d747510SLisandro Dalcin There must be no intervening spaces between the values. 24812d747510SLisandro Dalcin 24822d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 24832d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 24842d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 24852d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 24862d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 24872d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 24882d747510SLisandro Dalcin @*/ 24892d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetIntArray(PetscOptions options,const char pre[],const char name[],PetscInt ivalue[],PetscInt *nmax,PetscBool *set) 24902d747510SLisandro Dalcin { 24912d747510SLisandro Dalcin const char *svalue; 24922d747510SLisandro Dalcin char *value; 24932d747510SLisandro Dalcin PetscErrorCode ierr; 24942d747510SLisandro Dalcin PetscInt n = 0,i,j,start,end,inc,nvalues; 24952d747510SLisandro Dalcin size_t len; 24962d747510SLisandro Dalcin PetscBool flag,foundrange; 24972d747510SLisandro Dalcin PetscToken token; 24982d747510SLisandro Dalcin 24992d747510SLisandro Dalcin PetscFunctionBegin; 25002d747510SLisandro Dalcin PetscValidCharPointer(name,3); 25012d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 25022d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 25032d747510SLisandro Dalcin 25042d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 25052d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 25062d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 25072d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 25082d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 25092d747510SLisandro Dalcin while (value && n < *nmax) { 25102d747510SLisandro Dalcin /* look for form d-D where d and D are integers */ 25112d747510SLisandro Dalcin foundrange = PETSC_FALSE; 25122d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 25132d747510SLisandro Dalcin if (value[0] == '-') i=2; 25142d747510SLisandro Dalcin else i=1; 25152d747510SLisandro Dalcin for (;i<(int)len; i++) { 25162d747510SLisandro Dalcin if (value[i] == '-') { 25172d747510SLisandro Dalcin if (i == (int)len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value); 25182d747510SLisandro Dalcin value[i] = 0; 25192d747510SLisandro Dalcin 25202d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,&start);CHKERRQ(ierr); 25212d747510SLisandro Dalcin inc = 1; 25222d747510SLisandro Dalcin j = i+1; 25232d747510SLisandro Dalcin for (;j<(int)len; j++) { 25242d747510SLisandro Dalcin if (value[j] == ':') { 25252d747510SLisandro Dalcin value[j] = 0; 25262d747510SLisandro Dalcin 25272d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+j+1,&inc);CHKERRQ(ierr); 25282d747510SLisandro 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); 25292d747510SLisandro Dalcin break; 25302d747510SLisandro Dalcin } 25312d747510SLisandro Dalcin } 25322d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+i+1,&end);CHKERRQ(ierr); 25332d747510SLisandro 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); 25342d747510SLisandro Dalcin nvalues = (end-start)/inc + (end-start)%inc; 25352d747510SLisandro 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); 25362d747510SLisandro Dalcin for (;start<end; start+=inc) { 25372d747510SLisandro Dalcin *ivalue = start; ivalue++;n++; 25382d747510SLisandro Dalcin } 25392d747510SLisandro Dalcin foundrange = PETSC_TRUE; 25402d747510SLisandro Dalcin break; 25412d747510SLisandro Dalcin } 25422d747510SLisandro Dalcin } 25432d747510SLisandro Dalcin if (!foundrange) { 25442d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 25452d747510SLisandro Dalcin ivalue++; 25462d747510SLisandro Dalcin n++; 25472d747510SLisandro Dalcin } 25482d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 25492d747510SLisandro Dalcin } 25502d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 25512d747510SLisandro Dalcin *nmax = n; 25522d747510SLisandro Dalcin PetscFunctionReturn(0); 25532d747510SLisandro Dalcin } 25542d747510SLisandro Dalcin 25552d747510SLisandro Dalcin /*@C 25562d747510SLisandro Dalcin PetscOptionsGetRealArray - Gets an array of double precision values for a 25572d747510SLisandro Dalcin particular option in the database. The values must be separated with 25582d747510SLisandro Dalcin commas with no intervening spaces. 25592d747510SLisandro Dalcin 25602d747510SLisandro Dalcin Not Collective 25612d747510SLisandro Dalcin 25622d747510SLisandro Dalcin Input Parameters: 25632d747510SLisandro Dalcin + options - options database, use NULL for default global database 25642d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 25652d747510SLisandro Dalcin . name - the option one is seeking 25662d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 25672d747510SLisandro Dalcin 25682d747510SLisandro Dalcin Output Parameters: 25692d747510SLisandro Dalcin + dvalue - the double values to return 25702d747510SLisandro Dalcin . nmax - actual number of values retreived 25712d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 25722d747510SLisandro Dalcin 25732d747510SLisandro Dalcin Level: beginner 25742d747510SLisandro Dalcin 25752d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 25762d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 25772d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 25782d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 25792d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 25802d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 25812d747510SLisandro Dalcin @*/ 25822d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetRealArray(PetscOptions options,const char pre[],const char name[],PetscReal dvalue[],PetscInt *nmax,PetscBool *set) 25832d747510SLisandro Dalcin { 25842d747510SLisandro Dalcin const char *svalue; 25852d747510SLisandro Dalcin char *value; 25862d747510SLisandro Dalcin PetscErrorCode ierr; 25872d747510SLisandro Dalcin PetscInt n = 0; 25882d747510SLisandro Dalcin PetscBool flag; 25892d747510SLisandro Dalcin PetscToken token; 25902d747510SLisandro Dalcin 25912d747510SLisandro Dalcin PetscFunctionBegin; 25922d747510SLisandro Dalcin PetscValidCharPointer(name,3); 25932d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 25942d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 25952d747510SLisandro Dalcin 25962d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 25972d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 25982d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 25992d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26002d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26012d747510SLisandro Dalcin while (value && n < *nmax) { 26022d747510SLisandro Dalcin ierr = PetscOptionsStringToReal(value,dvalue++);CHKERRQ(ierr); 26032d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26042d747510SLisandro Dalcin n++; 26052d747510SLisandro Dalcin } 26062d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26072d747510SLisandro Dalcin *nmax = n; 26082d747510SLisandro Dalcin PetscFunctionReturn(0); 26092d747510SLisandro Dalcin } 26102d747510SLisandro Dalcin 26112d747510SLisandro Dalcin /*@C 26122d747510SLisandro Dalcin PetscOptionsGetScalarArray - Gets an array of scalars for a 26132d747510SLisandro Dalcin particular option in the database. The values must be separated with 26142d747510SLisandro Dalcin commas with no intervening spaces. 26152d747510SLisandro Dalcin 26162d747510SLisandro Dalcin Not Collective 26172d747510SLisandro Dalcin 26182d747510SLisandro Dalcin Input Parameters: 26192d747510SLisandro Dalcin + options - options database, use NULL for default global database 26202d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 26212d747510SLisandro Dalcin . name - the option one is seeking 26222d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 26232d747510SLisandro Dalcin 26242d747510SLisandro Dalcin Output Parameters: 26252d747510SLisandro Dalcin + dvalue - the scalar values to return 26262d747510SLisandro Dalcin . nmax - actual number of values retreived 26272d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26282d747510SLisandro Dalcin 26292d747510SLisandro Dalcin Level: beginner 26302d747510SLisandro Dalcin 26312d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 26322d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 26332d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 26342d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 26352d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26362d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 26372d747510SLisandro Dalcin @*/ 26382d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set) 26392d747510SLisandro Dalcin { 26402d747510SLisandro Dalcin const char *svalue; 26412d747510SLisandro Dalcin char *value; 26422d747510SLisandro Dalcin PetscErrorCode ierr; 26432d747510SLisandro Dalcin PetscInt n = 0; 26442d747510SLisandro Dalcin PetscBool flag; 26452d747510SLisandro Dalcin PetscToken token; 26462d747510SLisandro Dalcin 26472d747510SLisandro Dalcin PetscFunctionBegin; 26482d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26492d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 26502d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 26512d747510SLisandro Dalcin 26522d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 26532d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26542d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26552d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26562d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26572d747510SLisandro Dalcin while (value && n < *nmax) { 26582d747510SLisandro Dalcin ierr = PetscOptionsStringToScalar(value,dvalue++);CHKERRQ(ierr); 26592d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26602d747510SLisandro Dalcin n++; 26612d747510SLisandro Dalcin } 26622d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26632d747510SLisandro Dalcin *nmax = n; 26642d747510SLisandro Dalcin PetscFunctionReturn(0); 26652d747510SLisandro Dalcin } 266614ce751eSBarry Smith 2667e5c89e4eSSatish Balay /*@C 2668e5c89e4eSSatish Balay PetscOptionsGetStringArray - Gets an array of string values for a particular 2669e5c89e4eSSatish Balay option in the database. The values must be separated with commas with 2670e5c89e4eSSatish Balay no intervening spaces. 2671e5c89e4eSSatish Balay 2672e5c89e4eSSatish Balay Not Collective 2673e5c89e4eSSatish Balay 2674e5c89e4eSSatish Balay Input Parameters: 26755c9cc608SHong Zhang + options - options database, use NULL for default global database 2676c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2677e5c89e4eSSatish Balay . name - the option one is seeking 2678e5c89e4eSSatish Balay - nmax - maximum number of strings 2679e5c89e4eSSatish Balay 2680e5c89e4eSSatish Balay Output Parameter: 2681e5c89e4eSSatish Balay + strings - location to copy strings 268296ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2683e5c89e4eSSatish Balay 2684e5c89e4eSSatish Balay Level: beginner 2685e5c89e4eSSatish Balay 2686e5c89e4eSSatish Balay Notes: 2687e5c89e4eSSatish Balay The user should pass in an array of pointers to char, to hold all the 2688e5c89e4eSSatish Balay strings returned by this function. 2689e5c89e4eSSatish Balay 2690e5c89e4eSSatish Balay The user is responsible for deallocating the strings that are 2691e5c89e4eSSatish Balay returned. The Fortran interface for this routine is not supported. 2692e5c89e4eSSatish Balay 2693e5c89e4eSSatish Balay Contributed by Matthew Knepley. 2694e5c89e4eSSatish Balay 2695e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2696acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2697e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2698e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2699acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2700a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2701e5c89e4eSSatish Balay @*/ 2702c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetStringArray(PetscOptions options,const char pre[],const char name[],char *strings[],PetscInt *nmax,PetscBool *set) 2703e5c89e4eSSatish Balay { 27042d747510SLisandro Dalcin const char *svalue; 2705e5c89e4eSSatish Balay char *value; 2706e5c89e4eSSatish Balay PetscErrorCode ierr; 27072d747510SLisandro Dalcin PetscInt n = 0; 2708ace3abfcSBarry Smith PetscBool flag; 27099c9d3cfdSBarry Smith PetscToken token; 2710e5c89e4eSSatish Balay 2711e5c89e4eSSatish Balay PetscFunctionBegin; 27122d747510SLisandro Dalcin PetscValidCharPointer(name,3); 27132d747510SLisandro Dalcin PetscValidPointer(strings,4); 27142d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 2715e5c89e4eSSatish Balay 27162d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 27172d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 27182d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 27192d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 2720e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27212d747510SLisandro Dalcin while (value && n < *nmax) { 2722e5c89e4eSSatish Balay ierr = PetscStrallocpy(value,&strings[n]);CHKERRQ(ierr); 2723e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 2724e5c89e4eSSatish Balay n++; 2725e5c89e4eSSatish Balay } 27268c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 2727e5c89e4eSSatish Balay *nmax = n; 2728e5c89e4eSSatish Balay PetscFunctionReturn(0); 2729e5c89e4eSSatish Balay } 273006824ed3SPatrick Sanan 273106824ed3SPatrick Sanan /*@C 273206824ed3SPatrick Sanan PetscOptionsDeprecated - mark an option as deprecated, optionally replacing it with a new one 273306824ed3SPatrick Sanan 273406824ed3SPatrick Sanan Prints a deprecation warning, unless an option is supplied to suppress. 273506824ed3SPatrick Sanan 273606824ed3SPatrick Sanan Not Collective 273706824ed3SPatrick Sanan 273806824ed3SPatrick Sanan Input Parameters: 27399503aa97SPatrick Sanan + pre - string to prepend to name or NULL 274006824ed3SPatrick Sanan . oldname - the old, deprecated option 274106824ed3SPatrick Sanan . newname - the new option, or NULL if option is purely removed 27429f3a6782SPatrick Sanan . version - a string describing the version of first deprecation, e.g. "3.9" 27439f3a6782SPatrick Sanan - info - additional information string, or NULL. 274406824ed3SPatrick Sanan 274506824ed3SPatrick Sanan Options Database Keys: 274606824ed3SPatrick Sanan . -options_suppress_deprecated_warnings - do not print deprecation warnings 274706824ed3SPatrick Sanan 274806824ed3SPatrick Sanan Notes: 2749b40114eaSPatrick Sanan Must be called between PetscOptionsBegin() and PetscOptionsEnd(). 2750b40114eaSPatrick Sanan If newname is provided, the old option is replaced. Otherwise, it remains 2751b40114eaSPatrick Sanan in the options database. 27529f3a6782SPatrick Sanan If an option is not replaced, the info argument should be used to advise the user 27539f3a6782SPatrick Sanan on how to proceed. 27549f3a6782SPatrick Sanan There is a limit on the length of the warning printed, so very long strings 27559f3a6782SPatrick Sanan provided as info may be truncated. 275606824ed3SPatrick Sanan 275706824ed3SPatrick Sanan Level: developer 275806824ed3SPatrick Sanan 275906824ed3SPatrick Sanan .seealso: PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsScalar(), PetscOptionsBool(), PetscOptionsString(), PetscOptionsSetValue() 276006824ed3SPatrick Sanan 276106824ed3SPatrick Sanan @*/ 27629f3a6782SPatrick Sanan PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems *PetscOptionsObject,const char oldname[],const char newname[],const char version[],const char info[]) 276306824ed3SPatrick Sanan { 276406824ed3SPatrick Sanan PetscErrorCode ierr; 276506824ed3SPatrick Sanan PetscBool found,quiet; 276606824ed3SPatrick Sanan const char *value; 276706824ed3SPatrick Sanan const char * const quietopt="-options_suppress_deprecated_warnings"; 27689f3a6782SPatrick Sanan char msg[4096]; 276906824ed3SPatrick Sanan 277006824ed3SPatrick Sanan PetscFunctionBegin; 277106824ed3SPatrick Sanan PetscValidCharPointer(oldname,2); 277206824ed3SPatrick Sanan PetscValidCharPointer(version,4); 277306824ed3SPatrick Sanan 277406824ed3SPatrick Sanan ierr = PetscOptionsFindPair(PetscOptionsObject->options,PetscOptionsObject->prefix,oldname,&value,&found);CHKERRQ(ierr); 277506824ed3SPatrick Sanan if (found) { 277606824ed3SPatrick Sanan if (newname) { 2777d255429eSPatrick Sanan if (PetscOptionsObject->prefix) { 277806824ed3SPatrick Sanan ierr = PetscOptionsPrefixPush(PetscOptionsObject->options,PetscOptionsObject->prefix);CHKERRQ(ierr); 2779d255429eSPatrick Sanan } 278006824ed3SPatrick Sanan ierr = PetscOptionsSetValue(PetscOptionsObject->options,newname,value);CHKERRQ(ierr); 2781d255429eSPatrick Sanan if (PetscOptionsObject->prefix) { 278206824ed3SPatrick Sanan ierr = PetscOptionsPrefixPop(PetscOptionsObject->options);CHKERRQ(ierr); 2783d255429eSPatrick Sanan } 278406824ed3SPatrick Sanan ierr = PetscOptionsClearValue(PetscOptionsObject->options,oldname);CHKERRQ(ierr); 2785b40114eaSPatrick Sanan } 278606824ed3SPatrick Sanan quiet = PETSC_FALSE; 278706824ed3SPatrick Sanan ierr = PetscOptionsGetBool(PetscOptionsObject->options,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr); 278806824ed3SPatrick Sanan if (!quiet) { 27899f3a6782SPatrick Sanan ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr); 27901fa95f81SSatish Balay ierr = PetscStrcat(msg,oldname);CHKERRQ(ierr); 2791928bb9adSStefano Zampini ierr = PetscStrcat(msg," is deprecated as of version ");CHKERRQ(ierr); 27929f3a6782SPatrick Sanan ierr = PetscStrcat(msg,version);CHKERRQ(ierr); 27939f3a6782SPatrick Sanan ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr); 279406824ed3SPatrick Sanan if (newname) { 27959f3a6782SPatrick Sanan ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr); 27969f3a6782SPatrick Sanan ierr = PetscStrcat(msg,newname);CHKERRQ(ierr); 27979f3a6782SPatrick Sanan ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr); 279806824ed3SPatrick Sanan } 27999f3a6782SPatrick Sanan if (info) { 28009f3a6782SPatrick Sanan ierr = PetscStrcat(msg," ");CHKERRQ(ierr); 28019f3a6782SPatrick Sanan ierr = PetscStrcat(msg,info);CHKERRQ(ierr); 28029f3a6782SPatrick Sanan } 28039f3a6782SPatrick Sanan ierr = PetscStrcat(msg," (Silence this warning with ");CHKERRQ(ierr); 28049f3a6782SPatrick Sanan ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr); 28059f3a6782SPatrick Sanan ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr); 28069f3a6782SPatrick Sanan ierr = PetscPrintf(PetscOptionsObject->comm,msg);CHKERRQ(ierr); 280706824ed3SPatrick Sanan } 280806824ed3SPatrick Sanan } 280906824ed3SPatrick Sanan PetscFunctionReturn(0); 281006824ed3SPatrick Sanan } 2811