173fca5a0SBarry Smith /* Define Feature test macros to make sure atoll is available (SVr4, POSIX.1-2001, 4.3BSD, C99), not in (C89 and POSIX.1-1996) */ 20039db0dSBarry Smith #define PETSC_DESIRE_FEATURE_TEST_MACROS /* for atoll() */ 3e5ea902fSJed Brown 4e5c89e4eSSatish Balay /* 53fc1eb6aSBarry Smith These routines simplify the use of command line, file options, etc., and are used to manipulate the options database. 63fc1eb6aSBarry Smith This provides the low-level interface, the high level interface is in aoptions.c 7e5c89e4eSSatish Balay 83fc1eb6aSBarry Smith Some routines use regular malloc and free because it cannot know what malloc is requested with the 93fc1eb6aSBarry Smith options database until it has already processed the input. 10e5c89e4eSSatish Balay */ 11e5c89e4eSSatish Balay 12af0996ceSBarry Smith #include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/ 13665c2dedSJed Brown #include <petscviewer.h> 14ad1ac5ecSJed Brown #include <ctype.h> 15e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MALLOC_H) 16e5c89e4eSSatish Balay #include <malloc.h> 17e5c89e4eSSatish Balay #endif 18ef279fd6SBarry Smith #if defined(PETSC_HAVE_STRINGS_H) 19ef279fd6SBarry Smith # include <strings.h> /* strcasecmp */ 20ef279fd6SBarry Smith #endif 213bcbd388SSean Farley #if defined(PETSC_HAVE_YAML) 223bcbd388SSean Farley #include <yaml.h> 233bcbd388SSean Farley #endif 24e5c89e4eSSatish Balay 252d747510SLisandro Dalcin #if defined(PETSC_HAVE_STRCASECMP) 262d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) strcasecmp(a,b) 272d747510SLisandro Dalcin #elif defined(PETSC_HAVE_STRICMP) 282d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) stricmp(a,b) 292d747510SLisandro Dalcin #else 302d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) Error_strcasecmp_not_found 312d747510SLisandro Dalcin #endif 322d747510SLisandro Dalcin 332d747510SLisandro Dalcin #include <petsc/private/hashtable.h> 342d747510SLisandro Dalcin 352d747510SLisandro Dalcin /* This assumes ASCII encoding and ignores locale settings */ 362d747510SLisandro Dalcin /* Using tolower() is about 2X slower in microbenchmarks */ 372d747510SLisandro Dalcin PETSC_STATIC_INLINE int PetscToLower(int c) 382d747510SLisandro Dalcin { 392d747510SLisandro Dalcin return ((c >= 'A') & (c <= 'Z')) ? c + 'a' - 'A' : c; 402d747510SLisandro Dalcin } 412d747510SLisandro Dalcin 422d747510SLisandro Dalcin /* Bob Jenkins's one at a time hash function (case-insensitive) */ 432d747510SLisandro Dalcin PETSC_STATIC_INLINE unsigned int PetscOptHash(const char key[]) 442d747510SLisandro Dalcin { 452d747510SLisandro Dalcin unsigned int hash = 0; 462d747510SLisandro Dalcin while (*key) { 472d747510SLisandro Dalcin hash += PetscToLower(*key++); 482d747510SLisandro Dalcin hash += hash << 10; 492d747510SLisandro Dalcin hash ^= hash >> 6; 502d747510SLisandro Dalcin } 512d747510SLisandro Dalcin hash += hash << 3; 522d747510SLisandro Dalcin hash ^= hash >> 11; 532d747510SLisandro Dalcin hash += hash << 15; 542d747510SLisandro Dalcin return hash; 552d747510SLisandro Dalcin } 562d747510SLisandro Dalcin 572d747510SLisandro Dalcin PETSC_STATIC_INLINE int PetscOptEqual(const char a[],const char b[]) 582d747510SLisandro Dalcin { 592d747510SLisandro Dalcin return !PetscOptNameCmp(a,b); 602d747510SLisandro Dalcin } 612d747510SLisandro Dalcin 622d747510SLisandro Dalcin KHASH_INIT(HO, kh_cstr_t, int, 1, PetscOptHash, PetscOptEqual) 632d747510SLisandro Dalcin 64e5c89e4eSSatish Balay /* 653fc1eb6aSBarry Smith This table holds all the options set by the user. For simplicity, we use a static size database 66e5c89e4eSSatish Balay */ 672d747510SLisandro Dalcin #define MAXOPTNAME 512 68e5c89e4eSSatish Balay #define MAXOPTIONS 512 69e5c89e4eSSatish Balay #define MAXALIASES 25 7074e0666dSJed Brown #define MAXPREFIXES 25 712d747510SLisandro Dalcin #define MAXOPTIONSMONITORS 5 72e5c89e4eSSatish Balay 734416b707SBarry Smith struct _n_PetscOptions { 743de2bfdfSBarry Smith PetscOptions previous; 752d747510SLisandro Dalcin int N; /* number of options */ 762d747510SLisandro Dalcin char *names[MAXOPTIONS]; /* option names */ 772d747510SLisandro Dalcin char *values[MAXOPTIONS]; /* option values */ 782d747510SLisandro Dalcin PetscBool used[MAXOPTIONS]; /* flag option use */ 79*c5b5d8d5SVaclav Hapla PetscBool precedentProcessed; 80081c24baSBoyana Norris 812d747510SLisandro Dalcin /* Hash table */ 822d747510SLisandro Dalcin khash_t(HO) *ht; 832d747510SLisandro Dalcin 842d747510SLisandro Dalcin /* Prefixes */ 852d747510SLisandro Dalcin int prefixind; 862d747510SLisandro Dalcin int prefixstack[MAXPREFIXES]; 872d747510SLisandro Dalcin char prefix[MAXOPTNAME]; 882d747510SLisandro Dalcin 892d747510SLisandro Dalcin /* Aliases */ 902d747510SLisandro Dalcin int Naliases; /* number or aliases */ 912d747510SLisandro Dalcin char *aliases1[MAXALIASES]; /* aliased */ 922d747510SLisandro Dalcin char *aliases2[MAXALIASES]; /* aliasee */ 932d747510SLisandro Dalcin 942d747510SLisandro Dalcin /* Help */ 952d747510SLisandro Dalcin PetscBool help; /* flag whether "-help" is in the database */ 962d747510SLisandro Dalcin 972d747510SLisandro Dalcin /* Monitors */ 98*c5b5d8d5SVaclav Hapla PetscBool monitorFromOptions, monitorCancel; 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 105b4205f0bSBarry Smith static PetscOptions defaultoptions = NULL; /* the options database routines query this object for options */ 1062d747510SLisandro Dalcin 107*c5b5d8d5SVaclav Hapla /* list of options which preceed others, i.e., are processed in PetscOptionsProcessPrecedentFlags() */ 108*c5b5d8d5SVaclav Hapla static const char *precedentOptions[] = {"-options_monitor","-options_monitor_cancel","-h","-help","-skip_petscrc","-options_file_yaml","-options_string_yaml"}; 109*c5b5d8d5SVaclav Hapla enum PetscPrecedentOption {PO_OPTIONS_MONITOR,PO_OPTIONS_MONITOR_CANCEL,PO_H,PO_HELP,PO_SKIP_PETSCRC,PO_OPTIONS_FILE_YAML,PO_OPTIONS_STRING_YAML,PO_NUM}; 110*c5b5d8d5SVaclav Hapla 111*c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsSetValue_Private(PetscOptions,const char[],const char[],int*); 112*c5b5d8d5SVaclav Hapla 113081c24baSBoyana Norris /* 114081c24baSBoyana Norris Options events monitor 115081c24baSBoyana Norris */ 1162d747510SLisandro Dalcin static PetscErrorCode PetscOptionsMonitor(PetscOptions options,const char name[],const char value[]) 117e5c89e4eSSatish Balay { 1182d747510SLisandro Dalcin PetscInt i; 119e5c89e4eSSatish Balay PetscErrorCode ierr; 120e5c89e4eSSatish Balay 1218ad20175SVaclav Hapla if (!PetscErrorHandlingInitialized) return 0; 122e5c89e4eSSatish Balay PetscFunctionBegin; 123*c5b5d8d5SVaclav Hapla if (!value) value = ""; 124*c5b5d8d5SVaclav Hapla if (options->monitorFromOptions) { 125*c5b5d8d5SVaclav Hapla ierr = PetscOptionsMonitorDefault(name,value,NULL);CHKERRQ(ierr); 126*c5b5d8d5SVaclav Hapla } 1272d747510SLisandro Dalcin for (i=0; i<options->numbermonitors; i++) { 1282d747510SLisandro Dalcin ierr = (*options->monitor[i])(name,value,options->monitorcontext[i]);CHKERRQ(ierr); 129e5c89e4eSSatish Balay } 130e5c89e4eSSatish Balay PetscFunctionReturn(0); 131e5c89e4eSSatish Balay } 132e5c89e4eSSatish Balay 1332d747510SLisandro Dalcin /*@ 1342d747510SLisandro Dalcin PetscOptionsCreate - Creates an empty options database. 135e5c89e4eSSatish Balay 1361c9f3c13SBarry Smith Logically collective 1371c9f3c13SBarry Smith 138e5c89e4eSSatish Balay Output Parameter: 1392d747510SLisandro Dalcin . options - Options database object 140e5c89e4eSSatish Balay 141e5c89e4eSSatish Balay Level: advanced 142e5c89e4eSSatish Balay 1431c9f3c13SBarry Smith Developer Note: We may want eventually to pass a MPI_Comm to determine the ownership of the object 1441c9f3c13SBarry Smith 145b4205f0bSBarry Smith .seealso: PetscOptionsDestroy(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 146e5c89e4eSSatish Balay @*/ 1472d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreate(PetscOptions *options) 1482d747510SLisandro Dalcin { 1492d747510SLisandro Dalcin if (!options) return PETSC_ERR_ARG_NULL; 1502d747510SLisandro Dalcin *options = (PetscOptions)calloc(1,sizeof(**options)); 1512d747510SLisandro Dalcin if (!*options) return PETSC_ERR_MEM; 1522d747510SLisandro Dalcin return 0; 1532d747510SLisandro Dalcin } 1542d747510SLisandro Dalcin 1552d747510SLisandro Dalcin /*@ 1562d747510SLisandro Dalcin PetscOptionsDestroy - Destroys an option database. 1572d747510SLisandro Dalcin 1581c9f3c13SBarry Smith Logically collective on whatever communicator was associated with the call to PetscOptionsCreate() 1591c9f3c13SBarry Smith 1602d747510SLisandro Dalcin Input Parameter: 1612d747510SLisandro Dalcin . options - the PetscOptions object 1622d747510SLisandro Dalcin 1633de2bfdfSBarry Smith Level: advanced 1642d747510SLisandro Dalcin 165b4205f0bSBarry Smith .seealso: PetscOptionsInsert(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 1662d747510SLisandro Dalcin @*/ 1672d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroy(PetscOptions *options) 168e5c89e4eSSatish Balay { 169e5c89e4eSSatish Balay PetscErrorCode ierr; 170e5c89e4eSSatish Balay 1712d747510SLisandro Dalcin if (!*options) return 0; 1723de2bfdfSBarry Smith if ((*options)->previous) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"You are destroying an option that has been used with PetscOptionsPush() but does not have a corresponding PetscOptionsPop()"); 1732d747510SLisandro Dalcin ierr = PetscOptionsClear(*options);if (ierr) return ierr; 1742d747510SLisandro Dalcin /* XXX what about monitors ? */ 1752800570dSLisandro Dalcin free(*options); 1762d747510SLisandro Dalcin *options = NULL; 177e5c89e4eSSatish Balay PetscFunctionReturn(0); 178e5c89e4eSSatish Balay } 179e5c89e4eSSatish Balay 1802d747510SLisandro Dalcin /* 1812d747510SLisandro Dalcin PetscOptionsCreateDefault - Creates the default global options database 1822d747510SLisandro Dalcin */ 1832d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreateDefault(void) 184e5c89e4eSSatish Balay { 185e5c89e4eSSatish Balay PetscErrorCode ierr; 186e5c89e4eSSatish Balay 1872d747510SLisandro Dalcin if (!defaultoptions) { 1882d747510SLisandro Dalcin ierr = PetscOptionsCreate(&defaultoptions);if (ierr) return ierr; 1892d747510SLisandro Dalcin } 1902d747510SLisandro Dalcin return 0; 1912d747510SLisandro Dalcin } 1922d747510SLisandro Dalcin 193b4205f0bSBarry Smith /*@ 194b4205f0bSBarry Smith PetscOptionsPush - Push a new PetscOptions object as the default provider of options 1951c9f3c13SBarry Smith Allows using different parts of a code to use different options databases 196b4205f0bSBarry Smith 197b4205f0bSBarry Smith Logically Collective 198b4205f0bSBarry Smith 199b4205f0bSBarry Smith Input Parameter: 200b4205f0bSBarry Smith . opt - the options obtained with PetscOptionsCreate() 201b4205f0bSBarry Smith 202b4205f0bSBarry Smith Notes: 203b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 2041c9f3c13SBarry Smith 2059666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 2061c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 2071c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 2081c9f3c13SBarry Smith on different ranks. 209b4205f0bSBarry Smith 2103de2bfdfSBarry Smith Level: advanced 2113de2bfdfSBarry Smith 2123c6db4c4SPierre Jolivet .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsInsert(), PetscOptionsSetValue(), PetscOptionsLeft() 213b4205f0bSBarry Smith 214b4205f0bSBarry Smith @*/ 215b4205f0bSBarry Smith PetscErrorCode PetscOptionsPush(PetscOptions opt) 216b4205f0bSBarry Smith { 217b4205f0bSBarry Smith PetscErrorCode ierr; 218b4205f0bSBarry Smith 219b4205f0bSBarry Smith PetscFunctionBegin; 220b4205f0bSBarry Smith ierr = PetscOptionsCreateDefault();CHKERRQ(ierr); 221b4205f0bSBarry Smith opt->previous = defaultoptions; 222b4205f0bSBarry Smith defaultoptions = opt; 223b4205f0bSBarry Smith PetscFunctionReturn(0); 224b4205f0bSBarry Smith } 225b4205f0bSBarry Smith 226b4205f0bSBarry Smith /*@ 227b4205f0bSBarry Smith PetscOptionsPop - Pop the most recent PetscOptionsPush() to return to the previous default options 228b4205f0bSBarry Smith 2291c9f3c13SBarry Smith Logically collective on whatever communicator was associated with the call to PetscOptionsCreate() 230b4205f0bSBarry Smith 231b4205f0bSBarry Smith Notes: 232b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 233b4205f0bSBarry Smith Allows using different parts of a code to use different options databases 234b4205f0bSBarry Smith 2353de2bfdfSBarry Smith Level: advanced 2363de2bfdfSBarry Smith 2373c6db4c4SPierre Jolivet .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsInsert(), PetscOptionsSetValue(), PetscOptionsLeft() 238b4205f0bSBarry Smith 239b4205f0bSBarry Smith @*/ 240b4205f0bSBarry Smith PetscErrorCode PetscOptionsPop(void) 241b4205f0bSBarry Smith { 2423de2bfdfSBarry Smith PetscOptions current = defaultoptions; 2433de2bfdfSBarry Smith 244b4205f0bSBarry Smith PetscFunctionBegin; 245b4205f0bSBarry Smith if (!defaultoptions) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Missing default options"); 246b4205f0bSBarry Smith if (!defaultoptions->previous) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"PetscOptionsPop() called too many times"); 247b4205f0bSBarry Smith defaultoptions = defaultoptions->previous; 2483de2bfdfSBarry Smith current->previous = NULL; 249b4205f0bSBarry Smith PetscFunctionReturn(0); 250b4205f0bSBarry Smith } 251b4205f0bSBarry Smith 2522d747510SLisandro Dalcin /* 2532d747510SLisandro Dalcin PetscOptionsDestroyDefault - Destroys the default global options database 2542d747510SLisandro Dalcin */ 2552d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroyDefault(void) 2562d747510SLisandro Dalcin { 2572d747510SLisandro Dalcin PetscErrorCode ierr; 2583de2bfdfSBarry Smith PetscOptions tmp; 2592d747510SLisandro Dalcin 2603de2bfdfSBarry Smith /* Destroy any options that the user forgot to pop */ 2613de2bfdfSBarry Smith while (defaultoptions->previous) { 2623de2bfdfSBarry Smith tmp = defaultoptions; 2633de2bfdfSBarry Smith ierr = PetscOptionsPop();CHKERRQ(ierr); 2643de2bfdfSBarry Smith ierr = PetscOptionsDestroy(&tmp);CHKERRQ(ierr); 2653de2bfdfSBarry Smith } 2662d747510SLisandro Dalcin ierr = PetscOptionsDestroy(&defaultoptions);if (ierr) return ierr; 2672d747510SLisandro Dalcin return 0; 268e5c89e4eSSatish Balay } 269e5c89e4eSSatish Balay 27094ef8ddeSSatish Balay /*@C 2717cd08cecSJed Brown PetscOptionsValidKey - PETSc Options database keys must begin with one or two dashes (-) followed by a letter. 2723fc1eb6aSBarry Smith 273447722d5SBarry Smith Not collective 2741c9f3c13SBarry Smith 2753fc1eb6aSBarry Smith Input Parameter: 2762d747510SLisandro Dalcin . key - string to check if valid 2773fc1eb6aSBarry Smith 2783fc1eb6aSBarry Smith Output Parameter: 2792d747510SLisandro Dalcin . valid - PETSC_TRUE if a valid key 2803fc1eb6aSBarry Smith 281f6680f47SSatish Balay Level: intermediate 2823fc1eb6aSBarry Smith @*/ 2832d747510SLisandro Dalcin PetscErrorCode PetscOptionsValidKey(const char key[],PetscBool *valid) 28496fc60bcSBarry Smith { 285f603b5e9SToby Isaac char *ptr; 2867c5db45bSBarry Smith 28796fc60bcSBarry Smith PetscFunctionBegin; 2882d747510SLisandro Dalcin if (key) PetscValidCharPointer(key,1); 2892d747510SLisandro Dalcin PetscValidPointer(valid,2); 2902d747510SLisandro Dalcin *valid = PETSC_FALSE; 2912d747510SLisandro Dalcin if (!key) PetscFunctionReturn(0); 2922d747510SLisandro Dalcin if (key[0] != '-') PetscFunctionReturn(0); 2932d747510SLisandro Dalcin if (key[1] == '-') key++; 294c850d057SPierre Jolivet if (!isalpha((int)key[1])) PetscFunctionReturn(0); 2952d747510SLisandro Dalcin (void) strtod(key,&ptr); 296c850d057SPierre Jolivet if (ptr != key && !(*ptr == '_' || isalnum((int)*ptr))) PetscFunctionReturn(0); 2972d747510SLisandro Dalcin *valid = PETSC_TRUE; 29896fc60bcSBarry Smith PetscFunctionReturn(0); 29996fc60bcSBarry Smith } 30096fc60bcSBarry Smith 301e5c89e4eSSatish Balay /*@C 302e5c89e4eSSatish Balay PetscOptionsInsertString - Inserts options into the database from a string 303e5c89e4eSSatish Balay 3041c9f3c13SBarry Smith Logically Collective 305e5c89e4eSSatish Balay 306e5c89e4eSSatish Balay Input Parameter: 307080f0011SToby Isaac + options - options object 308080f0011SToby Isaac - in_str - string that contains options separated by blanks 309e5c89e4eSSatish Balay 310e5c89e4eSSatish Balay Level: intermediate 311e5c89e4eSSatish Balay 3129666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 3131c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 3141c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 3151c9f3c13SBarry Smith on different ranks. 3161c9f3c13SBarry Smith 317e5c89e4eSSatish Balay Contributed by Boyana Norris 318e5c89e4eSSatish Balay 31988c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 320acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 321e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 322e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 323acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 324a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsInsertFile() 325e5c89e4eSSatish Balay @*/ 326c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertString(PetscOptions options,const char in_str[]) 327e5c89e4eSSatish Balay { 32896fc60bcSBarry Smith char *first,*second; 329e5c89e4eSSatish Balay PetscErrorCode ierr; 3309c9d3cfdSBarry Smith PetscToken token; 331bf9c6086SStefano Zampini PetscBool key,ispush,ispop,isopts; 332e5c89e4eSSatish Balay 333e5c89e4eSSatish Balay PetscFunctionBegin; 33496fc60bcSBarry Smith ierr = PetscTokenCreate(in_str,' ',&token);CHKERRQ(ierr); 335e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 33696fc60bcSBarry Smith while (first) { 3379db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_push",&ispush);CHKERRQ(ierr); 3389db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_pop",&ispop);CHKERRQ(ierr); 339bf9c6086SStefano Zampini ierr = PetscStrcasecmp(first,"-options_file",&isopts);CHKERRQ(ierr); 34096fc60bcSBarry Smith ierr = PetscOptionsValidKey(first,&key);CHKERRQ(ierr); 3419db968c8SJed Brown if (ispush) { 3429db968c8SJed Brown ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 343c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,second);CHKERRQ(ierr); 3449db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 3459db968c8SJed Brown } else if (ispop) { 346c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 3479db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 348bf9c6086SStefano Zampini } else if (isopts) { 349bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 350bf9c6086SStefano Zampini ierr = PetscOptionsInsertFile(PETSC_COMM_SELF,options,second,PETSC_TRUE);CHKERRQ(ierr); 351bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 3529db968c8SJed Brown } else if (key) { 353e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 35496fc60bcSBarry Smith ierr = PetscOptionsValidKey(second,&key);CHKERRQ(ierr); 35596fc60bcSBarry Smith if (!key) { 356c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,second);CHKERRQ(ierr); 35796fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 35896fc60bcSBarry Smith } else { 359c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,NULL);CHKERRQ(ierr); 36096fc60bcSBarry Smith first = second; 36196fc60bcSBarry Smith } 36296fc60bcSBarry Smith } else { 36396fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 364e5c89e4eSSatish Balay } 365e5c89e4eSSatish Balay } 3668c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 367e5c89e4eSSatish Balay PetscFunctionReturn(0); 368e5c89e4eSSatish Balay } 369e5c89e4eSSatish Balay 3703fc1eb6aSBarry Smith /* 3713fc1eb6aSBarry Smith Returns a line (ended by a \n, \r or null character of any length. Result should be freed with free() 3723fc1eb6aSBarry Smith */ 3735fa91da5SBarry Smith static char *Petscgetline(FILE * f) 3745fa91da5SBarry Smith { 3755fa91da5SBarry Smith size_t size = 0; 3765fa91da5SBarry Smith size_t len = 0; 3775fa91da5SBarry Smith size_t last = 0; 3780298fd71SBarry Smith char *buf = NULL; 3795fa91da5SBarry Smith 38002c9f0b5SLisandro Dalcin if (feof(f)) return NULL; 3815fa91da5SBarry Smith do { 3825fa91da5SBarry Smith size += 1024; /* BUFSIZ is defined as "the optimal read size for this platform" */ 3836e0c8459SSatish Balay buf = (char*)realloc((void*)buf,size); /* realloc(NULL,n) is the same as malloc(n) */ 3845fa91da5SBarry Smith /* Actually do the read. Note that fgets puts a terminal '\0' on the 3855fa91da5SBarry Smith end of the string, so we make sure we overwrite this */ 386e86f3e45SDave May if (!fgets(buf+len,1024,f)) buf[len]=0; 3875fa91da5SBarry Smith PetscStrlen(buf,&len); 3885fa91da5SBarry Smith last = len - 1; 3895fa91da5SBarry Smith } while (!feof(f) && buf[last] != '\n' && buf[last] != '\r'); 39008ac41f7SSatish Balay if (len) return buf; 3915fa91da5SBarry Smith free(buf); 39202c9f0b5SLisandro Dalcin return NULL; 3935fa91da5SBarry Smith } 3945fa91da5SBarry Smith 395e5c89e4eSSatish Balay /*@C 396e5c89e4eSSatish Balay PetscOptionsInsertFile - Inserts options into the database from a file. 397e5c89e4eSSatish Balay 398d083f849SBarry Smith Collective 399e5c89e4eSSatish Balay 400e5c89e4eSSatish Balay Input Parameter: 4019b754dc9SBarry Smith + comm - the processes that will share the options (usually PETSC_COMM_WORLD) 402c5929fdfSBarry Smith . options - options database, use NULL for default global database 403e5c89e4eSSatish Balay . file - name of file 4049b754dc9SBarry Smith - require - if PETSC_TRUE will generate an error if the file does not exist 405e5c89e4eSSatish Balay 406e5c89e4eSSatish Balay 40795452b02SPatrick Sanan Notes: 40895452b02SPatrick Sanan Use # for lines that are comments and which should be ignored. 409f0feba65SBarry Smith Usually, instead of using this command, one should list the file name in the call to PetscInitialize(), this insures that certain options 410609bdbeeSBarry 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 411f0feba65SBarry Smith calls to XXXSetFromOptions() it should not be used for options listed under PetscInitialize(). 4129666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes in comm will 4131c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 4141c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 4151c9f3c13SBarry Smith on different ranks. 416f0feba65SBarry Smith 4173bcbd388SSean Farley Level: developer 418e5c89e4eSSatish Balay 41988c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 420acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 421e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 422e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 423acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 424a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 425e5c89e4eSSatish Balay 426e5c89e4eSSatish Balay @*/ 427c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertFile(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require) 428e5c89e4eSSatish Balay { 4297fb43599SVaclav Hapla char *string,fname[PETSC_MAX_PATH_LEN],*vstring = NULL,*astring = NULL,*packed = NULL; 4307fb43599SVaclav Hapla char *tokens[4]; 431e5c89e4eSSatish Balay PetscErrorCode ierr; 43213e3f751SJed Brown size_t i,len,bytes; 433e5c89e4eSSatish Balay FILE *fd; 4347fb43599SVaclav Hapla PetscToken token=NULL; 435ed9cf6e9SBarry Smith int err; 436581bbe83SVaclav Hapla char *cmatch; 437581bbe83SVaclav Hapla const char cmt='#'; 4389210b8eaSVaclav Hapla PetscInt line=1; 4393a018368SJed Brown PetscMPIInt rank,cnt=0,acnt=0,counts[2]; 4409210b8eaSVaclav Hapla PetscBool isdir,alias=PETSC_FALSE,valid; 441e5c89e4eSSatish Balay 442e5c89e4eSSatish Balay PetscFunctionBegin; 44305c7dedfSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 4447fb43599SVaclav Hapla ierr = PetscMemzero(tokens,sizeof(tokens));CHKERRQ(ierr); 44505c7dedfSBarry Smith if (!rank) { 44666af5158SSatish Balay cnt = 0; 44766af5158SSatish Balay acnt = 0; 44805c7dedfSBarry Smith 449e5c89e4eSSatish Balay ierr = PetscFixFilename(file,fname);CHKERRQ(ierr); 450e5c89e4eSSatish Balay fd = fopen(fname,"r"); 451ad38b122SPatrick Sanan ierr = PetscTestDirectory(fname,'r',&isdir);CHKERRQ(ierr); 452ad38b122SPatrick Sanan if (isdir && require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Specified options file %s is a directory",fname); 453ad38b122SPatrick Sanan if (fd && !isdir) { 4543a018368SJed Brown PetscSegBuffer vseg,aseg; 4553a018368SJed Brown ierr = PetscSegBufferCreate(1,4000,&vseg);CHKERRQ(ierr); 4563a018368SJed Brown ierr = PetscSegBufferCreate(1,2000,&aseg);CHKERRQ(ierr); 4573a018368SJed Brown 4589b754dc9SBarry Smith /* the following line will not work when opening initial files (like .petscrc) since info is not yet set */ 45902c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Opened options file %s\n",file);CHKERRQ(ierr); 460e24ecc5dSJed Brown 4615fa91da5SBarry Smith while ((string = Petscgetline(fd))) { 4624704e885SBarry Smith /* eliminate comments from each line */ 463581bbe83SVaclav Hapla ierr = PetscStrchr(string,cmt,&cmatch);CHKERRQ(ierr); 46490f79514SSatish Balay if (cmatch) *cmatch = 0; 465e5c89e4eSSatish Balay ierr = PetscStrlen(string,&len);CHKERRQ(ierr); 4665981331cSSatish Balay /* replace tabs, ^M, \n with " " */ 467e5c89e4eSSatish Balay for (i=0; i<len; i++) { 4685981331cSSatish Balay if (string[i] == '\t' || string[i] == '\r' || string[i] == '\n') { 469e5c89e4eSSatish Balay string[i] = ' '; 470e5c89e4eSSatish Balay } 471e5c89e4eSSatish Balay } 47290f79514SSatish Balay ierr = PetscTokenCreate(string,' ',&token);CHKERRQ(ierr); 4737fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 4747fb43599SVaclav Hapla if (!tokens[0]) { 47502b0d46eSSatish Balay goto destroy; 4767fb43599SVaclav Hapla } else if (!tokens[0][0]) { /* if token 0 is empty (string begins with spaces), redo */ 4777fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 47890f79514SSatish Balay } 4797fb43599SVaclav Hapla for (i=1; i<4; i++) { 4807fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[i]);CHKERRQ(ierr); 4817fb43599SVaclav Hapla } 4827fb43599SVaclav Hapla if (!tokens[0]) { 4832662f744SSatish Balay goto destroy; 4847fb43599SVaclav Hapla } else if (tokens[0][0] == '-') { 4859210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[0],&valid);CHKERRQ(ierr); 4869210b8eaSVaclav Hapla if (!valid) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: invalid option %s",fname,line,tokens[0]); 4877fb43599SVaclav Hapla ierr = PetscStrlen(tokens[0],&len);CHKERRQ(ierr); 48813e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+1,&vstring);CHKERRQ(ierr); 4897fb43599SVaclav Hapla ierr = PetscArraycpy(vstring,tokens[0],len);CHKERRQ(ierr); 490e24ecc5dSJed Brown vstring[len] = ' '; 4917fb43599SVaclav Hapla if (tokens[1]) { 4929210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[1],&valid);CHKERRQ(ierr); 4939210b8eaSVaclav Hapla if (valid) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: cannot specify two options per line (%s %s)",fname,line,tokens[0],tokens[1]); 4947fb43599SVaclav Hapla ierr = PetscStrlen(tokens[1],&len);CHKERRQ(ierr); 49513e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+3,&vstring);CHKERRQ(ierr); 496e24ecc5dSJed Brown vstring[0] = '"'; 4977fb43599SVaclav Hapla ierr = PetscArraycpy(vstring+1,tokens[1],len);CHKERRQ(ierr); 498e24ecc5dSJed Brown vstring[len+1] = '"'; 499e24ecc5dSJed Brown vstring[len+2] = ' '; 50009192fe3SBarry Smith } 50190f79514SSatish Balay } else { 5029210b8eaSVaclav Hapla ierr = PetscStrcasecmp(tokens[0],"alias",&alias);CHKERRQ(ierr); 5039210b8eaSVaclav Hapla if (alias) { 5049210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[1],&valid);CHKERRQ(ierr); 5059210b8eaSVaclav Hapla if (!valid) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: invalid aliased option %s",fname,line,tokens[1]); 5069210b8eaSVaclav Hapla if (!tokens[2]) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: alias missing for %s",fname,line,tokens[1]); 5079210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[2],&valid);CHKERRQ(ierr); 5089210b8eaSVaclav Hapla if (!valid) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: invalid aliasee option %s",fname,line,tokens[2]); 5097fb43599SVaclav Hapla ierr = PetscStrlen(tokens[1],&len);CHKERRQ(ierr); 51013e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 5117fb43599SVaclav Hapla ierr = PetscArraycpy(astring,tokens[1],len);CHKERRQ(ierr); 512e24ecc5dSJed Brown astring[len] = ' '; 513e24ecc5dSJed Brown 5147fb43599SVaclav Hapla ierr = PetscStrlen(tokens[2],&len);CHKERRQ(ierr); 51513e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 5167fb43599SVaclav Hapla ierr = PetscArraycpy(astring,tokens[2],len);CHKERRQ(ierr); 517e24ecc5dSJed Brown astring[len] = ' '; 5189210b8eaSVaclav Hapla } else SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown first token in options file %s line %D: %s",fname,line,tokens[0]); 5199210b8eaSVaclav Hapla } 5209210b8eaSVaclav Hapla { 5219210b8eaSVaclav Hapla const char *extraToken = alias ? tokens[3] : tokens[2]; 5229210b8eaSVaclav Hapla if (extraToken) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: extra token %s",fname,line,extraToken); 523e5c89e4eSSatish Balay } 52402b0d46eSSatish Balay destroy: 5254b40f50bSBarry Smith free(string); 5268c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 5279210b8eaSVaclav Hapla alias = PETSC_FALSE; 5289210b8eaSVaclav Hapla line++; 529e5c89e4eSSatish Balay } 530ed9cf6e9SBarry Smith err = fclose(fd); 5319210b8eaSVaclav Hapla if (err) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file %s",fname); 532e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(aseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 533e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&acnt);CHKERRQ(ierr); 534e24ecc5dSJed Brown ierr = PetscSegBufferGet(aseg,1,&astring);CHKERRQ(ierr); 535e24ecc5dSJed Brown astring[0] = 0; 536e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(vseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 537e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&cnt);CHKERRQ(ierr); 538e24ecc5dSJed Brown ierr = PetscSegBufferGet(vseg,1,&vstring);CHKERRQ(ierr); 539e24ecc5dSJed Brown vstring[0] = 0; 540854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 5413a018368SJed Brown ierr = PetscSegBufferExtractTo(aseg,packed);CHKERRQ(ierr); 5423a018368SJed Brown ierr = PetscSegBufferExtractTo(vseg,packed+acnt+1);CHKERRQ(ierr); 5433a018368SJed Brown ierr = PetscSegBufferDestroy(&aseg);CHKERRQ(ierr); 5443a018368SJed Brown ierr = PetscSegBufferDestroy(&vseg);CHKERRQ(ierr); 5459210b8eaSVaclav Hapla } else if (require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Unable to open options file %s",fname); 5469b754dc9SBarry Smith } 54705c7dedfSBarry Smith 5483a018368SJed Brown counts[0] = acnt; 5493a018368SJed Brown counts[1] = cnt; 5503a018368SJed Brown ierr = MPI_Bcast(counts,2,MPI_INT,0,comm);CHKERRQ(ierr); 5513a018368SJed Brown acnt = counts[0]; 5523a018368SJed Brown cnt = counts[1]; 5533a018368SJed Brown if (rank) { 554854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 5553a018368SJed Brown } 5563a018368SJed Brown if (acnt || cnt) { 5573a018368SJed Brown ierr = MPI_Bcast(packed,2+acnt+cnt,MPI_CHAR,0,comm);CHKERRQ(ierr); 5583a018368SJed Brown astring = packed; 5593a018368SJed Brown vstring = packed + acnt + 1; 5603a018368SJed Brown } 5613a018368SJed Brown 5629b754dc9SBarry Smith if (acnt) { 5639b754dc9SBarry Smith ierr = PetscTokenCreate(astring,' ',&token);CHKERRQ(ierr); 5647fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 5657fb43599SVaclav Hapla while (tokens[0]) { 5667fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[1]);CHKERRQ(ierr); 5677fb43599SVaclav Hapla ierr = PetscOptionsSetAlias(options,tokens[0],tokens[1]);CHKERRQ(ierr); 5687fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 5699b754dc9SBarry Smith } 5708c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 5719b754dc9SBarry Smith } 5729b754dc9SBarry Smith 5739b754dc9SBarry Smith if (cnt) { 574c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,vstring);CHKERRQ(ierr); 575e5c89e4eSSatish Balay } 5763a018368SJed Brown ierr = PetscFree(packed);CHKERRQ(ierr); 577e5c89e4eSSatish Balay PetscFunctionReturn(0); 578e5c89e4eSSatish Balay } 579e5c89e4eSSatish Balay 5802d747510SLisandro Dalcin static PetscErrorCode PetscOptionsInsertArgs(PetscOptions options,int argc,char *args[]) 58185079163SJed Brown { 58285079163SJed Brown PetscErrorCode ierr; 58385079163SJed Brown int left = argc - 1; 58485079163SJed Brown char **eargs = args + 1; 58585079163SJed Brown 58685079163SJed Brown PetscFunctionBegin; 58785079163SJed Brown while (left) { 588093de6efSBarry Smith PetscBool isoptions_file,isprefixpush,isprefixpop,isp4,tisp4,isp4yourname,isp4rmrank,key; 58985079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-options_file",&isoptions_file);CHKERRQ(ierr); 5909db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_push",&isprefixpush);CHKERRQ(ierr); 5919db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_pop",&isprefixpop);CHKERRQ(ierr); 59285079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4pg",&isp4);CHKERRQ(ierr); 59385079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4yourname",&isp4yourname);CHKERRQ(ierr); 59485079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4rmrank",&isp4rmrank);CHKERRQ(ierr); 59585079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4wd",&tisp4);CHKERRQ(ierr); 596ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 59785079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-np",&tisp4);CHKERRQ(ierr); 598ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 59985079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4amslave",&tisp4);CHKERRQ(ierr); 600093de6efSBarry Smith ierr = PetscOptionsValidKey(eargs[0],&key);CHKERRQ(ierr); 60185079163SJed Brown 602093de6efSBarry Smith if (!key) { 60385079163SJed Brown eargs++; left--; 60485079163SJed Brown } else if (isoptions_file) { 60585079163SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 60685079163SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 607c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,eargs[1],PETSC_TRUE);CHKERRQ(ierr); 60885079163SJed Brown eargs += 2; left -= 2; 6099db968c8SJed Brown } else if (isprefixpush) { 6109db968c8SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option"); 6119db968c8SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option (prefixes cannot start with '-')"); 612c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,eargs[1]);CHKERRQ(ierr); 6139db968c8SJed Brown eargs += 2; left -= 2; 6149db968c8SJed Brown } else if (isprefixpop) { 615c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 6169db968c8SJed Brown eargs++; left--; 61785079163SJed Brown 61885079163SJed Brown /* 61985079163SJed Brown These are "bad" options that MPICH, etc put on the command line 62085079163SJed Brown we strip them out here. 62185079163SJed Brown */ 62285079163SJed Brown } else if (tisp4 || isp4rmrank) { 62385079163SJed Brown eargs += 1; left -= 1; 62485079163SJed Brown } else if (isp4 || isp4yourname) { 62585079163SJed Brown eargs += 2; left -= 2; 6267935c3d8SJed Brown } else { 6277935c3d8SJed Brown PetscBool nextiskey = PETSC_FALSE; 6287935c3d8SJed Brown if (left >= 2) {ierr = PetscOptionsValidKey(eargs[1],&nextiskey);CHKERRQ(ierr);} 62998b6bf53SJed Brown if (left < 2 || nextiskey) { 630c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],NULL);CHKERRQ(ierr); 63185079163SJed Brown eargs++; left--; 63285079163SJed Brown } else { 633c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],eargs[1]);CHKERRQ(ierr); 63485079163SJed Brown eargs += 2; left -= 2; 63585079163SJed Brown } 63685079163SJed Brown } 6377935c3d8SJed Brown } 63885079163SJed Brown PetscFunctionReturn(0); 63985079163SJed Brown } 64085079163SJed Brown 641*c5b5d8d5SVaclav Hapla PETSC_STATIC_INLINE PetscErrorCode PetscOptionsStringToBoolIfSet_Private(enum PetscPrecedentOption opt,const char *val[],PetscBool set[],PetscBool *flg) 642*c5b5d8d5SVaclav Hapla { 643*c5b5d8d5SVaclav Hapla PetscErrorCode ierr; 644*c5b5d8d5SVaclav Hapla 645*c5b5d8d5SVaclav Hapla PetscFunctionBegin; 646*c5b5d8d5SVaclav Hapla if (set[opt]) { 647*c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBool(val[opt],flg);CHKERRQ(ierr); 648*c5b5d8d5SVaclav Hapla } else *flg = PETSC_FALSE; 649*c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 650*c5b5d8d5SVaclav Hapla } 651*c5b5d8d5SVaclav Hapla 652*c5b5d8d5SVaclav Hapla /* Process options with absolute precedence */ 653*c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsProcessPrecedentFlags(PetscOptions options,int argc,char *args[],PetscBool *skip_petscrc,PetscBool *skip_petscrc_set) 654*c5b5d8d5SVaclav Hapla { 655*c5b5d8d5SVaclav Hapla const char* const *opt = precedentOptions; 656*c5b5d8d5SVaclav Hapla const size_t n = PO_NUM; 657*c5b5d8d5SVaclav Hapla size_t o; 658*c5b5d8d5SVaclav Hapla int a; 659*c5b5d8d5SVaclav Hapla const char **val; 660*c5b5d8d5SVaclav Hapla PetscBool *set; 661*c5b5d8d5SVaclav Hapla PetscErrorCode ierr; 662*c5b5d8d5SVaclav Hapla 663*c5b5d8d5SVaclav Hapla PetscFunctionBegin; 664*c5b5d8d5SVaclav Hapla ierr = PetscCalloc2(n,&val,n,&set);CHKERRQ(ierr); 665*c5b5d8d5SVaclav Hapla 666*c5b5d8d5SVaclav Hapla /* Look for options possibly set using PetscOptionsSetValue beforehand */ 667*c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 668*c5b5d8d5SVaclav Hapla ierr = PetscOptionsFindPair(options,NULL,opt[o],&val[o],&set[o]);CHKERRQ(ierr); 669*c5b5d8d5SVaclav Hapla } 670*c5b5d8d5SVaclav Hapla 671*c5b5d8d5SVaclav Hapla /* Loop through all args to collect last occuring value of each option */ 672*c5b5d8d5SVaclav Hapla for (a=1; a<argc; a++) { 673*c5b5d8d5SVaclav Hapla PetscBool valid, eq; 674*c5b5d8d5SVaclav Hapla 675*c5b5d8d5SVaclav Hapla ierr = PetscOptionsValidKey(args[a],&valid);CHKERRQ(ierr); 676*c5b5d8d5SVaclav Hapla if (!valid) continue; 677*c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 678*c5b5d8d5SVaclav Hapla ierr = PetscStrcasecmp(args[a],opt[o],&eq);CHKERRQ(ierr); 679*c5b5d8d5SVaclav Hapla if (eq) { 680*c5b5d8d5SVaclav Hapla set[o] = PETSC_TRUE; 681*c5b5d8d5SVaclav Hapla if (a == argc-1 || !args[a+1] || !args[a+1][0] || args[a+1][0] == '-') val[o] = NULL; 682*c5b5d8d5SVaclav Hapla else val[o] = args[a+1]; 683*c5b5d8d5SVaclav Hapla break; 684*c5b5d8d5SVaclav Hapla } 685*c5b5d8d5SVaclav Hapla } 686*c5b5d8d5SVaclav Hapla } 687*c5b5d8d5SVaclav Hapla 688*c5b5d8d5SVaclav Hapla /* Process flags */ 689*c5b5d8d5SVaclav Hapla /* -h and -help are equivalent (p4 does not like -help)*/ 690*c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_H, val,set,&options->help);CHKERRQ(ierr); 691*c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_HELP, val,set,&options->help);CHKERRQ(ierr); 692*c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_OPTIONS_MONITOR_CANCEL,val,set,&options->monitorCancel);CHKERRQ(ierr); 693*c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_OPTIONS_MONITOR, val,set,&options->monitorFromOptions);CHKERRQ(ierr); 694*c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_SKIP_PETSCRC, val,set,skip_petscrc);CHKERRQ(ierr); 695*c5b5d8d5SVaclav Hapla *skip_petscrc_set = set[PO_SKIP_PETSCRC]; 696*c5b5d8d5SVaclav Hapla 697*c5b5d8d5SVaclav Hapla /* Store precedent options in database and mark them as used */ 698*c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 699*c5b5d8d5SVaclav Hapla if (set[o]) { 700*c5b5d8d5SVaclav Hapla int pos; 701*c5b5d8d5SVaclav Hapla 702*c5b5d8d5SVaclav Hapla ierr = PetscOptionsSetValue_Private(options,opt[o],val[o],&pos);CHKERRQ(ierr); 703*c5b5d8d5SVaclav Hapla options->used[pos] = PETSC_TRUE; 704*c5b5d8d5SVaclav Hapla } 705*c5b5d8d5SVaclav Hapla } 706*c5b5d8d5SVaclav Hapla 707*c5b5d8d5SVaclav Hapla ierr = PetscFree2(val,set);CHKERRQ(ierr); 708*c5b5d8d5SVaclav Hapla options->precedentProcessed = PETSC_TRUE; 709*c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 710*c5b5d8d5SVaclav Hapla } 711*c5b5d8d5SVaclav Hapla 712*c5b5d8d5SVaclav Hapla PETSC_STATIC_INLINE PetscErrorCode PetscOptionsSkipPrecedent(PetscOptions options,const char name[],PetscBool *flg) 713*c5b5d8d5SVaclav Hapla { 714*c5b5d8d5SVaclav Hapla int i; 715*c5b5d8d5SVaclav Hapla PetscErrorCode ierr; 716*c5b5d8d5SVaclav Hapla 717*c5b5d8d5SVaclav Hapla *flg = PETSC_FALSE; 718*c5b5d8d5SVaclav Hapla if (options->precedentProcessed) { 719*c5b5d8d5SVaclav Hapla for (i=0; i<PO_NUM; i++) { 720*c5b5d8d5SVaclav Hapla if (!PetscOptNameCmp(precedentOptions[i],name)) { 721*c5b5d8d5SVaclav Hapla /* check if precedent option has been set already */ 722*c5b5d8d5SVaclav Hapla ierr = PetscOptionsFindPair(options,NULL,name,NULL,flg);CHKERRQ(ierr); 723*c5b5d8d5SVaclav Hapla if (*flg) break; 724*c5b5d8d5SVaclav Hapla } 725*c5b5d8d5SVaclav Hapla } 726*c5b5d8d5SVaclav Hapla } 727*c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 728*c5b5d8d5SVaclav Hapla } 72985079163SJed Brown 730e5c89e4eSSatish Balay /*@C 731e5c89e4eSSatish Balay PetscOptionsInsert - Inserts into the options database from the command line, 732e5c89e4eSSatish Balay the environmental variable and a file. 733e5c89e4eSSatish Balay 7341c9f3c13SBarry Smith Collective on PETSC_COMM_WORLD 7351c9f3c13SBarry Smith 736e5c89e4eSSatish Balay Input Parameters: 737c5929fdfSBarry Smith + options - options database or NULL for the default global database 738c5929fdfSBarry Smith . argc - count of number of command line arguments 739e5c89e4eSSatish Balay . args - the command line arguments 740*c5b5d8d5SVaclav Hapla - file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc. 741*c5b5d8d5SVaclav Hapla Use NULL to not check for code specific file. 742*c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 743e5c89e4eSSatish Balay 744e5c89e4eSSatish Balay Note: 745e5c89e4eSSatish Balay Since PetscOptionsInsert() is automatically called by PetscInitialize(), 746e5c89e4eSSatish Balay the user does not typically need to call this routine. PetscOptionsInsert() 747e5c89e4eSSatish Balay can be called several times, adding additional entries into the database. 748e5c89e4eSSatish Balay 749081c24baSBoyana Norris Options Database Keys: 750*c5b5d8d5SVaclav Hapla . -options_file <filename> - read options from a file 751*c5b5d8d5SVaclav Hapla 752*c5b5d8d5SVaclav Hapla See PetscInitialize() for options related to option database monitoring. 753081c24baSBoyana Norris 754e5c89e4eSSatish Balay Level: advanced 755e5c89e4eSSatish Balay 7562d747510SLisandro Dalcin .seealso: PetscOptionsDestroy(), PetscOptionsView(), PetscOptionsInsertString(), PetscOptionsInsertFile(), 75796fc60bcSBarry Smith PetscInitialize() 758e5c89e4eSSatish Balay @*/ 759c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsert(PetscOptions options,int *argc,char ***args,const char file[]) 760e5c89e4eSSatish Balay { 761e5c89e4eSSatish Balay PetscErrorCode ierr; 762e5c89e4eSSatish Balay PetscMPIInt rank; 7632d747510SLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 764*c5b5d8d5SVaclav Hapla PetscBool hasArgs = (argc && *argc) ? PETSC_TRUE : PETSC_FALSE; 765*c5b5d8d5SVaclav Hapla PetscBool skipPetscrc = PETSC_FALSE, skipPetscrcSet = PETSC_FALSE; 766e5c89e4eSSatish Balay 7678dea33a6SBarry Smith 768e5c89e4eSSatish Balay PetscFunctionBegin; 769*c5b5d8d5SVaclav Hapla if (hasArgs && !(args && *args)) SETERRQ(PETSC_COMM_WORLD, PETSC_ERR_ARG_NULL, "*argc > 1 but *args not given"); 770e5c89e4eSSatish Balay ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 771e5c89e4eSSatish Balay 772*c5b5d8d5SVaclav Hapla if (!options) { 773*c5b5d8d5SVaclav Hapla ierr = PetscOptionsCreateDefault();CHKERRQ(ierr); 774*c5b5d8d5SVaclav Hapla options = defaultoptions; 775*c5b5d8d5SVaclav Hapla } 776*c5b5d8d5SVaclav Hapla if (hasArgs) { 777*c5b5d8d5SVaclav Hapla /* process options with absolute precedence */ 778*c5b5d8d5SVaclav Hapla ierr = PetscOptionsProcessPrecedentFlags(options,*argc,*args,&skipPetscrc,&skipPetscrcSet);CHKERRQ(ierr); 779*c5b5d8d5SVaclav Hapla } 7804b09e917SBarry Smith if (file && file[0]) { 7812d747510SLisandro Dalcin ierr = PetscStrreplace(PETSC_COMM_WORLD,file,filename,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 7822d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_TRUE);CHKERRQ(ierr); 783*c5b5d8d5SVaclav Hapla /* if -skip_petscrc has not been set from command line, check whether it has been set in the file */ 784*c5b5d8d5SVaclav Hapla if (!skipPetscrcSet) {ierr = PetscOptionsGetBool(options,NULL,"-skip_petscrc",&skipPetscrc,NULL);CHKERRQ(ierr);} 785321366bcSBarry Smith } 786*c5b5d8d5SVaclav Hapla if (!skipPetscrc) { 7872d747510SLisandro Dalcin ierr = PetscGetHomeDirectory(filename,PETSC_MAX_PATH_LEN-16);CHKERRQ(ierr); 7881ea3218fSSatish Balay /* PetscOptionsInsertFile() does a fopen() on rank0 only - so only rank0 HomeDir value is relavent */ 7892d747510SLisandro Dalcin if (filename[0]) { ierr = PetscStrcat(filename,"/.petscrc");CHKERRQ(ierr); } 7902d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_FALSE);CHKERRQ(ierr); 791c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,".petscrc",PETSC_FALSE);CHKERRQ(ierr); 792c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,"petscrc",PETSC_FALSE);CHKERRQ(ierr); 793e5c89e4eSSatish Balay } 794e5c89e4eSSatish Balay 7952d747510SLisandro Dalcin /* insert environment options */ 796e5c89e4eSSatish Balay { 7972d747510SLisandro Dalcin char *eoptions = NULL; 798e5c89e4eSSatish Balay size_t len = 0; 799e5c89e4eSSatish Balay if (!rank) { 800e5c89e4eSSatish Balay eoptions = (char*)getenv("PETSC_OPTIONS"); 801e5c89e4eSSatish Balay ierr = PetscStrlen(eoptions,&len);CHKERRQ(ierr); 80276434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 803e5c89e4eSSatish Balay } else { 80476434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 805e5c89e4eSSatish Balay if (len) { 806854ce69bSBarry Smith ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr); 807e5c89e4eSSatish Balay } 808e5c89e4eSSatish Balay } 809e5c89e4eSSatish Balay if (len) { 810e5c89e4eSSatish Balay ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 81196fc60bcSBarry Smith if (rank) eoptions[len] = 0; 812c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,eoptions);CHKERRQ(ierr); 813e5c89e4eSSatish Balay if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);} 814e5c89e4eSSatish Balay } 815e5c89e4eSSatish Balay } 816e5c89e4eSSatish Balay 8173bcbd388SSean Farley #if defined(PETSC_HAVE_YAML) 81856a31166SBarry Smith { 8199fc438c3SToby Isaac char *eoptions = NULL; 8209fc438c3SToby Isaac size_t len = 0; 8219fc438c3SToby Isaac if (!rank) { 8229fc438c3SToby Isaac eoptions = (char*)getenv("PETSC_OPTIONS_YAML"); 8239fc438c3SToby Isaac ierr = PetscStrlen(eoptions,&len);CHKERRQ(ierr); 8249fc438c3SToby Isaac ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 8259fc438c3SToby Isaac } else { 8269fc438c3SToby Isaac ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 8279fc438c3SToby Isaac if (len) { 8289fc438c3SToby Isaac ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr); 8299fc438c3SToby Isaac } 8309fc438c3SToby Isaac } 8319fc438c3SToby Isaac if (len) { 8329fc438c3SToby Isaac ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 8339fc438c3SToby Isaac if (rank) eoptions[len] = 0; 8349fc438c3SToby Isaac ierr = PetscOptionsInsertStringYAML(options,eoptions);CHKERRQ(ierr); 8359fc438c3SToby Isaac if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);} 8369fc438c3SToby Isaac } 8379fc438c3SToby Isaac } 8389fc438c3SToby Isaac { 8393bcbd388SSean Farley char yaml_file[PETSC_MAX_PATH_LEN]; 840080f0011SToby Isaac char yaml_string[BUFSIZ]; 84156a31166SBarry Smith PetscBool yaml_flg; 842589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-options_file_yaml",yaml_file,sizeof(yaml_file),&yaml_flg);CHKERRQ(ierr); 84356a31166SBarry Smith if (yaml_flg) { 84456a31166SBarry Smith ierr = PetscOptionsInsertFileYAML(PETSC_COMM_WORLD,yaml_file,PETSC_TRUE);CHKERRQ(ierr); 84556a31166SBarry Smith } 846589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-options_string_yaml",yaml_string,sizeof(yaml_string),&yaml_flg);CHKERRQ(ierr); 847080f0011SToby Isaac if (yaml_flg) { 848080f0011SToby Isaac ierr = PetscOptionsInsertStringYAML(NULL,yaml_string);CHKERRQ(ierr); 849080f0011SToby Isaac } 85056a31166SBarry Smith } 8513bcbd388SSean Farley #endif 8523bcbd388SSean Farley 853*c5b5d8d5SVaclav Hapla /* insert command line options here because they take precedence over arguments in petscrc/environment */ 854*c5b5d8d5SVaclav Hapla if (hasArgs) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);} 855e5c89e4eSSatish Balay PetscFunctionReturn(0); 856e5c89e4eSSatish Balay } 857e5c89e4eSSatish Balay 858e5c89e4eSSatish Balay /*@C 85988c29154SBarry Smith PetscOptionsView - Prints the options that have been loaded. This is 860e5c89e4eSSatish Balay useful for debugging purposes. 861e5c89e4eSSatish Balay 862c139c21fSBarry Smith Logically Collective on PetscViewer 863e5c89e4eSSatish Balay 864e5c89e4eSSatish Balay Input Parameter: 865a2b725a8SWilliam Gropp + options - options database, use NULL for default global database 866a2b725a8SWilliam Gropp - viewer - must be an PETSCVIEWERASCII viewer 867e5c89e4eSSatish Balay 868e5c89e4eSSatish Balay Options Database Key: 86926a7e8d4SBarry Smith . -options_view - Activates PetscOptionsView() within PetscFinalize() 870e5c89e4eSSatish Balay 8719666a313SBarry Smith Notes: 8729666a313SBarry Smith Only the rank zero process of MPI_Comm used to create view prints the option values. Other processes 8731c9f3c13SBarry Smith may have different values but they are not printed. 8741c9f3c13SBarry Smith 875e5c89e4eSSatish Balay Level: advanced 876e5c89e4eSSatish Balay 877e5c89e4eSSatish Balay .seealso: PetscOptionsAllUsed() 878e5c89e4eSSatish Balay @*/ 879c5929fdfSBarry Smith PetscErrorCode PetscOptionsView(PetscOptions options,PetscViewer viewer) 880e5c89e4eSSatish Balay { 881e5c89e4eSSatish Balay PetscErrorCode ierr; 882431c96f7SBarry Smith PetscInt i; 88388c29154SBarry Smith PetscBool isascii; 884e5c89e4eSSatish Balay 885e5c89e4eSSatish Balay PetscFunctionBegin; 8862d747510SLisandro Dalcin if (viewer) PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 887c5929fdfSBarry Smith options = options ? options : defaultoptions; 88888c29154SBarry Smith if (!viewer) viewer = PETSC_VIEWER_STDOUT_WORLD; 889251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 890ce94432eSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Only supports ASCII viewer"); 89188c29154SBarry Smith 8922d747510SLisandro Dalcin if (!options->N) { 89388c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#No PETSc Option Table entries\n");CHKERRQ(ierr); 8942d747510SLisandro Dalcin PetscFunctionReturn(0); 89530694fe9SBarry Smith } 8962d747510SLisandro Dalcin 8972d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"#PETSc Option Table entries:\n");CHKERRQ(ierr); 898e5c89e4eSSatish Balay for (i=0; i<options->N; i++) { 899e5c89e4eSSatish Balay if (options->values[i]) { 90088c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s %s\n",options->names[i],options->values[i]);CHKERRQ(ierr); 901e5c89e4eSSatish Balay } else { 90288c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s\n",options->names[i]);CHKERRQ(ierr); 903e5c89e4eSSatish Balay } 904e5c89e4eSSatish Balay } 90588c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#End of PETSc Option Table entries\n");CHKERRQ(ierr); 906e5c89e4eSSatish Balay PetscFunctionReturn(0); 907e5c89e4eSSatish Balay } 908e5c89e4eSSatish Balay 909e11779c2SBarry Smith /* 910e11779c2SBarry Smith Called by error handlers to print options used in run 911e11779c2SBarry Smith */ 91295c0884eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsViewError(void) 913e11779c2SBarry Smith { 914e11779c2SBarry Smith PetscInt i; 9154416b707SBarry Smith PetscOptions options = defaultoptions; 916e11779c2SBarry Smith 917e11779c2SBarry Smith PetscFunctionBegin; 918e11779c2SBarry Smith if (options->N) { 919e11779c2SBarry Smith (*PetscErrorPrintf)("PETSc Option Table entries:\n"); 920e11779c2SBarry Smith } else { 921e11779c2SBarry Smith (*PetscErrorPrintf)("No PETSc Option Table entries\n"); 922e11779c2SBarry Smith } 923e11779c2SBarry Smith for (i=0; i<options->N; i++) { 924e11779c2SBarry Smith if (options->values[i]) { 925e11779c2SBarry Smith (*PetscErrorPrintf)("-%s %s\n",options->names[i],options->values[i]); 926e11779c2SBarry Smith } else { 927e11779c2SBarry Smith (*PetscErrorPrintf)("-%s\n",options->names[i]); 928e11779c2SBarry Smith } 929e11779c2SBarry Smith } 930e11779c2SBarry Smith PetscFunctionReturn(0); 931e11779c2SBarry Smith } 932e11779c2SBarry Smith 933e5c89e4eSSatish Balay /*@C 93474e0666dSJed Brown PetscOptionsPrefixPush - Designate a prefix to be used by all options insertions to follow. 93574e0666dSJed Brown 9361c9f3c13SBarry Smith Logically Collective 93774e0666dSJed Brown 9389db968c8SJed Brown Input Parameter: 939c5929fdfSBarry Smith + options - options database, or NULL for the default global database 940c5929fdfSBarry Smith - prefix - The string to append to the existing prefix 9419db968c8SJed Brown 9429db968c8SJed Brown Options Database Keys: 9439db968c8SJed Brown + -prefix_push <some_prefix_> - push the given prefix 9449db968c8SJed Brown - -prefix_pop - pop the last prefix 9459db968c8SJed Brown 9469db968c8SJed Brown Notes: 9479db968c8SJed Brown It is common to use this in conjunction with -options_file as in 9489db968c8SJed Brown 9499db968c8SJed Brown $ -prefix_push system1_ -options_file system1rc -prefix_pop -prefix_push system2_ -options_file system2rc -prefix_pop 9509db968c8SJed Brown 9519db968c8SJed Brown where the files no longer require all options to be prefixed with -system2_. 95274e0666dSJed Brown 9539666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 9541c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 9551c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 9561c9f3c13SBarry Smith on different ranks. 9571c9f3c13SBarry Smith 95874e0666dSJed Brown Level: advanced 95974e0666dSJed Brown 9601c9f3c13SBarry Smith .seealso: PetscOptionsPrefixPop(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsSetValue() 96174e0666dSJed Brown @*/ 962c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPush(PetscOptions options,const char prefix[]) 96374e0666dSJed Brown { 96474e0666dSJed Brown PetscErrorCode ierr; 96574e0666dSJed Brown size_t n; 96674e0666dSJed Brown PetscInt start; 9672d747510SLisandro Dalcin char key[MAXOPTNAME+1]; 9682d747510SLisandro Dalcin PetscBool valid; 96974e0666dSJed Brown 97074e0666dSJed Brown PetscFunctionBegin; 9719db968c8SJed Brown PetscValidCharPointer(prefix,1); 972c5929fdfSBarry Smith options = options ? options : defaultoptions; 97374e0666dSJed 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); 9742d747510SLisandro Dalcin key[0] = '-'; /* keys must start with '-' */ 9752d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,prefix,sizeof(key)-1);CHKERRQ(ierr); 9762d747510SLisandro Dalcin ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 9772d747510SLisandro 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); 97874e0666dSJed Brown start = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 97974e0666dSJed Brown ierr = PetscStrlen(prefix,&n);CHKERRQ(ierr); 98074e0666dSJed Brown if (n+1 > sizeof(options->prefix)-start) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum prefix length %d exceeded",sizeof(options->prefix)); 981580bdb30SBarry Smith ierr = PetscArraycpy(options->prefix+start,prefix,n+1);CHKERRQ(ierr); 98274e0666dSJed Brown options->prefixstack[options->prefixind++] = start+n; 98374e0666dSJed Brown PetscFunctionReturn(0); 98474e0666dSJed Brown } 98574e0666dSJed Brown 986c5929fdfSBarry Smith /*@C 98774e0666dSJed Brown PetscOptionsPrefixPop - Remove the latest options prefix, see PetscOptionsPrefixPush() for details 98874e0666dSJed Brown 9891c9f3c13SBarry Smith Logically Collective on the MPI_Comm that called PetscOptionsPrefixPush() 99074e0666dSJed Brown 991c5929fdfSBarry Smith Input Parameters: 992c5929fdfSBarry Smith . options - options database, or NULL for the default global database 993c5929fdfSBarry Smith 99474e0666dSJed Brown Level: advanced 99574e0666dSJed Brown 9961c9f3c13SBarry Smith .seealso: PetscOptionsPrefixPush(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsSetValue() 99774e0666dSJed Brown @*/ 998c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPop(PetscOptions options) 99974e0666dSJed Brown { 100074e0666dSJed Brown PetscInt offset; 100174e0666dSJed Brown 100274e0666dSJed Brown PetscFunctionBegin; 1003c5929fdfSBarry Smith options = options ? options : defaultoptions; 100474e0666dSJed Brown if (options->prefixind < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"More prefixes popped than pushed"); 100574e0666dSJed Brown options->prefixind--; 100674e0666dSJed Brown offset = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 100774e0666dSJed Brown options->prefix[offset] = 0; 100874e0666dSJed Brown PetscFunctionReturn(0); 100974e0666dSJed Brown } 101074e0666dSJed Brown 1011a542b6e8SBarry Smith /*@C 1012a542b6e8SBarry Smith PetscOptionsClear - Removes all options form the database leaving it empty. 1013a542b6e8SBarry Smith 10141c9f3c13SBarry Smith Logically Collective 10151c9f3c13SBarry Smith 1016c5929fdfSBarry Smith Input Parameters: 1017c5929fdfSBarry Smith . options - options database, use NULL for the default global database 1018c5929fdfSBarry Smith 10199666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 10201c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 10211c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 10221c9f3c13SBarry Smith on different ranks. 10231c9f3c13SBarry Smith 1024a542b6e8SBarry Smith Level: developer 1025a542b6e8SBarry Smith 1026a542b6e8SBarry Smith .seealso: PetscOptionsInsert() 1027a542b6e8SBarry Smith @*/ 1028c5929fdfSBarry Smith PetscErrorCode PetscOptionsClear(PetscOptions options) 1029a542b6e8SBarry Smith { 1030a542b6e8SBarry Smith PetscInt i; 1031a542b6e8SBarry Smith 1032c5929fdfSBarry Smith options = options ? options : defaultoptions; 10332d747510SLisandro Dalcin if (!options) return 0; 10342d747510SLisandro Dalcin 1035a542b6e8SBarry Smith for (i=0; i<options->N; i++) { 1036a542b6e8SBarry Smith if (options->names[i]) free(options->names[i]); 1037a542b6e8SBarry Smith if (options->values[i]) free(options->values[i]); 1038a542b6e8SBarry Smith } 10392d747510SLisandro Dalcin options->N = 0; 10402d747510SLisandro Dalcin 1041a542b6e8SBarry Smith for (i=0; i<options->Naliases; i++) { 1042a542b6e8SBarry Smith free(options->aliases1[i]); 1043a542b6e8SBarry Smith free(options->aliases2[i]); 1044a542b6e8SBarry Smith } 1045a542b6e8SBarry Smith options->Naliases = 0; 1046a542b6e8SBarry Smith 10472d747510SLisandro Dalcin /* destroy hash table */ 10482d747510SLisandro Dalcin kh_destroy(HO,options->ht); 10492d747510SLisandro Dalcin options->ht = NULL; 10500eb63584SBarry Smith 10512d747510SLisandro Dalcin options->prefixind = 0; 10522d747510SLisandro Dalcin options->prefix[0] = 0; 10532d747510SLisandro Dalcin options->help = PETSC_FALSE; 10544416b707SBarry Smith return 0; 10554416b707SBarry Smith } 10564416b707SBarry Smith 10572d747510SLisandro Dalcin /*@C 10582d747510SLisandro Dalcin PetscOptionsSetAlias - Makes a key and alias for another key 10592d747510SLisandro Dalcin 10601c9f3c13SBarry Smith Logically Collective 10612d747510SLisandro Dalcin 10622d747510SLisandro Dalcin Input Parameters: 10632d747510SLisandro Dalcin + options - options database, or NULL for default global database 10642d747510SLisandro Dalcin . newname - the alias 10652d747510SLisandro Dalcin - oldname - the name that alias will refer to 10662d747510SLisandro Dalcin 10672d747510SLisandro Dalcin Level: advanced 10682d747510SLisandro Dalcin 10699666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 10701c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 10711c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 10721c9f3c13SBarry Smith on different ranks. 10731c9f3c13SBarry Smith 10742d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 10752d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 10762d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 10772d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 10782d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 10792d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 10802d747510SLisandro Dalcin @*/ 10812d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetAlias(PetscOptions options,const char newname[],const char oldname[]) 10822d747510SLisandro Dalcin { 10832d747510SLisandro Dalcin PetscInt n; 10842d747510SLisandro Dalcin size_t len; 10859210b8eaSVaclav Hapla PetscBool valid; 10862d747510SLisandro Dalcin PetscErrorCode ierr; 10872d747510SLisandro Dalcin 10882d747510SLisandro Dalcin PetscFunctionBegin; 10892d747510SLisandro Dalcin PetscValidCharPointer(newname,2); 10902d747510SLisandro Dalcin PetscValidCharPointer(oldname,3); 10912d747510SLisandro Dalcin options = options ? options : defaultoptions; 10929210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(newname,&valid);CHKERRQ(ierr); 10939210b8eaSVaclav Hapla if (!valid) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid aliased option %s",newname); 10949210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(oldname,&valid);CHKERRQ(ierr); 10959210b8eaSVaclav Hapla if (!valid) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid aliasee option %s",oldname); 10962d747510SLisandro Dalcin 10972d747510SLisandro Dalcin n = options->Naliases; 10982d747510SLisandro 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); 10992d747510SLisandro Dalcin 11002d747510SLisandro Dalcin newname++; oldname++; 11012d747510SLisandro Dalcin ierr = PetscStrlen(newname,&len);CHKERRQ(ierr); 11022d747510SLisandro Dalcin options->aliases1[n] = (char*)malloc((len+1)*sizeof(char)); 11032d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases1[n],newname);CHKERRQ(ierr); 11042d747510SLisandro Dalcin ierr = PetscStrlen(oldname,&len);CHKERRQ(ierr); 11052d747510SLisandro Dalcin options->aliases2[n] = (char*)malloc((len+1)*sizeof(char)); 11062d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases2[n],oldname);CHKERRQ(ierr); 11072d747510SLisandro Dalcin options->Naliases++; 11082d747510SLisandro Dalcin PetscFunctionReturn(0); 11092d747510SLisandro Dalcin } 11104416b707SBarry Smith 1111e5c89e4eSSatish Balay /*@C 1112e5c89e4eSSatish Balay PetscOptionsSetValue - Sets an option name-value pair in the options 1113e5c89e4eSSatish Balay database, overriding whatever is already present. 1114e5c89e4eSSatish Balay 11151c9f3c13SBarry Smith Logically Collective 1116e5c89e4eSSatish Balay 1117e5c89e4eSSatish Balay Input Parameters: 1118c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1119c5929fdfSBarry Smith . name - name of option, this SHOULD have the - prepended 11202d747510SLisandro Dalcin - value - the option value (not used for all options, so can be NULL) 1121e5c89e4eSSatish Balay 1122e5c89e4eSSatish Balay Level: intermediate 1123e5c89e4eSSatish Balay 1124e5c89e4eSSatish Balay Note: 1125d49172ceSBarry Smith This function can be called BEFORE PetscInitialize() 1126d49172ceSBarry Smith 11279666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 11281c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 11291c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 11301c9f3c13SBarry Smith on different ranks. 11311c9f3c13SBarry Smith 11322d747510SLisandro Dalcin Developers Note: Uses malloc() directly because PETSc may not be initialized yet. 1133b0250c70SBarry Smith 11342d747510SLisandro Dalcin .seealso: PetscOptionsInsert(), PetscOptionsClearValue() 1135e5c89e4eSSatish Balay @*/ 11362d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetValue(PetscOptions options,const char name[],const char value[]) 1137e5c89e4eSSatish Balay { 1138*c5b5d8d5SVaclav Hapla return PetscOptionsSetValue_Private(options,name,value,NULL); 1139*c5b5d8d5SVaclav Hapla } 1140*c5b5d8d5SVaclav Hapla 1141*c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsSetValue_Private(PetscOptions options,const char name[],const char value[],int *pos) 1142*c5b5d8d5SVaclav Hapla { 1143e5c89e4eSSatish Balay size_t len; 11442d747510SLisandro Dalcin int N,n,i; 1145e5c89e4eSSatish Balay char **names; 11462d747510SLisandro Dalcin char fullname[MAXOPTNAME] = ""; 1147*c5b5d8d5SVaclav Hapla PetscBool flg; 11482d747510SLisandro Dalcin PetscErrorCode ierr; 1149e5c89e4eSSatish Balay 11507272c0d2SVaclav Hapla if (!options) { 11512d747510SLisandro Dalcin ierr = PetscOptionsCreateDefault();if (ierr) return ierr; 11527272c0d2SVaclav Hapla options = defaultoptions; 1153c5929fdfSBarry Smith } 11542d747510SLisandro Dalcin 11552d747510SLisandro Dalcin if (name[0] != '-') return PETSC_ERR_ARG_OUTOFRANGE; 1156e5c89e4eSSatish Balay 1157*c5b5d8d5SVaclav Hapla ierr = PetscOptionsSkipPrecedent(options,name,&flg);CHKERRQ(ierr); 1158*c5b5d8d5SVaclav Hapla if (flg) return 0; 1159e5c89e4eSSatish Balay 11602d747510SLisandro Dalcin name++; /* skip starting dash */ 11612d747510SLisandro Dalcin 116274e0666dSJed Brown if (options->prefixind > 0) { 1163d49172ceSBarry Smith strncpy(fullname,options->prefix,sizeof(fullname)); 11642d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 116589ae1891SBarry Smith strncat(fullname,name,sizeof(fullname)-strlen(fullname)-1); 11662d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 116774e0666dSJed Brown name = fullname; 116874e0666dSJed Brown } 116974e0666dSJed Brown 117074e0666dSJed Brown /* check against aliases */ 1171e5c89e4eSSatish Balay N = options->Naliases; 1172e5c89e4eSSatish Balay for (i=0; i<N; i++) { 11732d747510SLisandro Dalcin int result = PetscOptNameCmp(options->aliases1[i],name); 11742d747510SLisandro Dalcin if (!result) { name = options->aliases2[i]; break; } 1175e5c89e4eSSatish Balay } 1176e5c89e4eSSatish Balay 11772d747510SLisandro Dalcin /* slow search */ 11782d747510SLisandro Dalcin N = n = options->N; 1179e5c89e4eSSatish Balay names = options->names; 1180e5c89e4eSSatish Balay for (i=0; i<N; i++) { 11812d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 11822d747510SLisandro Dalcin if (!result) { 11832d747510SLisandro Dalcin n = i; goto setvalue; 11842d747510SLisandro Dalcin } else if (result > 0) { 11852d747510SLisandro Dalcin n = i; break; 1186e5c89e4eSSatish Balay } 1187e5c89e4eSSatish Balay } 11882d747510SLisandro Dalcin if (N >= MAXOPTIONS) return PETSC_ERR_MEM; 11892d747510SLisandro Dalcin /* shift remaining values up 1 */ 1190e5c89e4eSSatish Balay for (i=N; i>n; i--) { 11915e8c5e88SLisandro Dalcin options->names[i] = options->names[i-1]; 1192e5c89e4eSSatish Balay options->values[i] = options->values[i-1]; 1193e5c89e4eSSatish Balay options->used[i] = options->used[i-1]; 1194e5c89e4eSSatish Balay } 11952d747510SLisandro Dalcin options->names[n] = NULL; 11962d747510SLisandro Dalcin options->values[n] = NULL; 11972d747510SLisandro Dalcin options->used[n] = PETSC_FALSE; 11982d747510SLisandro Dalcin options->N++; 11992d747510SLisandro Dalcin 12002d747510SLisandro Dalcin /* destroy hash table */ 12012d747510SLisandro Dalcin kh_destroy(HO,options->ht); 12022d747510SLisandro Dalcin options->ht = NULL; 12032d747510SLisandro Dalcin 12042d747510SLisandro Dalcin /* set new name */ 120570d8d27cSBarry Smith len = strlen(name); 12065e8c5e88SLisandro Dalcin options->names[n] = (char*)malloc((len+1)*sizeof(char)); 1207d49172ceSBarry Smith if (!options->names[n]) return PETSC_ERR_MEM; 1208d49172ceSBarry Smith strcpy(options->names[n],name); 12092d747510SLisandro Dalcin 12102d747510SLisandro Dalcin setvalue: 12112d747510SLisandro Dalcin /* set new value */ 12122d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1213d49172ceSBarry Smith len = value ? strlen(value) : 0; 12145e8c5e88SLisandro Dalcin if (len) { 1215e5c89e4eSSatish Balay options->values[n] = (char*)malloc((len+1)*sizeof(char)); 1216d49172ceSBarry Smith if (!options->values[n]) return PETSC_ERR_MEM; 1217d49172ceSBarry Smith strcpy(options->values[n],value); 12182d747510SLisandro Dalcin } else { 12192d747510SLisandro Dalcin options->values[n] = NULL; 12202d747510SLisandro Dalcin } 12212d747510SLisandro Dalcin 1222*c5b5d8d5SVaclav Hapla if (PetscErrorHandlingInitialized) { 1223*c5b5d8d5SVaclav Hapla ierr = PetscOptionsMonitor(options,name,value);CHKERRQ(ierr); 1224*c5b5d8d5SVaclav Hapla } 1225*c5b5d8d5SVaclav Hapla if (pos) *pos = n; 1226d49172ceSBarry Smith return 0; 1227e5c89e4eSSatish Balay } 1228e5c89e4eSSatish Balay 1229e5c89e4eSSatish Balay /*@C 1230e5c89e4eSSatish Balay PetscOptionsClearValue - Clears an option name-value pair in the options 1231e5c89e4eSSatish Balay database, overriding whatever is already present. 1232e5c89e4eSSatish Balay 12331c9f3c13SBarry Smith Logically Collective 1234e5c89e4eSSatish Balay 1235e5c89e4eSSatish Balay Input Parameter: 1236c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1237a2b725a8SWilliam Gropp - name - name of option, this SHOULD have the - prepended 1238e5c89e4eSSatish Balay 1239e5c89e4eSSatish Balay Level: intermediate 1240e5c89e4eSSatish Balay 12419666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 12421c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 12431c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 12441c9f3c13SBarry Smith on different ranks. 12451c9f3c13SBarry Smith 1246e5c89e4eSSatish Balay .seealso: PetscOptionsInsert() 1247e5c89e4eSSatish Balay @*/ 12482d747510SLisandro Dalcin PetscErrorCode PetscOptionsClearValue(PetscOptions options,const char name[]) 1249e5c89e4eSSatish Balay { 12502d747510SLisandro Dalcin int N,n,i; 12512d747510SLisandro Dalcin char **names; 1252e5c89e4eSSatish Balay PetscErrorCode ierr; 1253e5c89e4eSSatish Balay 1254e5c89e4eSSatish Balay PetscFunctionBegin; 1255c5929fdfSBarry Smith options = options ? options : defaultoptions; 12562d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1257e5c89e4eSSatish Balay 12582d747510SLisandro Dalcin /* this is so that -h and -help are equivalent (p4 does not like -help)*/ 12592d747510SLisandro Dalcin if (!strcmp(name,"-h")) name = "-help"; 12602d747510SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_FALSE; 12612d747510SLisandro Dalcin 12622d747510SLisandro Dalcin name++; /* skip starting dash */ 12632d747510SLisandro Dalcin 12642d747510SLisandro Dalcin /* slow search */ 12652d747510SLisandro Dalcin N = n = options->N; 1266e5c89e4eSSatish Balay names = options->names; 1267e5c89e4eSSatish Balay for (i=0; i<N; i++) { 12682d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 12692d747510SLisandro Dalcin if (!result) { 12702d747510SLisandro Dalcin n = i; break; 12712d747510SLisandro Dalcin } else if (result > 0) { 12722d747510SLisandro Dalcin n = N; break; 1273e5c89e4eSSatish Balay } 12742d747510SLisandro Dalcin } 12752d747510SLisandro Dalcin if (n == N) PetscFunctionReturn(0); /* it was not present */ 1276e5c89e4eSSatish Balay 12772d747510SLisandro Dalcin /* remove name and value */ 12782d747510SLisandro Dalcin if (options->names[n]) free(options->names[n]); 12792d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1280e5c89e4eSSatish Balay /* shift remaining values down 1 */ 1281e5c89e4eSSatish Balay for (i=n; i<N-1; i++) { 12825e8c5e88SLisandro Dalcin options->names[i] = options->names[i+1]; 1283e5c89e4eSSatish Balay options->values[i] = options->values[i+1]; 1284e5c89e4eSSatish Balay options->used[i] = options->used[i+1]; 1285e5c89e4eSSatish Balay } 1286e5c89e4eSSatish Balay options->N--; 12872d747510SLisandro Dalcin 12882d747510SLisandro Dalcin /* destroy hash table */ 12892d747510SLisandro Dalcin kh_destroy(HO,options->ht); 12902d747510SLisandro Dalcin options->ht = NULL; 12912d747510SLisandro Dalcin 12922d747510SLisandro Dalcin ierr = PetscOptionsMonitor(options,name,NULL);CHKERRQ(ierr); 1293e5c89e4eSSatish Balay PetscFunctionReturn(0); 1294e5c89e4eSSatish Balay } 1295e5c89e4eSSatish Balay 1296e5c89e4eSSatish Balay /*@C 12972d747510SLisandro Dalcin PetscOptionsFindPair - Gets an option name-value pair from the options database. 1298e5c89e4eSSatish Balay 12992d747510SLisandro Dalcin Not Collective 1300e5c89e4eSSatish Balay 1301e5c89e4eSSatish Balay Input Parameters: 13022d747510SLisandro Dalcin + options - options database, use NULL for the default global database 13032d747510SLisandro Dalcin . pre - the string to prepend to the name or NULL, this SHOULD NOT have the "-" prepended 13042d747510SLisandro Dalcin - name - name of option, this SHOULD have the "-" prepended 1305e5c89e4eSSatish Balay 13062d747510SLisandro Dalcin Output Parameters: 13072d747510SLisandro Dalcin + value - the option value (optional, not used for all options) 13082d747510SLisandro Dalcin - set - whether the option is set (optional) 1309e5c89e4eSSatish Balay 13109666a313SBarry Smith Notes: 13119666a313SBarry Smith Each process may find different values or no value depending on how options were inserted into the database 13121c9f3c13SBarry Smith 13132d747510SLisandro Dalcin Level: developer 13142d747510SLisandro Dalcin 13152d747510SLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsClearValue() 1316e5c89e4eSSatish Balay @*/ 13172d747510SLisandro Dalcin PetscErrorCode PetscOptionsFindPair(PetscOptions options,const char pre[],const char name[],const char *value[],PetscBool *set) 1318e5c89e4eSSatish Balay { 13192d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1320daabea38SBarry Smith PetscBool usehashtable = PETSC_TRUE; 13212d747510SLisandro Dalcin PetscBool matchnumbers = PETSC_TRUE; 1322e5c89e4eSSatish Balay PetscErrorCode ierr; 1323e5c89e4eSSatish Balay 1324e5c89e4eSSatish Balay PetscFunctionBegin; 1325c5929fdfSBarry Smith options = options ? options : defaultoptions; 13262d747510SLisandro Dalcin if (pre && PetscUnlikely(pre[0] == '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 13272d747510SLisandro Dalcin if (PetscUnlikely(name[0] != '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1328e5c89e4eSSatish Balay 13292d747510SLisandro Dalcin name++; /* skip starting dash */ 1330e5c89e4eSSatish Balay 13317cd08cecSJed Brown /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 13322d747510SLisandro Dalcin if (pre && pre[0]) { 13332d747510SLisandro Dalcin char *ptr = buf; 13342d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 13352d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,buf+sizeof(buf)-ptr);CHKERRQ(ierr); 13362d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 13372d747510SLisandro Dalcin name = buf; 13387cd08cecSJed Brown } 13392d747510SLisandro Dalcin 134076bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 13412f828895SJed Brown PetscBool valid; 13422d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 13432d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 13442f828895SJed Brown ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 13452f828895SJed 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); 13462f828895SJed Brown } 1347e5c89e4eSSatish Balay 13482d747510SLisandro Dalcin if (!options->ht && usehashtable) { 13492d747510SLisandro Dalcin int i,ret; 13502d747510SLisandro Dalcin khiter_t it; 13512d747510SLisandro Dalcin khash_t(HO) *ht; 13522d747510SLisandro Dalcin ht = kh_init(HO); 13532d747510SLisandro Dalcin if (PetscUnlikely(!ht)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13542d747510SLisandro Dalcin ret = kh_resize(HO,ht,options->N*2); /* twice the required size to reduce risk of collisions */ 13552d747510SLisandro Dalcin if (PetscUnlikely(ret)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13562d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 13572d747510SLisandro Dalcin it = kh_put(HO,ht,options->names[i],&ret); 13582d747510SLisandro Dalcin if (PetscUnlikely(ret != 1)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13592d747510SLisandro Dalcin kh_val(ht,it) = i; 13602d747510SLisandro Dalcin } 13612d747510SLisandro Dalcin options->ht = ht; 13622d747510SLisandro Dalcin } 13632d747510SLisandro Dalcin 13642d747510SLisandro Dalcin if (usehashtable) 13652d747510SLisandro Dalcin { /* fast search */ 13662d747510SLisandro Dalcin khash_t(HO) *ht = options->ht; 13672d747510SLisandro Dalcin khiter_t it = kh_get(HO,ht,name); 13682d747510SLisandro Dalcin if (it != kh_end(ht)) { 13692d747510SLisandro Dalcin int i = kh_val(ht,it); 1370e5c89e4eSSatish Balay options->used[i] = PETSC_TRUE; 13712d747510SLisandro Dalcin if (value) *value = options->values[i]; 13722d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 13732d747510SLisandro Dalcin PetscFunctionReturn(0); 13742d747510SLisandro Dalcin } 13752d747510SLisandro Dalcin } else 13762d747510SLisandro Dalcin { /* slow search */ 13772d747510SLisandro Dalcin int i, N = options->N; 13782d747510SLisandro Dalcin for (i=0; i<N; i++) { 1379daabea38SBarry Smith int result = PetscOptNameCmp(options->names[i],name); 13802d747510SLisandro Dalcin if (!result) { 13812d747510SLisandro Dalcin options->used[i] = PETSC_TRUE; 13822d747510SLisandro Dalcin if (value) *value = options->values[i]; 13832d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 13842d747510SLisandro Dalcin PetscFunctionReturn(0); 13852d747510SLisandro Dalcin } else if (result > 0) { 1386e5c89e4eSSatish Balay break; 1387e5c89e4eSSatish Balay } 1388e5c89e4eSSatish Balay } 13892d747510SLisandro Dalcin } 13902d747510SLisandro Dalcin 13912d747510SLisandro Dalcin /* 13922d747510SLisandro Dalcin The following block slows down all lookups in the most frequent path (most lookups are unsuccessful). 13932d747510SLisandro Dalcin Maybe this special lookup mode should be enabled on request with a push/pop API. 13942d747510SLisandro Dalcin The feature of matching _%d_ used sparingly in the codebase. 13952d747510SLisandro Dalcin */ 13962d747510SLisandro Dalcin if (matchnumbers) { 13972d747510SLisandro Dalcin int i,j,cnt = 0,locs[16],loce[16]; 1398e5c89e4eSSatish Balay /* determine the location and number of all _%d_ in the key */ 13992d747510SLisandro Dalcin for (i=0; name[i]; i++) { 14002d747510SLisandro Dalcin if (name[i] == '_') { 14012d747510SLisandro Dalcin for (j=i+1; name[j]; j++) { 14022d747510SLisandro Dalcin if (name[j] >= '0' && name[j] <= '9') continue; 14032d747510SLisandro Dalcin if (name[j] == '_' && j > i+1) { /* found a number */ 1404e5c89e4eSSatish Balay locs[cnt] = i+1; 1405e5c89e4eSSatish Balay loce[cnt++] = j+1; 1406e5c89e4eSSatish Balay } 14072d747510SLisandro Dalcin i = j-1; 1408e5c89e4eSSatish Balay break; 1409e5c89e4eSSatish Balay } 1410e5c89e4eSSatish Balay } 1411e5c89e4eSSatish Balay } 1412e5c89e4eSSatish Balay for (i=0; i<cnt; i++) { 14132d747510SLisandro Dalcin PetscBool found; 14142d747510SLisandro Dalcin char opt[MAXOPTNAME+1] = "-", tmp[MAXOPTNAME]; 14152d747510SLisandro Dalcin ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[i]+1),sizeof(tmp)));CHKERRQ(ierr); 14162d747510SLisandro Dalcin ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 14172d747510SLisandro Dalcin ierr = PetscStrlcat(opt,name+loce[i],sizeof(opt));CHKERRQ(ierr); 14182d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,NULL,opt,value,&found);CHKERRQ(ierr); 14192d747510SLisandro Dalcin if (found) {if (set) *set = PETSC_TRUE; PetscFunctionReturn(0);} 1420e5c89e4eSSatish Balay } 1421e5c89e4eSSatish Balay } 14222d747510SLisandro Dalcin 14232d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1424e5c89e4eSSatish Balay PetscFunctionReturn(0); 1425e5c89e4eSSatish Balay } 1426e5c89e4eSSatish Balay 1427d6ced9c0SMatthew G. Knepley /* Check whether any option begins with pre+name */ 14282d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions options,const char pre[], const char name[],const char *value[],PetscBool *set) 1429514bf10dSMatthew G Knepley { 14302d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1431d6ced9c0SMatthew G. Knepley int numCnt = 0, locs[16],loce[16]; 1432514bf10dSMatthew G Knepley PetscErrorCode ierr; 1433514bf10dSMatthew G Knepley 1434514bf10dSMatthew G Knepley PetscFunctionBegin; 1435c5929fdfSBarry Smith options = options ? options : defaultoptions; 14362d747510SLisandro Dalcin if (pre && pre[0] == '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 14372d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1438514bf10dSMatthew G Knepley 14392d747510SLisandro Dalcin name++; /* skip starting dash */ 1440514bf10dSMatthew G Knepley 1441514bf10dSMatthew G Knepley /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 14422d747510SLisandro Dalcin if (pre && pre[0]) { 14432d747510SLisandro Dalcin char *ptr = buf; 14442d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 14452d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,sizeof(buf)+(size_t)(ptr-buf));CHKERRQ(ierr); 14462d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 14472d747510SLisandro Dalcin name = buf; 1448514bf10dSMatthew G Knepley } 14492d747510SLisandro Dalcin 145076bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1451514bf10dSMatthew G Knepley PetscBool valid; 14522d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 14532d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 1454514bf10dSMatthew G Knepley ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 1455514bf10dSMatthew 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); 1456514bf10dSMatthew G Knepley } 1457514bf10dSMatthew G Knepley 1458d6ced9c0SMatthew G. Knepley /* determine the location and number of all _%d_ in the key */ 1459d6ced9c0SMatthew G. Knepley { 1460d6ced9c0SMatthew G. Knepley int i,j; 1461d6ced9c0SMatthew G. Knepley for (i=0; name[i]; i++) { 1462d6ced9c0SMatthew G. Knepley if (name[i] == '_') { 1463d6ced9c0SMatthew G. Knepley for (j=i+1; name[j]; j++) { 1464d6ced9c0SMatthew G. Knepley if (name[j] >= '0' && name[j] <= '9') continue; 1465d6ced9c0SMatthew G. Knepley if (name[j] == '_' && j > i+1) { /* found a number */ 1466d6ced9c0SMatthew G. Knepley locs[numCnt] = i+1; 1467d6ced9c0SMatthew G. Knepley loce[numCnt++] = j+1; 1468d6ced9c0SMatthew G. Knepley } 1469d6ced9c0SMatthew G. Knepley i = j-1; 1470d6ced9c0SMatthew G. Knepley break; 1471d6ced9c0SMatthew G. Knepley } 1472d6ced9c0SMatthew G. Knepley } 1473d6ced9c0SMatthew G. Knepley } 1474d6ced9c0SMatthew G. Knepley } 1475d6ced9c0SMatthew G. Knepley 14762d747510SLisandro Dalcin { /* slow search */ 1477d6ced9c0SMatthew G. Knepley int c, i; 14782d747510SLisandro Dalcin size_t len; 14792d747510SLisandro Dalcin PetscBool match; 1480d6ced9c0SMatthew G. Knepley 1481d6ced9c0SMatthew G. Knepley for (c = -1; c < numCnt; ++c) { 1482d6ced9c0SMatthew G. Knepley char opt[MAXOPTNAME+1] = "", tmp[MAXOPTNAME]; 1483d6ced9c0SMatthew G. Knepley 1484d6ced9c0SMatthew G. Knepley if (c < 0) { 1485d6ced9c0SMatthew G. Knepley ierr = PetscStrcpy(opt,name);CHKERRQ(ierr); 1486d6ced9c0SMatthew G. Knepley } else { 1487d6ced9c0SMatthew G. Knepley ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[c]+1),sizeof(tmp)));CHKERRQ(ierr); 1488d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 1489d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,name+loce[c],sizeof(opt));CHKERRQ(ierr); 1490d6ced9c0SMatthew G. Knepley } 1491d6ced9c0SMatthew G. Knepley ierr = PetscStrlen(opt,&len);CHKERRQ(ierr); 14922d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 1493d6ced9c0SMatthew G. Knepley ierr = PetscStrncmp(options->names[i],opt,len,&match);CHKERRQ(ierr); 1494514bf10dSMatthew G Knepley if (match) { 1495514bf10dSMatthew G Knepley options->used[i] = PETSC_TRUE; 14962d747510SLisandro Dalcin if (value) *value = options->values[i]; 14972d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 14982d747510SLisandro Dalcin PetscFunctionReturn(0); 1499514bf10dSMatthew G Knepley } 1500514bf10dSMatthew G Knepley } 15012d747510SLisandro Dalcin } 1502d6ced9c0SMatthew G. Knepley } 15032d747510SLisandro Dalcin 15042d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1505514bf10dSMatthew G Knepley PetscFunctionReturn(0); 1506514bf10dSMatthew G Knepley } 1507514bf10dSMatthew G Knepley 1508e5c89e4eSSatish Balay /*@C 1509e5c89e4eSSatish Balay PetscOptionsReject - Generates an error if a certain option is given. 1510e5c89e4eSSatish Balay 15111c9f3c13SBarry Smith Not Collective 1512e5c89e4eSSatish Balay 1513e5c89e4eSSatish Balay Input Parameters: 15145c9cc608SHong Zhang + options - options database, use NULL for default global database 15152d747510SLisandro Dalcin . pre - the option prefix (may be NULL) 15162d747510SLisandro Dalcin . name - the option name one is seeking 15170298fd71SBarry Smith - mess - error message (may be NULL) 1518e5c89e4eSSatish Balay 1519e5c89e4eSSatish Balay Level: advanced 1520e5c89e4eSSatish Balay 1521e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 1522acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1523e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1524e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1525acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1526a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1527e5c89e4eSSatish Balay @*/ 15282d747510SLisandro Dalcin PetscErrorCode PetscOptionsReject(PetscOptions options,const char pre[],const char name[],const char mess[]) 1529e5c89e4eSSatish Balay { 1530e5c89e4eSSatish Balay PetscErrorCode ierr; 1531ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 1532e5c89e4eSSatish Balay 1533e5c89e4eSSatish Balay PetscFunctionBegin; 15342d747510SLisandro Dalcin ierr = PetscOptionsHasName(options,pre,name,&flag);CHKERRQ(ierr); 1535e5c89e4eSSatish Balay if (flag) { 15362d747510SLisandro 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); 15372d747510SLisandro Dalcin else SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s",pre?pre:"",name+1); 1538e5c89e4eSSatish Balay } 1539e5c89e4eSSatish Balay PetscFunctionReturn(0); 1540e5c89e4eSSatish Balay } 1541e5c89e4eSSatish Balay 1542e5c89e4eSSatish Balay /*@C 15432d747510SLisandro Dalcin PetscOptionsHasHelp - Determines whether the "-help" option is in the database. 15442d747510SLisandro Dalcin 15452d747510SLisandro Dalcin Not Collective 15462d747510SLisandro Dalcin 15472d747510SLisandro Dalcin Input Parameters: 15482d747510SLisandro Dalcin . options - options database, use NULL for default global database 15492d747510SLisandro Dalcin 15502d747510SLisandro Dalcin Output Parameters: 15512d747510SLisandro Dalcin . set - PETSC_TRUE if found else PETSC_FALSE. 15522d747510SLisandro Dalcin 15532d747510SLisandro Dalcin Level: advanced 15542d747510SLisandro Dalcin 15552d747510SLisandro Dalcin .seealso: PetscOptionsHasName() 15562d747510SLisandro Dalcin @*/ 15572d747510SLisandro Dalcin PetscErrorCode PetscOptionsHasHelp(PetscOptions options,PetscBool *set) 15582d747510SLisandro Dalcin { 15592d747510SLisandro Dalcin PetscFunctionBegin; 15602d747510SLisandro Dalcin PetscValidPointer(set,2); 15612d747510SLisandro Dalcin options = options ? options : defaultoptions; 15622d747510SLisandro Dalcin *set = options->help; 15632d747510SLisandro Dalcin PetscFunctionReturn(0); 15642d747510SLisandro Dalcin } 15652d747510SLisandro Dalcin 15662d747510SLisandro Dalcin /*@C 156790d69ab7SBarry 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 156890d69ab7SBarry Smith its value is set to false. 1569e5c89e4eSSatish Balay 1570e5c89e4eSSatish Balay Not Collective 1571e5c89e4eSSatish Balay 1572e5c89e4eSSatish Balay Input Parameters: 15735c9cc608SHong Zhang + options - options database, use NULL for default global database 15743de71b31SHong Zhang . pre - string to prepend to the name or NULL 15753de71b31SHong Zhang - name - the option one is seeking 1576e5c89e4eSSatish Balay 1577e5c89e4eSSatish Balay Output Parameters: 157896ef3cdfSSatish Balay . set - PETSC_TRUE if found else PETSC_FALSE. 1579e5c89e4eSSatish Balay 1580e5c89e4eSSatish Balay Level: beginner 1581e5c89e4eSSatish Balay 158295452b02SPatrick Sanan Notes: 15832d747510SLisandro Dalcin Name cannot be simply "-h". 1584431c96f7SBarry Smith 1585acfcf0e5SJed Brown In many cases you probably want to use PetscOptionsGetBool() instead of calling this, to allowing toggling values. 158690d69ab7SBarry Smith 1587e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1588f3e3d7dfSBarry Smith PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1589e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1590e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1591acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1592a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1593e5c89e4eSSatish Balay @*/ 1594c5929fdfSBarry Smith PetscErrorCode PetscOptionsHasName(PetscOptions options,const char pre[],const char name[],PetscBool *set) 1595e5c89e4eSSatish Balay { 15962d747510SLisandro Dalcin const char *value; 1597e5c89e4eSSatish Balay PetscErrorCode ierr; 1598ace3abfcSBarry Smith PetscBool flag; 1599e5c89e4eSSatish Balay 1600e5c89e4eSSatish Balay PetscFunctionBegin; 16012d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 160296ef3cdfSSatish Balay if (set) *set = flag; 1603e5c89e4eSSatish Balay PetscFunctionReturn(0); 1604e5c89e4eSSatish Balay } 1605e5c89e4eSSatish Balay 1606e5c89e4eSSatish Balay /*@C 16072d747510SLisandro Dalcin PetscOptionsGetAll - Lists all the options the program was run with in a single string. 16082d747510SLisandro Dalcin 16092d747510SLisandro Dalcin Not Collective 16102d747510SLisandro Dalcin 1611fd292e60Sprj- Input Parameter: 16122d747510SLisandro Dalcin . options - the options database, use NULL for the default global database 16132d747510SLisandro Dalcin 16142d747510SLisandro Dalcin Output Parameter: 16152d747510SLisandro Dalcin . copts - pointer where string pointer is stored 16162d747510SLisandro Dalcin 16172d747510SLisandro Dalcin Notes: 16181c9f3c13SBarry Smith The array and each entry in the array should be freed with PetscFree() 16191c9f3c13SBarry Smith Each process may have different values depending on how the options were inserted into the database 16202d747510SLisandro Dalcin 16212d747510SLisandro Dalcin Level: advanced 16222d747510SLisandro Dalcin 16231c9f3c13SBarry Smith .seealso: PetscOptionsAllUsed(), PetscOptionsView(), PetscOptionsPush(), PetscOptionsPop() 16242d747510SLisandro Dalcin @*/ 16252d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetAll(PetscOptions options,char *copts[]) 16262d747510SLisandro Dalcin { 16272d747510SLisandro Dalcin PetscErrorCode ierr; 16282d747510SLisandro Dalcin PetscInt i; 16292d747510SLisandro Dalcin size_t len = 1,lent = 0; 16302d747510SLisandro Dalcin char *coptions = NULL; 16312d747510SLisandro Dalcin 16322d747510SLisandro Dalcin PetscFunctionBegin; 16332d747510SLisandro Dalcin PetscValidPointer(copts,2); 16342d747510SLisandro Dalcin options = options ? options : defaultoptions; 16352d747510SLisandro Dalcin /* count the length of the required string */ 16362d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16372d747510SLisandro Dalcin ierr = PetscStrlen(options->names[i],&lent);CHKERRQ(ierr); 16382d747510SLisandro Dalcin len += 2 + lent; 16392d747510SLisandro Dalcin if (options->values[i]) { 16402d747510SLisandro Dalcin ierr = PetscStrlen(options->values[i],&lent);CHKERRQ(ierr); 16412d747510SLisandro Dalcin len += 1 + lent; 16422d747510SLisandro Dalcin } 16432d747510SLisandro Dalcin } 16442d747510SLisandro Dalcin ierr = PetscMalloc1(len,&coptions);CHKERRQ(ierr); 16452d747510SLisandro Dalcin coptions[0] = 0; 16462d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16472d747510SLisandro Dalcin ierr = PetscStrcat(coptions,"-");CHKERRQ(ierr); 16482d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->names[i]);CHKERRQ(ierr); 16492d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 16502d747510SLisandro Dalcin if (options->values[i]) { 16512d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->values[i]);CHKERRQ(ierr); 16522d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 16532d747510SLisandro Dalcin } 16542d747510SLisandro Dalcin } 16552d747510SLisandro Dalcin *copts = coptions; 16562d747510SLisandro Dalcin PetscFunctionReturn(0); 16572d747510SLisandro Dalcin } 16582d747510SLisandro Dalcin 16592d747510SLisandro Dalcin /*@C 16602d747510SLisandro Dalcin PetscOptionsUsed - Indicates if PETSc has used a particular option set in the database 16612d747510SLisandro Dalcin 16622d747510SLisandro Dalcin Not Collective 16632d747510SLisandro Dalcin 16642d747510SLisandro Dalcin Input Parameter: 16652d747510SLisandro Dalcin + options - options database, use NULL for default global database 16662d747510SLisandro Dalcin - name - string name of option 16672d747510SLisandro Dalcin 16682d747510SLisandro Dalcin Output Parameter: 16692d747510SLisandro Dalcin . used - PETSC_TRUE if the option was used, otherwise false, including if option was not found in options database 16702d747510SLisandro Dalcin 16712d747510SLisandro Dalcin Level: advanced 16722d747510SLisandro Dalcin 16739666a313SBarry Smith Notes: 16749666a313SBarry Smith The value returned may be different on each process and depends on which options have been processed 16751c9f3c13SBarry Smith on the given process 16761c9f3c13SBarry Smith 16772d747510SLisandro Dalcin .seealso: PetscOptionsView(), PetscOptionsLeft(), PetscOptionsAllUsed() 16782d747510SLisandro Dalcin @*/ 16792d747510SLisandro Dalcin PetscErrorCode PetscOptionsUsed(PetscOptions options,const char *name,PetscBool *used) 16802d747510SLisandro Dalcin { 16812d747510SLisandro Dalcin PetscInt i; 16822d747510SLisandro Dalcin PetscErrorCode ierr; 16832d747510SLisandro Dalcin 16842d747510SLisandro Dalcin PetscFunctionBegin; 16852d747510SLisandro Dalcin PetscValidCharPointer(name,2); 16862d747510SLisandro Dalcin PetscValidPointer(used,3); 16872d747510SLisandro Dalcin options = options ? options : defaultoptions; 16882d747510SLisandro Dalcin *used = PETSC_FALSE; 16892d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16902d747510SLisandro Dalcin ierr = PetscStrcmp(options->names[i],name,used);CHKERRQ(ierr); 16912d747510SLisandro Dalcin if (*used) { 16922d747510SLisandro Dalcin *used = options->used[i]; 16932d747510SLisandro Dalcin break; 16942d747510SLisandro Dalcin } 16952d747510SLisandro Dalcin } 16962d747510SLisandro Dalcin PetscFunctionReturn(0); 16972d747510SLisandro Dalcin } 16982d747510SLisandro Dalcin 1699487a658cSBarry Smith /*@ 17002d747510SLisandro Dalcin PetscOptionsAllUsed - Returns a count of the number of options in the 17012d747510SLisandro Dalcin database that have never been selected. 17022d747510SLisandro Dalcin 17032d747510SLisandro Dalcin Not Collective 17042d747510SLisandro Dalcin 17052d747510SLisandro Dalcin Input Parameter: 17062d747510SLisandro Dalcin . options - options database, use NULL for default global database 17072d747510SLisandro Dalcin 17082d747510SLisandro Dalcin Output Parameter: 17092d747510SLisandro Dalcin . N - count of options not used 17102d747510SLisandro Dalcin 17112d747510SLisandro Dalcin Level: advanced 17122d747510SLisandro Dalcin 17139666a313SBarry Smith Notes: 17149666a313SBarry Smith The value returned may be different on each process and depends on which options have been processed 17151c9f3c13SBarry Smith on the given process 17161c9f3c13SBarry Smith 17172d747510SLisandro Dalcin .seealso: PetscOptionsView() 17182d747510SLisandro Dalcin @*/ 17192d747510SLisandro Dalcin PetscErrorCode PetscOptionsAllUsed(PetscOptions options,PetscInt *N) 17202d747510SLisandro Dalcin { 17212d747510SLisandro Dalcin PetscInt i,n = 0; 17222d747510SLisandro Dalcin 17232d747510SLisandro Dalcin PetscFunctionBegin; 17242d747510SLisandro Dalcin PetscValidIntPointer(N,2); 17252d747510SLisandro Dalcin options = options ? options : defaultoptions; 17262d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 17272d747510SLisandro Dalcin if (!options->used[i]) n++; 17282d747510SLisandro Dalcin } 17292d747510SLisandro Dalcin *N = n; 17302d747510SLisandro Dalcin PetscFunctionReturn(0); 17312d747510SLisandro Dalcin } 17322d747510SLisandro Dalcin 1733487a658cSBarry Smith /*@ 17342d747510SLisandro Dalcin PetscOptionsLeft - Prints to screen any options that were set and never used. 17352d747510SLisandro Dalcin 17362d747510SLisandro Dalcin Not Collective 17372d747510SLisandro Dalcin 17382d747510SLisandro Dalcin Input Parameter: 17392d747510SLisandro Dalcin . options - options database; use NULL for default global database 17402d747510SLisandro Dalcin 17412d747510SLisandro Dalcin Options Database Key: 17423c6db4c4SPierre Jolivet . -options_left - activates PetscOptionsAllUsed() within PetscFinalize() 17432d747510SLisandro Dalcin 17443de2bfdfSBarry Smith Notes: 17453de2bfdfSBarry Smith This is rarely used directly, it is called by PetscFinalize() in debug more or if -options_left 17461c9f3c13SBarry Smith is passed otherwise to help users determine possible mistakes in their usage of options. This 17471c9f3c13SBarry Smith only prints values on process zero of PETSC_COMM_WORLD. Other processes depending the objects 17481c9f3c13SBarry Smith used may have different options that are left unused. 17493de2bfdfSBarry Smith 17502d747510SLisandro Dalcin Level: advanced 17512d747510SLisandro Dalcin 17522d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed() 17532d747510SLisandro Dalcin @*/ 17542d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeft(PetscOptions options) 17552d747510SLisandro Dalcin { 17562d747510SLisandro Dalcin PetscErrorCode ierr; 17572d747510SLisandro Dalcin PetscInt i; 17583de2bfdfSBarry Smith PetscInt cnt = 0; 17593de2bfdfSBarry Smith PetscOptions toptions; 17602d747510SLisandro Dalcin 17612d747510SLisandro Dalcin PetscFunctionBegin; 17623de2bfdfSBarry Smith toptions = options ? options : defaultoptions; 17633de2bfdfSBarry Smith for (i=0; i<toptions->N; i++) { 17643de2bfdfSBarry Smith if (!toptions->used[i]) { 17653de2bfdfSBarry Smith if (toptions->values[i]) { 17663de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s value: %s\n",toptions->names[i],toptions->values[i]);CHKERRQ(ierr); 17672d747510SLisandro Dalcin } else { 17683de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s (no value)\n",toptions->names[i]);CHKERRQ(ierr); 17692d747510SLisandro Dalcin } 17702d747510SLisandro Dalcin } 17712d747510SLisandro Dalcin } 17723de2bfdfSBarry Smith if (!options) { 17733de2bfdfSBarry Smith toptions = defaultoptions; 17743de2bfdfSBarry Smith while (toptions->previous) { 17753de2bfdfSBarry Smith cnt++; 17763de2bfdfSBarry Smith toptions = toptions->previous; 17773de2bfdfSBarry Smith } 17783de2bfdfSBarry Smith if (cnt) { 17793de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: You may have forgotten some calls to PetscOptionsPop(),\n PetscOptionsPop() has been called %D less times than PetscOptionsPush()\n",cnt);CHKERRQ(ierr); 17803de2bfdfSBarry Smith } 17813de2bfdfSBarry Smith } 17822d747510SLisandro Dalcin PetscFunctionReturn(0); 17832d747510SLisandro Dalcin } 17842d747510SLisandro Dalcin 17852d747510SLisandro Dalcin /*@C 17862d747510SLisandro Dalcin PetscOptionsLeftGet - Returns all options that were set and never used. 17872d747510SLisandro Dalcin 17882d747510SLisandro Dalcin Not Collective 17892d747510SLisandro Dalcin 17902d747510SLisandro Dalcin Input Parameter: 17912d747510SLisandro Dalcin . options - options database, use NULL for default global database 17922d747510SLisandro Dalcin 17932d747510SLisandro Dalcin Output Parameter: 1794a2b725a8SWilliam Gropp + N - count of options not used 17952d747510SLisandro Dalcin . names - names of options not used 1796a2b725a8SWilliam Gropp - values - values of options not used 17972d747510SLisandro Dalcin 17982d747510SLisandro Dalcin Level: advanced 17992d747510SLisandro Dalcin 18002d747510SLisandro Dalcin Notes: 18012d747510SLisandro Dalcin Users should call PetscOptionsLeftRestore() to free the memory allocated in this routine 18021c9f3c13SBarry Smith Notes: The value returned may be different on each process and depends on which options have been processed 18031c9f3c13SBarry Smith on the given process 18042d747510SLisandro Dalcin 18052d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft() 18062d747510SLisandro Dalcin @*/ 18072d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftGet(PetscOptions options,PetscInt *N,char **names[],char **values[]) 18082d747510SLisandro Dalcin { 18092d747510SLisandro Dalcin PetscErrorCode ierr; 18102d747510SLisandro Dalcin PetscInt i,n; 18112d747510SLisandro Dalcin 18122d747510SLisandro Dalcin PetscFunctionBegin; 18132d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 18142d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 18152d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 18162d747510SLisandro Dalcin options = options ? options : defaultoptions; 18172d747510SLisandro Dalcin 18182d747510SLisandro Dalcin /* The number of unused PETSc options */ 18192d747510SLisandro Dalcin n = 0; 18202d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 18212d747510SLisandro Dalcin if (!options->used[i]) n++; 18222d747510SLisandro Dalcin } 18232d747510SLisandro Dalcin if (N) { *N = n; } 18242d747510SLisandro Dalcin if (names) { ierr = PetscMalloc1(n,names);CHKERRQ(ierr); } 18252d747510SLisandro Dalcin if (values) { ierr = PetscMalloc1(n,values);CHKERRQ(ierr); } 18262d747510SLisandro Dalcin 18272d747510SLisandro Dalcin n = 0; 18282d747510SLisandro Dalcin if (names || values) { 18292d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 18302d747510SLisandro Dalcin if (!options->used[i]) { 18312d747510SLisandro Dalcin if (names) (*names)[n] = options->names[i]; 18322d747510SLisandro Dalcin if (values) (*values)[n] = options->values[i]; 18332d747510SLisandro Dalcin n++; 18342d747510SLisandro Dalcin } 18352d747510SLisandro Dalcin } 18362d747510SLisandro Dalcin } 18372d747510SLisandro Dalcin PetscFunctionReturn(0); 18382d747510SLisandro Dalcin } 18392d747510SLisandro Dalcin 18402d747510SLisandro Dalcin /*@C 18412d747510SLisandro Dalcin PetscOptionsLeftRestore - Free memory for the unused PETSc options obtained using PetscOptionsLeftGet. 18422d747510SLisandro Dalcin 18432d747510SLisandro Dalcin Not Collective 18442d747510SLisandro Dalcin 18452d747510SLisandro Dalcin Input Parameter: 1846a2b725a8SWilliam Gropp + options - options database, use NULL for default global database 18472d747510SLisandro Dalcin . names - names of options not used 1848a2b725a8SWilliam Gropp - values - values of options not used 18492d747510SLisandro Dalcin 18502d747510SLisandro Dalcin Level: advanced 18512d747510SLisandro Dalcin 18522d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft(), PetscOptionsLeftGet() 18532d747510SLisandro Dalcin @*/ 18542d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftRestore(PetscOptions options,PetscInt *N,char **names[],char **values[]) 18552d747510SLisandro Dalcin { 18562d747510SLisandro Dalcin PetscErrorCode ierr; 18572d747510SLisandro Dalcin 18582d747510SLisandro Dalcin PetscFunctionBegin; 18592d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 18602d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 18612d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 18622d747510SLisandro Dalcin if (N) { *N = 0; } 18632d747510SLisandro Dalcin if (names) { ierr = PetscFree(*names);CHKERRQ(ierr); } 18642d747510SLisandro Dalcin if (values) { ierr = PetscFree(*values);CHKERRQ(ierr); } 18652d747510SLisandro Dalcin PetscFunctionReturn(0); 18662d747510SLisandro Dalcin } 18672d747510SLisandro Dalcin 18682d747510SLisandro Dalcin /*@C 18699060e2f9SVaclav Hapla PetscOptionsMonitorDefault - Print all options set value events using the supplied PetscViewer. 18702d747510SLisandro Dalcin 18711c9f3c13SBarry Smith Logically Collective on ctx 18722d747510SLisandro Dalcin 18732d747510SLisandro Dalcin Input Parameters: 18742d747510SLisandro Dalcin + name - option name string 18752d747510SLisandro Dalcin . value - option value string 18769060e2f9SVaclav Hapla - ctx - an ASCII viewer or NULL 18772d747510SLisandro Dalcin 18782d747510SLisandro Dalcin Level: intermediate 18792d747510SLisandro Dalcin 18809666a313SBarry Smith Notes: 18819060e2f9SVaclav Hapla If ctx=NULL, PetscPrintf() is used. 18829666a313SBarry Smith The first MPI rank in the PetscViewer viewer actually prints the values, other 18831c9f3c13SBarry Smith processes may have different values set 18841c9f3c13SBarry Smith 18852d747510SLisandro Dalcin .seealso: PetscOptionsMonitorSet() 18862d747510SLisandro Dalcin @*/ 18872d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorDefault(const char name[],const char value[],void *ctx) 18882d747510SLisandro Dalcin { 18892d747510SLisandro Dalcin PetscErrorCode ierr; 18902d747510SLisandro Dalcin 18912d747510SLisandro Dalcin PetscFunctionBegin; 18929060e2f9SVaclav Hapla if (ctx) { 18939060e2f9SVaclav Hapla PetscViewer viewer = (PetscViewer)ctx; 18942d747510SLisandro Dalcin if (!value) { 18952d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Removing option: %s\n",name,value);CHKERRQ(ierr); 18962d747510SLisandro Dalcin } else if (!value[0]) { 18972d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s (no value)\n",name);CHKERRQ(ierr); 18982d747510SLisandro Dalcin } else { 18992d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr); 19002d747510SLisandro Dalcin } 19019060e2f9SVaclav Hapla } else { 19029060e2f9SVaclav Hapla MPI_Comm comm = PETSC_COMM_WORLD; 19039060e2f9SVaclav Hapla if (!value) { 19049060e2f9SVaclav Hapla ierr = PetscPrintf(comm,"Removing option: %s\n",name,value);CHKERRQ(ierr); 19059060e2f9SVaclav Hapla } else if (!value[0]) { 19069060e2f9SVaclav Hapla ierr = PetscPrintf(comm,"Setting option: %s (no value)\n",name);CHKERRQ(ierr); 19079060e2f9SVaclav Hapla } else { 19089060e2f9SVaclav Hapla ierr = PetscPrintf(comm,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr); 19099060e2f9SVaclav Hapla } 19109060e2f9SVaclav Hapla } 19112d747510SLisandro Dalcin PetscFunctionReturn(0); 19122d747510SLisandro Dalcin } 19132d747510SLisandro Dalcin 19142d747510SLisandro Dalcin /*@C 19152d747510SLisandro Dalcin PetscOptionsMonitorSet - Sets an ADDITIONAL function to be called at every method that 19162d747510SLisandro Dalcin modified the PETSc options database. 19172d747510SLisandro Dalcin 19182d747510SLisandro Dalcin Not Collective 19192d747510SLisandro Dalcin 19202d747510SLisandro Dalcin Input Parameters: 19212d747510SLisandro Dalcin + monitor - pointer to function (if this is NULL, it turns off monitoring 19222d747510SLisandro Dalcin . mctx - [optional] context for private data for the 19232d747510SLisandro Dalcin monitor routine (use NULL if no context is desired) 19242d747510SLisandro Dalcin - monitordestroy - [optional] routine that frees monitor context 19252d747510SLisandro Dalcin (may be NULL) 19262d747510SLisandro Dalcin 19272d747510SLisandro Dalcin Calling Sequence of monitor: 19282d747510SLisandro Dalcin $ monitor (const char name[], const char value[], void *mctx) 19292d747510SLisandro Dalcin 19302d747510SLisandro Dalcin + name - option name string 19312d747510SLisandro Dalcin . value - option value string 19322d747510SLisandro Dalcin - mctx - optional monitoring context, as set by PetscOptionsMonitorSet() 19332d747510SLisandro Dalcin 19342d747510SLisandro Dalcin Options Database Keys: 1935*c5b5d8d5SVaclav Hapla See PetscInitialize() for options related to option database monitoring. 19362d747510SLisandro Dalcin 19372d747510SLisandro Dalcin Notes: 19382d747510SLisandro Dalcin The default is to do nothing. To print the name and value of options 19392d747510SLisandro Dalcin being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine, 19402d747510SLisandro Dalcin with a null monitoring context. 19412d747510SLisandro Dalcin 19422d747510SLisandro Dalcin Several different monitoring routines may be set by calling 19432d747510SLisandro Dalcin PetscOptionsMonitorSet() multiple times; all will be called in the 19442d747510SLisandro Dalcin order in which they were set. 19452d747510SLisandro Dalcin 19469060e2f9SVaclav Hapla Level: intermediate 19472d747510SLisandro Dalcin 1948*c5b5d8d5SVaclav Hapla .seealso: PetscOptionsMonitorDefault(), PetscInitialize() 19492d747510SLisandro Dalcin @*/ 19502d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 19512d747510SLisandro Dalcin { 19522d747510SLisandro Dalcin PetscOptions options = defaultoptions; 19532d747510SLisandro Dalcin 19542d747510SLisandro Dalcin PetscFunctionBegin; 1955*c5b5d8d5SVaclav Hapla if (options->monitorCancel) PetscFunctionReturn(0); 19562d747510SLisandro Dalcin if (options->numbermonitors >= MAXOPTIONSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptions monitors set"); 19572d747510SLisandro Dalcin options->monitor[options->numbermonitors] = monitor; 19582d747510SLisandro Dalcin options->monitordestroy[options->numbermonitors] = monitordestroy; 19592d747510SLisandro Dalcin options->monitorcontext[options->numbermonitors++] = (void*)mctx; 19602d747510SLisandro Dalcin PetscFunctionReturn(0); 19612d747510SLisandro Dalcin } 19622d747510SLisandro Dalcin 19632d747510SLisandro Dalcin /* 19642d747510SLisandro Dalcin PetscOptionsStringToBool - Converts string to PetscBool, handles cases like "yes", "no", "true", "false", "0", "1", "off", "on". 196563fe8743SVaclav Hapla Empty string is considered as true. 19662d747510SLisandro Dalcin */ 19672d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToBool(const char value[],PetscBool *a) 19682d747510SLisandro Dalcin { 19692d747510SLisandro Dalcin PetscBool istrue,isfalse; 19702d747510SLisandro Dalcin size_t len; 19712d747510SLisandro Dalcin PetscErrorCode ierr; 19722d747510SLisandro Dalcin 19732d747510SLisandro Dalcin PetscFunctionBegin; 197463fe8743SVaclav Hapla /* PetscStrlen() returns 0 for NULL or "" */ 19752d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 197663fe8743SVaclav Hapla if (!len) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19772d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"TRUE",&istrue);CHKERRQ(ierr); 19782d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19792d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"YES",&istrue);CHKERRQ(ierr); 19802d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19812d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"1",&istrue);CHKERRQ(ierr); 19822d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19832d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"on",&istrue);CHKERRQ(ierr); 19842d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19852d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"FALSE",&isfalse);CHKERRQ(ierr); 19862d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 19872d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"NO",&isfalse);CHKERRQ(ierr); 19882d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 19892d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"0",&isfalse);CHKERRQ(ierr); 19902d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 19912d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"off",&isfalse);CHKERRQ(ierr); 19922d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 19932d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown logical value: %s",value); 19942d747510SLisandro Dalcin } 19952d747510SLisandro Dalcin 19962d747510SLisandro Dalcin /* 19972d747510SLisandro Dalcin PetscOptionsStringToInt - Converts a string to an integer value. Handles special cases such as "default" and "decide" 19982d747510SLisandro Dalcin */ 19992d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToInt(const char name[],PetscInt *a) 20002d747510SLisandro Dalcin { 20012d747510SLisandro Dalcin PetscErrorCode ierr; 20022d747510SLisandro Dalcin size_t len; 20032d747510SLisandro Dalcin PetscBool decide,tdefault,mouse; 20042d747510SLisandro Dalcin 20052d747510SLisandro Dalcin PetscFunctionBegin; 20062d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 20072d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 20082d747510SLisandro Dalcin 20092d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&tdefault);CHKERRQ(ierr); 20102d747510SLisandro Dalcin if (!tdefault) { 20112d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&tdefault);CHKERRQ(ierr); 20122d747510SLisandro Dalcin } 20132d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&decide);CHKERRQ(ierr); 20142d747510SLisandro Dalcin if (!decide) { 20152d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&decide);CHKERRQ(ierr); 20162d747510SLisandro Dalcin } 20172d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"mouse",&mouse);CHKERRQ(ierr); 20182d747510SLisandro Dalcin 20192d747510SLisandro Dalcin if (tdefault) *a = PETSC_DEFAULT; 20202d747510SLisandro Dalcin else if (decide) *a = PETSC_DECIDE; 20212d747510SLisandro Dalcin else if (mouse) *a = -1; 20222d747510SLisandro Dalcin else { 20232d747510SLisandro Dalcin char *endptr; 20242d747510SLisandro Dalcin long strtolval; 20252d747510SLisandro Dalcin 20262d747510SLisandro Dalcin strtolval = strtol(name,&endptr,10); 20272d747510SLisandro 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); 20282d747510SLisandro Dalcin 20292d747510SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE_ATOLL) 20302d747510SLisandro Dalcin (void) strtolval; 20312d747510SLisandro Dalcin *a = atoll(name); 20322d747510SLisandro Dalcin #elif defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE___INT64) 20332d747510SLisandro Dalcin (void) strtolval; 20342d747510SLisandro Dalcin *a = _atoi64(name); 20352d747510SLisandro Dalcin #else 20362d747510SLisandro Dalcin *a = (PetscInt)strtolval; 20372d747510SLisandro Dalcin #endif 20382d747510SLisandro Dalcin } 20392d747510SLisandro Dalcin PetscFunctionReturn(0); 20402d747510SLisandro Dalcin } 20412d747510SLisandro Dalcin 20422d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 20432d747510SLisandro Dalcin #include <quadmath.h> 20442d747510SLisandro Dalcin #endif 20452d747510SLisandro Dalcin 20462d747510SLisandro Dalcin static PetscErrorCode PetscStrtod(const char name[],PetscReal *a,char **endptr) 20472d747510SLisandro Dalcin { 20482d747510SLisandro Dalcin PetscFunctionBegin; 20492d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 20502d747510SLisandro Dalcin *a = strtoflt128(name,endptr); 20512d747510SLisandro Dalcin #else 20522d747510SLisandro Dalcin *a = (PetscReal)strtod(name,endptr); 20532d747510SLisandro Dalcin #endif 20542d747510SLisandro Dalcin PetscFunctionReturn(0); 20552d747510SLisandro Dalcin } 20562d747510SLisandro Dalcin 20572d747510SLisandro Dalcin static PetscErrorCode PetscStrtoz(const char name[],PetscScalar *a,char **endptr,PetscBool *isImaginary) 20582d747510SLisandro Dalcin { 20592d747510SLisandro Dalcin PetscBool hasi = PETSC_FALSE; 20602d747510SLisandro Dalcin char *ptr; 20612d747510SLisandro Dalcin PetscReal strtoval; 20622d747510SLisandro Dalcin PetscErrorCode ierr; 20632d747510SLisandro Dalcin 20642d747510SLisandro Dalcin PetscFunctionBegin; 20652d747510SLisandro Dalcin ierr = PetscStrtod(name,&strtoval,&ptr);CHKERRQ(ierr); 20662d747510SLisandro Dalcin if (ptr == name) { 20672d747510SLisandro Dalcin strtoval = 1.; 20682d747510SLisandro Dalcin hasi = PETSC_TRUE; 20692d747510SLisandro Dalcin if (name[0] == 'i') { 20702d747510SLisandro Dalcin ptr++; 20712d747510SLisandro Dalcin } else if (name[0] == '+' && name[1] == 'i') { 20722d747510SLisandro Dalcin ptr += 2; 20732d747510SLisandro Dalcin } else if (name[0] == '-' && name[1] == 'i') { 20742d747510SLisandro Dalcin strtoval = -1.; 20752d747510SLisandro Dalcin ptr += 2; 20762d747510SLisandro Dalcin } 20772d747510SLisandro Dalcin } else if (*ptr == 'i') { 20782d747510SLisandro Dalcin hasi = PETSC_TRUE; 20792d747510SLisandro Dalcin ptr++; 20802d747510SLisandro Dalcin } 20812d747510SLisandro Dalcin *endptr = ptr; 20822d747510SLisandro Dalcin *isImaginary = hasi; 20832d747510SLisandro Dalcin if (hasi) { 20842d747510SLisandro Dalcin #if !defined(PETSC_USE_COMPLEX) 20852d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s contains imaginary but complex not supported ",name); 20862d747510SLisandro Dalcin #else 20872d747510SLisandro Dalcin *a = PetscCMPLX(0.,strtoval); 20882d747510SLisandro Dalcin #endif 20892d747510SLisandro Dalcin } else { 20902d747510SLisandro Dalcin *a = strtoval; 20912d747510SLisandro Dalcin } 20922d747510SLisandro Dalcin PetscFunctionReturn(0); 20932d747510SLisandro Dalcin } 20942d747510SLisandro Dalcin 20952d747510SLisandro Dalcin /* 20962d747510SLisandro Dalcin Converts a string to PetscReal value. Handles special cases like "default" and "decide" 20972d747510SLisandro Dalcin */ 20982d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToReal(const char name[],PetscReal *a) 20992d747510SLisandro Dalcin { 21002d747510SLisandro Dalcin size_t len; 21012d747510SLisandro Dalcin PetscBool match; 21022d747510SLisandro Dalcin char *endptr; 21032d747510SLisandro Dalcin PetscErrorCode ierr; 21042d747510SLisandro Dalcin 21052d747510SLisandro Dalcin PetscFunctionBegin; 21062d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 21072d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"String of length zero has no numerical value"); 21082d747510SLisandro Dalcin 21092d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&match);CHKERRQ(ierr); 21102d747510SLisandro Dalcin if (!match) { 21112d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&match);CHKERRQ(ierr); 21122d747510SLisandro Dalcin } 21132d747510SLisandro Dalcin if (match) {*a = PETSC_DEFAULT; PetscFunctionReturn(0);} 21142d747510SLisandro Dalcin 21152d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&match);CHKERRQ(ierr); 21162d747510SLisandro Dalcin if (!match) { 21172d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&match);CHKERRQ(ierr); 21182d747510SLisandro Dalcin } 21192d747510SLisandro Dalcin if (match) {*a = PETSC_DECIDE; PetscFunctionReturn(0);} 21202d747510SLisandro Dalcin 21212d747510SLisandro Dalcin ierr = PetscStrtod(name,a,&endptr);CHKERRQ(ierr); 21222d747510SLisandro Dalcin if ((size_t) (endptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value",name); 21232d747510SLisandro Dalcin PetscFunctionReturn(0); 21242d747510SLisandro Dalcin } 21252d747510SLisandro Dalcin 21262d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToScalar(const char name[],PetscScalar *a) 21272d747510SLisandro Dalcin { 21282d747510SLisandro Dalcin PetscBool imag1; 21292d747510SLisandro Dalcin size_t len; 21302d747510SLisandro Dalcin PetscScalar val = 0.; 21312d747510SLisandro Dalcin char *ptr = NULL; 21322d747510SLisandro Dalcin PetscErrorCode ierr; 21332d747510SLisandro Dalcin 21342d747510SLisandro Dalcin PetscFunctionBegin; 21352d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 21362d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 21372d747510SLisandro Dalcin ierr = PetscStrtoz(name,&val,&ptr,&imag1);CHKERRQ(ierr); 21382d747510SLisandro Dalcin #if defined(PETSC_USE_COMPLEX) 21392d747510SLisandro Dalcin if ((size_t) (ptr - name) < len) { 21402d747510SLisandro Dalcin PetscBool imag2; 21412d747510SLisandro Dalcin PetscScalar val2; 21422d747510SLisandro Dalcin 21432d747510SLisandro Dalcin ierr = PetscStrtoz(ptr,&val2,&ptr,&imag2);CHKERRQ(ierr); 21442d747510SLisandro Dalcin if (imag1 || !imag2) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s: must specify imaginary component second",name); 21452d747510SLisandro Dalcin val = PetscCMPLX(PetscRealPart(val),PetscImaginaryPart(val2)); 21462d747510SLisandro Dalcin } 21472d747510SLisandro Dalcin #endif 21482d747510SLisandro Dalcin if ((size_t) (ptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value ",name); 21492d747510SLisandro Dalcin *a = val; 21502d747510SLisandro Dalcin PetscFunctionReturn(0); 21512d747510SLisandro Dalcin } 21522d747510SLisandro Dalcin 21532d747510SLisandro Dalcin /*@C 21542d747510SLisandro Dalcin PetscOptionsGetBool - Gets the Logical (true or false) value for a particular 21552d747510SLisandro Dalcin option in the database. 2156e5c89e4eSSatish Balay 2157e5c89e4eSSatish Balay Not Collective 2158e5c89e4eSSatish Balay 2159e5c89e4eSSatish Balay Input Parameters: 21605c9cc608SHong Zhang + options - options database, use NULL for default global database 2161c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2162e5c89e4eSSatish Balay - name - the option one is seeking 2163e5c89e4eSSatish Balay 2164e5c89e4eSSatish Balay Output Parameter: 21652d747510SLisandro Dalcin + ivalue - the logical value to return 216696ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2167e5c89e4eSSatish Balay 2168e5c89e4eSSatish Balay Level: beginner 2169e5c89e4eSSatish Balay 217095452b02SPatrick Sanan Notes: 21712d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 21722d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 21732d747510SLisandro Dalcin 21742d747510SLisandro 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 21752d747510SLisandro Dalcin is equivalent to -requested_bool true 21762d747510SLisandro Dalcin 21772d747510SLisandro Dalcin If the user does not supply the option at all ivalue is NOT changed. Thus 21782efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 21792efd9cb1SBarry Smith 2180e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 21812d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetInt(), PetscOptionsBool(), 2182e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2183e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2184acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2185a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2186e5c89e4eSSatish Balay @*/ 21872d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBool(PetscOptions options,const char pre[],const char name[],PetscBool *ivalue,PetscBool *set) 2188e5c89e4eSSatish Balay { 21892d747510SLisandro Dalcin const char *value; 2190ace3abfcSBarry Smith PetscBool flag; 21912d747510SLisandro Dalcin PetscErrorCode ierr; 2192e5c89e4eSSatish Balay 2193e5c89e4eSSatish Balay PetscFunctionBegin; 21942d747510SLisandro Dalcin PetscValidCharPointer(name,3); 21952d747510SLisandro Dalcin if (ivalue) PetscValidIntPointer(ivalue,4); 21962d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2197e5c89e4eSSatish Balay if (flag) { 219896ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 21992d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value, &flag);CHKERRQ(ierr); 22002d747510SLisandro Dalcin if (ivalue) *ivalue = flag; 2201e5c89e4eSSatish Balay } else { 220296ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2203e5c89e4eSSatish Balay } 2204e5c89e4eSSatish Balay PetscFunctionReturn(0); 2205e5c89e4eSSatish Balay } 2206e5c89e4eSSatish Balay 2207e5c89e4eSSatish Balay /*@C 2208e5c89e4eSSatish Balay PetscOptionsGetEList - Puts a list of option values that a single one may be selected from 2209e5c89e4eSSatish Balay 2210e5c89e4eSSatish Balay Not Collective 2211e5c89e4eSSatish Balay 2212e5c89e4eSSatish Balay Input Parameters: 22135c9cc608SHong Zhang + options - options database, use NULL for default global database 2214c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2215e5c89e4eSSatish Balay . opt - option name 2216a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 2217a2b725a8SWilliam Gropp - ntext - number of choices 2218e5c89e4eSSatish Balay 2219e5c89e4eSSatish Balay Output Parameter: 22202efd9cb1SBarry Smith + value - the index of the value to return (defaults to zero if the option name is given but no choice is listed) 2221e5c89e4eSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2222e5c89e4eSSatish Balay 2223e5c89e4eSSatish Balay Level: intermediate 2224e5c89e4eSSatish Balay 222595452b02SPatrick Sanan Notes: 222695452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 22272efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 22282efd9cb1SBarry Smith 2229a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 2230e5c89e4eSSatish Balay 2231e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2232acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2233e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2234e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2235acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2236a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2237e5c89e4eSSatish Balay @*/ 2238c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEList(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscInt ntext,PetscInt *value,PetscBool *set) 2239e5c89e4eSSatish Balay { 2240e5c89e4eSSatish Balay PetscErrorCode ierr; 224158b0ac4eSStefano Zampini size_t alen,len = 0, tlen = 0; 2242e5c89e4eSSatish Balay char *svalue; 2243ace3abfcSBarry Smith PetscBool aset,flg = PETSC_FALSE; 2244e5c89e4eSSatish Balay PetscInt i; 2245e5c89e4eSSatish Balay 2246e5c89e4eSSatish Balay PetscFunctionBegin; 22472d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2248e5c89e4eSSatish Balay for (i=0; i<ntext; i++) { 2249e5c89e4eSSatish Balay ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr); 2250e5c89e4eSSatish Balay if (alen > len) len = alen; 225158b0ac4eSStefano Zampini tlen += len + 1; 2252e5c89e4eSSatish Balay } 2253e5c89e4eSSatish Balay len += 5; /* a little extra space for user mistypes */ 2254785e854fSJed Brown ierr = PetscMalloc1(len,&svalue);CHKERRQ(ierr); 2255c5929fdfSBarry Smith ierr = PetscOptionsGetString(options,pre,opt,svalue,len,&aset);CHKERRQ(ierr); 2256e5c89e4eSSatish Balay if (aset) { 2257fbedd5e0SJed Brown ierr = PetscEListFind(ntext,list,svalue,value,&flg);CHKERRQ(ierr); 225858b0ac4eSStefano Zampini if (!flg) { 225958b0ac4eSStefano Zampini char *avail,*pavl; 226058b0ac4eSStefano Zampini 226158b0ac4eSStefano Zampini ierr = PetscMalloc1(tlen,&avail);CHKERRQ(ierr); 226258b0ac4eSStefano Zampini pavl = avail; 226358b0ac4eSStefano Zampini for (i=0; i<ntext; i++) { 226458b0ac4eSStefano Zampini ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr); 226558b0ac4eSStefano Zampini ierr = PetscStrcpy(pavl,list[i]);CHKERRQ(ierr); 226658b0ac4eSStefano Zampini pavl += alen; 226758b0ac4eSStefano Zampini ierr = PetscStrcpy(pavl," ");CHKERRQ(ierr); 226858b0ac4eSStefano Zampini pavl += 1; 226958b0ac4eSStefano Zampini } 227058b0ac4eSStefano Zampini ierr = PetscStrtolower(avail);CHKERRQ(ierr); 227158b0ac4eSStefano Zampini SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown option %s for -%s%s. Available options: %s",svalue,pre ? pre : "",opt+1,avail); 227258b0ac4eSStefano Zampini } 2273fbedd5e0SJed Brown if (set) *set = PETSC_TRUE; 2274a297a907SKarl Rupp } else if (set) *set = PETSC_FALSE; 2275e5c89e4eSSatish Balay ierr = PetscFree(svalue);CHKERRQ(ierr); 2276e5c89e4eSSatish Balay PetscFunctionReturn(0); 2277e5c89e4eSSatish Balay } 2278e5c89e4eSSatish Balay 2279e5c89e4eSSatish Balay /*@C 2280e5c89e4eSSatish Balay PetscOptionsGetEnum - Gets the enum value for a particular option in the database. 2281e5c89e4eSSatish Balay 2282e5c89e4eSSatish Balay Not Collective 2283e5c89e4eSSatish Balay 2284e5c89e4eSSatish Balay Input Parameters: 22855c9cc608SHong Zhang + options - options database, use NULL for default global database 2286c5929fdfSBarry Smith . pre - option prefix or NULL 2287e5c89e4eSSatish Balay . opt - option name 2288e5c89e4eSSatish Balay . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 2289e5c89e4eSSatish Balay - defaultv - the default (current) value 2290e5c89e4eSSatish Balay 2291e5c89e4eSSatish Balay Output Parameter: 2292e5c89e4eSSatish Balay + value - the value to return 229396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2294e5c89e4eSSatish Balay 2295e5c89e4eSSatish Balay Level: beginner 2296e5c89e4eSSatish Balay 229795452b02SPatrick Sanan Notes: 229895452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 22992efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2300e5c89e4eSSatish Balay 23012efd9cb1SBarry Smith List is usually something like PCASMTypes or some other predefined list of enum names 2302e5c89e4eSSatish Balay 2303e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 2304acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 2305acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2306e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2307e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2308acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2309a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 2310e5c89e4eSSatish Balay @*/ 2311c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set) 2312e5c89e4eSSatish Balay { 2313e5c89e4eSSatish Balay PetscErrorCode ierr; 231469a24498SJed Brown PetscInt ntext = 0,tval; 2315ace3abfcSBarry Smith PetscBool fset; 2316e5c89e4eSSatish Balay 2317e5c89e4eSSatish Balay PetscFunctionBegin; 23182d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2319e5c89e4eSSatish Balay while (list[ntext++]) { 2320e32f2f54SBarry Smith if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 2321e5c89e4eSSatish Balay } 2322e32f2f54SBarry Smith if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 2323e5c89e4eSSatish Balay ntext -= 3; 2324c5929fdfSBarry Smith ierr = PetscOptionsGetEList(options,pre,opt,list,ntext,&tval,&fset);CHKERRQ(ierr); 232569a24498SJed Brown /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 2326809ceb46SBarry Smith if (fset) *value = (PetscEnum)tval; 2327809ceb46SBarry Smith if (set) *set = fset; 2328e5c89e4eSSatish Balay PetscFunctionReturn(0); 2329e5c89e4eSSatish Balay } 2330e5c89e4eSSatish Balay 2331e5c89e4eSSatish Balay /*@C 23322d747510SLisandro Dalcin PetscOptionsGetInt - Gets the integer value for a particular option in the database. 2333e5c89e4eSSatish Balay 2334e5c89e4eSSatish Balay Not Collective 2335e5c89e4eSSatish Balay 2336e5c89e4eSSatish Balay Input Parameters: 23375c9cc608SHong Zhang + options - options database, use NULL for default global database 2338c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2339e5c89e4eSSatish Balay - name - the option one is seeking 2340e5c89e4eSSatish Balay 2341e5c89e4eSSatish Balay Output Parameter: 23422d747510SLisandro Dalcin + ivalue - the integer value to return 234396ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2344e5c89e4eSSatish Balay 2345e5c89e4eSSatish Balay Level: beginner 2346e5c89e4eSSatish Balay 2347e5c89e4eSSatish Balay Notes: 23482d747510SLisandro Dalcin If the user does not supply the option ivalue is NOT changed. Thus 23492efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 23505c07ccb8SBarry Smith 2351e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 23522d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 23532d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2354e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2355e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2356acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2357a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2358e5c89e4eSSatish Balay @*/ 23592d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetInt(PetscOptions options,const char pre[],const char name[],PetscInt *ivalue,PetscBool *set) 2360e5c89e4eSSatish Balay { 23612d747510SLisandro Dalcin const char *value; 2362e5c89e4eSSatish Balay PetscErrorCode ierr; 23632d747510SLisandro Dalcin PetscBool flag; 2364e5c89e4eSSatish Balay 2365e5c89e4eSSatish Balay PetscFunctionBegin; 23662d747510SLisandro Dalcin PetscValidCharPointer(name,3); 23672d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 23682d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2369e5c89e4eSSatish Balay if (flag) { 237034a9cc2cSBarry Smith if (!value) { 23712d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 237234a9cc2cSBarry Smith } else { 23732d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 23742d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 2375e5c89e4eSSatish Balay } 2376e5c89e4eSSatish Balay } else { 237796ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2378e5c89e4eSSatish Balay } 2379e5c89e4eSSatish Balay PetscFunctionReturn(0); 2380e5c89e4eSSatish Balay } 2381e5c89e4eSSatish Balay 2382e2446a98SMatthew Knepley /*@C 2383e5c89e4eSSatish Balay PetscOptionsGetReal - Gets the double precision value for a particular 2384e5c89e4eSSatish Balay option in the database. 2385e5c89e4eSSatish Balay 2386e5c89e4eSSatish Balay Not Collective 2387e5c89e4eSSatish Balay 2388e5c89e4eSSatish Balay Input Parameters: 23895c9cc608SHong Zhang + options - options database, use NULL for default global database 2390c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2391e5c89e4eSSatish Balay - name - the option one is seeking 2392e5c89e4eSSatish Balay 2393e5c89e4eSSatish Balay Output Parameter: 2394e5c89e4eSSatish Balay + dvalue - the double value to return 239596ef3cdfSSatish Balay - set - PETSC_TRUE if found, PETSC_FALSE if not found 2396e5c89e4eSSatish Balay 239795452b02SPatrick Sanan Notes: 239895452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 23992efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2400e4974155SBarry Smith 2401e5c89e4eSSatish Balay Level: beginner 2402e5c89e4eSSatish Balay 2403e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2404acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 2405e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2406e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2407acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2408a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2409e5c89e4eSSatish Balay @*/ 2410c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetReal(PetscOptions options,const char pre[],const char name[],PetscReal *dvalue,PetscBool *set) 2411e5c89e4eSSatish Balay { 24122d747510SLisandro Dalcin const char *value; 2413ace3abfcSBarry Smith PetscBool flag; 24142d747510SLisandro Dalcin PetscErrorCode ierr; 2415e5c89e4eSSatish Balay 2416e5c89e4eSSatish Balay PetscFunctionBegin; 24172d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24182d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 24192d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2420e5c89e4eSSatish Balay if (flag) { 2421a297a907SKarl Rupp if (!value) { 2422a297a907SKarl Rupp if (set) *set = PETSC_FALSE; 2423a297a907SKarl Rupp } else { 2424a297a907SKarl Rupp if (set) *set = PETSC_TRUE; 2425a297a907SKarl Rupp ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2426a297a907SKarl Rupp } 2427e5c89e4eSSatish Balay } else { 242896ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2429e5c89e4eSSatish Balay } 2430e5c89e4eSSatish Balay PetscFunctionReturn(0); 2431e5c89e4eSSatish Balay } 2432e5c89e4eSSatish Balay 2433e5c89e4eSSatish Balay /*@C 2434e5c89e4eSSatish Balay PetscOptionsGetScalar - Gets the scalar value for a particular 2435e5c89e4eSSatish Balay option in the database. 2436e5c89e4eSSatish Balay 2437e5c89e4eSSatish Balay Not Collective 2438e5c89e4eSSatish Balay 2439e5c89e4eSSatish Balay Input Parameters: 24405c9cc608SHong Zhang + options - options database, use NULL for default global database 2441c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2442e5c89e4eSSatish Balay - name - the option one is seeking 2443e5c89e4eSSatish Balay 2444e5c89e4eSSatish Balay Output Parameter: 2445e5c89e4eSSatish Balay + dvalue - the double value to return 244696ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2447e5c89e4eSSatish Balay 2448e5c89e4eSSatish Balay Level: beginner 2449e5c89e4eSSatish Balay 2450e5c89e4eSSatish Balay Usage: 2451eb4ae41dSBarry Smith A complex number 2+3i must be specified with NO spaces 2452e5c89e4eSSatish Balay 245395452b02SPatrick Sanan Notes: 245495452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 24552efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2456e4974155SBarry Smith 2457e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2458acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2459e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2460e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2461acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2462a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2463e5c89e4eSSatish Balay @*/ 2464c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetScalar(PetscOptions options,const char pre[],const char name[],PetscScalar *dvalue,PetscBool *set) 2465e5c89e4eSSatish Balay { 24662d747510SLisandro Dalcin const char *value; 2467ace3abfcSBarry Smith PetscBool flag; 2468e5c89e4eSSatish Balay PetscErrorCode ierr; 2469e5c89e4eSSatish Balay 2470e5c89e4eSSatish Balay PetscFunctionBegin; 24712d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24722d747510SLisandro Dalcin PetscValidScalarPointer(dvalue,4); 24732d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2474e5c89e4eSSatish Balay if (flag) { 2475e5c89e4eSSatish Balay if (!value) { 247696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2477e5c89e4eSSatish Balay } else { 2478e5c89e4eSSatish Balay #if !defined(PETSC_USE_COMPLEX) 2479cfbddea1SSatish Balay ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2480e5c89e4eSSatish Balay #else 2481eb4ae41dSBarry Smith ierr = PetscOptionsStringToScalar(value,dvalue);CHKERRQ(ierr); 2482e5c89e4eSSatish Balay #endif 248396ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2484e5c89e4eSSatish Balay } 2485e5c89e4eSSatish Balay } else { /* flag */ 248696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2487e5c89e4eSSatish Balay } 2488e5c89e4eSSatish Balay PetscFunctionReturn(0); 2489e5c89e4eSSatish Balay } 2490e5c89e4eSSatish Balay 2491e5c89e4eSSatish Balay /*@C 2492e5c89e4eSSatish Balay PetscOptionsGetString - Gets the string value for a particular option in 2493e5c89e4eSSatish Balay the database. 2494e5c89e4eSSatish Balay 2495e5c89e4eSSatish Balay Not Collective 2496e5c89e4eSSatish Balay 2497e5c89e4eSSatish Balay Input Parameters: 24985c9cc608SHong Zhang + options - options database, use NULL for default global database 2499c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2500e5c89e4eSSatish Balay . name - the option one is seeking 2501bcbf2dc5SJed Brown - len - maximum length of the string including null termination 2502e5c89e4eSSatish Balay 2503e5c89e4eSSatish Balay Output Parameters: 2504e5c89e4eSSatish Balay + string - location to copy string 250596ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2506e5c89e4eSSatish Balay 2507e5c89e4eSSatish Balay Level: beginner 2508e5c89e4eSSatish Balay 2509e5c89e4eSSatish Balay Fortran Note: 2510e5c89e4eSSatish Balay The Fortran interface is slightly different from the C/C++ 2511e5c89e4eSSatish Balay interface (len is not used). Sample usage in Fortran follows 2512e5c89e4eSSatish Balay .vb 2513e5c89e4eSSatish Balay character *20 string 251493e6ba5cSBarry Smith PetscErrorCode ierr 251593e6ba5cSBarry Smith PetscBool set 25161b266c99SBarry Smith call PetscOptionsGetString(PETSC_NULL_OPTIONS,PETSC_NULL_CHARACTER,'-s',string,set,ierr) 2517e5c89e4eSSatish Balay .ve 2518e5c89e4eSSatish Balay 251995452b02SPatrick Sanan Notes: 252095452b02SPatrick 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 2521e4974155SBarry Smith 25222efd9cb1SBarry Smith If the user does not use the option then the string is not changed. Thus 25232efd9cb1SBarry Smith you should ALWAYS initialize the string if you access it without first checking if the set flag is true. 25242efd9cb1SBarry Smith 2525f3dea69dSBarry Smith Note: 2526f3dea69dSBarry 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). 2527f3dea69dSBarry Smith 2528e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2529acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2530e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2531e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2532acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2533a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2534e5c89e4eSSatish Balay @*/ 2535c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetString(PetscOptions options,const char pre[],const char name[],char string[],size_t len,PetscBool *set) 2536e5c89e4eSSatish Balay { 25372d747510SLisandro Dalcin const char *value; 2538ace3abfcSBarry Smith PetscBool flag; 25392d747510SLisandro Dalcin PetscErrorCode ierr; 2540e5c89e4eSSatish Balay 2541e5c89e4eSSatish Balay PetscFunctionBegin; 25422d747510SLisandro Dalcin PetscValidCharPointer(name,3); 25432d747510SLisandro Dalcin PetscValidCharPointer(string,4); 25442d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2545e5c89e4eSSatish Balay if (!flag) { 254696ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2547e5c89e4eSSatish Balay } else { 254896ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2549e5c89e4eSSatish Balay if (value) { 2550e5c89e4eSSatish Balay ierr = PetscStrncpy(string,value,len);CHKERRQ(ierr); 2551e5c89e4eSSatish Balay } else { 2552580bdb30SBarry Smith ierr = PetscArrayzero(string,len);CHKERRQ(ierr); 2553e5c89e4eSSatish Balay } 2554e5c89e4eSSatish Balay } 2555e5c89e4eSSatish Balay PetscFunctionReturn(0); 2556e5c89e4eSSatish Balay } 2557e5c89e4eSSatish Balay 2558c5929fdfSBarry Smith char *PetscOptionsGetStringMatlab(PetscOptions options,const char pre[],const char name[]) 255914ce751eSBarry Smith { 25602d747510SLisandro Dalcin const char *value; 256114ce751eSBarry Smith PetscBool flag; 25622d747510SLisandro Dalcin PetscErrorCode ierr; 256314ce751eSBarry Smith 256414ce751eSBarry Smith PetscFunctionBegin; 256502c9f0b5SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);if (ierr) PetscFunctionReturn(NULL); 25662d747510SLisandro Dalcin if (flag) PetscFunctionReturn((char*)value); 256702c9f0b5SLisandro Dalcin else PetscFunctionReturn(NULL); 256814ce751eSBarry Smith } 256914ce751eSBarry Smith 25702d747510SLisandro Dalcin /*@C 25712d747510SLisandro Dalcin PetscOptionsGetBoolArray - Gets an array of Logical (true or false) values for a particular 25722d747510SLisandro Dalcin option in the database. The values must be separated with commas with 25732d747510SLisandro Dalcin no intervening spaces. 25742d747510SLisandro Dalcin 25752d747510SLisandro Dalcin Not Collective 25762d747510SLisandro Dalcin 25772d747510SLisandro Dalcin Input Parameters: 25782d747510SLisandro Dalcin + options - options database, use NULL for default global database 25792d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 25802d747510SLisandro Dalcin . name - the option one is seeking 25812d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 25822d747510SLisandro Dalcin 25832d747510SLisandro Dalcin Output Parameter: 25842d747510SLisandro Dalcin + dvalue - the integer values to return 25852d747510SLisandro Dalcin . nmax - actual number of values retreived 25862d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 25872d747510SLisandro Dalcin 25882d747510SLisandro Dalcin Level: beginner 25892d747510SLisandro Dalcin 25902d747510SLisandro Dalcin Notes: 25912d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 25922d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 25932d747510SLisandro Dalcin 25942d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 25952d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 25962d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 25972d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 25982d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 25992d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 26002d747510SLisandro Dalcin @*/ 26012d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBoolArray(PetscOptions options,const char pre[],const char name[],PetscBool dvalue[],PetscInt *nmax,PetscBool *set) 26022d747510SLisandro Dalcin { 26032d747510SLisandro Dalcin const char *svalue; 26042d747510SLisandro Dalcin char *value; 26052d747510SLisandro Dalcin PetscErrorCode ierr; 26062d747510SLisandro Dalcin PetscInt n = 0; 26072d747510SLisandro Dalcin PetscBool flag; 26082d747510SLisandro Dalcin PetscToken token; 26092d747510SLisandro Dalcin 26102d747510SLisandro Dalcin PetscFunctionBegin; 26112d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26122d747510SLisandro Dalcin PetscValidIntPointer(dvalue,4); 26132d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 26142d747510SLisandro Dalcin 26152d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 26162d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26172d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26182d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26192d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26202d747510SLisandro Dalcin while (value && n < *nmax) { 26212d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value,dvalue);CHKERRQ(ierr); 26222d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26232d747510SLisandro Dalcin dvalue++; 26242d747510SLisandro Dalcin n++; 26252d747510SLisandro Dalcin } 26262d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26272d747510SLisandro Dalcin *nmax = n; 26282d747510SLisandro Dalcin PetscFunctionReturn(0); 26292d747510SLisandro Dalcin } 26302d747510SLisandro Dalcin 26312d747510SLisandro Dalcin /*@C 26322d747510SLisandro Dalcin PetscOptionsGetEnumArray - Gets an array of enum values for a particular option in the database. 26332d747510SLisandro Dalcin 26342d747510SLisandro Dalcin Not Collective 26352d747510SLisandro Dalcin 26362d747510SLisandro Dalcin Input Parameters: 26372d747510SLisandro Dalcin + options - options database, use NULL for default global database 26382d747510SLisandro Dalcin . pre - option prefix or NULL 26392d747510SLisandro Dalcin . name - option name 26402d747510SLisandro Dalcin . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 26412d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 26422d747510SLisandro Dalcin 26432d747510SLisandro Dalcin Output Parameters: 26442d747510SLisandro Dalcin + ivalue - the enum values to return 26452d747510SLisandro Dalcin . nmax - actual number of values retreived 26462d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26472d747510SLisandro Dalcin 26482d747510SLisandro Dalcin Level: beginner 26492d747510SLisandro Dalcin 26502d747510SLisandro Dalcin Notes: 26512d747510SLisandro Dalcin The array must be passed as a comma separated list. 26522d747510SLisandro Dalcin 26532d747510SLisandro Dalcin There must be no intervening spaces between the values. 26542d747510SLisandro Dalcin 26552d747510SLisandro Dalcin list is usually something like PCASMTypes or some other predefined list of enum names. 26562d747510SLisandro Dalcin 26572d747510SLisandro Dalcin .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 26582d747510SLisandro Dalcin PetscOptionsGetEnum(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 26592d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), 26602d747510SLisandro Dalcin PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), 26612d747510SLisandro Dalcin PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26622d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 26632d747510SLisandro Dalcin @*/ 26642d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetEnumArray(PetscOptions options,const char pre[],const char name[],const char *const *list,PetscEnum ivalue[],PetscInt *nmax,PetscBool *set) 26652d747510SLisandro Dalcin { 26662d747510SLisandro Dalcin const char *svalue; 26672d747510SLisandro Dalcin char *value; 26682d747510SLisandro Dalcin PetscInt n = 0; 26692d747510SLisandro Dalcin PetscEnum evalue; 26702d747510SLisandro Dalcin PetscBool flag; 26712d747510SLisandro Dalcin PetscToken token; 26722d747510SLisandro Dalcin PetscErrorCode ierr; 26732d747510SLisandro Dalcin 26742d747510SLisandro Dalcin PetscFunctionBegin; 26752d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26762d747510SLisandro Dalcin PetscValidPointer(list,4); 26772d747510SLisandro Dalcin PetscValidPointer(ivalue,5); 26782d747510SLisandro Dalcin PetscValidIntPointer(nmax,6); 26792d747510SLisandro Dalcin 26802d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 26812d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26822d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26832d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26842d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26852d747510SLisandro Dalcin while (value && n < *nmax) { 26862d747510SLisandro Dalcin ierr = PetscEnumFind(list,value,&evalue,&flag);CHKERRQ(ierr); 26872d747510SLisandro Dalcin if (!flag) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown enum value '%s' for -%s%s",svalue,pre ? pre : "",name+1); 26882d747510SLisandro Dalcin ivalue[n++] = evalue; 26892d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26902d747510SLisandro Dalcin } 26912d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26922d747510SLisandro Dalcin *nmax = n; 26932d747510SLisandro Dalcin PetscFunctionReturn(0); 26942d747510SLisandro Dalcin } 26952d747510SLisandro Dalcin 26962d747510SLisandro Dalcin /*@C 26972d747510SLisandro Dalcin PetscOptionsGetIntArray - Gets an array of integer values for a particular 26982d747510SLisandro Dalcin option in the database. 26992d747510SLisandro Dalcin 27002d747510SLisandro Dalcin Not Collective 27012d747510SLisandro Dalcin 27022d747510SLisandro Dalcin Input Parameters: 27032d747510SLisandro Dalcin + options - options database, use NULL for default global database 27042d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 27052d747510SLisandro Dalcin . name - the option one is seeking 27062d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 27072d747510SLisandro Dalcin 27082d747510SLisandro Dalcin Output Parameter: 27092d747510SLisandro Dalcin + ivalue - the integer values to return 27102d747510SLisandro Dalcin . nmax - actual number of values retreived 27112d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 27122d747510SLisandro Dalcin 27132d747510SLisandro Dalcin Level: beginner 27142d747510SLisandro Dalcin 27152d747510SLisandro Dalcin Notes: 27162d747510SLisandro Dalcin The array can be passed as 27172d747510SLisandro Dalcin a comma separated list: 0,1,2,3,4,5,6,7 27182d747510SLisandro Dalcin a range (start-end+1): 0-8 27192d747510SLisandro Dalcin a range with given increment (start-end+1:inc): 0-7:2 27202d747510SLisandro Dalcin a combination of values and ranges separated by commas: 0,1-8,8-15:2 27212d747510SLisandro Dalcin 27222d747510SLisandro Dalcin There must be no intervening spaces between the values. 27232d747510SLisandro Dalcin 27242d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 27252d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 27262d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 27272d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 27282d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 27292d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 27302d747510SLisandro Dalcin @*/ 27312d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetIntArray(PetscOptions options,const char pre[],const char name[],PetscInt ivalue[],PetscInt *nmax,PetscBool *set) 27322d747510SLisandro Dalcin { 27332d747510SLisandro Dalcin const char *svalue; 27342d747510SLisandro Dalcin char *value; 27352d747510SLisandro Dalcin PetscErrorCode ierr; 27362d747510SLisandro Dalcin PetscInt n = 0,i,j,start,end,inc,nvalues; 27372d747510SLisandro Dalcin size_t len; 27382d747510SLisandro Dalcin PetscBool flag,foundrange; 27392d747510SLisandro Dalcin PetscToken token; 27402d747510SLisandro Dalcin 27412d747510SLisandro Dalcin PetscFunctionBegin; 27422d747510SLisandro Dalcin PetscValidCharPointer(name,3); 27432d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 27442d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 27452d747510SLisandro Dalcin 27462d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 27472d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 27482d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 27492d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 27502d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27512d747510SLisandro Dalcin while (value && n < *nmax) { 27522d747510SLisandro Dalcin /* look for form d-D where d and D are integers */ 27532d747510SLisandro Dalcin foundrange = PETSC_FALSE; 27542d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 27552d747510SLisandro Dalcin if (value[0] == '-') i=2; 27562d747510SLisandro Dalcin else i=1; 27572d747510SLisandro Dalcin for (;i<(int)len; i++) { 27582d747510SLisandro Dalcin if (value[i] == '-') { 27592d747510SLisandro Dalcin if (i == (int)len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value); 27602d747510SLisandro Dalcin value[i] = 0; 27612d747510SLisandro Dalcin 27622d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,&start);CHKERRQ(ierr); 27632d747510SLisandro Dalcin inc = 1; 27642d747510SLisandro Dalcin j = i+1; 27652d747510SLisandro Dalcin for (;j<(int)len; j++) { 27662d747510SLisandro Dalcin if (value[j] == ':') { 27672d747510SLisandro Dalcin value[j] = 0; 27682d747510SLisandro Dalcin 27692d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+j+1,&inc);CHKERRQ(ierr); 27702d747510SLisandro 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); 27712d747510SLisandro Dalcin break; 27722d747510SLisandro Dalcin } 27732d747510SLisandro Dalcin } 27742d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+i+1,&end);CHKERRQ(ierr); 27752d747510SLisandro 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); 27762d747510SLisandro Dalcin nvalues = (end-start)/inc + (end-start)%inc; 27772d747510SLisandro 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); 27782d747510SLisandro Dalcin for (;start<end; start+=inc) { 27792d747510SLisandro Dalcin *ivalue = start; ivalue++;n++; 27802d747510SLisandro Dalcin } 27812d747510SLisandro Dalcin foundrange = PETSC_TRUE; 27822d747510SLisandro Dalcin break; 27832d747510SLisandro Dalcin } 27842d747510SLisandro Dalcin } 27852d747510SLisandro Dalcin if (!foundrange) { 27862d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 27872d747510SLisandro Dalcin ivalue++; 27882d747510SLisandro Dalcin n++; 27892d747510SLisandro Dalcin } 27902d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27912d747510SLisandro Dalcin } 27922d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 27932d747510SLisandro Dalcin *nmax = n; 27942d747510SLisandro Dalcin PetscFunctionReturn(0); 27952d747510SLisandro Dalcin } 27962d747510SLisandro Dalcin 27972d747510SLisandro Dalcin /*@C 27982d747510SLisandro Dalcin PetscOptionsGetRealArray - Gets an array of double precision values for a 27992d747510SLisandro Dalcin particular option in the database. The values must be separated with 28002d747510SLisandro Dalcin commas with no intervening spaces. 28012d747510SLisandro Dalcin 28022d747510SLisandro Dalcin Not Collective 28032d747510SLisandro Dalcin 28042d747510SLisandro Dalcin Input Parameters: 28052d747510SLisandro Dalcin + options - options database, use NULL for default global database 28062d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 28072d747510SLisandro Dalcin . name - the option one is seeking 28082d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 28092d747510SLisandro Dalcin 28102d747510SLisandro Dalcin Output Parameters: 28112d747510SLisandro Dalcin + dvalue - the double values to return 28122d747510SLisandro Dalcin . nmax - actual number of values retreived 28132d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 28142d747510SLisandro Dalcin 28152d747510SLisandro Dalcin Level: beginner 28162d747510SLisandro Dalcin 28172d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 28182d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 28192d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 28202d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 28212d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 28222d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 28232d747510SLisandro Dalcin @*/ 28242d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetRealArray(PetscOptions options,const char pre[],const char name[],PetscReal dvalue[],PetscInt *nmax,PetscBool *set) 28252d747510SLisandro Dalcin { 28262d747510SLisandro Dalcin const char *svalue; 28272d747510SLisandro Dalcin char *value; 28282d747510SLisandro Dalcin PetscErrorCode ierr; 28292d747510SLisandro Dalcin PetscInt n = 0; 28302d747510SLisandro Dalcin PetscBool flag; 28312d747510SLisandro Dalcin PetscToken token; 28322d747510SLisandro Dalcin 28332d747510SLisandro Dalcin PetscFunctionBegin; 28342d747510SLisandro Dalcin PetscValidCharPointer(name,3); 28352d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 28362d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 28372d747510SLisandro Dalcin 28382d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 28392d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 28402d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 28412d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 28422d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 28432d747510SLisandro Dalcin while (value && n < *nmax) { 28442d747510SLisandro Dalcin ierr = PetscOptionsStringToReal(value,dvalue++);CHKERRQ(ierr); 28452d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 28462d747510SLisandro Dalcin n++; 28472d747510SLisandro Dalcin } 28482d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 28492d747510SLisandro Dalcin *nmax = n; 28502d747510SLisandro Dalcin PetscFunctionReturn(0); 28512d747510SLisandro Dalcin } 28522d747510SLisandro Dalcin 28532d747510SLisandro Dalcin /*@C 28542d747510SLisandro Dalcin PetscOptionsGetScalarArray - Gets an array of scalars for a 28552d747510SLisandro Dalcin particular option in the database. The values must be separated with 28562d747510SLisandro Dalcin commas with no intervening spaces. 28572d747510SLisandro Dalcin 28582d747510SLisandro Dalcin Not Collective 28592d747510SLisandro Dalcin 28602d747510SLisandro Dalcin Input Parameters: 28612d747510SLisandro Dalcin + options - options database, use NULL for default global database 28622d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 28632d747510SLisandro Dalcin . name - the option one is seeking 28642d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 28652d747510SLisandro Dalcin 28662d747510SLisandro Dalcin Output Parameters: 28672d747510SLisandro Dalcin + dvalue - the scalar values to return 28682d747510SLisandro Dalcin . nmax - actual number of values retreived 28692d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 28702d747510SLisandro Dalcin 28712d747510SLisandro Dalcin Level: beginner 28722d747510SLisandro Dalcin 28732d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 28742d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 28752d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 28762d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 28772d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 28782d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 28792d747510SLisandro Dalcin @*/ 28802d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set) 28812d747510SLisandro Dalcin { 28822d747510SLisandro Dalcin const char *svalue; 28832d747510SLisandro Dalcin char *value; 28842d747510SLisandro Dalcin PetscErrorCode ierr; 28852d747510SLisandro Dalcin PetscInt n = 0; 28862d747510SLisandro Dalcin PetscBool flag; 28872d747510SLisandro Dalcin PetscToken token; 28882d747510SLisandro Dalcin 28892d747510SLisandro Dalcin PetscFunctionBegin; 28902d747510SLisandro Dalcin PetscValidCharPointer(name,3); 28912d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 28922d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 28932d747510SLisandro Dalcin 28942d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 28952d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 28962d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 28972d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 28982d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 28992d747510SLisandro Dalcin while (value && n < *nmax) { 29002d747510SLisandro Dalcin ierr = PetscOptionsStringToScalar(value,dvalue++);CHKERRQ(ierr); 29012d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 29022d747510SLisandro Dalcin n++; 29032d747510SLisandro Dalcin } 29042d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 29052d747510SLisandro Dalcin *nmax = n; 29062d747510SLisandro Dalcin PetscFunctionReturn(0); 29072d747510SLisandro Dalcin } 290814ce751eSBarry Smith 2909e5c89e4eSSatish Balay /*@C 2910e5c89e4eSSatish Balay PetscOptionsGetStringArray - Gets an array of string values for a particular 2911e5c89e4eSSatish Balay option in the database. The values must be separated with commas with 2912e5c89e4eSSatish Balay no intervening spaces. 2913e5c89e4eSSatish Balay 2914e5c89e4eSSatish Balay Not Collective 2915e5c89e4eSSatish Balay 2916e5c89e4eSSatish Balay Input Parameters: 29175c9cc608SHong Zhang + options - options database, use NULL for default global database 2918c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2919e5c89e4eSSatish Balay . name - the option one is seeking 2920e5c89e4eSSatish Balay - nmax - maximum number of strings 2921e5c89e4eSSatish Balay 2922e5c89e4eSSatish Balay Output Parameter: 2923e5c89e4eSSatish Balay + strings - location to copy strings 292496ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2925e5c89e4eSSatish Balay 2926e5c89e4eSSatish Balay Level: beginner 2927e5c89e4eSSatish Balay 2928e5c89e4eSSatish Balay Notes: 2929e5c89e4eSSatish Balay The user should pass in an array of pointers to char, to hold all the 2930e5c89e4eSSatish Balay strings returned by this function. 2931e5c89e4eSSatish Balay 2932e5c89e4eSSatish Balay The user is responsible for deallocating the strings that are 2933e5c89e4eSSatish Balay returned. The Fortran interface for this routine is not supported. 2934e5c89e4eSSatish Balay 2935e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2936acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2937e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2938e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2939acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2940a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2941e5c89e4eSSatish Balay @*/ 2942c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetStringArray(PetscOptions options,const char pre[],const char name[],char *strings[],PetscInt *nmax,PetscBool *set) 2943e5c89e4eSSatish Balay { 29442d747510SLisandro Dalcin const char *svalue; 2945e5c89e4eSSatish Balay char *value; 2946e5c89e4eSSatish Balay PetscErrorCode ierr; 29472d747510SLisandro Dalcin PetscInt n = 0; 2948ace3abfcSBarry Smith PetscBool flag; 29499c9d3cfdSBarry Smith PetscToken token; 2950e5c89e4eSSatish Balay 2951e5c89e4eSSatish Balay PetscFunctionBegin; 29522d747510SLisandro Dalcin PetscValidCharPointer(name,3); 29532d747510SLisandro Dalcin PetscValidPointer(strings,4); 29542d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 2955e5c89e4eSSatish Balay 29562d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 29572d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 29582d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 29592d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 2960e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 29612d747510SLisandro Dalcin while (value && n < *nmax) { 2962e5c89e4eSSatish Balay ierr = PetscStrallocpy(value,&strings[n]);CHKERRQ(ierr); 2963e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 2964e5c89e4eSSatish Balay n++; 2965e5c89e4eSSatish Balay } 29668c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 2967e5c89e4eSSatish Balay *nmax = n; 2968e5c89e4eSSatish Balay PetscFunctionReturn(0); 2969e5c89e4eSSatish Balay } 297006824ed3SPatrick Sanan 297106824ed3SPatrick Sanan /*@C 297206824ed3SPatrick Sanan PetscOptionsDeprecated - mark an option as deprecated, optionally replacing it with a new one 297306824ed3SPatrick Sanan 297406824ed3SPatrick Sanan Prints a deprecation warning, unless an option is supplied to suppress. 297506824ed3SPatrick Sanan 29761c9f3c13SBarry Smith Logically Collective 297706824ed3SPatrick Sanan 297806824ed3SPatrick Sanan Input Parameters: 29799503aa97SPatrick Sanan + pre - string to prepend to name or NULL 298006824ed3SPatrick Sanan . oldname - the old, deprecated option 298106824ed3SPatrick Sanan . newname - the new option, or NULL if option is purely removed 29829f3a6782SPatrick Sanan . version - a string describing the version of first deprecation, e.g. "3.9" 29839f3a6782SPatrick Sanan - info - additional information string, or NULL. 298406824ed3SPatrick Sanan 298506824ed3SPatrick Sanan Options Database Keys: 298606824ed3SPatrick Sanan . -options_suppress_deprecated_warnings - do not print deprecation warnings 298706824ed3SPatrick Sanan 298806824ed3SPatrick Sanan Notes: 29891c9f3c13SBarry Smith Must be called between PetscOptionsBegin() (or PetscObjectOptionsBegin()) and PetscOptionsEnd(). 29901c9f3c13SBarry Smith Only the proces of rank zero that owns the PetscOptionsItems are argument (managed by PetscOptionsBegin() or 29911c9f3c13SBarry Smith PetscObjectOptionsBegin() prints the information 2992b40114eaSPatrick Sanan If newname is provided, the old option is replaced. Otherwise, it remains 2993b40114eaSPatrick Sanan in the options database. 29949f3a6782SPatrick Sanan If an option is not replaced, the info argument should be used to advise the user 29959f3a6782SPatrick Sanan on how to proceed. 29969f3a6782SPatrick Sanan There is a limit on the length of the warning printed, so very long strings 29979f3a6782SPatrick Sanan provided as info may be truncated. 299806824ed3SPatrick Sanan 299906824ed3SPatrick Sanan Level: developer 300006824ed3SPatrick Sanan 300106824ed3SPatrick Sanan .seealso: PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsScalar(), PetscOptionsBool(), PetscOptionsString(), PetscOptionsSetValue() 300206824ed3SPatrick Sanan 300306824ed3SPatrick Sanan @*/ 30049f3a6782SPatrick Sanan PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems *PetscOptionsObject,const char oldname[],const char newname[],const char version[],const char info[]) 300506824ed3SPatrick Sanan { 300606824ed3SPatrick Sanan PetscErrorCode ierr; 300706824ed3SPatrick Sanan PetscBool found,quiet; 300806824ed3SPatrick Sanan const char *value; 300906824ed3SPatrick Sanan const char * const quietopt="-options_suppress_deprecated_warnings"; 30109f3a6782SPatrick Sanan char msg[4096]; 3011b0bdc838SStefano Zampini char *prefix = NULL; 3012b0bdc838SStefano Zampini PetscOptions options = NULL; 3013b0bdc838SStefano Zampini MPI_Comm comm = PETSC_COMM_SELF; 301406824ed3SPatrick Sanan 301506824ed3SPatrick Sanan PetscFunctionBegin; 301606824ed3SPatrick Sanan PetscValidCharPointer(oldname,2); 301706824ed3SPatrick Sanan PetscValidCharPointer(version,4); 3018b0bdc838SStefano Zampini if (PetscOptionsObject) { 3019b0bdc838SStefano Zampini prefix = PetscOptionsObject->prefix; 3020b0bdc838SStefano Zampini options = PetscOptionsObject->options; 3021b0bdc838SStefano Zampini comm = PetscOptionsObject->comm; 3022b0bdc838SStefano Zampini } 3023b0bdc838SStefano Zampini ierr = PetscOptionsFindPair(options,prefix,oldname,&value,&found);CHKERRQ(ierr); 302406824ed3SPatrick Sanan if (found) { 302506824ed3SPatrick Sanan if (newname) { 3026b0bdc838SStefano Zampini if (prefix) { 3027b0bdc838SStefano Zampini ierr = PetscOptionsPrefixPush(options,prefix);CHKERRQ(ierr); 3028d255429eSPatrick Sanan } 3029b0bdc838SStefano Zampini ierr = PetscOptionsSetValue(options,newname,value);CHKERRQ(ierr); 3030b0bdc838SStefano Zampini if (prefix) { 3031b0bdc838SStefano Zampini ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 3032d255429eSPatrick Sanan } 3033b0bdc838SStefano Zampini ierr = PetscOptionsClearValue(options,oldname);CHKERRQ(ierr); 3034b40114eaSPatrick Sanan } 303506824ed3SPatrick Sanan quiet = PETSC_FALSE; 3036b0bdc838SStefano Zampini ierr = PetscOptionsGetBool(options,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr); 303706824ed3SPatrick Sanan if (!quiet) { 30389f3a6782SPatrick Sanan ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr); 30391fa95f81SSatish Balay ierr = PetscStrcat(msg,oldname);CHKERRQ(ierr); 3040928bb9adSStefano Zampini ierr = PetscStrcat(msg," is deprecated as of version ");CHKERRQ(ierr); 30419f3a6782SPatrick Sanan ierr = PetscStrcat(msg,version);CHKERRQ(ierr); 30429f3a6782SPatrick Sanan ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr); 304306824ed3SPatrick Sanan if (newname) { 30449f3a6782SPatrick Sanan ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr); 30459f3a6782SPatrick Sanan ierr = PetscStrcat(msg,newname);CHKERRQ(ierr); 30469f3a6782SPatrick Sanan ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr); 304706824ed3SPatrick Sanan } 30489f3a6782SPatrick Sanan if (info) { 30499f3a6782SPatrick Sanan ierr = PetscStrcat(msg," ");CHKERRQ(ierr); 30509f3a6782SPatrick Sanan ierr = PetscStrcat(msg,info);CHKERRQ(ierr); 30519f3a6782SPatrick Sanan } 30529f3a6782SPatrick Sanan ierr = PetscStrcat(msg," (Silence this warning with ");CHKERRQ(ierr); 30539f3a6782SPatrick Sanan ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr); 30549f3a6782SPatrick Sanan ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr); 3055b0bdc838SStefano Zampini ierr = PetscPrintf(comm,msg);CHKERRQ(ierr); 305606824ed3SPatrick Sanan } 305706824ed3SPatrick Sanan } 305806824ed3SPatrick Sanan PetscFunctionReturn(0); 305906824ed3SPatrick Sanan } 3060