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 */ 79c5b5d8d5SVaclav 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 */ 96d314f959SVaclav Hapla PetscBool help_intro; /* flag whether "-help intro" is in the database */ 972d747510SLisandro Dalcin 982d747510SLisandro Dalcin /* Monitors */ 99c5b5d8d5SVaclav Hapla PetscBool monitorFromOptions, monitorCancel; 100081c24baSBoyana Norris PetscErrorCode (*monitor[MAXOPTIONSMONITORS])(const char[],const char[],void*); /* returns control to user after */ 101c2efdce3SBarry Smith PetscErrorCode (*monitordestroy[MAXOPTIONSMONITORS])(void**); /* */ 102081c24baSBoyana Norris void *monitorcontext[MAXOPTIONSMONITORS]; /* to pass arbitrary user data into monitor */ 103081c24baSBoyana Norris PetscInt numbermonitors; /* to, for instance, detect options being set */ 1044416b707SBarry Smith }; 105e5c89e4eSSatish Balay 106b4205f0bSBarry Smith static PetscOptions defaultoptions = NULL; /* the options database routines query this object for options */ 1072d747510SLisandro Dalcin 108c5b5d8d5SVaclav Hapla /* list of options which preceed others, i.e., are processed in PetscOptionsProcessPrecedentFlags() */ 109d314f959SVaclav Hapla static const char *precedentOptions[] = {"-options_monitor","-options_monitor_cancel","-help","-skip_petscrc","-options_file_yaml","-options_string_yaml"}; 110d314f959SVaclav Hapla enum PetscPrecedentOption {PO_OPTIONS_MONITOR,PO_OPTIONS_MONITOR_CANCEL,PO_HELP,PO_SKIP_PETSCRC,PO_OPTIONS_FILE_YAML,PO_OPTIONS_STRING_YAML,PO_NUM}; 111c5b5d8d5SVaclav Hapla 112c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsSetValue_Private(PetscOptions,const char[],const char[],int*); 113c5b5d8d5SVaclav Hapla 114081c24baSBoyana Norris /* 115081c24baSBoyana Norris Options events monitor 116081c24baSBoyana Norris */ 1172d747510SLisandro Dalcin static PetscErrorCode PetscOptionsMonitor(PetscOptions options,const char name[],const char value[]) 118e5c89e4eSSatish Balay { 1192d747510SLisandro Dalcin PetscInt i; 120e5c89e4eSSatish Balay PetscErrorCode ierr; 121e5c89e4eSSatish Balay 1228ad20175SVaclav Hapla if (!PetscErrorHandlingInitialized) return 0; 123e5c89e4eSSatish Balay PetscFunctionBegin; 124c5b5d8d5SVaclav Hapla if (!value) value = ""; 125c5b5d8d5SVaclav Hapla if (options->monitorFromOptions) { 126c5b5d8d5SVaclav Hapla ierr = PetscOptionsMonitorDefault(name,value,NULL);CHKERRQ(ierr); 127c5b5d8d5SVaclav Hapla } 1282d747510SLisandro Dalcin for (i=0; i<options->numbermonitors; i++) { 1292d747510SLisandro Dalcin ierr = (*options->monitor[i])(name,value,options->monitorcontext[i]);CHKERRQ(ierr); 130e5c89e4eSSatish Balay } 131e5c89e4eSSatish Balay PetscFunctionReturn(0); 132e5c89e4eSSatish Balay } 133e5c89e4eSSatish Balay 1342d747510SLisandro Dalcin /*@ 1352d747510SLisandro Dalcin PetscOptionsCreate - Creates an empty options database. 136e5c89e4eSSatish Balay 1371c9f3c13SBarry Smith Logically collective 1381c9f3c13SBarry Smith 139e5c89e4eSSatish Balay Output Parameter: 1402d747510SLisandro Dalcin . options - Options database object 141e5c89e4eSSatish Balay 142e5c89e4eSSatish Balay Level: advanced 143e5c89e4eSSatish Balay 1441c9f3c13SBarry Smith Developer Note: We may want eventually to pass a MPI_Comm to determine the ownership of the object 1451c9f3c13SBarry Smith 146b4205f0bSBarry Smith .seealso: PetscOptionsDestroy(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 147e5c89e4eSSatish Balay @*/ 1482d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreate(PetscOptions *options) 1492d747510SLisandro Dalcin { 1502d747510SLisandro Dalcin if (!options) return PETSC_ERR_ARG_NULL; 1512d747510SLisandro Dalcin *options = (PetscOptions)calloc(1,sizeof(**options)); 1522d747510SLisandro Dalcin if (!*options) return PETSC_ERR_MEM; 1532d747510SLisandro Dalcin return 0; 1542d747510SLisandro Dalcin } 1552d747510SLisandro Dalcin 1562d747510SLisandro Dalcin /*@ 1572d747510SLisandro Dalcin PetscOptionsDestroy - Destroys an option database. 1582d747510SLisandro Dalcin 1591c9f3c13SBarry Smith Logically collective on whatever communicator was associated with the call to PetscOptionsCreate() 1601c9f3c13SBarry Smith 1612d747510SLisandro Dalcin Input Parameter: 1622d747510SLisandro Dalcin . options - the PetscOptions object 1632d747510SLisandro Dalcin 1643de2bfdfSBarry Smith Level: advanced 1652d747510SLisandro Dalcin 166b4205f0bSBarry Smith .seealso: PetscOptionsInsert(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsInsert(), PetscOptionsSetValue() 1672d747510SLisandro Dalcin @*/ 1682d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroy(PetscOptions *options) 169e5c89e4eSSatish Balay { 170e5c89e4eSSatish Balay PetscErrorCode ierr; 171e5c89e4eSSatish Balay 1722d747510SLisandro Dalcin if (!*options) return 0; 1733de2bfdfSBarry 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()"); 1742d747510SLisandro Dalcin ierr = PetscOptionsClear(*options);if (ierr) return ierr; 1752d747510SLisandro Dalcin /* XXX what about monitors ? */ 1762800570dSLisandro Dalcin free(*options); 1772d747510SLisandro Dalcin *options = NULL; 178e5c89e4eSSatish Balay PetscFunctionReturn(0); 179e5c89e4eSSatish Balay } 180e5c89e4eSSatish Balay 1812d747510SLisandro Dalcin /* 1822d747510SLisandro Dalcin PetscOptionsCreateDefault - Creates the default global options database 1832d747510SLisandro Dalcin */ 1842d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreateDefault(void) 185e5c89e4eSSatish Balay { 186e5c89e4eSSatish Balay PetscErrorCode ierr; 187e5c89e4eSSatish Balay 1882d747510SLisandro Dalcin if (!defaultoptions) { 1892d747510SLisandro Dalcin ierr = PetscOptionsCreate(&defaultoptions);if (ierr) return ierr; 1902d747510SLisandro Dalcin } 1912d747510SLisandro Dalcin return 0; 1922d747510SLisandro Dalcin } 1932d747510SLisandro Dalcin 194b4205f0bSBarry Smith /*@ 195b4205f0bSBarry Smith PetscOptionsPush - Push a new PetscOptions object as the default provider of options 1961c9f3c13SBarry Smith Allows using different parts of a code to use different options databases 197b4205f0bSBarry Smith 198b4205f0bSBarry Smith Logically Collective 199b4205f0bSBarry Smith 200b4205f0bSBarry Smith Input Parameter: 201b4205f0bSBarry Smith . opt - the options obtained with PetscOptionsCreate() 202b4205f0bSBarry Smith 203b4205f0bSBarry Smith Notes: 204b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 2051c9f3c13SBarry Smith 2069666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 2071c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 2081c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 2091c9f3c13SBarry Smith on different ranks. 210b4205f0bSBarry Smith 2113de2bfdfSBarry Smith Level: advanced 2123de2bfdfSBarry Smith 2133c6db4c4SPierre Jolivet .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsInsert(), PetscOptionsSetValue(), PetscOptionsLeft() 214b4205f0bSBarry Smith 215b4205f0bSBarry Smith @*/ 216b4205f0bSBarry Smith PetscErrorCode PetscOptionsPush(PetscOptions opt) 217b4205f0bSBarry Smith { 218b4205f0bSBarry Smith PetscErrorCode ierr; 219b4205f0bSBarry Smith 220b4205f0bSBarry Smith PetscFunctionBegin; 221b4205f0bSBarry Smith ierr = PetscOptionsCreateDefault();CHKERRQ(ierr); 222b4205f0bSBarry Smith opt->previous = defaultoptions; 223b4205f0bSBarry Smith defaultoptions = opt; 224b4205f0bSBarry Smith PetscFunctionReturn(0); 225b4205f0bSBarry Smith } 226b4205f0bSBarry Smith 227b4205f0bSBarry Smith /*@ 228b4205f0bSBarry Smith PetscOptionsPop - Pop the most recent PetscOptionsPush() to return to the previous default options 229b4205f0bSBarry Smith 2301c9f3c13SBarry Smith Logically collective on whatever communicator was associated with the call to PetscOptionsCreate() 231b4205f0bSBarry Smith 232b4205f0bSBarry Smith Notes: 233b4205f0bSBarry Smith Use PetscOptionsPop() to return to the previous default options database 234b4205f0bSBarry Smith Allows using different parts of a code to use different options databases 235b4205f0bSBarry Smith 2363de2bfdfSBarry Smith Level: advanced 2373de2bfdfSBarry Smith 2383c6db4c4SPierre Jolivet .seealso: PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsInsert(), PetscOptionsSetValue(), PetscOptionsLeft() 239b4205f0bSBarry Smith 240b4205f0bSBarry Smith @*/ 241b4205f0bSBarry Smith PetscErrorCode PetscOptionsPop(void) 242b4205f0bSBarry Smith { 2433de2bfdfSBarry Smith PetscOptions current = defaultoptions; 2443de2bfdfSBarry Smith 245b4205f0bSBarry Smith PetscFunctionBegin; 246b4205f0bSBarry Smith if (!defaultoptions) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Missing default options"); 247b4205f0bSBarry Smith if (!defaultoptions->previous) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"PetscOptionsPop() called too many times"); 248b4205f0bSBarry Smith defaultoptions = defaultoptions->previous; 2493de2bfdfSBarry Smith current->previous = NULL; 250b4205f0bSBarry Smith PetscFunctionReturn(0); 251b4205f0bSBarry Smith } 252b4205f0bSBarry Smith 2532d747510SLisandro Dalcin /* 2542d747510SLisandro Dalcin PetscOptionsDestroyDefault - Destroys the default global options database 2552d747510SLisandro Dalcin */ 2562d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroyDefault(void) 2572d747510SLisandro Dalcin { 2582d747510SLisandro Dalcin PetscErrorCode ierr; 2593de2bfdfSBarry Smith PetscOptions tmp; 2602d747510SLisandro Dalcin 26186dbd7c4SLisandro Dalcin if (!defaultoptions) return 0; 2623de2bfdfSBarry Smith /* Destroy any options that the user forgot to pop */ 2633de2bfdfSBarry Smith while (defaultoptions->previous) { 2643de2bfdfSBarry Smith tmp = defaultoptions; 2653de2bfdfSBarry Smith ierr = PetscOptionsPop();CHKERRQ(ierr); 2663de2bfdfSBarry Smith ierr = PetscOptionsDestroy(&tmp);CHKERRQ(ierr); 2673de2bfdfSBarry Smith } 2682d747510SLisandro Dalcin ierr = PetscOptionsDestroy(&defaultoptions);if (ierr) return ierr; 2692d747510SLisandro Dalcin return 0; 270e5c89e4eSSatish Balay } 271e5c89e4eSSatish Balay 27294ef8ddeSSatish Balay /*@C 2737cd08cecSJed Brown PetscOptionsValidKey - PETSc Options database keys must begin with one or two dashes (-) followed by a letter. 2743fc1eb6aSBarry Smith 275447722d5SBarry Smith Not collective 2761c9f3c13SBarry Smith 2773fc1eb6aSBarry Smith Input Parameter: 2782d747510SLisandro Dalcin . key - string to check if valid 2793fc1eb6aSBarry Smith 2803fc1eb6aSBarry Smith Output Parameter: 2812d747510SLisandro Dalcin . valid - PETSC_TRUE if a valid key 2823fc1eb6aSBarry Smith 283f6680f47SSatish Balay Level: intermediate 2843fc1eb6aSBarry Smith @*/ 2852d747510SLisandro Dalcin PetscErrorCode PetscOptionsValidKey(const char key[],PetscBool *valid) 28696fc60bcSBarry Smith { 287f603b5e9SToby Isaac char *ptr; 2887c5db45bSBarry Smith 28996fc60bcSBarry Smith PetscFunctionBegin; 2902d747510SLisandro Dalcin if (key) PetscValidCharPointer(key,1); 2912d747510SLisandro Dalcin PetscValidPointer(valid,2); 2922d747510SLisandro Dalcin *valid = PETSC_FALSE; 2932d747510SLisandro Dalcin if (!key) PetscFunctionReturn(0); 2942d747510SLisandro Dalcin if (key[0] != '-') PetscFunctionReturn(0); 2952d747510SLisandro Dalcin if (key[1] == '-') key++; 296c850d057SPierre Jolivet if (!isalpha((int)key[1])) PetscFunctionReturn(0); 2972d747510SLisandro Dalcin (void) strtod(key,&ptr); 298c850d057SPierre Jolivet if (ptr != key && !(*ptr == '_' || isalnum((int)*ptr))) PetscFunctionReturn(0); 2992d747510SLisandro Dalcin *valid = PETSC_TRUE; 30096fc60bcSBarry Smith PetscFunctionReturn(0); 30196fc60bcSBarry Smith } 30296fc60bcSBarry Smith 303e5c89e4eSSatish Balay /*@C 304e5c89e4eSSatish Balay PetscOptionsInsertString - Inserts options into the database from a string 305e5c89e4eSSatish Balay 3061c9f3c13SBarry Smith Logically Collective 307e5c89e4eSSatish Balay 308e5c89e4eSSatish Balay Input Parameter: 309080f0011SToby Isaac + options - options object 310080f0011SToby Isaac - in_str - string that contains options separated by blanks 311e5c89e4eSSatish Balay 312e5c89e4eSSatish Balay Level: intermediate 313e5c89e4eSSatish Balay 3149666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 3151c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 3161c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 3171c9f3c13SBarry Smith on different ranks. 3181c9f3c13SBarry Smith 319e5c89e4eSSatish Balay Contributed by Boyana Norris 320e5c89e4eSSatish Balay 32188c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 322acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 323e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 324e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 325acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 326a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsInsertFile() 327e5c89e4eSSatish Balay @*/ 328c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertString(PetscOptions options,const char in_str[]) 329e5c89e4eSSatish Balay { 33096fc60bcSBarry Smith char *first,*second; 331e5c89e4eSSatish Balay PetscErrorCode ierr; 3329c9d3cfdSBarry Smith PetscToken token; 333bf9c6086SStefano Zampini PetscBool key,ispush,ispop,isopts; 334e5c89e4eSSatish Balay 335e5c89e4eSSatish Balay PetscFunctionBegin; 33696fc60bcSBarry Smith ierr = PetscTokenCreate(in_str,' ',&token);CHKERRQ(ierr); 337e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 33896fc60bcSBarry Smith while (first) { 3399db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_push",&ispush);CHKERRQ(ierr); 3409db968c8SJed Brown ierr = PetscStrcasecmp(first,"-prefix_pop",&ispop);CHKERRQ(ierr); 341bf9c6086SStefano Zampini ierr = PetscStrcasecmp(first,"-options_file",&isopts);CHKERRQ(ierr); 34296fc60bcSBarry Smith ierr = PetscOptionsValidKey(first,&key);CHKERRQ(ierr); 3439db968c8SJed Brown if (ispush) { 3449db968c8SJed Brown ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 345c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,second);CHKERRQ(ierr); 3469db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 3479db968c8SJed Brown } else if (ispop) { 348c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 3499db968c8SJed Brown ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 350bf9c6086SStefano Zampini } else if (isopts) { 351bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 352bf9c6086SStefano Zampini ierr = PetscOptionsInsertFile(PETSC_COMM_SELF,options,second,PETSC_TRUE);CHKERRQ(ierr); 353bf9c6086SStefano Zampini ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 3549db968c8SJed Brown } else if (key) { 355e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&second);CHKERRQ(ierr); 35696fc60bcSBarry Smith ierr = PetscOptionsValidKey(second,&key);CHKERRQ(ierr); 35796fc60bcSBarry Smith if (!key) { 358c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,second);CHKERRQ(ierr); 35996fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 36096fc60bcSBarry Smith } else { 361c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,first,NULL);CHKERRQ(ierr); 36296fc60bcSBarry Smith first = second; 36396fc60bcSBarry Smith } 36496fc60bcSBarry Smith } else { 36596fc60bcSBarry Smith ierr = PetscTokenFind(token,&first);CHKERRQ(ierr); 366e5c89e4eSSatish Balay } 367e5c89e4eSSatish Balay } 3688c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 369e5c89e4eSSatish Balay PetscFunctionReturn(0); 370e5c89e4eSSatish Balay } 371e5c89e4eSSatish Balay 3723fc1eb6aSBarry Smith /* 3733fc1eb6aSBarry Smith Returns a line (ended by a \n, \r or null character of any length. Result should be freed with free() 3743fc1eb6aSBarry Smith */ 3755fa91da5SBarry Smith static char *Petscgetline(FILE * f) 3765fa91da5SBarry Smith { 3775fa91da5SBarry Smith size_t size = 0; 3785fa91da5SBarry Smith size_t len = 0; 3795fa91da5SBarry Smith size_t last = 0; 3800298fd71SBarry Smith char *buf = NULL; 3815fa91da5SBarry Smith 38202c9f0b5SLisandro Dalcin if (feof(f)) return NULL; 3835fa91da5SBarry Smith do { 3845fa91da5SBarry Smith size += 1024; /* BUFSIZ is defined as "the optimal read size for this platform" */ 3856e0c8459SSatish Balay buf = (char*)realloc((void*)buf,size); /* realloc(NULL,n) is the same as malloc(n) */ 3865fa91da5SBarry Smith /* Actually do the read. Note that fgets puts a terminal '\0' on the 3875fa91da5SBarry Smith end of the string, so we make sure we overwrite this */ 388e86f3e45SDave May if (!fgets(buf+len,1024,f)) buf[len]=0; 3895fa91da5SBarry Smith PetscStrlen(buf,&len); 3905fa91da5SBarry Smith last = len - 1; 3915fa91da5SBarry Smith } while (!feof(f) && buf[last] != '\n' && buf[last] != '\r'); 39208ac41f7SSatish Balay if (len) return buf; 3935fa91da5SBarry Smith free(buf); 39402c9f0b5SLisandro Dalcin return NULL; 3955fa91da5SBarry Smith } 3965fa91da5SBarry Smith 397e5c89e4eSSatish Balay /*@C 398e5c89e4eSSatish Balay PetscOptionsInsertFile - Inserts options into the database from a file. 399e5c89e4eSSatish Balay 400d083f849SBarry Smith Collective 401e5c89e4eSSatish Balay 402e5c89e4eSSatish Balay Input Parameter: 4039b754dc9SBarry Smith + comm - the processes that will share the options (usually PETSC_COMM_WORLD) 404c5929fdfSBarry Smith . options - options database, use NULL for default global database 405e5c89e4eSSatish Balay . file - name of file 4069b754dc9SBarry Smith - require - if PETSC_TRUE will generate an error if the file does not exist 407e5c89e4eSSatish Balay 408e5c89e4eSSatish Balay 40995452b02SPatrick Sanan Notes: 41095452b02SPatrick Sanan Use # for lines that are comments and which should be ignored. 411f0feba65SBarry Smith Usually, instead of using this command, one should list the file name in the call to PetscInitialize(), this insures that certain options 412609bdbeeSBarry 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 413f0feba65SBarry Smith calls to XXXSetFromOptions() it should not be used for options listed under PetscInitialize(). 4149666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes in comm will 4151c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 4161c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 4171c9f3c13SBarry Smith on different ranks. 418f0feba65SBarry Smith 4193bcbd388SSean Farley Level: developer 420e5c89e4eSSatish Balay 42188c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(), 422acfcf0e5SJed Brown PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 423e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 424e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 425acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 426a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 427e5c89e4eSSatish Balay 428e5c89e4eSSatish Balay @*/ 429c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertFile(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require) 430e5c89e4eSSatish Balay { 4317fb43599SVaclav Hapla char *string,fname[PETSC_MAX_PATH_LEN],*vstring = NULL,*astring = NULL,*packed = NULL; 4327fb43599SVaclav Hapla char *tokens[4]; 433e5c89e4eSSatish Balay PetscErrorCode ierr; 43413e3f751SJed Brown size_t i,len,bytes; 435e5c89e4eSSatish Balay FILE *fd; 4367fb43599SVaclav Hapla PetscToken token=NULL; 437ed9cf6e9SBarry Smith int err; 438581bbe83SVaclav Hapla char *cmatch; 439581bbe83SVaclav Hapla const char cmt='#'; 4409210b8eaSVaclav Hapla PetscInt line=1; 4413a018368SJed Brown PetscMPIInt rank,cnt=0,acnt=0,counts[2]; 4429210b8eaSVaclav Hapla PetscBool isdir,alias=PETSC_FALSE,valid; 443e5c89e4eSSatish Balay 444e5c89e4eSSatish Balay PetscFunctionBegin; 44505c7dedfSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 4467fb43599SVaclav Hapla ierr = PetscMemzero(tokens,sizeof(tokens));CHKERRQ(ierr); 44705c7dedfSBarry Smith if (!rank) { 44866af5158SSatish Balay cnt = 0; 44966af5158SSatish Balay acnt = 0; 45005c7dedfSBarry Smith 451e5c89e4eSSatish Balay ierr = PetscFixFilename(file,fname);CHKERRQ(ierr); 452e5c89e4eSSatish Balay fd = fopen(fname,"r"); 453ad38b122SPatrick Sanan ierr = PetscTestDirectory(fname,'r',&isdir);CHKERRQ(ierr); 454ad38b122SPatrick Sanan if (isdir && require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Specified options file %s is a directory",fname); 455ad38b122SPatrick Sanan if (fd && !isdir) { 4563a018368SJed Brown PetscSegBuffer vseg,aseg; 4573a018368SJed Brown ierr = PetscSegBufferCreate(1,4000,&vseg);CHKERRQ(ierr); 4583a018368SJed Brown ierr = PetscSegBufferCreate(1,2000,&aseg);CHKERRQ(ierr); 4593a018368SJed Brown 4609b754dc9SBarry Smith /* the following line will not work when opening initial files (like .petscrc) since info is not yet set */ 46102c9f0b5SLisandro Dalcin ierr = PetscInfo1(NULL,"Opened options file %s\n",file);CHKERRQ(ierr); 462e24ecc5dSJed Brown 4635fa91da5SBarry Smith while ((string = Petscgetline(fd))) { 4644704e885SBarry Smith /* eliminate comments from each line */ 465581bbe83SVaclav Hapla ierr = PetscStrchr(string,cmt,&cmatch);CHKERRQ(ierr); 46690f79514SSatish Balay if (cmatch) *cmatch = 0; 467e5c89e4eSSatish Balay ierr = PetscStrlen(string,&len);CHKERRQ(ierr); 4685981331cSSatish Balay /* replace tabs, ^M, \n with " " */ 469e5c89e4eSSatish Balay for (i=0; i<len; i++) { 4705981331cSSatish Balay if (string[i] == '\t' || string[i] == '\r' || string[i] == '\n') { 471e5c89e4eSSatish Balay string[i] = ' '; 472e5c89e4eSSatish Balay } 473e5c89e4eSSatish Balay } 47490f79514SSatish Balay ierr = PetscTokenCreate(string,' ',&token);CHKERRQ(ierr); 4757fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 4767fb43599SVaclav Hapla if (!tokens[0]) { 47702b0d46eSSatish Balay goto destroy; 4787fb43599SVaclav Hapla } else if (!tokens[0][0]) { /* if token 0 is empty (string begins with spaces), redo */ 4797fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 48090f79514SSatish Balay } 4817fb43599SVaclav Hapla for (i=1; i<4; i++) { 4827fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[i]);CHKERRQ(ierr); 4837fb43599SVaclav Hapla } 4847fb43599SVaclav Hapla if (!tokens[0]) { 4852662f744SSatish Balay goto destroy; 4867fb43599SVaclav Hapla } else if (tokens[0][0] == '-') { 4879210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[0],&valid);CHKERRQ(ierr); 4889210b8eaSVaclav 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]); 4897fb43599SVaclav Hapla ierr = PetscStrlen(tokens[0],&len);CHKERRQ(ierr); 49013e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+1,&vstring);CHKERRQ(ierr); 4917fb43599SVaclav Hapla ierr = PetscArraycpy(vstring,tokens[0],len);CHKERRQ(ierr); 492e24ecc5dSJed Brown vstring[len] = ' '; 4937fb43599SVaclav Hapla if (tokens[1]) { 4949210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[1],&valid);CHKERRQ(ierr); 4959210b8eaSVaclav 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]); 4967fb43599SVaclav Hapla ierr = PetscStrlen(tokens[1],&len);CHKERRQ(ierr); 49713e3f751SJed Brown ierr = PetscSegBufferGet(vseg,len+3,&vstring);CHKERRQ(ierr); 498e24ecc5dSJed Brown vstring[0] = '"'; 4997fb43599SVaclav Hapla ierr = PetscArraycpy(vstring+1,tokens[1],len);CHKERRQ(ierr); 500e24ecc5dSJed Brown vstring[len+1] = '"'; 501e24ecc5dSJed Brown vstring[len+2] = ' '; 50209192fe3SBarry Smith } 50390f79514SSatish Balay } else { 5049210b8eaSVaclav Hapla ierr = PetscStrcasecmp(tokens[0],"alias",&alias);CHKERRQ(ierr); 5059210b8eaSVaclav Hapla if (alias) { 5069210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[1],&valid);CHKERRQ(ierr); 5079210b8eaSVaclav 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]); 5089210b8eaSVaclav 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]); 5099210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(tokens[2],&valid);CHKERRQ(ierr); 5109210b8eaSVaclav 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]); 5117fb43599SVaclav Hapla ierr = PetscStrlen(tokens[1],&len);CHKERRQ(ierr); 51213e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 5137fb43599SVaclav Hapla ierr = PetscArraycpy(astring,tokens[1],len);CHKERRQ(ierr); 514e24ecc5dSJed Brown astring[len] = ' '; 515e24ecc5dSJed Brown 5167fb43599SVaclav Hapla ierr = PetscStrlen(tokens[2],&len);CHKERRQ(ierr); 51713e3f751SJed Brown ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr); 5187fb43599SVaclav Hapla ierr = PetscArraycpy(astring,tokens[2],len);CHKERRQ(ierr); 519e24ecc5dSJed Brown astring[len] = ' '; 5209210b8eaSVaclav Hapla } else SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown first token in options file %s line %D: %s",fname,line,tokens[0]); 5219210b8eaSVaclav Hapla } 5229210b8eaSVaclav Hapla { 5239210b8eaSVaclav Hapla const char *extraToken = alias ? tokens[3] : tokens[2]; 5249210b8eaSVaclav Hapla if (extraToken) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file %s line %D: extra token %s",fname,line,extraToken); 525e5c89e4eSSatish Balay } 52602b0d46eSSatish Balay destroy: 5274b40f50bSBarry Smith free(string); 5288c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 5299210b8eaSVaclav Hapla alias = PETSC_FALSE; 5309210b8eaSVaclav Hapla line++; 531e5c89e4eSSatish Balay } 532ed9cf6e9SBarry Smith err = fclose(fd); 5339210b8eaSVaclav Hapla if (err) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file %s",fname); 534e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(aseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 535e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&acnt);CHKERRQ(ierr); 536e24ecc5dSJed Brown ierr = PetscSegBufferGet(aseg,1,&astring);CHKERRQ(ierr); 537e24ecc5dSJed Brown astring[0] = 0; 538e24ecc5dSJed Brown ierr = PetscSegBufferGetSize(vseg,&bytes);CHKERRQ(ierr); /* size without null termination */ 539e24ecc5dSJed Brown ierr = PetscMPIIntCast(bytes,&cnt);CHKERRQ(ierr); 540e24ecc5dSJed Brown ierr = PetscSegBufferGet(vseg,1,&vstring);CHKERRQ(ierr); 541e24ecc5dSJed Brown vstring[0] = 0; 542854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 5433a018368SJed Brown ierr = PetscSegBufferExtractTo(aseg,packed);CHKERRQ(ierr); 5443a018368SJed Brown ierr = PetscSegBufferExtractTo(vseg,packed+acnt+1);CHKERRQ(ierr); 5453a018368SJed Brown ierr = PetscSegBufferDestroy(&aseg);CHKERRQ(ierr); 5463a018368SJed Brown ierr = PetscSegBufferDestroy(&vseg);CHKERRQ(ierr); 5479210b8eaSVaclav Hapla } else if (require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Unable to open options file %s",fname); 5489b754dc9SBarry Smith } 54905c7dedfSBarry Smith 5503a018368SJed Brown counts[0] = acnt; 5513a018368SJed Brown counts[1] = cnt; 5524201f521SBarry Smith err = MPI_Bcast(counts,2,MPI_INT,0,comm); 5534201f521SBarry Smith if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in first MPI collective call, could be caused by using an incorrect mpiexec or a network problem, it can be caused by having VPN running: see https://www.mcs.anl.gov/petsc/documentation/faq.html"); 5543a018368SJed Brown acnt = counts[0]; 5553a018368SJed Brown cnt = counts[1]; 5563a018368SJed Brown if (rank) { 557854ce69bSBarry Smith ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr); 5583a018368SJed Brown } 5593a018368SJed Brown if (acnt || cnt) { 5603a018368SJed Brown ierr = MPI_Bcast(packed,2+acnt+cnt,MPI_CHAR,0,comm);CHKERRQ(ierr); 5613a018368SJed Brown astring = packed; 5623a018368SJed Brown vstring = packed + acnt + 1; 5633a018368SJed Brown } 5643a018368SJed Brown 5659b754dc9SBarry Smith if (acnt) { 5669b754dc9SBarry Smith ierr = PetscTokenCreate(astring,' ',&token);CHKERRQ(ierr); 5677fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 5687fb43599SVaclav Hapla while (tokens[0]) { 5697fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[1]);CHKERRQ(ierr); 5707fb43599SVaclav Hapla ierr = PetscOptionsSetAlias(options,tokens[0],tokens[1]);CHKERRQ(ierr); 5717fb43599SVaclav Hapla ierr = PetscTokenFind(token,&tokens[0]);CHKERRQ(ierr); 5729b754dc9SBarry Smith } 5738c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 5749b754dc9SBarry Smith } 5759b754dc9SBarry Smith 5769b754dc9SBarry Smith if (cnt) { 577c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,vstring);CHKERRQ(ierr); 578e5c89e4eSSatish Balay } 5793a018368SJed Brown ierr = PetscFree(packed);CHKERRQ(ierr); 580e5c89e4eSSatish Balay PetscFunctionReturn(0); 581e5c89e4eSSatish Balay } 582e5c89e4eSSatish Balay 5832d747510SLisandro Dalcin static PetscErrorCode PetscOptionsInsertArgs(PetscOptions options,int argc,char *args[]) 58485079163SJed Brown { 58585079163SJed Brown PetscErrorCode ierr; 58685079163SJed Brown int left = argc - 1; 58785079163SJed Brown char **eargs = args + 1; 58885079163SJed Brown 58985079163SJed Brown PetscFunctionBegin; 59085079163SJed Brown while (left) { 591093de6efSBarry Smith PetscBool isoptions_file,isprefixpush,isprefixpop,isp4,tisp4,isp4yourname,isp4rmrank,key; 59285079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-options_file",&isoptions_file);CHKERRQ(ierr); 5939db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_push",&isprefixpush);CHKERRQ(ierr); 5949db968c8SJed Brown ierr = PetscStrcasecmp(eargs[0],"-prefix_pop",&isprefixpop);CHKERRQ(ierr); 59585079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4pg",&isp4);CHKERRQ(ierr); 59685079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4yourname",&isp4yourname);CHKERRQ(ierr); 59785079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4rmrank",&isp4rmrank);CHKERRQ(ierr); 59885079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4wd",&tisp4);CHKERRQ(ierr); 599ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 60085079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-np",&tisp4);CHKERRQ(ierr); 601ace3abfcSBarry Smith isp4 = (PetscBool) (isp4 || tisp4); 60285079163SJed Brown ierr = PetscStrcasecmp(eargs[0],"-p4amslave",&tisp4);CHKERRQ(ierr); 603093de6efSBarry Smith ierr = PetscOptionsValidKey(eargs[0],&key);CHKERRQ(ierr); 60485079163SJed Brown 605093de6efSBarry Smith if (!key) { 60685079163SJed Brown eargs++; left--; 60785079163SJed Brown } else if (isoptions_file) { 60885079163SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 60985079163SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option"); 610c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,eargs[1],PETSC_TRUE);CHKERRQ(ierr); 61185079163SJed Brown eargs += 2; left -= 2; 6129db968c8SJed Brown } else if (isprefixpush) { 6139db968c8SJed Brown if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option"); 6149db968c8SJed Brown if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option (prefixes cannot start with '-')"); 615c5929fdfSBarry Smith ierr = PetscOptionsPrefixPush(options,eargs[1]);CHKERRQ(ierr); 6169db968c8SJed Brown eargs += 2; left -= 2; 6179db968c8SJed Brown } else if (isprefixpop) { 618c5929fdfSBarry Smith ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 6199db968c8SJed Brown eargs++; left--; 62085079163SJed Brown 62185079163SJed Brown /* 62285079163SJed Brown These are "bad" options that MPICH, etc put on the command line 62385079163SJed Brown we strip them out here. 62485079163SJed Brown */ 62585079163SJed Brown } else if (tisp4 || isp4rmrank) { 62685079163SJed Brown eargs += 1; left -= 1; 62785079163SJed Brown } else if (isp4 || isp4yourname) { 62885079163SJed Brown eargs += 2; left -= 2; 6297935c3d8SJed Brown } else { 6307935c3d8SJed Brown PetscBool nextiskey = PETSC_FALSE; 6317935c3d8SJed Brown if (left >= 2) {ierr = PetscOptionsValidKey(eargs[1],&nextiskey);CHKERRQ(ierr);} 63298b6bf53SJed Brown if (left < 2 || nextiskey) { 633c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],NULL);CHKERRQ(ierr); 63485079163SJed Brown eargs++; left--; 63585079163SJed Brown } else { 636c5929fdfSBarry Smith ierr = PetscOptionsSetValue(options,eargs[0],eargs[1]);CHKERRQ(ierr); 63785079163SJed Brown eargs += 2; left -= 2; 63885079163SJed Brown } 63985079163SJed Brown } 6407935c3d8SJed Brown } 64185079163SJed Brown PetscFunctionReturn(0); 64285079163SJed Brown } 64385079163SJed Brown 644c5b5d8d5SVaclav Hapla PETSC_STATIC_INLINE PetscErrorCode PetscOptionsStringToBoolIfSet_Private(enum PetscPrecedentOption opt,const char *val[],PetscBool set[],PetscBool *flg) 645c5b5d8d5SVaclav Hapla { 646c5b5d8d5SVaclav Hapla PetscErrorCode ierr; 647c5b5d8d5SVaclav Hapla 648c5b5d8d5SVaclav Hapla PetscFunctionBegin; 649c5b5d8d5SVaclav Hapla if (set[opt]) { 650c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBool(val[opt],flg);CHKERRQ(ierr); 651c5b5d8d5SVaclav Hapla } else *flg = PETSC_FALSE; 652c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 653c5b5d8d5SVaclav Hapla } 654c5b5d8d5SVaclav Hapla 655c5b5d8d5SVaclav Hapla /* Process options with absolute precedence */ 656c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsProcessPrecedentFlags(PetscOptions options,int argc,char *args[],PetscBool *skip_petscrc,PetscBool *skip_petscrc_set) 657c5b5d8d5SVaclav Hapla { 658c5b5d8d5SVaclav Hapla const char* const *opt = precedentOptions; 659c5b5d8d5SVaclav Hapla const size_t n = PO_NUM; 660c5b5d8d5SVaclav Hapla size_t o; 661c5b5d8d5SVaclav Hapla int a; 662c5b5d8d5SVaclav Hapla const char **val; 663c5b5d8d5SVaclav Hapla PetscBool *set; 664c5b5d8d5SVaclav Hapla PetscErrorCode ierr; 665c5b5d8d5SVaclav Hapla 666c5b5d8d5SVaclav Hapla PetscFunctionBegin; 667c5b5d8d5SVaclav Hapla ierr = PetscCalloc2(n,&val,n,&set);CHKERRQ(ierr); 668c5b5d8d5SVaclav Hapla 669c5b5d8d5SVaclav Hapla /* Look for options possibly set using PetscOptionsSetValue beforehand */ 670c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 671c5b5d8d5SVaclav Hapla ierr = PetscOptionsFindPair(options,NULL,opt[o],&val[o],&set[o]);CHKERRQ(ierr); 672c5b5d8d5SVaclav Hapla } 673c5b5d8d5SVaclav Hapla 674c5b5d8d5SVaclav Hapla /* Loop through all args to collect last occuring value of each option */ 675c5b5d8d5SVaclav Hapla for (a=1; a<argc; a++) { 676c5b5d8d5SVaclav Hapla PetscBool valid, eq; 677c5b5d8d5SVaclav Hapla 678c5b5d8d5SVaclav Hapla ierr = PetscOptionsValidKey(args[a],&valid);CHKERRQ(ierr); 679c5b5d8d5SVaclav Hapla if (!valid) continue; 680c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 681c5b5d8d5SVaclav Hapla ierr = PetscStrcasecmp(args[a],opt[o],&eq);CHKERRQ(ierr); 682c5b5d8d5SVaclav Hapla if (eq) { 683c5b5d8d5SVaclav Hapla set[o] = PETSC_TRUE; 684c5b5d8d5SVaclav Hapla if (a == argc-1 || !args[a+1] || !args[a+1][0] || args[a+1][0] == '-') val[o] = NULL; 685c5b5d8d5SVaclav Hapla else val[o] = args[a+1]; 686c5b5d8d5SVaclav Hapla break; 687c5b5d8d5SVaclav Hapla } 688c5b5d8d5SVaclav Hapla } 689c5b5d8d5SVaclav Hapla } 690c5b5d8d5SVaclav Hapla 691c5b5d8d5SVaclav Hapla /* Process flags */ 692d314f959SVaclav Hapla ierr = PetscStrcasecmp(val[PO_HELP], "intro", &options->help_intro);CHKERRQ(ierr); 693d314f959SVaclav Hapla if (options->help_intro) options->help = PETSC_TRUE; 694d314f959SVaclav Hapla else {ierr = PetscOptionsStringToBoolIfSet_Private(PO_HELP, val,set,&options->help);CHKERRQ(ierr);} 695c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_OPTIONS_MONITOR_CANCEL,val,set,&options->monitorCancel);CHKERRQ(ierr); 696c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_OPTIONS_MONITOR, val,set,&options->monitorFromOptions);CHKERRQ(ierr); 697c5b5d8d5SVaclav Hapla ierr = PetscOptionsStringToBoolIfSet_Private(PO_SKIP_PETSCRC, val,set,skip_petscrc);CHKERRQ(ierr); 698c5b5d8d5SVaclav Hapla *skip_petscrc_set = set[PO_SKIP_PETSCRC]; 699c5b5d8d5SVaclav Hapla 700c5b5d8d5SVaclav Hapla /* Store precedent options in database and mark them as used */ 701c5b5d8d5SVaclav Hapla for (o=0; o<n; o++) { 702c5b5d8d5SVaclav Hapla if (set[o]) { 703c5b5d8d5SVaclav Hapla int pos; 704c5b5d8d5SVaclav Hapla 705c5b5d8d5SVaclav Hapla ierr = PetscOptionsSetValue_Private(options,opt[o],val[o],&pos);CHKERRQ(ierr); 706c5b5d8d5SVaclav Hapla options->used[pos] = PETSC_TRUE; 707c5b5d8d5SVaclav Hapla } 708c5b5d8d5SVaclav Hapla } 709c5b5d8d5SVaclav Hapla 710c5b5d8d5SVaclav Hapla ierr = PetscFree2(val,set);CHKERRQ(ierr); 711c5b5d8d5SVaclav Hapla options->precedentProcessed = PETSC_TRUE; 712c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 713c5b5d8d5SVaclav Hapla } 714c5b5d8d5SVaclav Hapla 715c5b5d8d5SVaclav Hapla PETSC_STATIC_INLINE PetscErrorCode PetscOptionsSkipPrecedent(PetscOptions options,const char name[],PetscBool *flg) 716c5b5d8d5SVaclav Hapla { 717c5b5d8d5SVaclav Hapla int i; 718c5b5d8d5SVaclav Hapla PetscErrorCode ierr; 719c5b5d8d5SVaclav Hapla 720c5b5d8d5SVaclav Hapla *flg = PETSC_FALSE; 721c5b5d8d5SVaclav Hapla if (options->precedentProcessed) { 722c5b5d8d5SVaclav Hapla for (i=0; i<PO_NUM; i++) { 723c5b5d8d5SVaclav Hapla if (!PetscOptNameCmp(precedentOptions[i],name)) { 724c5b5d8d5SVaclav Hapla /* check if precedent option has been set already */ 725c5b5d8d5SVaclav Hapla ierr = PetscOptionsFindPair(options,NULL,name,NULL,flg);CHKERRQ(ierr); 726c5b5d8d5SVaclav Hapla if (*flg) break; 727c5b5d8d5SVaclav Hapla } 728c5b5d8d5SVaclav Hapla } 729c5b5d8d5SVaclav Hapla } 730c5b5d8d5SVaclav Hapla PetscFunctionReturn(0); 731c5b5d8d5SVaclav Hapla } 73285079163SJed Brown 733e5c89e4eSSatish Balay /*@C 734e5c89e4eSSatish Balay PetscOptionsInsert - Inserts into the options database from the command line, 735e5c89e4eSSatish Balay the environmental variable and a file. 736e5c89e4eSSatish Balay 7371c9f3c13SBarry Smith Collective on PETSC_COMM_WORLD 7381c9f3c13SBarry Smith 739e5c89e4eSSatish Balay Input Parameters: 740c5929fdfSBarry Smith + options - options database or NULL for the default global database 741c5929fdfSBarry Smith . argc - count of number of command line arguments 742e5c89e4eSSatish Balay . args - the command line arguments 743c5b5d8d5SVaclav Hapla - file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc. 744c5b5d8d5SVaclav Hapla Use NULL to not check for code specific file. 745c5b5d8d5SVaclav Hapla Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 746e5c89e4eSSatish Balay 747e5c89e4eSSatish Balay Note: 748e5c89e4eSSatish Balay Since PetscOptionsInsert() is automatically called by PetscInitialize(), 749e5c89e4eSSatish Balay the user does not typically need to call this routine. PetscOptionsInsert() 750e5c89e4eSSatish Balay can be called several times, adding additional entries into the database. 751e5c89e4eSSatish Balay 752081c24baSBoyana Norris Options Database Keys: 753c5b5d8d5SVaclav Hapla . -options_file <filename> - read options from a file 754c5b5d8d5SVaclav Hapla 755c5b5d8d5SVaclav Hapla See PetscInitialize() for options related to option database monitoring. 756081c24baSBoyana Norris 757e5c89e4eSSatish Balay Level: advanced 758e5c89e4eSSatish Balay 7592d747510SLisandro Dalcin .seealso: PetscOptionsDestroy(), PetscOptionsView(), PetscOptionsInsertString(), PetscOptionsInsertFile(), 76096fc60bcSBarry Smith PetscInitialize() 761e5c89e4eSSatish Balay @*/ 762c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsert(PetscOptions options,int *argc,char ***args,const char file[]) 763e5c89e4eSSatish Balay { 764e5c89e4eSSatish Balay PetscErrorCode ierr; 765e5c89e4eSSatish Balay PetscMPIInt rank; 7662d747510SLisandro Dalcin char filename[PETSC_MAX_PATH_LEN]; 767c5b5d8d5SVaclav Hapla PetscBool hasArgs = (argc && *argc) ? PETSC_TRUE : PETSC_FALSE; 768c5b5d8d5SVaclav Hapla PetscBool skipPetscrc = PETSC_FALSE, skipPetscrcSet = PETSC_FALSE; 769e5c89e4eSSatish Balay 7708dea33a6SBarry Smith 771e5c89e4eSSatish Balay PetscFunctionBegin; 772c5b5d8d5SVaclav Hapla if (hasArgs && !(args && *args)) SETERRQ(PETSC_COMM_WORLD, PETSC_ERR_ARG_NULL, "*argc > 1 but *args not given"); 773e5c89e4eSSatish Balay ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 774e5c89e4eSSatish Balay 775c5b5d8d5SVaclav Hapla if (!options) { 776c5b5d8d5SVaclav Hapla ierr = PetscOptionsCreateDefault();CHKERRQ(ierr); 777c5b5d8d5SVaclav Hapla options = defaultoptions; 778c5b5d8d5SVaclav Hapla } 779c5b5d8d5SVaclav Hapla if (hasArgs) { 780c5b5d8d5SVaclav Hapla /* process options with absolute precedence */ 781c5b5d8d5SVaclav Hapla ierr = PetscOptionsProcessPrecedentFlags(options,*argc,*args,&skipPetscrc,&skipPetscrcSet);CHKERRQ(ierr); 782c5b5d8d5SVaclav Hapla } 7834b09e917SBarry Smith if (file && file[0]) { 7842d747510SLisandro Dalcin ierr = PetscStrreplace(PETSC_COMM_WORLD,file,filename,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 7852d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_TRUE);CHKERRQ(ierr); 786c5b5d8d5SVaclav Hapla /* if -skip_petscrc has not been set from command line, check whether it has been set in the file */ 787c5b5d8d5SVaclav Hapla if (!skipPetscrcSet) {ierr = PetscOptionsGetBool(options,NULL,"-skip_petscrc",&skipPetscrc,NULL);CHKERRQ(ierr);} 788321366bcSBarry Smith } 789c5b5d8d5SVaclav Hapla if (!skipPetscrc) { 7902d747510SLisandro Dalcin ierr = PetscGetHomeDirectory(filename,PETSC_MAX_PATH_LEN-16);CHKERRQ(ierr); 7911ea3218fSSatish Balay /* PetscOptionsInsertFile() does a fopen() on rank0 only - so only rank0 HomeDir value is relavent */ 7922d747510SLisandro Dalcin if (filename[0]) { ierr = PetscStrcat(filename,"/.petscrc");CHKERRQ(ierr); } 7932d747510SLisandro Dalcin ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_FALSE);CHKERRQ(ierr); 794c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,".petscrc",PETSC_FALSE);CHKERRQ(ierr); 795c5929fdfSBarry Smith ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,"petscrc",PETSC_FALSE);CHKERRQ(ierr); 796e5c89e4eSSatish Balay } 797e5c89e4eSSatish Balay 7982d747510SLisandro Dalcin /* insert environment options */ 799e5c89e4eSSatish Balay { 8002d747510SLisandro Dalcin char *eoptions = NULL; 801e5c89e4eSSatish Balay size_t len = 0; 802e5c89e4eSSatish Balay if (!rank) { 803e5c89e4eSSatish Balay eoptions = (char*)getenv("PETSC_OPTIONS"); 804e5c89e4eSSatish Balay ierr = PetscStrlen(eoptions,&len);CHKERRQ(ierr); 80576434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 806e5c89e4eSSatish Balay } else { 80776434e50SSatish Balay ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 808e5c89e4eSSatish Balay if (len) { 809854ce69bSBarry Smith ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr); 810e5c89e4eSSatish Balay } 811e5c89e4eSSatish Balay } 812e5c89e4eSSatish Balay if (len) { 813e5c89e4eSSatish Balay ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 81496fc60bcSBarry Smith if (rank) eoptions[len] = 0; 815c5929fdfSBarry Smith ierr = PetscOptionsInsertString(options,eoptions);CHKERRQ(ierr); 816e5c89e4eSSatish Balay if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);} 817e5c89e4eSSatish Balay } 818e5c89e4eSSatish Balay } 819e5c89e4eSSatish Balay 8203bcbd388SSean Farley #if defined(PETSC_HAVE_YAML) 82156a31166SBarry Smith { 8229fc438c3SToby Isaac char *eoptions = NULL; 8239fc438c3SToby Isaac size_t len = 0; 8249fc438c3SToby Isaac if (!rank) { 8259fc438c3SToby Isaac eoptions = (char*)getenv("PETSC_OPTIONS_YAML"); 8269fc438c3SToby Isaac ierr = PetscStrlen(eoptions,&len);CHKERRQ(ierr); 8279fc438c3SToby Isaac ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 8289fc438c3SToby Isaac } else { 8299fc438c3SToby Isaac ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 8309fc438c3SToby Isaac if (len) { 8319fc438c3SToby Isaac ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr); 8329fc438c3SToby Isaac } 8339fc438c3SToby Isaac } 8349fc438c3SToby Isaac if (len) { 8359fc438c3SToby Isaac ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 8369fc438c3SToby Isaac if (rank) eoptions[len] = 0; 8379fc438c3SToby Isaac ierr = PetscOptionsInsertStringYAML(options,eoptions);CHKERRQ(ierr); 8389fc438c3SToby Isaac if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);} 8399fc438c3SToby Isaac } 8409fc438c3SToby Isaac } 8419fc438c3SToby Isaac { 8423bcbd388SSean Farley char yaml_file[PETSC_MAX_PATH_LEN]; 843080f0011SToby Isaac char yaml_string[BUFSIZ]; 84456a31166SBarry Smith PetscBool yaml_flg; 845589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-options_file_yaml",yaml_file,sizeof(yaml_file),&yaml_flg);CHKERRQ(ierr); 84656a31166SBarry Smith if (yaml_flg) { 84756a31166SBarry Smith ierr = PetscOptionsInsertFileYAML(PETSC_COMM_WORLD,yaml_file,PETSC_TRUE);CHKERRQ(ierr); 84856a31166SBarry Smith } 849589a23caSBarry Smith ierr = PetscOptionsGetString(NULL,NULL,"-options_string_yaml",yaml_string,sizeof(yaml_string),&yaml_flg);CHKERRQ(ierr); 850080f0011SToby Isaac if (yaml_flg) { 851080f0011SToby Isaac ierr = PetscOptionsInsertStringYAML(NULL,yaml_string);CHKERRQ(ierr); 852080f0011SToby Isaac } 85356a31166SBarry Smith } 8543bcbd388SSean Farley #endif 8553bcbd388SSean Farley 856c5b5d8d5SVaclav Hapla /* insert command line options here because they take precedence over arguments in petscrc/environment */ 857c5b5d8d5SVaclav Hapla if (hasArgs) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);} 858e5c89e4eSSatish Balay PetscFunctionReturn(0); 859e5c89e4eSSatish Balay } 860e5c89e4eSSatish Balay 861e5c89e4eSSatish Balay /*@C 86288c29154SBarry Smith PetscOptionsView - Prints the options that have been loaded. This is 863e5c89e4eSSatish Balay useful for debugging purposes. 864e5c89e4eSSatish Balay 865c139c21fSBarry Smith Logically Collective on PetscViewer 866e5c89e4eSSatish Balay 867e5c89e4eSSatish Balay Input Parameter: 868a2b725a8SWilliam Gropp + options - options database, use NULL for default global database 869a2b725a8SWilliam Gropp - viewer - must be an PETSCVIEWERASCII viewer 870e5c89e4eSSatish Balay 871e5c89e4eSSatish Balay Options Database Key: 87226a7e8d4SBarry Smith . -options_view - Activates PetscOptionsView() within PetscFinalize() 873e5c89e4eSSatish Balay 8749666a313SBarry Smith Notes: 8759666a313SBarry Smith Only the rank zero process of MPI_Comm used to create view prints the option values. Other processes 8761c9f3c13SBarry Smith may have different values but they are not printed. 8771c9f3c13SBarry Smith 878e5c89e4eSSatish Balay Level: advanced 879e5c89e4eSSatish Balay 880e5c89e4eSSatish Balay .seealso: PetscOptionsAllUsed() 881e5c89e4eSSatish Balay @*/ 882c5929fdfSBarry Smith PetscErrorCode PetscOptionsView(PetscOptions options,PetscViewer viewer) 883e5c89e4eSSatish Balay { 884e5c89e4eSSatish Balay PetscErrorCode ierr; 885431c96f7SBarry Smith PetscInt i; 88688c29154SBarry Smith PetscBool isascii; 887e5c89e4eSSatish Balay 888e5c89e4eSSatish Balay PetscFunctionBegin; 8892d747510SLisandro Dalcin if (viewer) PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 890c5929fdfSBarry Smith options = options ? options : defaultoptions; 89188c29154SBarry Smith if (!viewer) viewer = PETSC_VIEWER_STDOUT_WORLD; 892251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 893ce94432eSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Only supports ASCII viewer"); 89488c29154SBarry Smith 8952d747510SLisandro Dalcin if (!options->N) { 89688c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#No PETSc Option Table entries\n");CHKERRQ(ierr); 8972d747510SLisandro Dalcin PetscFunctionReturn(0); 89830694fe9SBarry Smith } 8992d747510SLisandro Dalcin 9002d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"#PETSc Option Table entries:\n");CHKERRQ(ierr); 901e5c89e4eSSatish Balay for (i=0; i<options->N; i++) { 902e5c89e4eSSatish Balay if (options->values[i]) { 90388c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s %s\n",options->names[i],options->values[i]);CHKERRQ(ierr); 904e5c89e4eSSatish Balay } else { 90588c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"-%s\n",options->names[i]);CHKERRQ(ierr); 906e5c89e4eSSatish Balay } 907e5c89e4eSSatish Balay } 90888c29154SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"#End of PETSc Option Table entries\n");CHKERRQ(ierr); 909e5c89e4eSSatish Balay PetscFunctionReturn(0); 910e5c89e4eSSatish Balay } 911e5c89e4eSSatish Balay 912e11779c2SBarry Smith /* 913e11779c2SBarry Smith Called by error handlers to print options used in run 914e11779c2SBarry Smith */ 91595c0884eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsViewError(void) 916e11779c2SBarry Smith { 917e11779c2SBarry Smith PetscInt i; 9184416b707SBarry Smith PetscOptions options = defaultoptions; 919e11779c2SBarry Smith 920e11779c2SBarry Smith PetscFunctionBegin; 921e11779c2SBarry Smith if (options->N) { 922e11779c2SBarry Smith (*PetscErrorPrintf)("PETSc Option Table entries:\n"); 923e11779c2SBarry Smith } else { 924e11779c2SBarry Smith (*PetscErrorPrintf)("No PETSc Option Table entries\n"); 925e11779c2SBarry Smith } 926e11779c2SBarry Smith for (i=0; i<options->N; i++) { 927e11779c2SBarry Smith if (options->values[i]) { 928e11779c2SBarry Smith (*PetscErrorPrintf)("-%s %s\n",options->names[i],options->values[i]); 929e11779c2SBarry Smith } else { 930e11779c2SBarry Smith (*PetscErrorPrintf)("-%s\n",options->names[i]); 931e11779c2SBarry Smith } 932e11779c2SBarry Smith } 933e11779c2SBarry Smith PetscFunctionReturn(0); 934e11779c2SBarry Smith } 935e11779c2SBarry Smith 936e5c89e4eSSatish Balay /*@C 93774e0666dSJed Brown PetscOptionsPrefixPush - Designate a prefix to be used by all options insertions to follow. 93874e0666dSJed Brown 9391c9f3c13SBarry Smith Logically Collective 94074e0666dSJed Brown 9419db968c8SJed Brown Input Parameter: 942c5929fdfSBarry Smith + options - options database, or NULL for the default global database 943c5929fdfSBarry Smith - prefix - The string to append to the existing prefix 9449db968c8SJed Brown 9459db968c8SJed Brown Options Database Keys: 9469db968c8SJed Brown + -prefix_push <some_prefix_> - push the given prefix 9479db968c8SJed Brown - -prefix_pop - pop the last prefix 9489db968c8SJed Brown 9499db968c8SJed Brown Notes: 9509db968c8SJed Brown It is common to use this in conjunction with -options_file as in 9519db968c8SJed Brown 9529db968c8SJed Brown $ -prefix_push system1_ -options_file system1rc -prefix_pop -prefix_push system2_ -options_file system2rc -prefix_pop 9539db968c8SJed Brown 9549db968c8SJed Brown where the files no longer require all options to be prefixed with -system2_. 95574e0666dSJed Brown 9569666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 9571c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 9581c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 9591c9f3c13SBarry Smith on different ranks. 9601c9f3c13SBarry Smith 96174e0666dSJed Brown Level: advanced 96274e0666dSJed Brown 9631c9f3c13SBarry Smith .seealso: PetscOptionsPrefixPop(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsSetValue() 96474e0666dSJed Brown @*/ 965c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPush(PetscOptions options,const char prefix[]) 96674e0666dSJed Brown { 96774e0666dSJed Brown PetscErrorCode ierr; 96874e0666dSJed Brown size_t n; 96974e0666dSJed Brown PetscInt start; 9702d747510SLisandro Dalcin char key[MAXOPTNAME+1]; 9712d747510SLisandro Dalcin PetscBool valid; 97274e0666dSJed Brown 97374e0666dSJed Brown PetscFunctionBegin; 9749db968c8SJed Brown PetscValidCharPointer(prefix,1); 975c5929fdfSBarry Smith options = options ? options : defaultoptions; 97674e0666dSJed 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); 9772d747510SLisandro Dalcin key[0] = '-'; /* keys must start with '-' */ 9782d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,prefix,sizeof(key)-1);CHKERRQ(ierr); 9792d747510SLisandro Dalcin ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 980*8bf569ecSLisandro Dalcin if (!valid && options->prefixind > 0 && isdigit((int)prefix[0])) valid = PETSC_TRUE; /* If the prefix stack is not empty, make numbers a valid prefix */ 981*8bf569ecSLisandro Dalcin if (!valid) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Given prefix \"%s\" not valid (the first character must be a letter%s, do not include leading '-')",prefix,options->prefixind?" or digit":""); 98274e0666dSJed Brown start = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 98374e0666dSJed Brown ierr = PetscStrlen(prefix,&n);CHKERRQ(ierr); 98474e0666dSJed Brown if (n+1 > sizeof(options->prefix)-start) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum prefix length %d exceeded",sizeof(options->prefix)); 985580bdb30SBarry Smith ierr = PetscArraycpy(options->prefix+start,prefix,n+1);CHKERRQ(ierr); 98674e0666dSJed Brown options->prefixstack[options->prefixind++] = start+n; 98774e0666dSJed Brown PetscFunctionReturn(0); 98874e0666dSJed Brown } 98974e0666dSJed Brown 990c5929fdfSBarry Smith /*@C 99174e0666dSJed Brown PetscOptionsPrefixPop - Remove the latest options prefix, see PetscOptionsPrefixPush() for details 99274e0666dSJed Brown 9931c9f3c13SBarry Smith Logically Collective on the MPI_Comm that called PetscOptionsPrefixPush() 99474e0666dSJed Brown 995c5929fdfSBarry Smith Input Parameters: 996c5929fdfSBarry Smith . options - options database, or NULL for the default global database 997c5929fdfSBarry Smith 99874e0666dSJed Brown Level: advanced 99974e0666dSJed Brown 10001c9f3c13SBarry Smith .seealso: PetscOptionsPrefixPush(), PetscOptionsPush(), PetscOptionsPop(), PetscOptionsCreate(), PetscOptionsSetValue() 100174e0666dSJed Brown @*/ 1002c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPop(PetscOptions options) 100374e0666dSJed Brown { 100474e0666dSJed Brown PetscInt offset; 100574e0666dSJed Brown 100674e0666dSJed Brown PetscFunctionBegin; 1007c5929fdfSBarry Smith options = options ? options : defaultoptions; 100874e0666dSJed Brown if (options->prefixind < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"More prefixes popped than pushed"); 100974e0666dSJed Brown options->prefixind--; 101074e0666dSJed Brown offset = options->prefixind ? options->prefixstack[options->prefixind-1] : 0; 101174e0666dSJed Brown options->prefix[offset] = 0; 101274e0666dSJed Brown PetscFunctionReturn(0); 101374e0666dSJed Brown } 101474e0666dSJed Brown 1015a542b6e8SBarry Smith /*@C 1016a542b6e8SBarry Smith PetscOptionsClear - Removes all options form the database leaving it empty. 1017a542b6e8SBarry Smith 10181c9f3c13SBarry Smith Logically Collective 10191c9f3c13SBarry Smith 1020c5929fdfSBarry Smith Input Parameters: 1021c5929fdfSBarry Smith . options - options database, use NULL for the default global database 1022c5929fdfSBarry Smith 10239666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 10241c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 10251c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 10261c9f3c13SBarry Smith on different ranks. 10271c9f3c13SBarry Smith 1028a542b6e8SBarry Smith Level: developer 1029a542b6e8SBarry Smith 1030a542b6e8SBarry Smith .seealso: PetscOptionsInsert() 1031a542b6e8SBarry Smith @*/ 1032c5929fdfSBarry Smith PetscErrorCode PetscOptionsClear(PetscOptions options) 1033a542b6e8SBarry Smith { 1034a542b6e8SBarry Smith PetscInt i; 1035a542b6e8SBarry Smith 1036c5929fdfSBarry Smith options = options ? options : defaultoptions; 10372d747510SLisandro Dalcin if (!options) return 0; 10382d747510SLisandro Dalcin 1039a542b6e8SBarry Smith for (i=0; i<options->N; i++) { 1040a542b6e8SBarry Smith if (options->names[i]) free(options->names[i]); 1041a542b6e8SBarry Smith if (options->values[i]) free(options->values[i]); 1042a542b6e8SBarry Smith } 10432d747510SLisandro Dalcin options->N = 0; 10442d747510SLisandro Dalcin 1045a542b6e8SBarry Smith for (i=0; i<options->Naliases; i++) { 1046a542b6e8SBarry Smith free(options->aliases1[i]); 1047a542b6e8SBarry Smith free(options->aliases2[i]); 1048a542b6e8SBarry Smith } 1049a542b6e8SBarry Smith options->Naliases = 0; 1050a542b6e8SBarry Smith 10512d747510SLisandro Dalcin /* destroy hash table */ 10522d747510SLisandro Dalcin kh_destroy(HO,options->ht); 10532d747510SLisandro Dalcin options->ht = NULL; 10540eb63584SBarry Smith 10552d747510SLisandro Dalcin options->prefixind = 0; 10562d747510SLisandro Dalcin options->prefix[0] = 0; 10572d747510SLisandro Dalcin options->help = PETSC_FALSE; 10584416b707SBarry Smith return 0; 10594416b707SBarry Smith } 10604416b707SBarry Smith 10612d747510SLisandro Dalcin /*@C 10622d747510SLisandro Dalcin PetscOptionsSetAlias - Makes a key and alias for another key 10632d747510SLisandro Dalcin 10641c9f3c13SBarry Smith Logically Collective 10652d747510SLisandro Dalcin 10662d747510SLisandro Dalcin Input Parameters: 10672d747510SLisandro Dalcin + options - options database, or NULL for default global database 10682d747510SLisandro Dalcin . newname - the alias 10692d747510SLisandro Dalcin - oldname - the name that alias will refer to 10702d747510SLisandro Dalcin 10712d747510SLisandro Dalcin Level: advanced 10722d747510SLisandro Dalcin 10739666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 10741c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 10751c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 10761c9f3c13SBarry Smith on different ranks. 10771c9f3c13SBarry Smith 10782d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 10792d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 10802d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 10812d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 10822d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 10832d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 10842d747510SLisandro Dalcin @*/ 10852d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetAlias(PetscOptions options,const char newname[],const char oldname[]) 10862d747510SLisandro Dalcin { 10872d747510SLisandro Dalcin PetscInt n; 10882d747510SLisandro Dalcin size_t len; 10899210b8eaSVaclav Hapla PetscBool valid; 10902d747510SLisandro Dalcin PetscErrorCode ierr; 10912d747510SLisandro Dalcin 10922d747510SLisandro Dalcin PetscFunctionBegin; 10932d747510SLisandro Dalcin PetscValidCharPointer(newname,2); 10942d747510SLisandro Dalcin PetscValidCharPointer(oldname,3); 10952d747510SLisandro Dalcin options = options ? options : defaultoptions; 10969210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(newname,&valid);CHKERRQ(ierr); 10979210b8eaSVaclav Hapla if (!valid) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid aliased option %s",newname); 10989210b8eaSVaclav Hapla ierr = PetscOptionsValidKey(oldname,&valid);CHKERRQ(ierr); 10999210b8eaSVaclav Hapla if (!valid) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid aliasee option %s",oldname); 11002d747510SLisandro Dalcin 11012d747510SLisandro Dalcin n = options->Naliases; 11022d747510SLisandro 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); 11032d747510SLisandro Dalcin 11042d747510SLisandro Dalcin newname++; oldname++; 11052d747510SLisandro Dalcin ierr = PetscStrlen(newname,&len);CHKERRQ(ierr); 11062d747510SLisandro Dalcin options->aliases1[n] = (char*)malloc((len+1)*sizeof(char)); 11072d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases1[n],newname);CHKERRQ(ierr); 11082d747510SLisandro Dalcin ierr = PetscStrlen(oldname,&len);CHKERRQ(ierr); 11092d747510SLisandro Dalcin options->aliases2[n] = (char*)malloc((len+1)*sizeof(char)); 11102d747510SLisandro Dalcin ierr = PetscStrcpy(options->aliases2[n],oldname);CHKERRQ(ierr); 11112d747510SLisandro Dalcin options->Naliases++; 11122d747510SLisandro Dalcin PetscFunctionReturn(0); 11132d747510SLisandro Dalcin } 11144416b707SBarry Smith 1115e5c89e4eSSatish Balay /*@C 1116e5c89e4eSSatish Balay PetscOptionsSetValue - Sets an option name-value pair in the options 1117e5c89e4eSSatish Balay database, overriding whatever is already present. 1118e5c89e4eSSatish Balay 11191c9f3c13SBarry Smith Logically Collective 1120e5c89e4eSSatish Balay 1121e5c89e4eSSatish Balay Input Parameters: 1122c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1123c5929fdfSBarry Smith . name - name of option, this SHOULD have the - prepended 11242d747510SLisandro Dalcin - value - the option value (not used for all options, so can be NULL) 1125e5c89e4eSSatish Balay 1126e5c89e4eSSatish Balay Level: intermediate 1127e5c89e4eSSatish Balay 1128e5c89e4eSSatish Balay Note: 1129d49172ceSBarry Smith This function can be called BEFORE PetscInitialize() 1130d49172ceSBarry Smith 11319666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 11321c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 11331c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 11341c9f3c13SBarry Smith on different ranks. 11351c9f3c13SBarry Smith 11362d747510SLisandro Dalcin Developers Note: Uses malloc() directly because PETSc may not be initialized yet. 1137b0250c70SBarry Smith 11382d747510SLisandro Dalcin .seealso: PetscOptionsInsert(), PetscOptionsClearValue() 1139e5c89e4eSSatish Balay @*/ 11402d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetValue(PetscOptions options,const char name[],const char value[]) 1141e5c89e4eSSatish Balay { 1142c5b5d8d5SVaclav Hapla return PetscOptionsSetValue_Private(options,name,value,NULL); 1143c5b5d8d5SVaclav Hapla } 1144c5b5d8d5SVaclav Hapla 1145c5b5d8d5SVaclav Hapla static PetscErrorCode PetscOptionsSetValue_Private(PetscOptions options,const char name[],const char value[],int *pos) 1146c5b5d8d5SVaclav Hapla { 1147e5c89e4eSSatish Balay size_t len; 11482d747510SLisandro Dalcin int N,n,i; 1149e5c89e4eSSatish Balay char **names; 11502d747510SLisandro Dalcin char fullname[MAXOPTNAME] = ""; 1151c5b5d8d5SVaclav Hapla PetscBool flg; 11522d747510SLisandro Dalcin PetscErrorCode ierr; 1153e5c89e4eSSatish Balay 11547272c0d2SVaclav Hapla if (!options) { 11552d747510SLisandro Dalcin ierr = PetscOptionsCreateDefault();if (ierr) return ierr; 11567272c0d2SVaclav Hapla options = defaultoptions; 1157c5929fdfSBarry Smith } 11582d747510SLisandro Dalcin 11592d747510SLisandro Dalcin if (name[0] != '-') return PETSC_ERR_ARG_OUTOFRANGE; 1160e5c89e4eSSatish Balay 1161c5b5d8d5SVaclav Hapla ierr = PetscOptionsSkipPrecedent(options,name,&flg);CHKERRQ(ierr); 1162c5b5d8d5SVaclav Hapla if (flg) return 0; 1163e5c89e4eSSatish Balay 11642d747510SLisandro Dalcin name++; /* skip starting dash */ 11652d747510SLisandro Dalcin 116674e0666dSJed Brown if (options->prefixind > 0) { 1167d49172ceSBarry Smith strncpy(fullname,options->prefix,sizeof(fullname)); 11682d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 116989ae1891SBarry Smith strncat(fullname,name,sizeof(fullname)-strlen(fullname)-1); 11702d747510SLisandro Dalcin fullname[sizeof(fullname)-1] = 0; 117174e0666dSJed Brown name = fullname; 117274e0666dSJed Brown } 117374e0666dSJed Brown 117474e0666dSJed Brown /* check against aliases */ 1175e5c89e4eSSatish Balay N = options->Naliases; 1176e5c89e4eSSatish Balay for (i=0; i<N; i++) { 11772d747510SLisandro Dalcin int result = PetscOptNameCmp(options->aliases1[i],name); 11782d747510SLisandro Dalcin if (!result) { name = options->aliases2[i]; break; } 1179e5c89e4eSSatish Balay } 1180e5c89e4eSSatish Balay 11812d747510SLisandro Dalcin /* slow search */ 11822d747510SLisandro Dalcin N = n = options->N; 1183e5c89e4eSSatish Balay names = options->names; 1184e5c89e4eSSatish Balay for (i=0; i<N; i++) { 11852d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 11862d747510SLisandro Dalcin if (!result) { 11872d747510SLisandro Dalcin n = i; goto setvalue; 11882d747510SLisandro Dalcin } else if (result > 0) { 11892d747510SLisandro Dalcin n = i; break; 1190e5c89e4eSSatish Balay } 1191e5c89e4eSSatish Balay } 11922d747510SLisandro Dalcin if (N >= MAXOPTIONS) return PETSC_ERR_MEM; 11932d747510SLisandro Dalcin /* shift remaining values up 1 */ 1194e5c89e4eSSatish Balay for (i=N; i>n; i--) { 11955e8c5e88SLisandro Dalcin options->names[i] = options->names[i-1]; 1196e5c89e4eSSatish Balay options->values[i] = options->values[i-1]; 1197e5c89e4eSSatish Balay options->used[i] = options->used[i-1]; 1198e5c89e4eSSatish Balay } 11992d747510SLisandro Dalcin options->names[n] = NULL; 12002d747510SLisandro Dalcin options->values[n] = NULL; 12012d747510SLisandro Dalcin options->used[n] = PETSC_FALSE; 12022d747510SLisandro Dalcin options->N++; 12032d747510SLisandro Dalcin 12042d747510SLisandro Dalcin /* destroy hash table */ 12052d747510SLisandro Dalcin kh_destroy(HO,options->ht); 12062d747510SLisandro Dalcin options->ht = NULL; 12072d747510SLisandro Dalcin 12082d747510SLisandro Dalcin /* set new name */ 120970d8d27cSBarry Smith len = strlen(name); 12105e8c5e88SLisandro Dalcin options->names[n] = (char*)malloc((len+1)*sizeof(char)); 1211d49172ceSBarry Smith if (!options->names[n]) return PETSC_ERR_MEM; 1212d49172ceSBarry Smith strcpy(options->names[n],name); 12132d747510SLisandro Dalcin 12142d747510SLisandro Dalcin setvalue: 12152d747510SLisandro Dalcin /* set new value */ 12162d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1217d49172ceSBarry Smith len = value ? strlen(value) : 0; 12185e8c5e88SLisandro Dalcin if (len) { 1219e5c89e4eSSatish Balay options->values[n] = (char*)malloc((len+1)*sizeof(char)); 1220d49172ceSBarry Smith if (!options->values[n]) return PETSC_ERR_MEM; 1221d49172ceSBarry Smith strcpy(options->values[n],value); 12222d747510SLisandro Dalcin } else { 12232d747510SLisandro Dalcin options->values[n] = NULL; 12242d747510SLisandro Dalcin } 12252d747510SLisandro Dalcin 122691ad3481SVaclav Hapla /* handle -help so that it can be set from anywhere */ 122791ad3481SVaclav Hapla if (!PetscOptNameCmp(name,"help")) { 122891ad3481SVaclav Hapla options->help = PETSC_TRUE; 122991ad3481SVaclav Hapla ierr = PetscStrcasecmp(value, "intro", &options->help_intro);CHKERRQ(ierr); 123091ad3481SVaclav Hapla options->used[n] = PETSC_TRUE; 123191ad3481SVaclav Hapla } 123291ad3481SVaclav Hapla 1233c5b5d8d5SVaclav Hapla if (PetscErrorHandlingInitialized) { 1234c5b5d8d5SVaclav Hapla ierr = PetscOptionsMonitor(options,name,value);CHKERRQ(ierr); 1235c5b5d8d5SVaclav Hapla } 1236c5b5d8d5SVaclav Hapla if (pos) *pos = n; 1237d49172ceSBarry Smith return 0; 1238e5c89e4eSSatish Balay } 1239e5c89e4eSSatish Balay 1240e5c89e4eSSatish Balay /*@C 1241e5c89e4eSSatish Balay PetscOptionsClearValue - Clears an option name-value pair in the options 1242e5c89e4eSSatish Balay database, overriding whatever is already present. 1243e5c89e4eSSatish Balay 12441c9f3c13SBarry Smith Logically Collective 1245e5c89e4eSSatish Balay 1246e5c89e4eSSatish Balay Input Parameter: 1247c5929fdfSBarry Smith + options - options database, use NULL for the default global database 1248a2b725a8SWilliam Gropp - name - name of option, this SHOULD have the - prepended 1249e5c89e4eSSatish Balay 1250e5c89e4eSSatish Balay Level: intermediate 1251e5c89e4eSSatish Balay 12529666a313SBarry Smith The collectivity of this routine is complex; only the MPI processes that call this routine will 12531c9f3c13SBarry Smith have the affect of these options. If some processes that create objects call this routine and others do 12541c9f3c13SBarry Smith not the code may fail in complicated ways because the same parallel solvers may incorrectly use different options 12551c9f3c13SBarry Smith on different ranks. 12561c9f3c13SBarry Smith 1257e5c89e4eSSatish Balay .seealso: PetscOptionsInsert() 1258e5c89e4eSSatish Balay @*/ 12592d747510SLisandro Dalcin PetscErrorCode PetscOptionsClearValue(PetscOptions options,const char name[]) 1260e5c89e4eSSatish Balay { 12612d747510SLisandro Dalcin int N,n,i; 12622d747510SLisandro Dalcin char **names; 1263e5c89e4eSSatish Balay PetscErrorCode ierr; 1264e5c89e4eSSatish Balay 1265e5c89e4eSSatish Balay PetscFunctionBegin; 1266c5929fdfSBarry Smith options = options ? options : defaultoptions; 12672d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1268c9dcd962SLisandro Dalcin if (!PetscOptNameCmp(name,"-help")) options->help = options->help_intro = PETSC_FALSE; 12692d747510SLisandro Dalcin 12702d747510SLisandro Dalcin name++; /* skip starting dash */ 12712d747510SLisandro Dalcin 12722d747510SLisandro Dalcin /* slow search */ 12732d747510SLisandro Dalcin N = n = options->N; 1274e5c89e4eSSatish Balay names = options->names; 1275e5c89e4eSSatish Balay for (i=0; i<N; i++) { 12762d747510SLisandro Dalcin int result = PetscOptNameCmp(names[i],name); 12772d747510SLisandro Dalcin if (!result) { 12782d747510SLisandro Dalcin n = i; break; 12792d747510SLisandro Dalcin } else if (result > 0) { 12802d747510SLisandro Dalcin n = N; break; 1281e5c89e4eSSatish Balay } 12822d747510SLisandro Dalcin } 12832d747510SLisandro Dalcin if (n == N) PetscFunctionReturn(0); /* it was not present */ 1284e5c89e4eSSatish Balay 12852d747510SLisandro Dalcin /* remove name and value */ 12862d747510SLisandro Dalcin if (options->names[n]) free(options->names[n]); 12872d747510SLisandro Dalcin if (options->values[n]) free(options->values[n]); 1288e5c89e4eSSatish Balay /* shift remaining values down 1 */ 1289e5c89e4eSSatish Balay for (i=n; i<N-1; i++) { 12905e8c5e88SLisandro Dalcin options->names[i] = options->names[i+1]; 1291e5c89e4eSSatish Balay options->values[i] = options->values[i+1]; 1292e5c89e4eSSatish Balay options->used[i] = options->used[i+1]; 1293e5c89e4eSSatish Balay } 1294e5c89e4eSSatish Balay options->N--; 12952d747510SLisandro Dalcin 12962d747510SLisandro Dalcin /* destroy hash table */ 12972d747510SLisandro Dalcin kh_destroy(HO,options->ht); 12982d747510SLisandro Dalcin options->ht = NULL; 12992d747510SLisandro Dalcin 13002d747510SLisandro Dalcin ierr = PetscOptionsMonitor(options,name,NULL);CHKERRQ(ierr); 1301e5c89e4eSSatish Balay PetscFunctionReturn(0); 1302e5c89e4eSSatish Balay } 1303e5c89e4eSSatish Balay 1304e5c89e4eSSatish Balay /*@C 13052d747510SLisandro Dalcin PetscOptionsFindPair - Gets an option name-value pair from the options database. 1306e5c89e4eSSatish Balay 13072d747510SLisandro Dalcin Not Collective 1308e5c89e4eSSatish Balay 1309e5c89e4eSSatish Balay Input Parameters: 13102d747510SLisandro Dalcin + options - options database, use NULL for the default global database 13112d747510SLisandro Dalcin . pre - the string to prepend to the name or NULL, this SHOULD NOT have the "-" prepended 13122d747510SLisandro Dalcin - name - name of option, this SHOULD have the "-" prepended 1313e5c89e4eSSatish Balay 13142d747510SLisandro Dalcin Output Parameters: 13152d747510SLisandro Dalcin + value - the option value (optional, not used for all options) 13162d747510SLisandro Dalcin - set - whether the option is set (optional) 1317e5c89e4eSSatish Balay 13189666a313SBarry Smith Notes: 13199666a313SBarry Smith Each process may find different values or no value depending on how options were inserted into the database 13201c9f3c13SBarry Smith 13212d747510SLisandro Dalcin Level: developer 13222d747510SLisandro Dalcin 13232d747510SLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsClearValue() 1324e5c89e4eSSatish Balay @*/ 13252d747510SLisandro Dalcin PetscErrorCode PetscOptionsFindPair(PetscOptions options,const char pre[],const char name[],const char *value[],PetscBool *set) 1326e5c89e4eSSatish Balay { 13272d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1328daabea38SBarry Smith PetscBool usehashtable = PETSC_TRUE; 13292d747510SLisandro Dalcin PetscBool matchnumbers = PETSC_TRUE; 1330e5c89e4eSSatish Balay PetscErrorCode ierr; 1331e5c89e4eSSatish Balay 1332e5c89e4eSSatish Balay PetscFunctionBegin; 1333c5929fdfSBarry Smith options = options ? options : defaultoptions; 13342d747510SLisandro Dalcin if (pre && PetscUnlikely(pre[0] == '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 13352d747510SLisandro Dalcin if (PetscUnlikely(name[0] != '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1336e5c89e4eSSatish Balay 13372d747510SLisandro Dalcin name++; /* skip starting dash */ 1338e5c89e4eSSatish Balay 13397cd08cecSJed Brown /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 13402d747510SLisandro Dalcin if (pre && pre[0]) { 13412d747510SLisandro Dalcin char *ptr = buf; 13422d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 13432d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,buf+sizeof(buf)-ptr);CHKERRQ(ierr); 13442d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 13452d747510SLisandro Dalcin name = buf; 13467cd08cecSJed Brown } 13472d747510SLisandro Dalcin 134876bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 13492f828895SJed Brown PetscBool valid; 13502d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 13512d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 13522f828895SJed Brown ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 13532f828895SJed 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); 13542f828895SJed Brown } 1355e5c89e4eSSatish Balay 13562d747510SLisandro Dalcin if (!options->ht && usehashtable) { 13572d747510SLisandro Dalcin int i,ret; 13582d747510SLisandro Dalcin khiter_t it; 13592d747510SLisandro Dalcin khash_t(HO) *ht; 13602d747510SLisandro Dalcin ht = kh_init(HO); 13612d747510SLisandro Dalcin if (PetscUnlikely(!ht)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13622d747510SLisandro Dalcin ret = kh_resize(HO,ht,options->N*2); /* twice the required size to reduce risk of collisions */ 13632d747510SLisandro Dalcin if (PetscUnlikely(ret)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13642d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 13652d747510SLisandro Dalcin it = kh_put(HO,ht,options->names[i],&ret); 13662d747510SLisandro Dalcin if (PetscUnlikely(ret != 1)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed"); 13672d747510SLisandro Dalcin kh_val(ht,it) = i; 13682d747510SLisandro Dalcin } 13692d747510SLisandro Dalcin options->ht = ht; 13702d747510SLisandro Dalcin } 13712d747510SLisandro Dalcin 13722d747510SLisandro Dalcin if (usehashtable) 13732d747510SLisandro Dalcin { /* fast search */ 13742d747510SLisandro Dalcin khash_t(HO) *ht = options->ht; 13752d747510SLisandro Dalcin khiter_t it = kh_get(HO,ht,name); 13762d747510SLisandro Dalcin if (it != kh_end(ht)) { 13772d747510SLisandro Dalcin int i = kh_val(ht,it); 1378e5c89e4eSSatish Balay options->used[i] = PETSC_TRUE; 13792d747510SLisandro Dalcin if (value) *value = options->values[i]; 13802d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 13812d747510SLisandro Dalcin PetscFunctionReturn(0); 13822d747510SLisandro Dalcin } 13832d747510SLisandro Dalcin } else 13842d747510SLisandro Dalcin { /* slow search */ 13852d747510SLisandro Dalcin int i, N = options->N; 13862d747510SLisandro Dalcin for (i=0; i<N; i++) { 1387daabea38SBarry Smith int result = PetscOptNameCmp(options->names[i],name); 13882d747510SLisandro Dalcin if (!result) { 13892d747510SLisandro Dalcin options->used[i] = PETSC_TRUE; 13902d747510SLisandro Dalcin if (value) *value = options->values[i]; 13912d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 13922d747510SLisandro Dalcin PetscFunctionReturn(0); 13932d747510SLisandro Dalcin } else if (result > 0) { 1394e5c89e4eSSatish Balay break; 1395e5c89e4eSSatish Balay } 1396e5c89e4eSSatish Balay } 13972d747510SLisandro Dalcin } 13982d747510SLisandro Dalcin 13992d747510SLisandro Dalcin /* 14002d747510SLisandro Dalcin The following block slows down all lookups in the most frequent path (most lookups are unsuccessful). 14012d747510SLisandro Dalcin Maybe this special lookup mode should be enabled on request with a push/pop API. 14022d747510SLisandro Dalcin The feature of matching _%d_ used sparingly in the codebase. 14032d747510SLisandro Dalcin */ 14042d747510SLisandro Dalcin if (matchnumbers) { 14052d747510SLisandro Dalcin int i,j,cnt = 0,locs[16],loce[16]; 1406e5c89e4eSSatish Balay /* determine the location and number of all _%d_ in the key */ 14072d747510SLisandro Dalcin for (i=0; name[i]; i++) { 14082d747510SLisandro Dalcin if (name[i] == '_') { 14092d747510SLisandro Dalcin for (j=i+1; name[j]; j++) { 14102d747510SLisandro Dalcin if (name[j] >= '0' && name[j] <= '9') continue; 14112d747510SLisandro Dalcin if (name[j] == '_' && j > i+1) { /* found a number */ 1412e5c89e4eSSatish Balay locs[cnt] = i+1; 1413e5c89e4eSSatish Balay loce[cnt++] = j+1; 1414e5c89e4eSSatish Balay } 14152d747510SLisandro Dalcin i = j-1; 1416e5c89e4eSSatish Balay break; 1417e5c89e4eSSatish Balay } 1418e5c89e4eSSatish Balay } 1419e5c89e4eSSatish Balay } 1420e5c89e4eSSatish Balay for (i=0; i<cnt; i++) { 14212d747510SLisandro Dalcin PetscBool found; 14222d747510SLisandro Dalcin char opt[MAXOPTNAME+1] = "-", tmp[MAXOPTNAME]; 14232d747510SLisandro Dalcin ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[i]+1),sizeof(tmp)));CHKERRQ(ierr); 14242d747510SLisandro Dalcin ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 14252d747510SLisandro Dalcin ierr = PetscStrlcat(opt,name+loce[i],sizeof(opt));CHKERRQ(ierr); 14262d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,NULL,opt,value,&found);CHKERRQ(ierr); 14272d747510SLisandro Dalcin if (found) {if (set) *set = PETSC_TRUE; PetscFunctionReturn(0);} 1428e5c89e4eSSatish Balay } 1429e5c89e4eSSatish Balay } 14302d747510SLisandro Dalcin 14312d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1432e5c89e4eSSatish Balay PetscFunctionReturn(0); 1433e5c89e4eSSatish Balay } 1434e5c89e4eSSatish Balay 1435d6ced9c0SMatthew G. Knepley /* Check whether any option begins with pre+name */ 14362d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions options,const char pre[], const char name[],const char *value[],PetscBool *set) 1437514bf10dSMatthew G Knepley { 14382d747510SLisandro Dalcin char buf[MAXOPTNAME]; 1439d6ced9c0SMatthew G. Knepley int numCnt = 0, locs[16],loce[16]; 1440514bf10dSMatthew G Knepley PetscErrorCode ierr; 1441514bf10dSMatthew G Knepley 1442514bf10dSMatthew G Knepley PetscFunctionBegin; 1443c5929fdfSBarry Smith options = options ? options : defaultoptions; 14442d747510SLisandro Dalcin if (pre && pre[0] == '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre); 14452d747510SLisandro Dalcin if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name); 1446514bf10dSMatthew G Knepley 14472d747510SLisandro Dalcin name++; /* skip starting dash */ 1448514bf10dSMatthew G Knepley 1449514bf10dSMatthew G Knepley /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */ 14502d747510SLisandro Dalcin if (pre && pre[0]) { 14512d747510SLisandro Dalcin char *ptr = buf; 14522d747510SLisandro Dalcin if (name[0] == '-') { *ptr++ = '-'; name++; } 14532d747510SLisandro Dalcin ierr = PetscStrncpy(ptr,pre,sizeof(buf)+(size_t)(ptr-buf));CHKERRQ(ierr); 14542d747510SLisandro Dalcin ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr); 14552d747510SLisandro Dalcin name = buf; 1456514bf10dSMatthew G Knepley } 14572d747510SLisandro Dalcin 145876bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1459514bf10dSMatthew G Knepley PetscBool valid; 14602d747510SLisandro Dalcin char key[MAXOPTNAME+1] = "-"; 14612d747510SLisandro Dalcin ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr); 1462514bf10dSMatthew G Knepley ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr); 1463514bf10dSMatthew 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); 1464514bf10dSMatthew G Knepley } 1465514bf10dSMatthew G Knepley 1466d6ced9c0SMatthew G. Knepley /* determine the location and number of all _%d_ in the key */ 1467d6ced9c0SMatthew G. Knepley { 1468d6ced9c0SMatthew G. Knepley int i,j; 1469d6ced9c0SMatthew G. Knepley for (i=0; name[i]; i++) { 1470d6ced9c0SMatthew G. Knepley if (name[i] == '_') { 1471d6ced9c0SMatthew G. Knepley for (j=i+1; name[j]; j++) { 1472d6ced9c0SMatthew G. Knepley if (name[j] >= '0' && name[j] <= '9') continue; 1473d6ced9c0SMatthew G. Knepley if (name[j] == '_' && j > i+1) { /* found a number */ 1474d6ced9c0SMatthew G. Knepley locs[numCnt] = i+1; 1475d6ced9c0SMatthew G. Knepley loce[numCnt++] = j+1; 1476d6ced9c0SMatthew G. Knepley } 1477d6ced9c0SMatthew G. Knepley i = j-1; 1478d6ced9c0SMatthew G. Knepley break; 1479d6ced9c0SMatthew G. Knepley } 1480d6ced9c0SMatthew G. Knepley } 1481d6ced9c0SMatthew G. Knepley } 1482d6ced9c0SMatthew G. Knepley } 1483d6ced9c0SMatthew G. Knepley 14842d747510SLisandro Dalcin { /* slow search */ 1485d6ced9c0SMatthew G. Knepley int c, i; 14862d747510SLisandro Dalcin size_t len; 14872d747510SLisandro Dalcin PetscBool match; 1488d6ced9c0SMatthew G. Knepley 1489d6ced9c0SMatthew G. Knepley for (c = -1; c < numCnt; ++c) { 1490d6ced9c0SMatthew G. Knepley char opt[MAXOPTNAME+1] = "", tmp[MAXOPTNAME]; 1491d6ced9c0SMatthew G. Knepley 1492d6ced9c0SMatthew G. Knepley if (c < 0) { 1493d6ced9c0SMatthew G. Knepley ierr = PetscStrcpy(opt,name);CHKERRQ(ierr); 1494d6ced9c0SMatthew G. Knepley } else { 1495d6ced9c0SMatthew G. Knepley ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[c]+1),sizeof(tmp)));CHKERRQ(ierr); 1496d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr); 1497d6ced9c0SMatthew G. Knepley ierr = PetscStrlcat(opt,name+loce[c],sizeof(opt));CHKERRQ(ierr); 1498d6ced9c0SMatthew G. Knepley } 1499d6ced9c0SMatthew G. Knepley ierr = PetscStrlen(opt,&len);CHKERRQ(ierr); 15002d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 1501d6ced9c0SMatthew G. Knepley ierr = PetscStrncmp(options->names[i],opt,len,&match);CHKERRQ(ierr); 1502514bf10dSMatthew G Knepley if (match) { 1503514bf10dSMatthew G Knepley options->used[i] = PETSC_TRUE; 15042d747510SLisandro Dalcin if (value) *value = options->values[i]; 15052d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 15062d747510SLisandro Dalcin PetscFunctionReturn(0); 1507514bf10dSMatthew G Knepley } 1508514bf10dSMatthew G Knepley } 15092d747510SLisandro Dalcin } 1510d6ced9c0SMatthew G. Knepley } 15112d747510SLisandro Dalcin 15122d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 1513514bf10dSMatthew G Knepley PetscFunctionReturn(0); 1514514bf10dSMatthew G Knepley } 1515514bf10dSMatthew G Knepley 1516e5c89e4eSSatish Balay /*@C 1517e5c89e4eSSatish Balay PetscOptionsReject - Generates an error if a certain option is given. 1518e5c89e4eSSatish Balay 15191c9f3c13SBarry Smith Not Collective 1520e5c89e4eSSatish Balay 1521e5c89e4eSSatish Balay Input Parameters: 15225c9cc608SHong Zhang + options - options database, use NULL for default global database 15232d747510SLisandro Dalcin . pre - the option prefix (may be NULL) 15242d747510SLisandro Dalcin . name - the option name one is seeking 15250298fd71SBarry Smith - mess - error message (may be NULL) 1526e5c89e4eSSatish Balay 1527e5c89e4eSSatish Balay Level: advanced 1528e5c89e4eSSatish Balay 1529e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(), 1530acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1531e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1532e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1533acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1534a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1535e5c89e4eSSatish Balay @*/ 15362d747510SLisandro Dalcin PetscErrorCode PetscOptionsReject(PetscOptions options,const char pre[],const char name[],const char mess[]) 1537e5c89e4eSSatish Balay { 1538e5c89e4eSSatish Balay PetscErrorCode ierr; 1539ace3abfcSBarry Smith PetscBool flag = PETSC_FALSE; 1540e5c89e4eSSatish Balay 1541e5c89e4eSSatish Balay PetscFunctionBegin; 15422d747510SLisandro Dalcin ierr = PetscOptionsHasName(options,pre,name,&flag);CHKERRQ(ierr); 1543e5c89e4eSSatish Balay if (flag) { 15442d747510SLisandro 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); 15452d747510SLisandro Dalcin else SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s",pre?pre:"",name+1); 1546e5c89e4eSSatish Balay } 1547e5c89e4eSSatish Balay PetscFunctionReturn(0); 1548e5c89e4eSSatish Balay } 1549e5c89e4eSSatish Balay 1550e5c89e4eSSatish Balay /*@C 15512d747510SLisandro Dalcin PetscOptionsHasHelp - Determines whether the "-help" option is in the database. 15522d747510SLisandro Dalcin 15532d747510SLisandro Dalcin Not Collective 15542d747510SLisandro Dalcin 15552d747510SLisandro Dalcin Input Parameters: 15562d747510SLisandro Dalcin . options - options database, use NULL for default global database 15572d747510SLisandro Dalcin 15582d747510SLisandro Dalcin Output Parameters: 15592d747510SLisandro Dalcin . set - PETSC_TRUE if found else PETSC_FALSE. 15602d747510SLisandro Dalcin 15612d747510SLisandro Dalcin Level: advanced 15622d747510SLisandro Dalcin 15632d747510SLisandro Dalcin .seealso: PetscOptionsHasName() 15642d747510SLisandro Dalcin @*/ 15652d747510SLisandro Dalcin PetscErrorCode PetscOptionsHasHelp(PetscOptions options,PetscBool *set) 15662d747510SLisandro Dalcin { 15672d747510SLisandro Dalcin PetscFunctionBegin; 15682d747510SLisandro Dalcin PetscValidPointer(set,2); 15692d747510SLisandro Dalcin options = options ? options : defaultoptions; 15702d747510SLisandro Dalcin *set = options->help; 15712d747510SLisandro Dalcin PetscFunctionReturn(0); 15722d747510SLisandro Dalcin } 15732d747510SLisandro Dalcin 1574d314f959SVaclav Hapla PetscErrorCode PetscOptionsHasHelpIntro_Internal(PetscOptions options,PetscBool *set) 1575d314f959SVaclav Hapla { 1576d314f959SVaclav Hapla PetscFunctionBegin; 1577d314f959SVaclav Hapla PetscValidPointer(set,2); 1578d314f959SVaclav Hapla options = options ? options : defaultoptions; 1579d314f959SVaclav Hapla *set = options->help_intro; 1580d314f959SVaclav Hapla PetscFunctionReturn(0); 1581d314f959SVaclav Hapla } 1582d314f959SVaclav Hapla 15832d747510SLisandro Dalcin /*@C 158490d69ab7SBarry 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 158590d69ab7SBarry Smith its value is set to false. 1586e5c89e4eSSatish Balay 1587e5c89e4eSSatish Balay Not Collective 1588e5c89e4eSSatish Balay 1589e5c89e4eSSatish Balay Input Parameters: 15905c9cc608SHong Zhang + options - options database, use NULL for default global database 15913de71b31SHong Zhang . pre - string to prepend to the name or NULL 15923de71b31SHong Zhang - name - the option one is seeking 1593e5c89e4eSSatish Balay 1594e5c89e4eSSatish Balay Output Parameters: 159596ef3cdfSSatish Balay . set - PETSC_TRUE if found else PETSC_FALSE. 1596e5c89e4eSSatish Balay 1597e5c89e4eSSatish Balay Level: beginner 1598e5c89e4eSSatish Balay 159995452b02SPatrick Sanan Notes: 1600acfcf0e5SJed Brown In many cases you probably want to use PetscOptionsGetBool() instead of calling this, to allowing toggling values. 160190d69ab7SBarry Smith 1602e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 1603f3e3d7dfSBarry Smith PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 1604e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 1605e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 1606acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 1607a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 1608e5c89e4eSSatish Balay @*/ 1609c5929fdfSBarry Smith PetscErrorCode PetscOptionsHasName(PetscOptions options,const char pre[],const char name[],PetscBool *set) 1610e5c89e4eSSatish Balay { 16112d747510SLisandro Dalcin const char *value; 1612e5c89e4eSSatish Balay PetscErrorCode ierr; 1613ace3abfcSBarry Smith PetscBool flag; 1614e5c89e4eSSatish Balay 1615e5c89e4eSSatish Balay PetscFunctionBegin; 16162d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 161796ef3cdfSSatish Balay if (set) *set = flag; 1618e5c89e4eSSatish Balay PetscFunctionReturn(0); 1619e5c89e4eSSatish Balay } 1620e5c89e4eSSatish Balay 1621e5c89e4eSSatish Balay /*@C 16222d747510SLisandro Dalcin PetscOptionsGetAll - Lists all the options the program was run with in a single string. 16232d747510SLisandro Dalcin 16242d747510SLisandro Dalcin Not Collective 16252d747510SLisandro Dalcin 1626fd292e60Sprj- Input Parameter: 16272d747510SLisandro Dalcin . options - the options database, use NULL for the default global database 16282d747510SLisandro Dalcin 16292d747510SLisandro Dalcin Output Parameter: 16302d747510SLisandro Dalcin . copts - pointer where string pointer is stored 16312d747510SLisandro Dalcin 16322d747510SLisandro Dalcin Notes: 16331c9f3c13SBarry Smith The array and each entry in the array should be freed with PetscFree() 16341c9f3c13SBarry Smith Each process may have different values depending on how the options were inserted into the database 16352d747510SLisandro Dalcin 16362d747510SLisandro Dalcin Level: advanced 16372d747510SLisandro Dalcin 16381c9f3c13SBarry Smith .seealso: PetscOptionsAllUsed(), PetscOptionsView(), PetscOptionsPush(), PetscOptionsPop() 16392d747510SLisandro Dalcin @*/ 16402d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetAll(PetscOptions options,char *copts[]) 16412d747510SLisandro Dalcin { 16422d747510SLisandro Dalcin PetscErrorCode ierr; 16432d747510SLisandro Dalcin PetscInt i; 16442d747510SLisandro Dalcin size_t len = 1,lent = 0; 16452d747510SLisandro Dalcin char *coptions = NULL; 16462d747510SLisandro Dalcin 16472d747510SLisandro Dalcin PetscFunctionBegin; 16482d747510SLisandro Dalcin PetscValidPointer(copts,2); 16492d747510SLisandro Dalcin options = options ? options : defaultoptions; 16502d747510SLisandro Dalcin /* count the length of the required string */ 16512d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16522d747510SLisandro Dalcin ierr = PetscStrlen(options->names[i],&lent);CHKERRQ(ierr); 16532d747510SLisandro Dalcin len += 2 + lent; 16542d747510SLisandro Dalcin if (options->values[i]) { 16552d747510SLisandro Dalcin ierr = PetscStrlen(options->values[i],&lent);CHKERRQ(ierr); 16562d747510SLisandro Dalcin len += 1 + lent; 16572d747510SLisandro Dalcin } 16582d747510SLisandro Dalcin } 16592d747510SLisandro Dalcin ierr = PetscMalloc1(len,&coptions);CHKERRQ(ierr); 16602d747510SLisandro Dalcin coptions[0] = 0; 16612d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 16622d747510SLisandro Dalcin ierr = PetscStrcat(coptions,"-");CHKERRQ(ierr); 16632d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->names[i]);CHKERRQ(ierr); 16642d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 16652d747510SLisandro Dalcin if (options->values[i]) { 16662d747510SLisandro Dalcin ierr = PetscStrcat(coptions,options->values[i]);CHKERRQ(ierr); 16672d747510SLisandro Dalcin ierr = PetscStrcat(coptions," ");CHKERRQ(ierr); 16682d747510SLisandro Dalcin } 16692d747510SLisandro Dalcin } 16702d747510SLisandro Dalcin *copts = coptions; 16712d747510SLisandro Dalcin PetscFunctionReturn(0); 16722d747510SLisandro Dalcin } 16732d747510SLisandro Dalcin 16742d747510SLisandro Dalcin /*@C 16752d747510SLisandro Dalcin PetscOptionsUsed - Indicates if PETSc has used a particular option set in the database 16762d747510SLisandro Dalcin 16772d747510SLisandro Dalcin Not Collective 16782d747510SLisandro Dalcin 16792d747510SLisandro Dalcin Input Parameter: 16802d747510SLisandro Dalcin + options - options database, use NULL for default global database 16812d747510SLisandro Dalcin - name - string name of option 16822d747510SLisandro Dalcin 16832d747510SLisandro Dalcin Output Parameter: 16842d747510SLisandro Dalcin . used - PETSC_TRUE if the option was used, otherwise false, including if option was not found in options database 16852d747510SLisandro Dalcin 16862d747510SLisandro Dalcin Level: advanced 16872d747510SLisandro Dalcin 16889666a313SBarry Smith Notes: 16899666a313SBarry Smith The value returned may be different on each process and depends on which options have been processed 16901c9f3c13SBarry Smith on the given process 16911c9f3c13SBarry Smith 16922d747510SLisandro Dalcin .seealso: PetscOptionsView(), PetscOptionsLeft(), PetscOptionsAllUsed() 16932d747510SLisandro Dalcin @*/ 16942d747510SLisandro Dalcin PetscErrorCode PetscOptionsUsed(PetscOptions options,const char *name,PetscBool *used) 16952d747510SLisandro Dalcin { 16962d747510SLisandro Dalcin PetscInt i; 16972d747510SLisandro Dalcin PetscErrorCode ierr; 16982d747510SLisandro Dalcin 16992d747510SLisandro Dalcin PetscFunctionBegin; 17002d747510SLisandro Dalcin PetscValidCharPointer(name,2); 17012d747510SLisandro Dalcin PetscValidPointer(used,3); 17022d747510SLisandro Dalcin options = options ? options : defaultoptions; 17032d747510SLisandro Dalcin *used = PETSC_FALSE; 17042d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 1705ee42b8b3SLisandro Dalcin ierr = PetscStrcasecmp(options->names[i],name,used);CHKERRQ(ierr); 17062d747510SLisandro Dalcin if (*used) { 17072d747510SLisandro Dalcin *used = options->used[i]; 17082d747510SLisandro Dalcin break; 17092d747510SLisandro Dalcin } 17102d747510SLisandro Dalcin } 17112d747510SLisandro Dalcin PetscFunctionReturn(0); 17122d747510SLisandro Dalcin } 17132d747510SLisandro Dalcin 1714487a658cSBarry Smith /*@ 17152d747510SLisandro Dalcin PetscOptionsAllUsed - Returns a count of the number of options in the 17162d747510SLisandro Dalcin database that have never been selected. 17172d747510SLisandro Dalcin 17182d747510SLisandro Dalcin Not Collective 17192d747510SLisandro Dalcin 17202d747510SLisandro Dalcin Input Parameter: 17212d747510SLisandro Dalcin . options - options database, use NULL for default global database 17222d747510SLisandro Dalcin 17232d747510SLisandro Dalcin Output Parameter: 17242d747510SLisandro Dalcin . N - count of options not used 17252d747510SLisandro Dalcin 17262d747510SLisandro Dalcin Level: advanced 17272d747510SLisandro Dalcin 17289666a313SBarry Smith Notes: 17299666a313SBarry Smith The value returned may be different on each process and depends on which options have been processed 17301c9f3c13SBarry Smith on the given process 17311c9f3c13SBarry Smith 17322d747510SLisandro Dalcin .seealso: PetscOptionsView() 17332d747510SLisandro Dalcin @*/ 17342d747510SLisandro Dalcin PetscErrorCode PetscOptionsAllUsed(PetscOptions options,PetscInt *N) 17352d747510SLisandro Dalcin { 17362d747510SLisandro Dalcin PetscInt i,n = 0; 17372d747510SLisandro Dalcin 17382d747510SLisandro Dalcin PetscFunctionBegin; 17392d747510SLisandro Dalcin PetscValidIntPointer(N,2); 17402d747510SLisandro Dalcin options = options ? options : defaultoptions; 17412d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 17422d747510SLisandro Dalcin if (!options->used[i]) n++; 17432d747510SLisandro Dalcin } 17442d747510SLisandro Dalcin *N = n; 17452d747510SLisandro Dalcin PetscFunctionReturn(0); 17462d747510SLisandro Dalcin } 17472d747510SLisandro Dalcin 1748487a658cSBarry Smith /*@ 17492d747510SLisandro Dalcin PetscOptionsLeft - Prints to screen any options that were set and never used. 17502d747510SLisandro Dalcin 17512d747510SLisandro Dalcin Not Collective 17522d747510SLisandro Dalcin 17532d747510SLisandro Dalcin Input Parameter: 17542d747510SLisandro Dalcin . options - options database; use NULL for default global database 17552d747510SLisandro Dalcin 17562d747510SLisandro Dalcin Options Database Key: 17573c6db4c4SPierre Jolivet . -options_left - activates PetscOptionsAllUsed() within PetscFinalize() 17582d747510SLisandro Dalcin 17593de2bfdfSBarry Smith Notes: 17603de2bfdfSBarry Smith This is rarely used directly, it is called by PetscFinalize() in debug more or if -options_left 17611c9f3c13SBarry Smith is passed otherwise to help users determine possible mistakes in their usage of options. This 17621c9f3c13SBarry Smith only prints values on process zero of PETSC_COMM_WORLD. Other processes depending the objects 17631c9f3c13SBarry Smith used may have different options that are left unused. 17643de2bfdfSBarry Smith 17652d747510SLisandro Dalcin Level: advanced 17662d747510SLisandro Dalcin 17672d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed() 17682d747510SLisandro Dalcin @*/ 17692d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeft(PetscOptions options) 17702d747510SLisandro Dalcin { 17712d747510SLisandro Dalcin PetscErrorCode ierr; 17722d747510SLisandro Dalcin PetscInt i; 17733de2bfdfSBarry Smith PetscInt cnt = 0; 17743de2bfdfSBarry Smith PetscOptions toptions; 17752d747510SLisandro Dalcin 17762d747510SLisandro Dalcin PetscFunctionBegin; 17773de2bfdfSBarry Smith toptions = options ? options : defaultoptions; 17783de2bfdfSBarry Smith for (i=0; i<toptions->N; i++) { 17793de2bfdfSBarry Smith if (!toptions->used[i]) { 17803de2bfdfSBarry Smith if (toptions->values[i]) { 17813de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s value: %s\n",toptions->names[i],toptions->values[i]);CHKERRQ(ierr); 17822d747510SLisandro Dalcin } else { 17833de2bfdfSBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s (no value)\n",toptions->names[i]);CHKERRQ(ierr); 17842d747510SLisandro Dalcin } 17852d747510SLisandro Dalcin } 17862d747510SLisandro Dalcin } 17873de2bfdfSBarry Smith if (!options) { 17883de2bfdfSBarry Smith toptions = defaultoptions; 17893de2bfdfSBarry Smith while (toptions->previous) { 17903de2bfdfSBarry Smith cnt++; 17913de2bfdfSBarry Smith toptions = toptions->previous; 17923de2bfdfSBarry Smith } 17933de2bfdfSBarry Smith if (cnt) { 17943de2bfdfSBarry 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); 17953de2bfdfSBarry Smith } 17963de2bfdfSBarry Smith } 17972d747510SLisandro Dalcin PetscFunctionReturn(0); 17982d747510SLisandro Dalcin } 17992d747510SLisandro Dalcin 18002d747510SLisandro Dalcin /*@C 18012d747510SLisandro Dalcin PetscOptionsLeftGet - Returns all options that were set and never used. 18022d747510SLisandro Dalcin 18032d747510SLisandro Dalcin Not Collective 18042d747510SLisandro Dalcin 18052d747510SLisandro Dalcin Input Parameter: 18062d747510SLisandro Dalcin . options - options database, use NULL for default global database 18072d747510SLisandro Dalcin 18082d747510SLisandro Dalcin Output Parameter: 1809a2b725a8SWilliam Gropp + N - count of options not used 18102d747510SLisandro Dalcin . names - names of options not used 1811a2b725a8SWilliam Gropp - values - values of options not used 18122d747510SLisandro Dalcin 18132d747510SLisandro Dalcin Level: advanced 18142d747510SLisandro Dalcin 18152d747510SLisandro Dalcin Notes: 18162d747510SLisandro Dalcin Users should call PetscOptionsLeftRestore() to free the memory allocated in this routine 18171c9f3c13SBarry Smith Notes: The value returned may be different on each process and depends on which options have been processed 18181c9f3c13SBarry Smith on the given process 18192d747510SLisandro Dalcin 18202d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft() 18212d747510SLisandro Dalcin @*/ 18222d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftGet(PetscOptions options,PetscInt *N,char **names[],char **values[]) 18232d747510SLisandro Dalcin { 18242d747510SLisandro Dalcin PetscErrorCode ierr; 18252d747510SLisandro Dalcin PetscInt i,n; 18262d747510SLisandro Dalcin 18272d747510SLisandro Dalcin PetscFunctionBegin; 18282d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 18292d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 18302d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 18312d747510SLisandro Dalcin options = options ? options : defaultoptions; 18322d747510SLisandro Dalcin 18332d747510SLisandro Dalcin /* The number of unused PETSc options */ 18342d747510SLisandro Dalcin n = 0; 18352d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 18362d747510SLisandro Dalcin if (!options->used[i]) n++; 18372d747510SLisandro Dalcin } 18382d747510SLisandro Dalcin if (N) { *N = n; } 18392d747510SLisandro Dalcin if (names) { ierr = PetscMalloc1(n,names);CHKERRQ(ierr); } 18402d747510SLisandro Dalcin if (values) { ierr = PetscMalloc1(n,values);CHKERRQ(ierr); } 18412d747510SLisandro Dalcin 18422d747510SLisandro Dalcin n = 0; 18432d747510SLisandro Dalcin if (names || values) { 18442d747510SLisandro Dalcin for (i=0; i<options->N; i++) { 18452d747510SLisandro Dalcin if (!options->used[i]) { 18462d747510SLisandro Dalcin if (names) (*names)[n] = options->names[i]; 18472d747510SLisandro Dalcin if (values) (*values)[n] = options->values[i]; 18482d747510SLisandro Dalcin n++; 18492d747510SLisandro Dalcin } 18502d747510SLisandro Dalcin } 18512d747510SLisandro Dalcin } 18522d747510SLisandro Dalcin PetscFunctionReturn(0); 18532d747510SLisandro Dalcin } 18542d747510SLisandro Dalcin 18552d747510SLisandro Dalcin /*@C 18562d747510SLisandro Dalcin PetscOptionsLeftRestore - Free memory for the unused PETSc options obtained using PetscOptionsLeftGet. 18572d747510SLisandro Dalcin 18582d747510SLisandro Dalcin Not Collective 18592d747510SLisandro Dalcin 18602d747510SLisandro Dalcin Input Parameter: 1861a2b725a8SWilliam Gropp + options - options database, use NULL for default global database 18622d747510SLisandro Dalcin . names - names of options not used 1863a2b725a8SWilliam Gropp - values - values of options not used 18642d747510SLisandro Dalcin 18652d747510SLisandro Dalcin Level: advanced 18662d747510SLisandro Dalcin 18672d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft(), PetscOptionsLeftGet() 18682d747510SLisandro Dalcin @*/ 18692d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftRestore(PetscOptions options,PetscInt *N,char **names[],char **values[]) 18702d747510SLisandro Dalcin { 18712d747510SLisandro Dalcin PetscErrorCode ierr; 18722d747510SLisandro Dalcin 18732d747510SLisandro Dalcin PetscFunctionBegin; 18742d747510SLisandro Dalcin if (N) PetscValidIntPointer(N,2); 18752d747510SLisandro Dalcin if (names) PetscValidPointer(names,3); 18762d747510SLisandro Dalcin if (values) PetscValidPointer(values,4); 18772d747510SLisandro Dalcin if (N) { *N = 0; } 18782d747510SLisandro Dalcin if (names) { ierr = PetscFree(*names);CHKERRQ(ierr); } 18792d747510SLisandro Dalcin if (values) { ierr = PetscFree(*values);CHKERRQ(ierr); } 18802d747510SLisandro Dalcin PetscFunctionReturn(0); 18812d747510SLisandro Dalcin } 18822d747510SLisandro Dalcin 18832d747510SLisandro Dalcin /*@C 18849060e2f9SVaclav Hapla PetscOptionsMonitorDefault - Print all options set value events using the supplied PetscViewer. 18852d747510SLisandro Dalcin 18861c9f3c13SBarry Smith Logically Collective on ctx 18872d747510SLisandro Dalcin 18882d747510SLisandro Dalcin Input Parameters: 18892d747510SLisandro Dalcin + name - option name string 18902d747510SLisandro Dalcin . value - option value string 18919060e2f9SVaclav Hapla - ctx - an ASCII viewer or NULL 18922d747510SLisandro Dalcin 18932d747510SLisandro Dalcin Level: intermediate 18942d747510SLisandro Dalcin 18959666a313SBarry Smith Notes: 18969060e2f9SVaclav Hapla If ctx=NULL, PetscPrintf() is used. 18979666a313SBarry Smith The first MPI rank in the PetscViewer viewer actually prints the values, other 18981c9f3c13SBarry Smith processes may have different values set 18991c9f3c13SBarry Smith 19002d747510SLisandro Dalcin .seealso: PetscOptionsMonitorSet() 19012d747510SLisandro Dalcin @*/ 19022d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorDefault(const char name[],const char value[],void *ctx) 19032d747510SLisandro Dalcin { 19042d747510SLisandro Dalcin PetscErrorCode ierr; 19052d747510SLisandro Dalcin 19062d747510SLisandro Dalcin PetscFunctionBegin; 19079060e2f9SVaclav Hapla if (ctx) { 19089060e2f9SVaclav Hapla PetscViewer viewer = (PetscViewer)ctx; 19092d747510SLisandro Dalcin if (!value) { 19102d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Removing option: %s\n",name,value);CHKERRQ(ierr); 19112d747510SLisandro Dalcin } else if (!value[0]) { 19122d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s (no value)\n",name);CHKERRQ(ierr); 19132d747510SLisandro Dalcin } else { 19142d747510SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr); 19152d747510SLisandro Dalcin } 19169060e2f9SVaclav Hapla } else { 19179060e2f9SVaclav Hapla MPI_Comm comm = PETSC_COMM_WORLD; 19189060e2f9SVaclav Hapla if (!value) { 19199060e2f9SVaclav Hapla ierr = PetscPrintf(comm,"Removing option: %s\n",name,value);CHKERRQ(ierr); 19209060e2f9SVaclav Hapla } else if (!value[0]) { 19219060e2f9SVaclav Hapla ierr = PetscPrintf(comm,"Setting option: %s (no value)\n",name);CHKERRQ(ierr); 19229060e2f9SVaclav Hapla } else { 19239060e2f9SVaclav Hapla ierr = PetscPrintf(comm,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr); 19249060e2f9SVaclav Hapla } 19259060e2f9SVaclav Hapla } 19262d747510SLisandro Dalcin PetscFunctionReturn(0); 19272d747510SLisandro Dalcin } 19282d747510SLisandro Dalcin 19292d747510SLisandro Dalcin /*@C 19302d747510SLisandro Dalcin PetscOptionsMonitorSet - Sets an ADDITIONAL function to be called at every method that 19312d747510SLisandro Dalcin modified the PETSc options database. 19322d747510SLisandro Dalcin 19332d747510SLisandro Dalcin Not Collective 19342d747510SLisandro Dalcin 19352d747510SLisandro Dalcin Input Parameters: 19362d747510SLisandro Dalcin + monitor - pointer to function (if this is NULL, it turns off monitoring 19372d747510SLisandro Dalcin . mctx - [optional] context for private data for the 19382d747510SLisandro Dalcin monitor routine (use NULL if no context is desired) 19392d747510SLisandro Dalcin - monitordestroy - [optional] routine that frees monitor context 19402d747510SLisandro Dalcin (may be NULL) 19412d747510SLisandro Dalcin 19422d747510SLisandro Dalcin Calling Sequence of monitor: 19432d747510SLisandro Dalcin $ monitor (const char name[], const char value[], void *mctx) 19442d747510SLisandro Dalcin 19452d747510SLisandro Dalcin + name - option name string 19462d747510SLisandro Dalcin . value - option value string 19472d747510SLisandro Dalcin - mctx - optional monitoring context, as set by PetscOptionsMonitorSet() 19482d747510SLisandro Dalcin 19492d747510SLisandro Dalcin Options Database Keys: 1950c5b5d8d5SVaclav Hapla See PetscInitialize() for options related to option database monitoring. 19512d747510SLisandro Dalcin 19522d747510SLisandro Dalcin Notes: 19532d747510SLisandro Dalcin The default is to do nothing. To print the name and value of options 19542d747510SLisandro Dalcin being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine, 19552d747510SLisandro Dalcin with a null monitoring context. 19562d747510SLisandro Dalcin 19572d747510SLisandro Dalcin Several different monitoring routines may be set by calling 19582d747510SLisandro Dalcin PetscOptionsMonitorSet() multiple times; all will be called in the 19592d747510SLisandro Dalcin order in which they were set. 19602d747510SLisandro Dalcin 19619060e2f9SVaclav Hapla Level: intermediate 19622d747510SLisandro Dalcin 1963c5b5d8d5SVaclav Hapla .seealso: PetscOptionsMonitorDefault(), PetscInitialize() 19642d747510SLisandro Dalcin @*/ 19652d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 19662d747510SLisandro Dalcin { 19672d747510SLisandro Dalcin PetscOptions options = defaultoptions; 19682d747510SLisandro Dalcin 19692d747510SLisandro Dalcin PetscFunctionBegin; 1970c5b5d8d5SVaclav Hapla if (options->monitorCancel) PetscFunctionReturn(0); 19712d747510SLisandro Dalcin if (options->numbermonitors >= MAXOPTIONSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptions monitors set"); 19722d747510SLisandro Dalcin options->monitor[options->numbermonitors] = monitor; 19732d747510SLisandro Dalcin options->monitordestroy[options->numbermonitors] = monitordestroy; 19742d747510SLisandro Dalcin options->monitorcontext[options->numbermonitors++] = (void*)mctx; 19752d747510SLisandro Dalcin PetscFunctionReturn(0); 19762d747510SLisandro Dalcin } 19772d747510SLisandro Dalcin 19782d747510SLisandro Dalcin /* 19792d747510SLisandro Dalcin PetscOptionsStringToBool - Converts string to PetscBool, handles cases like "yes", "no", "true", "false", "0", "1", "off", "on". 198063fe8743SVaclav Hapla Empty string is considered as true. 19812d747510SLisandro Dalcin */ 19822d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToBool(const char value[],PetscBool *a) 19832d747510SLisandro Dalcin { 19842d747510SLisandro Dalcin PetscBool istrue,isfalse; 19852d747510SLisandro Dalcin size_t len; 19862d747510SLisandro Dalcin PetscErrorCode ierr; 19872d747510SLisandro Dalcin 19882d747510SLisandro Dalcin PetscFunctionBegin; 198963fe8743SVaclav Hapla /* PetscStrlen() returns 0 for NULL or "" */ 19902d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 199163fe8743SVaclav Hapla if (!len) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19922d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"TRUE",&istrue);CHKERRQ(ierr); 19932d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19942d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"YES",&istrue);CHKERRQ(ierr); 19952d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19962d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"1",&istrue);CHKERRQ(ierr); 19972d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 19982d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"on",&istrue);CHKERRQ(ierr); 19992d747510SLisandro Dalcin if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);} 20002d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"FALSE",&isfalse);CHKERRQ(ierr); 20012d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20022d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"NO",&isfalse);CHKERRQ(ierr); 20032d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20042d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"0",&isfalse);CHKERRQ(ierr); 20052d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20062d747510SLisandro Dalcin ierr = PetscStrcasecmp(value,"off",&isfalse);CHKERRQ(ierr); 20072d747510SLisandro Dalcin if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);} 20082d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown logical value: %s",value); 20092d747510SLisandro Dalcin } 20102d747510SLisandro Dalcin 20112d747510SLisandro Dalcin /* 20122d747510SLisandro Dalcin PetscOptionsStringToInt - Converts a string to an integer value. Handles special cases such as "default" and "decide" 20132d747510SLisandro Dalcin */ 20142d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToInt(const char name[],PetscInt *a) 20152d747510SLisandro Dalcin { 20162d747510SLisandro Dalcin PetscErrorCode ierr; 20172d747510SLisandro Dalcin size_t len; 20182d747510SLisandro Dalcin PetscBool decide,tdefault,mouse; 20192d747510SLisandro Dalcin 20202d747510SLisandro Dalcin PetscFunctionBegin; 20212d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 20222d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 20232d747510SLisandro Dalcin 20242d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&tdefault);CHKERRQ(ierr); 20252d747510SLisandro Dalcin if (!tdefault) { 20262d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&tdefault);CHKERRQ(ierr); 20272d747510SLisandro Dalcin } 20282d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&decide);CHKERRQ(ierr); 20292d747510SLisandro Dalcin if (!decide) { 20302d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&decide);CHKERRQ(ierr); 20312d747510SLisandro Dalcin } 20322d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"mouse",&mouse);CHKERRQ(ierr); 20332d747510SLisandro Dalcin 20342d747510SLisandro Dalcin if (tdefault) *a = PETSC_DEFAULT; 20352d747510SLisandro Dalcin else if (decide) *a = PETSC_DECIDE; 20362d747510SLisandro Dalcin else if (mouse) *a = -1; 20372d747510SLisandro Dalcin else { 20382d747510SLisandro Dalcin char *endptr; 20392d747510SLisandro Dalcin long strtolval; 20402d747510SLisandro Dalcin 20412d747510SLisandro Dalcin strtolval = strtol(name,&endptr,10); 20422d747510SLisandro 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); 20432d747510SLisandro Dalcin 20442d747510SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE_ATOLL) 20452d747510SLisandro Dalcin (void) strtolval; 20462d747510SLisandro Dalcin *a = atoll(name); 20472d747510SLisandro Dalcin #elif defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE___INT64) 20482d747510SLisandro Dalcin (void) strtolval; 20492d747510SLisandro Dalcin *a = _atoi64(name); 20502d747510SLisandro Dalcin #else 20512d747510SLisandro Dalcin *a = (PetscInt)strtolval; 20522d747510SLisandro Dalcin #endif 20532d747510SLisandro Dalcin } 20542d747510SLisandro Dalcin PetscFunctionReturn(0); 20552d747510SLisandro Dalcin } 20562d747510SLisandro Dalcin 20572d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 20582d747510SLisandro Dalcin #include <quadmath.h> 20592d747510SLisandro Dalcin #endif 20602d747510SLisandro Dalcin 20612d747510SLisandro Dalcin static PetscErrorCode PetscStrtod(const char name[],PetscReal *a,char **endptr) 20622d747510SLisandro Dalcin { 20632d747510SLisandro Dalcin PetscFunctionBegin; 20642d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128) 20652d747510SLisandro Dalcin *a = strtoflt128(name,endptr); 20662d747510SLisandro Dalcin #else 20672d747510SLisandro Dalcin *a = (PetscReal)strtod(name,endptr); 20682d747510SLisandro Dalcin #endif 20692d747510SLisandro Dalcin PetscFunctionReturn(0); 20702d747510SLisandro Dalcin } 20712d747510SLisandro Dalcin 20722d747510SLisandro Dalcin static PetscErrorCode PetscStrtoz(const char name[],PetscScalar *a,char **endptr,PetscBool *isImaginary) 20732d747510SLisandro Dalcin { 20742d747510SLisandro Dalcin PetscBool hasi = PETSC_FALSE; 20752d747510SLisandro Dalcin char *ptr; 20762d747510SLisandro Dalcin PetscReal strtoval; 20772d747510SLisandro Dalcin PetscErrorCode ierr; 20782d747510SLisandro Dalcin 20792d747510SLisandro Dalcin PetscFunctionBegin; 20802d747510SLisandro Dalcin ierr = PetscStrtod(name,&strtoval,&ptr);CHKERRQ(ierr); 20812d747510SLisandro Dalcin if (ptr == name) { 20822d747510SLisandro Dalcin strtoval = 1.; 20832d747510SLisandro Dalcin hasi = PETSC_TRUE; 20842d747510SLisandro Dalcin if (name[0] == 'i') { 20852d747510SLisandro Dalcin ptr++; 20862d747510SLisandro Dalcin } else if (name[0] == '+' && name[1] == 'i') { 20872d747510SLisandro Dalcin ptr += 2; 20882d747510SLisandro Dalcin } else if (name[0] == '-' && name[1] == 'i') { 20892d747510SLisandro Dalcin strtoval = -1.; 20902d747510SLisandro Dalcin ptr += 2; 20912d747510SLisandro Dalcin } 20922d747510SLisandro Dalcin } else if (*ptr == 'i') { 20932d747510SLisandro Dalcin hasi = PETSC_TRUE; 20942d747510SLisandro Dalcin ptr++; 20952d747510SLisandro Dalcin } 20962d747510SLisandro Dalcin *endptr = ptr; 20972d747510SLisandro Dalcin *isImaginary = hasi; 20982d747510SLisandro Dalcin if (hasi) { 20992d747510SLisandro Dalcin #if !defined(PETSC_USE_COMPLEX) 21002d747510SLisandro Dalcin SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s contains imaginary but complex not supported ",name); 21012d747510SLisandro Dalcin #else 21022d747510SLisandro Dalcin *a = PetscCMPLX(0.,strtoval); 21032d747510SLisandro Dalcin #endif 21042d747510SLisandro Dalcin } else { 21052d747510SLisandro Dalcin *a = strtoval; 21062d747510SLisandro Dalcin } 21072d747510SLisandro Dalcin PetscFunctionReturn(0); 21082d747510SLisandro Dalcin } 21092d747510SLisandro Dalcin 21102d747510SLisandro Dalcin /* 21112d747510SLisandro Dalcin Converts a string to PetscReal value. Handles special cases like "default" and "decide" 21122d747510SLisandro Dalcin */ 21132d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToReal(const char name[],PetscReal *a) 21142d747510SLisandro Dalcin { 21152d747510SLisandro Dalcin size_t len; 21162d747510SLisandro Dalcin PetscBool match; 21172d747510SLisandro Dalcin char *endptr; 21182d747510SLisandro Dalcin PetscErrorCode ierr; 21192d747510SLisandro Dalcin 21202d747510SLisandro Dalcin PetscFunctionBegin; 21212d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 21222d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"String of length zero has no numerical value"); 21232d747510SLisandro Dalcin 21242d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&match);CHKERRQ(ierr); 21252d747510SLisandro Dalcin if (!match) { 21262d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DEFAULT",&match);CHKERRQ(ierr); 21272d747510SLisandro Dalcin } 21282d747510SLisandro Dalcin if (match) {*a = PETSC_DEFAULT; PetscFunctionReturn(0);} 21292d747510SLisandro Dalcin 21302d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&match);CHKERRQ(ierr); 21312d747510SLisandro Dalcin if (!match) { 21322d747510SLisandro Dalcin ierr = PetscStrcasecmp(name,"DECIDE",&match);CHKERRQ(ierr); 21332d747510SLisandro Dalcin } 21342d747510SLisandro Dalcin if (match) {*a = PETSC_DECIDE; PetscFunctionReturn(0);} 21352d747510SLisandro Dalcin 21362d747510SLisandro Dalcin ierr = PetscStrtod(name,a,&endptr);CHKERRQ(ierr); 21372d747510SLisandro Dalcin if ((size_t) (endptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value",name); 21382d747510SLisandro Dalcin PetscFunctionReturn(0); 21392d747510SLisandro Dalcin } 21402d747510SLisandro Dalcin 21412d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToScalar(const char name[],PetscScalar *a) 21422d747510SLisandro Dalcin { 21432d747510SLisandro Dalcin PetscBool imag1; 21442d747510SLisandro Dalcin size_t len; 21452d747510SLisandro Dalcin PetscScalar val = 0.; 21462d747510SLisandro Dalcin char *ptr = NULL; 21472d747510SLisandro Dalcin PetscErrorCode ierr; 21482d747510SLisandro Dalcin 21492d747510SLisandro Dalcin PetscFunctionBegin; 21502d747510SLisandro Dalcin ierr = PetscStrlen(name,&len);CHKERRQ(ierr); 21512d747510SLisandro Dalcin if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value"); 21522d747510SLisandro Dalcin ierr = PetscStrtoz(name,&val,&ptr,&imag1);CHKERRQ(ierr); 21532d747510SLisandro Dalcin #if defined(PETSC_USE_COMPLEX) 21542d747510SLisandro Dalcin if ((size_t) (ptr - name) < len) { 21552d747510SLisandro Dalcin PetscBool imag2; 21562d747510SLisandro Dalcin PetscScalar val2; 21572d747510SLisandro Dalcin 21582d747510SLisandro Dalcin ierr = PetscStrtoz(ptr,&val2,&ptr,&imag2);CHKERRQ(ierr); 21592d747510SLisandro Dalcin if (imag1 || !imag2) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s: must specify imaginary component second",name); 21602d747510SLisandro Dalcin val = PetscCMPLX(PetscRealPart(val),PetscImaginaryPart(val2)); 21612d747510SLisandro Dalcin } 21622d747510SLisandro Dalcin #endif 21632d747510SLisandro Dalcin if ((size_t) (ptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value ",name); 21642d747510SLisandro Dalcin *a = val; 21652d747510SLisandro Dalcin PetscFunctionReturn(0); 21662d747510SLisandro Dalcin } 21672d747510SLisandro Dalcin 21682d747510SLisandro Dalcin /*@C 21692d747510SLisandro Dalcin PetscOptionsGetBool - Gets the Logical (true or false) value for a particular 21702d747510SLisandro Dalcin option in the database. 2171e5c89e4eSSatish Balay 2172e5c89e4eSSatish Balay Not Collective 2173e5c89e4eSSatish Balay 2174e5c89e4eSSatish Balay Input Parameters: 21755c9cc608SHong Zhang + options - options database, use NULL for default global database 2176c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2177e5c89e4eSSatish Balay - name - the option one is seeking 2178e5c89e4eSSatish Balay 2179e5c89e4eSSatish Balay Output Parameter: 21802d747510SLisandro Dalcin + ivalue - the logical value to return 218196ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2182e5c89e4eSSatish Balay 2183e5c89e4eSSatish Balay Level: beginner 2184e5c89e4eSSatish Balay 218595452b02SPatrick Sanan Notes: 21862d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 21872d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 21882d747510SLisandro Dalcin 21892d747510SLisandro Dalcin If the option is given, but no value is provided, then ivalue and set are both given the value PETSC_TRUE. That is -requested_bool 21902d747510SLisandro Dalcin is equivalent to -requested_bool true 21912d747510SLisandro Dalcin 21922d747510SLisandro Dalcin If the user does not supply the option at all ivalue is NOT changed. Thus 21932efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 21942efd9cb1SBarry Smith 2195e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 21962d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetInt(), PetscOptionsBool(), 2197e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2198e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2199acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2200a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2201e5c89e4eSSatish Balay @*/ 22022d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBool(PetscOptions options,const char pre[],const char name[],PetscBool *ivalue,PetscBool *set) 2203e5c89e4eSSatish Balay { 22042d747510SLisandro Dalcin const char *value; 2205ace3abfcSBarry Smith PetscBool flag; 22062d747510SLisandro Dalcin PetscErrorCode ierr; 2207e5c89e4eSSatish Balay 2208e5c89e4eSSatish Balay PetscFunctionBegin; 22092d747510SLisandro Dalcin PetscValidCharPointer(name,3); 22102d747510SLisandro Dalcin if (ivalue) PetscValidIntPointer(ivalue,4); 22112d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2212e5c89e4eSSatish Balay if (flag) { 221396ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 22142d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value, &flag);CHKERRQ(ierr); 22152d747510SLisandro Dalcin if (ivalue) *ivalue = flag; 2216e5c89e4eSSatish Balay } else { 221796ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2218e5c89e4eSSatish Balay } 2219e5c89e4eSSatish Balay PetscFunctionReturn(0); 2220e5c89e4eSSatish Balay } 2221e5c89e4eSSatish Balay 2222e5c89e4eSSatish Balay /*@C 2223e5c89e4eSSatish Balay PetscOptionsGetEList - Puts a list of option values that a single one may be selected from 2224e5c89e4eSSatish Balay 2225e5c89e4eSSatish Balay Not Collective 2226e5c89e4eSSatish Balay 2227e5c89e4eSSatish Balay Input Parameters: 22285c9cc608SHong Zhang + options - options database, use NULL for default global database 2229c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2230e5c89e4eSSatish Balay . opt - option name 2231a264d7a6SBarry Smith . list - the possible choices (one of these must be selected, anything else is invalid) 2232a2b725a8SWilliam Gropp - ntext - number of choices 2233e5c89e4eSSatish Balay 2234e5c89e4eSSatish Balay Output Parameter: 22352efd9cb1SBarry Smith + value - the index of the value to return (defaults to zero if the option name is given but no choice is listed) 2236e5c89e4eSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2237e5c89e4eSSatish Balay 2238e5c89e4eSSatish Balay Level: intermediate 2239e5c89e4eSSatish Balay 224095452b02SPatrick Sanan Notes: 224195452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 22422efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 22432efd9cb1SBarry Smith 2244a264d7a6SBarry Smith See PetscOptionsFList() for when the choices are given in a PetscFunctionList() 2245e5c89e4eSSatish Balay 2246e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2247acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2248e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2249e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2250acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2251a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2252e5c89e4eSSatish Balay @*/ 2253c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEList(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscInt ntext,PetscInt *value,PetscBool *set) 2254e5c89e4eSSatish Balay { 2255e5c89e4eSSatish Balay PetscErrorCode ierr; 225658b0ac4eSStefano Zampini size_t alen,len = 0, tlen = 0; 2257e5c89e4eSSatish Balay char *svalue; 2258ace3abfcSBarry Smith PetscBool aset,flg = PETSC_FALSE; 2259e5c89e4eSSatish Balay PetscInt i; 2260e5c89e4eSSatish Balay 2261e5c89e4eSSatish Balay PetscFunctionBegin; 22622d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2263e5c89e4eSSatish Balay for (i=0; i<ntext; i++) { 2264e5c89e4eSSatish Balay ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr); 2265e5c89e4eSSatish Balay if (alen > len) len = alen; 226658b0ac4eSStefano Zampini tlen += len + 1; 2267e5c89e4eSSatish Balay } 2268e5c89e4eSSatish Balay len += 5; /* a little extra space for user mistypes */ 2269785e854fSJed Brown ierr = PetscMalloc1(len,&svalue);CHKERRQ(ierr); 2270c5929fdfSBarry Smith ierr = PetscOptionsGetString(options,pre,opt,svalue,len,&aset);CHKERRQ(ierr); 2271e5c89e4eSSatish Balay if (aset) { 2272fbedd5e0SJed Brown ierr = PetscEListFind(ntext,list,svalue,value,&flg);CHKERRQ(ierr); 227358b0ac4eSStefano Zampini if (!flg) { 227458b0ac4eSStefano Zampini char *avail,*pavl; 227558b0ac4eSStefano Zampini 227658b0ac4eSStefano Zampini ierr = PetscMalloc1(tlen,&avail);CHKERRQ(ierr); 227758b0ac4eSStefano Zampini pavl = avail; 227858b0ac4eSStefano Zampini for (i=0; i<ntext; i++) { 227958b0ac4eSStefano Zampini ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr); 228058b0ac4eSStefano Zampini ierr = PetscStrcpy(pavl,list[i]);CHKERRQ(ierr); 228158b0ac4eSStefano Zampini pavl += alen; 228258b0ac4eSStefano Zampini ierr = PetscStrcpy(pavl," ");CHKERRQ(ierr); 228358b0ac4eSStefano Zampini pavl += 1; 228458b0ac4eSStefano Zampini } 228558b0ac4eSStefano Zampini ierr = PetscStrtolower(avail);CHKERRQ(ierr); 228658b0ac4eSStefano Zampini SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown option %s for -%s%s. Available options: %s",svalue,pre ? pre : "",opt+1,avail); 228758b0ac4eSStefano Zampini } 2288fbedd5e0SJed Brown if (set) *set = PETSC_TRUE; 2289a297a907SKarl Rupp } else if (set) *set = PETSC_FALSE; 2290e5c89e4eSSatish Balay ierr = PetscFree(svalue);CHKERRQ(ierr); 2291e5c89e4eSSatish Balay PetscFunctionReturn(0); 2292e5c89e4eSSatish Balay } 2293e5c89e4eSSatish Balay 2294e5c89e4eSSatish Balay /*@C 2295e5c89e4eSSatish Balay PetscOptionsGetEnum - Gets the enum value for a particular option in the database. 2296e5c89e4eSSatish Balay 2297e5c89e4eSSatish Balay Not Collective 2298e5c89e4eSSatish Balay 2299e5c89e4eSSatish Balay Input Parameters: 23005c9cc608SHong Zhang + options - options database, use NULL for default global database 2301c5929fdfSBarry Smith . pre - option prefix or NULL 2302e5c89e4eSSatish Balay . opt - option name 2303e5c89e4eSSatish Balay . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 2304e5c89e4eSSatish Balay - defaultv - the default (current) value 2305e5c89e4eSSatish Balay 2306e5c89e4eSSatish Balay Output Parameter: 2307e5c89e4eSSatish Balay + value - the value to return 230896ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2309e5c89e4eSSatish Balay 2310e5c89e4eSSatish Balay Level: beginner 2311e5c89e4eSSatish Balay 231295452b02SPatrick Sanan Notes: 231395452b02SPatrick Sanan If the user does not supply the option value is NOT changed. Thus 23142efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2315e5c89e4eSSatish Balay 23162efd9cb1SBarry Smith List is usually something like PCASMTypes or some other predefined list of enum names 2317e5c89e4eSSatish Balay 2318e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 2319acfcf0e5SJed Brown PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 2320acfcf0e5SJed Brown PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2321e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2322e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2323acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2324a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 2325e5c89e4eSSatish Balay @*/ 2326c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set) 2327e5c89e4eSSatish Balay { 2328e5c89e4eSSatish Balay PetscErrorCode ierr; 232969a24498SJed Brown PetscInt ntext = 0,tval; 2330ace3abfcSBarry Smith PetscBool fset; 2331e5c89e4eSSatish Balay 2332e5c89e4eSSatish Balay PetscFunctionBegin; 23332d747510SLisandro Dalcin PetscValidCharPointer(opt,3); 2334e5c89e4eSSatish Balay while (list[ntext++]) { 2335e32f2f54SBarry Smith if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries"); 2336e5c89e4eSSatish Balay } 2337e32f2f54SBarry Smith if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix"); 2338e5c89e4eSSatish Balay ntext -= 3; 2339c5929fdfSBarry Smith ierr = PetscOptionsGetEList(options,pre,opt,list,ntext,&tval,&fset);CHKERRQ(ierr); 234069a24498SJed Brown /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */ 2341809ceb46SBarry Smith if (fset) *value = (PetscEnum)tval; 2342809ceb46SBarry Smith if (set) *set = fset; 2343e5c89e4eSSatish Balay PetscFunctionReturn(0); 2344e5c89e4eSSatish Balay } 2345e5c89e4eSSatish Balay 2346e5c89e4eSSatish Balay /*@C 23472d747510SLisandro Dalcin PetscOptionsGetInt - Gets the integer value for a particular option in the database. 2348e5c89e4eSSatish Balay 2349e5c89e4eSSatish Balay Not Collective 2350e5c89e4eSSatish Balay 2351e5c89e4eSSatish Balay Input Parameters: 23525c9cc608SHong Zhang + options - options database, use NULL for default global database 2353c5929fdfSBarry Smith . pre - the string to prepend to the name or NULL 2354e5c89e4eSSatish Balay - name - the option one is seeking 2355e5c89e4eSSatish Balay 2356e5c89e4eSSatish Balay Output Parameter: 23572d747510SLisandro Dalcin + ivalue - the integer value to return 235896ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2359e5c89e4eSSatish Balay 2360e5c89e4eSSatish Balay Level: beginner 2361e5c89e4eSSatish Balay 2362e5c89e4eSSatish Balay Notes: 23632d747510SLisandro Dalcin If the user does not supply the option ivalue is NOT changed. Thus 23642efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 23655c07ccb8SBarry Smith 2366e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 23672d747510SLisandro Dalcin PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 23682d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 2369e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2370e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2371acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2372a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2373e5c89e4eSSatish Balay @*/ 23742d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetInt(PetscOptions options,const char pre[],const char name[],PetscInt *ivalue,PetscBool *set) 2375e5c89e4eSSatish Balay { 23762d747510SLisandro Dalcin const char *value; 2377e5c89e4eSSatish Balay PetscErrorCode ierr; 23782d747510SLisandro Dalcin PetscBool flag; 2379e5c89e4eSSatish Balay 2380e5c89e4eSSatish Balay PetscFunctionBegin; 23812d747510SLisandro Dalcin PetscValidCharPointer(name,3); 23822d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 23832d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2384e5c89e4eSSatish Balay if (flag) { 238534a9cc2cSBarry Smith if (!value) { 23862d747510SLisandro Dalcin if (set) *set = PETSC_FALSE; 238734a9cc2cSBarry Smith } else { 23882d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 23892d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 2390e5c89e4eSSatish Balay } 2391e5c89e4eSSatish Balay } else { 239296ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2393e5c89e4eSSatish Balay } 2394e5c89e4eSSatish Balay PetscFunctionReturn(0); 2395e5c89e4eSSatish Balay } 2396e5c89e4eSSatish Balay 2397e2446a98SMatthew Knepley /*@C 2398e5c89e4eSSatish Balay PetscOptionsGetReal - Gets the double precision value for a particular 2399e5c89e4eSSatish Balay option in the database. 2400e5c89e4eSSatish Balay 2401e5c89e4eSSatish Balay Not Collective 2402e5c89e4eSSatish Balay 2403e5c89e4eSSatish Balay Input Parameters: 24045c9cc608SHong Zhang + options - options database, use NULL for default global database 2405c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2406e5c89e4eSSatish Balay - name - the option one is seeking 2407e5c89e4eSSatish Balay 2408e5c89e4eSSatish Balay Output Parameter: 2409e5c89e4eSSatish Balay + dvalue - the double value to return 241096ef3cdfSSatish Balay - set - PETSC_TRUE if found, PETSC_FALSE if not found 2411e5c89e4eSSatish Balay 241295452b02SPatrick Sanan Notes: 241395452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 24142efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2415e4974155SBarry Smith 2416e5c89e4eSSatish Balay Level: beginner 2417e5c89e4eSSatish Balay 2418e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2419acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(), 2420e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2421e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2422acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2423a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2424e5c89e4eSSatish Balay @*/ 2425c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetReal(PetscOptions options,const char pre[],const char name[],PetscReal *dvalue,PetscBool *set) 2426e5c89e4eSSatish Balay { 24272d747510SLisandro Dalcin const char *value; 2428ace3abfcSBarry Smith PetscBool flag; 24292d747510SLisandro Dalcin PetscErrorCode ierr; 2430e5c89e4eSSatish Balay 2431e5c89e4eSSatish Balay PetscFunctionBegin; 24322d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24332d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 24342d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2435e5c89e4eSSatish Balay if (flag) { 2436a297a907SKarl Rupp if (!value) { 2437a297a907SKarl Rupp if (set) *set = PETSC_FALSE; 2438a297a907SKarl Rupp } else { 2439a297a907SKarl Rupp if (set) *set = PETSC_TRUE; 2440a297a907SKarl Rupp ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2441a297a907SKarl Rupp } 2442e5c89e4eSSatish Balay } else { 244396ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2444e5c89e4eSSatish Balay } 2445e5c89e4eSSatish Balay PetscFunctionReturn(0); 2446e5c89e4eSSatish Balay } 2447e5c89e4eSSatish Balay 2448e5c89e4eSSatish Balay /*@C 2449e5c89e4eSSatish Balay PetscOptionsGetScalar - Gets the scalar value for a particular 2450e5c89e4eSSatish Balay option in the database. 2451e5c89e4eSSatish Balay 2452e5c89e4eSSatish Balay Not Collective 2453e5c89e4eSSatish Balay 2454e5c89e4eSSatish Balay Input Parameters: 24555c9cc608SHong Zhang + options - options database, use NULL for default global database 2456c5929fdfSBarry Smith . pre - string to prepend to each name or NULL 2457e5c89e4eSSatish Balay - name - the option one is seeking 2458e5c89e4eSSatish Balay 2459e5c89e4eSSatish Balay Output Parameter: 2460e5c89e4eSSatish Balay + dvalue - the double value to return 246196ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2462e5c89e4eSSatish Balay 2463e5c89e4eSSatish Balay Level: beginner 2464e5c89e4eSSatish Balay 2465e5c89e4eSSatish Balay Usage: 2466eb4ae41dSBarry Smith A complex number 2+3i must be specified with NO spaces 2467e5c89e4eSSatish Balay 246895452b02SPatrick Sanan Notes: 246995452b02SPatrick Sanan If the user does not supply the option dvalue is NOT changed. Thus 24702efd9cb1SBarry Smith you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true. 2471e4974155SBarry Smith 2472e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 2473acfcf0e5SJed Brown PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2474e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2475e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2476acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2477a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2478e5c89e4eSSatish Balay @*/ 2479c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetScalar(PetscOptions options,const char pre[],const char name[],PetscScalar *dvalue,PetscBool *set) 2480e5c89e4eSSatish Balay { 24812d747510SLisandro Dalcin const char *value; 2482ace3abfcSBarry Smith PetscBool flag; 2483e5c89e4eSSatish Balay PetscErrorCode ierr; 2484e5c89e4eSSatish Balay 2485e5c89e4eSSatish Balay PetscFunctionBegin; 24862d747510SLisandro Dalcin PetscValidCharPointer(name,3); 24872d747510SLisandro Dalcin PetscValidScalarPointer(dvalue,4); 24882d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2489e5c89e4eSSatish Balay if (flag) { 2490e5c89e4eSSatish Balay if (!value) { 249196ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2492e5c89e4eSSatish Balay } else { 2493e5c89e4eSSatish Balay #if !defined(PETSC_USE_COMPLEX) 2494cfbddea1SSatish Balay ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr); 2495e5c89e4eSSatish Balay #else 2496eb4ae41dSBarry Smith ierr = PetscOptionsStringToScalar(value,dvalue);CHKERRQ(ierr); 2497e5c89e4eSSatish Balay #endif 249896ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2499e5c89e4eSSatish Balay } 2500e5c89e4eSSatish Balay } else { /* flag */ 250196ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2502e5c89e4eSSatish Balay } 2503e5c89e4eSSatish Balay PetscFunctionReturn(0); 2504e5c89e4eSSatish Balay } 2505e5c89e4eSSatish Balay 2506e5c89e4eSSatish Balay /*@C 2507e5c89e4eSSatish Balay PetscOptionsGetString - Gets the string value for a particular option in 2508e5c89e4eSSatish Balay the database. 2509e5c89e4eSSatish Balay 2510e5c89e4eSSatish Balay Not Collective 2511e5c89e4eSSatish Balay 2512e5c89e4eSSatish Balay Input Parameters: 25135c9cc608SHong Zhang + options - options database, use NULL for default global database 2514c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2515e5c89e4eSSatish Balay . name - the option one is seeking 2516bcbf2dc5SJed Brown - len - maximum length of the string including null termination 2517e5c89e4eSSatish Balay 2518e5c89e4eSSatish Balay Output Parameters: 2519e5c89e4eSSatish Balay + string - location to copy string 252096ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2521e5c89e4eSSatish Balay 2522e5c89e4eSSatish Balay Level: beginner 2523e5c89e4eSSatish Balay 2524e5c89e4eSSatish Balay Fortran Note: 2525e5c89e4eSSatish Balay The Fortran interface is slightly different from the C/C++ 2526e5c89e4eSSatish Balay interface (len is not used). Sample usage in Fortran follows 2527e5c89e4eSSatish Balay .vb 2528e5c89e4eSSatish Balay character *20 string 252993e6ba5cSBarry Smith PetscErrorCode ierr 253093e6ba5cSBarry Smith PetscBool set 25311b266c99SBarry Smith call PetscOptionsGetString(PETSC_NULL_OPTIONS,PETSC_NULL_CHARACTER,'-s',string,set,ierr) 2532e5c89e4eSSatish Balay .ve 2533e5c89e4eSSatish Balay 253495452b02SPatrick Sanan Notes: 253595452b02SPatrick 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 2536e4974155SBarry Smith 25372efd9cb1SBarry Smith If the user does not use the option then the string is not changed. Thus 25382efd9cb1SBarry Smith you should ALWAYS initialize the string if you access it without first checking if the set flag is true. 25392efd9cb1SBarry Smith 2540f3dea69dSBarry Smith Note: 2541f3dea69dSBarry 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). 2542f3dea69dSBarry Smith 2543e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2544acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2545e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2546e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2547acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2548a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2549e5c89e4eSSatish Balay @*/ 2550c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetString(PetscOptions options,const char pre[],const char name[],char string[],size_t len,PetscBool *set) 2551e5c89e4eSSatish Balay { 25522d747510SLisandro Dalcin const char *value; 2553ace3abfcSBarry Smith PetscBool flag; 25542d747510SLisandro Dalcin PetscErrorCode ierr; 2555e5c89e4eSSatish Balay 2556e5c89e4eSSatish Balay PetscFunctionBegin; 25572d747510SLisandro Dalcin PetscValidCharPointer(name,3); 25582d747510SLisandro Dalcin PetscValidCharPointer(string,4); 25592d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr); 2560e5c89e4eSSatish Balay if (!flag) { 256196ef3cdfSSatish Balay if (set) *set = PETSC_FALSE; 2562e5c89e4eSSatish Balay } else { 256396ef3cdfSSatish Balay if (set) *set = PETSC_TRUE; 2564e5c89e4eSSatish Balay if (value) { 2565e5c89e4eSSatish Balay ierr = PetscStrncpy(string,value,len);CHKERRQ(ierr); 2566e5c89e4eSSatish Balay } else { 2567580bdb30SBarry Smith ierr = PetscArrayzero(string,len);CHKERRQ(ierr); 2568e5c89e4eSSatish Balay } 2569e5c89e4eSSatish Balay } 2570e5c89e4eSSatish Balay PetscFunctionReturn(0); 2571e5c89e4eSSatish Balay } 2572e5c89e4eSSatish Balay 2573c5929fdfSBarry Smith char *PetscOptionsGetStringMatlab(PetscOptions options,const char pre[],const char name[]) 257414ce751eSBarry Smith { 25752d747510SLisandro Dalcin const char *value; 257614ce751eSBarry Smith PetscBool flag; 25772d747510SLisandro Dalcin PetscErrorCode ierr; 257814ce751eSBarry Smith 257914ce751eSBarry Smith PetscFunctionBegin; 258002c9f0b5SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);if (ierr) PetscFunctionReturn(NULL); 25812d747510SLisandro Dalcin if (flag) PetscFunctionReturn((char*)value); 258202c9f0b5SLisandro Dalcin else PetscFunctionReturn(NULL); 258314ce751eSBarry Smith } 258414ce751eSBarry Smith 25852d747510SLisandro Dalcin /*@C 25862d747510SLisandro Dalcin PetscOptionsGetBoolArray - Gets an array of Logical (true or false) values for a particular 25872d747510SLisandro Dalcin option in the database. The values must be separated with commas with 25882d747510SLisandro Dalcin no intervening spaces. 25892d747510SLisandro Dalcin 25902d747510SLisandro Dalcin Not Collective 25912d747510SLisandro Dalcin 25922d747510SLisandro Dalcin Input Parameters: 25932d747510SLisandro Dalcin + options - options database, use NULL for default global database 25942d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 25952d747510SLisandro Dalcin . name - the option one is seeking 25962d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 25972d747510SLisandro Dalcin 25982d747510SLisandro Dalcin Output Parameter: 25992d747510SLisandro Dalcin + dvalue - the integer values to return 26002d747510SLisandro Dalcin . nmax - actual number of values retreived 26012d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26022d747510SLisandro Dalcin 26032d747510SLisandro Dalcin Level: beginner 26042d747510SLisandro Dalcin 26052d747510SLisandro Dalcin Notes: 26062d747510SLisandro Dalcin TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE 26072d747510SLisandro Dalcin FALSE, false, NO, no, and 0 all translate to PETSC_FALSE 26082d747510SLisandro Dalcin 26092d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 26102d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 26112d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 26122d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 26132d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26142d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 26152d747510SLisandro Dalcin @*/ 26162d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBoolArray(PetscOptions options,const char pre[],const char name[],PetscBool dvalue[],PetscInt *nmax,PetscBool *set) 26172d747510SLisandro Dalcin { 26182d747510SLisandro Dalcin const char *svalue; 26192d747510SLisandro Dalcin char *value; 26202d747510SLisandro Dalcin PetscErrorCode ierr; 26212d747510SLisandro Dalcin PetscInt n = 0; 26222d747510SLisandro Dalcin PetscBool flag; 26232d747510SLisandro Dalcin PetscToken token; 26242d747510SLisandro Dalcin 26252d747510SLisandro Dalcin PetscFunctionBegin; 26262d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26272d747510SLisandro Dalcin PetscValidIntPointer(dvalue,4); 26282d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 26292d747510SLisandro Dalcin 26302d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 26312d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26322d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26332d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26342d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26352d747510SLisandro Dalcin while (value && n < *nmax) { 26362d747510SLisandro Dalcin ierr = PetscOptionsStringToBool(value,dvalue);CHKERRQ(ierr); 26372d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 26382d747510SLisandro Dalcin dvalue++; 26392d747510SLisandro Dalcin n++; 26402d747510SLisandro Dalcin } 26412d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 26422d747510SLisandro Dalcin *nmax = n; 26432d747510SLisandro Dalcin PetscFunctionReturn(0); 26442d747510SLisandro Dalcin } 26452d747510SLisandro Dalcin 26462d747510SLisandro Dalcin /*@C 26472d747510SLisandro Dalcin PetscOptionsGetEnumArray - Gets an array of enum values for a particular option in the database. 26482d747510SLisandro Dalcin 26492d747510SLisandro Dalcin Not Collective 26502d747510SLisandro Dalcin 26512d747510SLisandro Dalcin Input Parameters: 26522d747510SLisandro Dalcin + options - options database, use NULL for default global database 26532d747510SLisandro Dalcin . pre - option prefix or NULL 26542d747510SLisandro Dalcin . name - option name 26552d747510SLisandro Dalcin . list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null 26562d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 26572d747510SLisandro Dalcin 26582d747510SLisandro Dalcin Output Parameters: 26592d747510SLisandro Dalcin + ivalue - the enum values to return 26602d747510SLisandro Dalcin . nmax - actual number of values retreived 26612d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 26622d747510SLisandro Dalcin 26632d747510SLisandro Dalcin Level: beginner 26642d747510SLisandro Dalcin 26652d747510SLisandro Dalcin Notes: 26662d747510SLisandro Dalcin The array must be passed as a comma separated list. 26672d747510SLisandro Dalcin 26682d747510SLisandro Dalcin There must be no intervening spaces between the values. 26692d747510SLisandro Dalcin 26702d747510SLisandro Dalcin list is usually something like PCASMTypes or some other predefined list of enum names. 26712d747510SLisandro Dalcin 26722d747510SLisandro Dalcin .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), 26732d747510SLisandro Dalcin PetscOptionsGetEnum(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 26742d747510SLisandro Dalcin PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), 26752d747510SLisandro Dalcin PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), 26762d747510SLisandro Dalcin PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 26772d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum() 26782d747510SLisandro Dalcin @*/ 26792d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetEnumArray(PetscOptions options,const char pre[],const char name[],const char *const *list,PetscEnum ivalue[],PetscInt *nmax,PetscBool *set) 26802d747510SLisandro Dalcin { 26812d747510SLisandro Dalcin const char *svalue; 26822d747510SLisandro Dalcin char *value; 26832d747510SLisandro Dalcin PetscInt n = 0; 26842d747510SLisandro Dalcin PetscEnum evalue; 26852d747510SLisandro Dalcin PetscBool flag; 26862d747510SLisandro Dalcin PetscToken token; 26872d747510SLisandro Dalcin PetscErrorCode ierr; 26882d747510SLisandro Dalcin 26892d747510SLisandro Dalcin PetscFunctionBegin; 26902d747510SLisandro Dalcin PetscValidCharPointer(name,3); 26912d747510SLisandro Dalcin PetscValidPointer(list,4); 26922d747510SLisandro Dalcin PetscValidPointer(ivalue,5); 26932d747510SLisandro Dalcin PetscValidIntPointer(nmax,6); 26942d747510SLisandro Dalcin 26952d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 26962d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 26972d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 26982d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 26992d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27002d747510SLisandro Dalcin while (value && n < *nmax) { 27012d747510SLisandro Dalcin ierr = PetscEnumFind(list,value,&evalue,&flag);CHKERRQ(ierr); 27022d747510SLisandro Dalcin if (!flag) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown enum value '%s' for -%s%s",svalue,pre ? pre : "",name+1); 27032d747510SLisandro Dalcin ivalue[n++] = evalue; 27042d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27052d747510SLisandro Dalcin } 27062d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 27072d747510SLisandro Dalcin *nmax = n; 27082d747510SLisandro Dalcin PetscFunctionReturn(0); 27092d747510SLisandro Dalcin } 27102d747510SLisandro Dalcin 27112d747510SLisandro Dalcin /*@C 27122d747510SLisandro Dalcin PetscOptionsGetIntArray - Gets an array of integer values for a particular 27132d747510SLisandro Dalcin option in the database. 27142d747510SLisandro Dalcin 27152d747510SLisandro Dalcin Not Collective 27162d747510SLisandro Dalcin 27172d747510SLisandro Dalcin Input Parameters: 27182d747510SLisandro Dalcin + options - options database, use NULL for default global database 27192d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 27202d747510SLisandro Dalcin . name - the option one is seeking 27212d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 27222d747510SLisandro Dalcin 27232d747510SLisandro Dalcin Output Parameter: 27242d747510SLisandro Dalcin + ivalue - the integer values to return 27252d747510SLisandro Dalcin . nmax - actual number of values retreived 27262d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 27272d747510SLisandro Dalcin 27282d747510SLisandro Dalcin Level: beginner 27292d747510SLisandro Dalcin 27302d747510SLisandro Dalcin Notes: 27312d747510SLisandro Dalcin The array can be passed as 27322d747510SLisandro Dalcin a comma separated list: 0,1,2,3,4,5,6,7 27332d747510SLisandro Dalcin a range (start-end+1): 0-8 27342d747510SLisandro Dalcin a range with given increment (start-end+1:inc): 0-7:2 27352d747510SLisandro Dalcin a combination of values and ranges separated by commas: 0,1-8,8-15:2 27362d747510SLisandro Dalcin 27372d747510SLisandro Dalcin There must be no intervening spaces between the values. 27382d747510SLisandro Dalcin 27392d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 27402d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(), 27412d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 27422d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 27432d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 27442d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 27452d747510SLisandro Dalcin @*/ 27462d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetIntArray(PetscOptions options,const char pre[],const char name[],PetscInt ivalue[],PetscInt *nmax,PetscBool *set) 27472d747510SLisandro Dalcin { 27482d747510SLisandro Dalcin const char *svalue; 27492d747510SLisandro Dalcin char *value; 27502d747510SLisandro Dalcin PetscErrorCode ierr; 27512d747510SLisandro Dalcin PetscInt n = 0,i,j,start,end,inc,nvalues; 27522d747510SLisandro Dalcin size_t len; 27532d747510SLisandro Dalcin PetscBool flag,foundrange; 27542d747510SLisandro Dalcin PetscToken token; 27552d747510SLisandro Dalcin 27562d747510SLisandro Dalcin PetscFunctionBegin; 27572d747510SLisandro Dalcin PetscValidCharPointer(name,3); 27582d747510SLisandro Dalcin PetscValidIntPointer(ivalue,4); 27592d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 27602d747510SLisandro Dalcin 27612d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 27622d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 27632d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 27642d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 27652d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 27662d747510SLisandro Dalcin while (value && n < *nmax) { 27672d747510SLisandro Dalcin /* look for form d-D where d and D are integers */ 27682d747510SLisandro Dalcin foundrange = PETSC_FALSE; 27692d747510SLisandro Dalcin ierr = PetscStrlen(value,&len);CHKERRQ(ierr); 27702d747510SLisandro Dalcin if (value[0] == '-') i=2; 27712d747510SLisandro Dalcin else i=1; 27722d747510SLisandro Dalcin for (;i<(int)len; i++) { 27732d747510SLisandro Dalcin if (value[i] == '-') { 27742d747510SLisandro Dalcin if (i == (int)len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value); 27752d747510SLisandro Dalcin value[i] = 0; 27762d747510SLisandro Dalcin 27772d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,&start);CHKERRQ(ierr); 27782d747510SLisandro Dalcin inc = 1; 27792d747510SLisandro Dalcin j = i+1; 27802d747510SLisandro Dalcin for (;j<(int)len; j++) { 27812d747510SLisandro Dalcin if (value[j] == ':') { 27822d747510SLisandro Dalcin value[j] = 0; 27832d747510SLisandro Dalcin 27842d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+j+1,&inc);CHKERRQ(ierr); 27852d747510SLisandro 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); 27862d747510SLisandro Dalcin break; 27872d747510SLisandro Dalcin } 27882d747510SLisandro Dalcin } 27892d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value+i+1,&end);CHKERRQ(ierr); 27902d747510SLisandro 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); 27912d747510SLisandro Dalcin nvalues = (end-start)/inc + (end-start)%inc; 27922d747510SLisandro 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); 27932d747510SLisandro Dalcin for (;start<end; start+=inc) { 27942d747510SLisandro Dalcin *ivalue = start; ivalue++;n++; 27952d747510SLisandro Dalcin } 27962d747510SLisandro Dalcin foundrange = PETSC_TRUE; 27972d747510SLisandro Dalcin break; 27982d747510SLisandro Dalcin } 27992d747510SLisandro Dalcin } 28002d747510SLisandro Dalcin if (!foundrange) { 28012d747510SLisandro Dalcin ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr); 28022d747510SLisandro Dalcin ivalue++; 28032d747510SLisandro Dalcin n++; 28042d747510SLisandro Dalcin } 28052d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 28062d747510SLisandro Dalcin } 28072d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 28082d747510SLisandro Dalcin *nmax = n; 28092d747510SLisandro Dalcin PetscFunctionReturn(0); 28102d747510SLisandro Dalcin } 28112d747510SLisandro Dalcin 28122d747510SLisandro Dalcin /*@C 28132d747510SLisandro Dalcin PetscOptionsGetRealArray - Gets an array of double precision values for a 28142d747510SLisandro Dalcin particular option in the database. The values must be separated with 28152d747510SLisandro Dalcin commas with no intervening spaces. 28162d747510SLisandro Dalcin 28172d747510SLisandro Dalcin Not Collective 28182d747510SLisandro Dalcin 28192d747510SLisandro Dalcin Input Parameters: 28202d747510SLisandro Dalcin + options - options database, use NULL for default global database 28212d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 28222d747510SLisandro Dalcin . name - the option one is seeking 28232d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 28242d747510SLisandro Dalcin 28252d747510SLisandro Dalcin Output Parameters: 28262d747510SLisandro Dalcin + dvalue - the double values to return 28272d747510SLisandro Dalcin . nmax - actual number of values retreived 28282d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 28292d747510SLisandro Dalcin 28302d747510SLisandro Dalcin Level: beginner 28312d747510SLisandro Dalcin 28322d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 28332d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 28342d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 28352d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 28362d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 28372d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 28382d747510SLisandro Dalcin @*/ 28392d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetRealArray(PetscOptions options,const char pre[],const char name[],PetscReal dvalue[],PetscInt *nmax,PetscBool *set) 28402d747510SLisandro Dalcin { 28412d747510SLisandro Dalcin const char *svalue; 28422d747510SLisandro Dalcin char *value; 28432d747510SLisandro Dalcin PetscErrorCode ierr; 28442d747510SLisandro Dalcin PetscInt n = 0; 28452d747510SLisandro Dalcin PetscBool flag; 28462d747510SLisandro Dalcin PetscToken token; 28472d747510SLisandro Dalcin 28482d747510SLisandro Dalcin PetscFunctionBegin; 28492d747510SLisandro Dalcin PetscValidCharPointer(name,3); 28502d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 28512d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 28522d747510SLisandro Dalcin 28532d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 28542d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 28552d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 28562d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 28572d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 28582d747510SLisandro Dalcin while (value && n < *nmax) { 28592d747510SLisandro Dalcin ierr = PetscOptionsStringToReal(value,dvalue++);CHKERRQ(ierr); 28602d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 28612d747510SLisandro Dalcin n++; 28622d747510SLisandro Dalcin } 28632d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 28642d747510SLisandro Dalcin *nmax = n; 28652d747510SLisandro Dalcin PetscFunctionReturn(0); 28662d747510SLisandro Dalcin } 28672d747510SLisandro Dalcin 28682d747510SLisandro Dalcin /*@C 28692d747510SLisandro Dalcin PetscOptionsGetScalarArray - Gets an array of scalars for a 28702d747510SLisandro Dalcin particular option in the database. The values must be separated with 28712d747510SLisandro Dalcin commas with no intervening spaces. 28722d747510SLisandro Dalcin 28732d747510SLisandro Dalcin Not Collective 28742d747510SLisandro Dalcin 28752d747510SLisandro Dalcin Input Parameters: 28762d747510SLisandro Dalcin + options - options database, use NULL for default global database 28772d747510SLisandro Dalcin . pre - string to prepend to each name or NULL 28782d747510SLisandro Dalcin . name - the option one is seeking 28792d747510SLisandro Dalcin - nmax - maximum number of values to retrieve 28802d747510SLisandro Dalcin 28812d747510SLisandro Dalcin Output Parameters: 28822d747510SLisandro Dalcin + dvalue - the scalar values to return 28832d747510SLisandro Dalcin . nmax - actual number of values retreived 28842d747510SLisandro Dalcin - set - PETSC_TRUE if found, else PETSC_FALSE 28852d747510SLisandro Dalcin 28862d747510SLisandro Dalcin Level: beginner 28872d747510SLisandro Dalcin 28882d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(), 28892d747510SLisandro Dalcin PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(), 28902d747510SLisandro Dalcin PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 28912d747510SLisandro Dalcin PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 28922d747510SLisandro Dalcin PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 28932d747510SLisandro Dalcin PetscOptionsFList(), PetscOptionsEList() 28942d747510SLisandro Dalcin @*/ 28952d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set) 28962d747510SLisandro Dalcin { 28972d747510SLisandro Dalcin const char *svalue; 28982d747510SLisandro Dalcin char *value; 28992d747510SLisandro Dalcin PetscErrorCode ierr; 29002d747510SLisandro Dalcin PetscInt n = 0; 29012d747510SLisandro Dalcin PetscBool flag; 29022d747510SLisandro Dalcin PetscToken token; 29032d747510SLisandro Dalcin 29042d747510SLisandro Dalcin PetscFunctionBegin; 29052d747510SLisandro Dalcin PetscValidCharPointer(name,3); 29062d747510SLisandro Dalcin PetscValidRealPointer(dvalue,4); 29072d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 29082d747510SLisandro Dalcin 29092d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 29102d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 29112d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 29122d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 29132d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 29142d747510SLisandro Dalcin while (value && n < *nmax) { 29152d747510SLisandro Dalcin ierr = PetscOptionsStringToScalar(value,dvalue++);CHKERRQ(ierr); 29162d747510SLisandro Dalcin ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 29172d747510SLisandro Dalcin n++; 29182d747510SLisandro Dalcin } 29192d747510SLisandro Dalcin ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 29202d747510SLisandro Dalcin *nmax = n; 29212d747510SLisandro Dalcin PetscFunctionReturn(0); 29222d747510SLisandro Dalcin } 292314ce751eSBarry Smith 2924e5c89e4eSSatish Balay /*@C 2925e5c89e4eSSatish Balay PetscOptionsGetStringArray - Gets an array of string values for a particular 2926e5c89e4eSSatish Balay option in the database. The values must be separated with commas with 2927e5c89e4eSSatish Balay no intervening spaces. 2928e5c89e4eSSatish Balay 2929e5c89e4eSSatish Balay Not Collective 2930e5c89e4eSSatish Balay 2931e5c89e4eSSatish Balay Input Parameters: 29325c9cc608SHong Zhang + options - options database, use NULL for default global database 2933c5929fdfSBarry Smith . pre - string to prepend to name or NULL 2934e5c89e4eSSatish Balay . name - the option one is seeking 2935e5c89e4eSSatish Balay - nmax - maximum number of strings 2936e5c89e4eSSatish Balay 2937e7b76fa7SPatrick Sanan Output Parameters: 2938e5c89e4eSSatish Balay + strings - location to copy strings 2939e7b76fa7SPatrick Sanan . nmax - the number of strings found 294096ef3cdfSSatish Balay - set - PETSC_TRUE if found, else PETSC_FALSE 2941e5c89e4eSSatish Balay 2942e5c89e4eSSatish Balay Level: beginner 2943e5c89e4eSSatish Balay 2944e5c89e4eSSatish Balay Notes: 2945e7b76fa7SPatrick Sanan The nmax parameter is used for both input and output. 2946e7b76fa7SPatrick Sanan 2947e5c89e4eSSatish Balay The user should pass in an array of pointers to char, to hold all the 2948e5c89e4eSSatish Balay strings returned by this function. 2949e5c89e4eSSatish Balay 2950e5c89e4eSSatish Balay The user is responsible for deallocating the strings that are 2951e5c89e4eSSatish Balay returned. The Fortran interface for this routine is not supported. 2952e5c89e4eSSatish Balay 2953e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(), 2954acfcf0e5SJed Brown PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), 2955e5c89e4eSSatish Balay PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 2956e5c89e4eSSatish Balay PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 2957acfcf0e5SJed Brown PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 2958a264d7a6SBarry Smith PetscOptionsFList(), PetscOptionsEList() 2959e5c89e4eSSatish Balay @*/ 2960c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetStringArray(PetscOptions options,const char pre[],const char name[],char *strings[],PetscInt *nmax,PetscBool *set) 2961e5c89e4eSSatish Balay { 29622d747510SLisandro Dalcin const char *svalue; 2963e5c89e4eSSatish Balay char *value; 2964e5c89e4eSSatish Balay PetscErrorCode ierr; 29652d747510SLisandro Dalcin PetscInt n = 0; 2966ace3abfcSBarry Smith PetscBool flag; 29679c9d3cfdSBarry Smith PetscToken token; 2968e5c89e4eSSatish Balay 2969e5c89e4eSSatish Balay PetscFunctionBegin; 29702d747510SLisandro Dalcin PetscValidCharPointer(name,3); 29712d747510SLisandro Dalcin PetscValidPointer(strings,4); 29722d747510SLisandro Dalcin PetscValidIntPointer(nmax,5); 2973e5c89e4eSSatish Balay 29742d747510SLisandro Dalcin ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr); 29752d747510SLisandro Dalcin if (!flag || !svalue) { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);} 29762d747510SLisandro Dalcin if (set) *set = PETSC_TRUE; 29772d747510SLisandro Dalcin ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr); 2978e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 29792d747510SLisandro Dalcin while (value && n < *nmax) { 2980e5c89e4eSSatish Balay ierr = PetscStrallocpy(value,&strings[n]);CHKERRQ(ierr); 2981e5c89e4eSSatish Balay ierr = PetscTokenFind(token,&value);CHKERRQ(ierr); 2982e5c89e4eSSatish Balay n++; 2983e5c89e4eSSatish Balay } 29848c74ee41SBarry Smith ierr = PetscTokenDestroy(&token);CHKERRQ(ierr); 2985e5c89e4eSSatish Balay *nmax = n; 2986e5c89e4eSSatish Balay PetscFunctionReturn(0); 2987e5c89e4eSSatish Balay } 298806824ed3SPatrick Sanan 298906824ed3SPatrick Sanan /*@C 299006824ed3SPatrick Sanan PetscOptionsDeprecated - mark an option as deprecated, optionally replacing it with a new one 299106824ed3SPatrick Sanan 299206824ed3SPatrick Sanan Prints a deprecation warning, unless an option is supplied to suppress. 299306824ed3SPatrick Sanan 29941c9f3c13SBarry Smith Logically Collective 299506824ed3SPatrick Sanan 299606824ed3SPatrick Sanan Input Parameters: 29979503aa97SPatrick Sanan + pre - string to prepend to name or NULL 299806824ed3SPatrick Sanan . oldname - the old, deprecated option 299906824ed3SPatrick Sanan . newname - the new option, or NULL if option is purely removed 30009f3a6782SPatrick Sanan . version - a string describing the version of first deprecation, e.g. "3.9" 30019f3a6782SPatrick Sanan - info - additional information string, or NULL. 300206824ed3SPatrick Sanan 300306824ed3SPatrick Sanan Options Database Keys: 300406824ed3SPatrick Sanan . -options_suppress_deprecated_warnings - do not print deprecation warnings 300506824ed3SPatrick Sanan 300606824ed3SPatrick Sanan Notes: 30071c9f3c13SBarry Smith Must be called between PetscOptionsBegin() (or PetscObjectOptionsBegin()) and PetscOptionsEnd(). 30081c9f3c13SBarry Smith Only the proces of rank zero that owns the PetscOptionsItems are argument (managed by PetscOptionsBegin() or 30091c9f3c13SBarry Smith PetscObjectOptionsBegin() prints the information 3010b40114eaSPatrick Sanan If newname is provided, the old option is replaced. Otherwise, it remains 3011b40114eaSPatrick Sanan in the options database. 30129f3a6782SPatrick Sanan If an option is not replaced, the info argument should be used to advise the user 30139f3a6782SPatrick Sanan on how to proceed. 30149f3a6782SPatrick Sanan There is a limit on the length of the warning printed, so very long strings 30159f3a6782SPatrick Sanan provided as info may be truncated. 301606824ed3SPatrick Sanan 301706824ed3SPatrick Sanan Level: developer 301806824ed3SPatrick Sanan 301906824ed3SPatrick Sanan .seealso: PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsScalar(), PetscOptionsBool(), PetscOptionsString(), PetscOptionsSetValue() 302006824ed3SPatrick Sanan 302106824ed3SPatrick Sanan @*/ 30229f3a6782SPatrick Sanan PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems *PetscOptionsObject,const char oldname[],const char newname[],const char version[],const char info[]) 302306824ed3SPatrick Sanan { 302406824ed3SPatrick Sanan PetscErrorCode ierr; 302506824ed3SPatrick Sanan PetscBool found,quiet; 302606824ed3SPatrick Sanan const char *value; 302706824ed3SPatrick Sanan const char * const quietopt="-options_suppress_deprecated_warnings"; 30289f3a6782SPatrick Sanan char msg[4096]; 3029b0bdc838SStefano Zampini char *prefix = NULL; 3030b0bdc838SStefano Zampini PetscOptions options = NULL; 3031b0bdc838SStefano Zampini MPI_Comm comm = PETSC_COMM_SELF; 303206824ed3SPatrick Sanan 303306824ed3SPatrick Sanan PetscFunctionBegin; 303406824ed3SPatrick Sanan PetscValidCharPointer(oldname,2); 303506824ed3SPatrick Sanan PetscValidCharPointer(version,4); 3036b0bdc838SStefano Zampini if (PetscOptionsObject) { 3037b0bdc838SStefano Zampini prefix = PetscOptionsObject->prefix; 3038b0bdc838SStefano Zampini options = PetscOptionsObject->options; 3039b0bdc838SStefano Zampini comm = PetscOptionsObject->comm; 3040b0bdc838SStefano Zampini } 3041b0bdc838SStefano Zampini ierr = PetscOptionsFindPair(options,prefix,oldname,&value,&found);CHKERRQ(ierr); 304206824ed3SPatrick Sanan if (found) { 304306824ed3SPatrick Sanan if (newname) { 3044b0bdc838SStefano Zampini if (prefix) { 3045b0bdc838SStefano Zampini ierr = PetscOptionsPrefixPush(options,prefix);CHKERRQ(ierr); 3046d255429eSPatrick Sanan } 3047b0bdc838SStefano Zampini ierr = PetscOptionsSetValue(options,newname,value);CHKERRQ(ierr); 3048b0bdc838SStefano Zampini if (prefix) { 3049b0bdc838SStefano Zampini ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr); 3050d255429eSPatrick Sanan } 3051b0bdc838SStefano Zampini ierr = PetscOptionsClearValue(options,oldname);CHKERRQ(ierr); 3052b40114eaSPatrick Sanan } 305306824ed3SPatrick Sanan quiet = PETSC_FALSE; 3054b0bdc838SStefano Zampini ierr = PetscOptionsGetBool(options,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr); 305506824ed3SPatrick Sanan if (!quiet) { 30569f3a6782SPatrick Sanan ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr); 30571fa95f81SSatish Balay ierr = PetscStrcat(msg,oldname);CHKERRQ(ierr); 3058928bb9adSStefano Zampini ierr = PetscStrcat(msg," is deprecated as of version ");CHKERRQ(ierr); 30599f3a6782SPatrick Sanan ierr = PetscStrcat(msg,version);CHKERRQ(ierr); 30609f3a6782SPatrick Sanan ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr); 306106824ed3SPatrick Sanan if (newname) { 30629f3a6782SPatrick Sanan ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr); 30639f3a6782SPatrick Sanan ierr = PetscStrcat(msg,newname);CHKERRQ(ierr); 30649f3a6782SPatrick Sanan ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr); 306506824ed3SPatrick Sanan } 30669f3a6782SPatrick Sanan if (info) { 30679f3a6782SPatrick Sanan ierr = PetscStrcat(msg," ");CHKERRQ(ierr); 30689f3a6782SPatrick Sanan ierr = PetscStrcat(msg,info);CHKERRQ(ierr); 30699f3a6782SPatrick Sanan } 30709f3a6782SPatrick Sanan ierr = PetscStrcat(msg," (Silence this warning with ");CHKERRQ(ierr); 30719f3a6782SPatrick Sanan ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr); 30729f3a6782SPatrick Sanan ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr); 3073b0bdc838SStefano Zampini ierr = PetscPrintf(comm,msg);CHKERRQ(ierr); 307406824ed3SPatrick Sanan } 307506824ed3SPatrick Sanan } 307606824ed3SPatrick Sanan PetscFunctionReturn(0); 307706824ed3SPatrick Sanan } 3078