xref: /petsc/src/sys/objects/options.c (revision d255429ead8db3d80f1cea5e2c8c5fc31cdd25c0)
173fca5a0SBarry Smith /* Define Feature test macros to make sure atoll is available (SVr4, POSIX.1-2001, 4.3BSD, C99), not in (C89 and POSIX.1-1996) */
20039db0dSBarry Smith #define PETSC_DESIRE_FEATURE_TEST_MACROS /* for atoll() */
3e5ea902fSJed Brown 
4e5c89e4eSSatish Balay /*
53fc1eb6aSBarry Smith    These routines simplify the use of command line, file options, etc., and are used to manipulate the options database.
63fc1eb6aSBarry Smith    This provides the low-level interface, the high level interface is in aoptions.c
7e5c89e4eSSatish Balay 
83fc1eb6aSBarry Smith    Some routines use regular malloc and free because it cannot know  what malloc is requested with the
93fc1eb6aSBarry Smith    options database until it has already processed the input.
10e5c89e4eSSatish Balay */
11e5c89e4eSSatish Balay 
12af0996ceSBarry Smith #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
13665c2dedSJed Brown #include <petscviewer.h>
14ad1ac5ecSJed Brown #include <ctype.h>
15e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MALLOC_H)
16e5c89e4eSSatish Balay #include <malloc.h>
17e5c89e4eSSatish Balay #endif
18ef279fd6SBarry Smith #if defined(PETSC_HAVE_STRING_H)
192d747510SLisandro Dalcin #include <string.h>             /* strcasecmp */
20ef279fd6SBarry Smith #endif
21ef279fd6SBarry Smith #if defined(PETSC_HAVE_STRINGS_H)
22ef279fd6SBarry Smith #  include <strings.h>          /* strcasecmp */
23ef279fd6SBarry Smith #endif
243bcbd388SSean Farley #if defined(PETSC_HAVE_YAML)
253bcbd388SSean Farley #include <yaml.h>
263bcbd388SSean Farley #endif
27e5c89e4eSSatish Balay 
282d747510SLisandro Dalcin #if defined(PETSC_HAVE_STRCASECMP)
292d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) strcasecmp(a,b)
302d747510SLisandro Dalcin #elif defined(PETSC_HAVE_STRICMP)
312d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) stricmp(a,b)
322d747510SLisandro Dalcin #else
332d747510SLisandro Dalcin #define PetscOptNameCmp(a,b) Error_strcasecmp_not_found
342d747510SLisandro Dalcin #endif
352d747510SLisandro Dalcin 
362d747510SLisandro Dalcin #include <petsc/private/hashtable.h>
372d747510SLisandro Dalcin 
382d747510SLisandro Dalcin /* This assumes ASCII encoding and ignores locale settings */
392d747510SLisandro Dalcin /* Using tolower() is about 2X slower in microbenchmarks   */
402d747510SLisandro Dalcin PETSC_STATIC_INLINE int PetscToLower(int c)
412d747510SLisandro Dalcin {
422d747510SLisandro Dalcin   return ((c >= 'A') & (c <= 'Z')) ? c + 'a' - 'A' : c;
432d747510SLisandro Dalcin }
442d747510SLisandro Dalcin 
452d747510SLisandro Dalcin /* Bob Jenkins's one at a time hash function (case-insensitive) */
462d747510SLisandro Dalcin PETSC_STATIC_INLINE unsigned int PetscOptHash(const char key[])
472d747510SLisandro Dalcin {
482d747510SLisandro Dalcin   unsigned int hash = 0;
492d747510SLisandro Dalcin   while (*key) {
502d747510SLisandro Dalcin     hash += PetscToLower(*key++);
512d747510SLisandro Dalcin     hash += hash << 10;
522d747510SLisandro Dalcin     hash ^= hash >>  6;
532d747510SLisandro Dalcin   }
542d747510SLisandro Dalcin   hash += hash <<  3;
552d747510SLisandro Dalcin   hash ^= hash >> 11;
562d747510SLisandro Dalcin   hash += hash << 15;
572d747510SLisandro Dalcin   return hash;
582d747510SLisandro Dalcin }
592d747510SLisandro Dalcin 
602d747510SLisandro Dalcin PETSC_STATIC_INLINE int PetscOptEqual(const char a[],const char b[])
612d747510SLisandro Dalcin {
622d747510SLisandro Dalcin   return !PetscOptNameCmp(a,b);
632d747510SLisandro Dalcin }
642d747510SLisandro Dalcin 
652d747510SLisandro Dalcin KHASH_INIT(HO, kh_cstr_t, int, 1, PetscOptHash, PetscOptEqual)
662d747510SLisandro Dalcin 
67e5c89e4eSSatish Balay /*
683fc1eb6aSBarry Smith     This table holds all the options set by the user. For simplicity, we use a static size database
69e5c89e4eSSatish Balay */
702d747510SLisandro Dalcin #define MAXOPTNAME 512
71e5c89e4eSSatish Balay #define MAXOPTIONS 512
72e5c89e4eSSatish Balay #define MAXALIASES  25
7374e0666dSJed Brown #define MAXPREFIXES 25
742d747510SLisandro Dalcin #define MAXOPTIONSMONITORS 5
75e5c89e4eSSatish Balay 
764416b707SBarry Smith struct  _n_PetscOptions {
772d747510SLisandro Dalcin   int        N;                    /* number of options */
782d747510SLisandro Dalcin   char       *names[MAXOPTIONS];   /* option names */
792d747510SLisandro Dalcin   char       *values[MAXOPTIONS];  /* option values */
802d747510SLisandro Dalcin   PetscBool  used[MAXOPTIONS];     /* flag option use */
81081c24baSBoyana Norris 
822d747510SLisandro Dalcin   /* Hash table */
832d747510SLisandro Dalcin   khash_t(HO) *ht;
842d747510SLisandro Dalcin 
852d747510SLisandro Dalcin   /* Prefixes */
862d747510SLisandro Dalcin   int   prefixind;
872d747510SLisandro Dalcin   int   prefixstack[MAXPREFIXES];
882d747510SLisandro Dalcin   char  prefix[MAXOPTNAME];
892d747510SLisandro Dalcin 
902d747510SLisandro Dalcin   /* Aliases */
912d747510SLisandro Dalcin   int  Naliases;                   /* number or aliases */
922d747510SLisandro Dalcin   char *aliases1[MAXALIASES];      /* aliased */
932d747510SLisandro Dalcin   char *aliases2[MAXALIASES];      /* aliasee */
942d747510SLisandro Dalcin 
952d747510SLisandro Dalcin   /* Help */
962d747510SLisandro Dalcin   PetscBool help; /* flag whether "-help" is in the database */
972d747510SLisandro Dalcin 
982d747510SLisandro Dalcin   /* Monitors */
99081c24baSBoyana Norris   PetscErrorCode (*monitor[MAXOPTIONSMONITORS])(const char[],const char[],void*); /* returns control to user after */
100c2efdce3SBarry Smith   PetscErrorCode (*monitordestroy[MAXOPTIONSMONITORS])(void**);         /* */
101081c24baSBoyana Norris   void           *monitorcontext[MAXOPTIONSMONITORS];                  /* to pass arbitrary user data into monitor */
102081c24baSBoyana Norris   PetscInt       numbermonitors;                                       /* to, for instance, detect options being set */
1034416b707SBarry Smith };
104e5c89e4eSSatish Balay 
1054416b707SBarry Smith static PetscOptions defaultoptions = NULL;
106f8d0b74dSMatthew Knepley 
1072d747510SLisandro Dalcin 
108081c24baSBoyana Norris /*
109081c24baSBoyana Norris     Options events monitor
110081c24baSBoyana Norris */
1112d747510SLisandro Dalcin static PetscErrorCode PetscOptionsMonitor(PetscOptions options,const char name[],const char value[])
112e5c89e4eSSatish Balay {
1132d747510SLisandro Dalcin   PetscInt       i;
114e5c89e4eSSatish Balay   PetscErrorCode ierr;
115e5c89e4eSSatish Balay 
1162d747510SLisandro Dalcin   if (!PetscInitializeCalled) return 0;
117e5c89e4eSSatish Balay   PetscFunctionBegin;
1182d747510SLisandro Dalcin   for (i=0; i<options->numbermonitors; i++) {
1192d747510SLisandro Dalcin     ierr = (*options->monitor[i])(name,value,options->monitorcontext[i]);CHKERRQ(ierr);
120e5c89e4eSSatish Balay   }
121e5c89e4eSSatish Balay   PetscFunctionReturn(0);
122e5c89e4eSSatish Balay }
123e5c89e4eSSatish Balay 
1242d747510SLisandro Dalcin /*@
1252d747510SLisandro Dalcin    PetscOptionsCreate - Creates an empty options database.
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay    Output Parameter:
1282d747510SLisandro Dalcin .  options - Options database object
129e5c89e4eSSatish Balay 
130e5c89e4eSSatish Balay    Level: advanced
131e5c89e4eSSatish Balay 
1322d747510SLisandro Dalcin .seealso: PetscOptionsDestroy()
133e5c89e4eSSatish Balay @*/
1342d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreate(PetscOptions *options)
1352d747510SLisandro Dalcin {
1362d747510SLisandro Dalcin   if (!options) return PETSC_ERR_ARG_NULL;
1372d747510SLisandro Dalcin   *options = (PetscOptions)calloc(1,sizeof(**options));
1382d747510SLisandro Dalcin   if (!*options) return PETSC_ERR_MEM;
1392d747510SLisandro Dalcin   return 0;
1402d747510SLisandro Dalcin }
1412d747510SLisandro Dalcin 
1422d747510SLisandro Dalcin /*@
1432d747510SLisandro Dalcin     PetscOptionsDestroy - Destroys an option database.
1442d747510SLisandro Dalcin 
1452d747510SLisandro Dalcin   Input Parameter:
1462d747510SLisandro Dalcin .  options - the PetscOptions object
1472d747510SLisandro Dalcin 
1482d747510SLisandro Dalcin    Level: developer
1492d747510SLisandro Dalcin 
1502d747510SLisandro Dalcin .seealso: PetscOptionsInsert()
1512d747510SLisandro Dalcin @*/
1522d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroy(PetscOptions *options)
153e5c89e4eSSatish Balay {
154e5c89e4eSSatish Balay   PetscErrorCode ierr;
155e5c89e4eSSatish Balay 
1562d747510SLisandro Dalcin   if (!*options) return 0;
1572d747510SLisandro Dalcin   ierr = PetscOptionsClear(*options);if (ierr) return ierr;
1582d747510SLisandro Dalcin   /* XXX what about monitors ? */
1592800570dSLisandro Dalcin   free(*options);
1602d747510SLisandro Dalcin   *options = NULL;
161e5c89e4eSSatish Balay   PetscFunctionReturn(0);
162e5c89e4eSSatish Balay }
163e5c89e4eSSatish Balay 
1642d747510SLisandro Dalcin /*
1652d747510SLisandro Dalcin     PetscOptionsCreateDefault - Creates the default global options database
1662d747510SLisandro Dalcin */
1672d747510SLisandro Dalcin PetscErrorCode PetscOptionsCreateDefault(void)
168e5c89e4eSSatish Balay {
169e5c89e4eSSatish Balay   PetscErrorCode ierr;
170e5c89e4eSSatish Balay 
1712d747510SLisandro Dalcin   if (!defaultoptions) {
1722d747510SLisandro Dalcin     ierr = PetscOptionsCreate(&defaultoptions);if (ierr) return ierr;
1732d747510SLisandro Dalcin   }
1742d747510SLisandro Dalcin   return 0;
1752d747510SLisandro Dalcin }
1762d747510SLisandro Dalcin 
1772d747510SLisandro Dalcin /*
1782d747510SLisandro Dalcin     PetscOptionsDestroyDefault - Destroys the default global options database
1792d747510SLisandro Dalcin */
1802d747510SLisandro Dalcin PetscErrorCode PetscOptionsDestroyDefault(void)
1812d747510SLisandro Dalcin {
1822d747510SLisandro Dalcin   PetscErrorCode ierr;
1832d747510SLisandro Dalcin 
1842d747510SLisandro Dalcin   ierr = PetscOptionsDestroy(&defaultoptions);if (ierr) return ierr;
1852d747510SLisandro Dalcin   return 0;
186e5c89e4eSSatish Balay }
187e5c89e4eSSatish Balay 
18894ef8ddeSSatish Balay /*@C
1897cd08cecSJed Brown    PetscOptionsValidKey - PETSc Options database keys must begin with one or two dashes (-) followed by a letter.
1903fc1eb6aSBarry Smith 
1913fc1eb6aSBarry Smith    Input Parameter:
1922d747510SLisandro Dalcin .  key - string to check if valid
1933fc1eb6aSBarry Smith 
1943fc1eb6aSBarry Smith    Output Parameter:
1952d747510SLisandro Dalcin .  valid - PETSC_TRUE if a valid key
1963fc1eb6aSBarry Smith 
197f6680f47SSatish Balay    Level: intermediate
1983fc1eb6aSBarry Smith @*/
1992d747510SLisandro Dalcin PetscErrorCode PetscOptionsValidKey(const char key[],PetscBool *valid)
20096fc60bcSBarry Smith {
201f603b5e9SToby Isaac   char           *ptr;
2027c5db45bSBarry Smith 
20396fc60bcSBarry Smith   PetscFunctionBegin;
2042d747510SLisandro Dalcin   if (key) PetscValidCharPointer(key,1);
2052d747510SLisandro Dalcin   PetscValidPointer(valid,2);
2062d747510SLisandro Dalcin   *valid = PETSC_FALSE;
2072d747510SLisandro Dalcin   if (!key) PetscFunctionReturn(0);
2082d747510SLisandro Dalcin   if (key[0] != '-') PetscFunctionReturn(0);
2092d747510SLisandro Dalcin   if (key[1] == '-') key++;
2102d747510SLisandro Dalcin   if (!isalpha((int)(key[1]))) PetscFunctionReturn(0);
2112d747510SLisandro Dalcin   (void) strtod(key,&ptr);
2122d747510SLisandro Dalcin   if (ptr != key && !(*ptr == '_' || isalnum(*ptr))) PetscFunctionReturn(0);
2132d747510SLisandro Dalcin   *valid = PETSC_TRUE;
21496fc60bcSBarry Smith   PetscFunctionReturn(0);
21596fc60bcSBarry Smith }
21696fc60bcSBarry Smith 
217e5c89e4eSSatish Balay /*@C
218e5c89e4eSSatish Balay    PetscOptionsInsertString - Inserts options into the database from a string
219e5c89e4eSSatish Balay 
2202d747510SLisandro Dalcin    Not Collective, but only processes that call this routine will set the options
22101508a89SJed Brown    included in the string
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay    Input Parameter:
224a8c7a070SBarry Smith .  in_str - string that contains options separated by blanks
225e5c89e4eSSatish Balay 
226e5c89e4eSSatish Balay 
227e5c89e4eSSatish Balay    Level: intermediate
228e5c89e4eSSatish Balay 
229e5c89e4eSSatish Balay    Contributed by Boyana Norris
230e5c89e4eSSatish Balay 
23188c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(),
232acfcf0e5SJed Brown           PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(),
233e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
234e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
235acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
236a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList(), PetscOptionsInsertFile()
237e5c89e4eSSatish Balay @*/
238c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertString(PetscOptions options,const char in_str[])
239e5c89e4eSSatish Balay {
24096fc60bcSBarry Smith   char           *first,*second;
241e5c89e4eSSatish Balay   PetscErrorCode ierr;
2429c9d3cfdSBarry Smith   PetscToken     token;
243ace3abfcSBarry Smith   PetscBool      key,ispush,ispop;
244e5c89e4eSSatish Balay 
245e5c89e4eSSatish Balay   PetscFunctionBegin;
24696fc60bcSBarry Smith   ierr = PetscTokenCreate(in_str,' ',&token);CHKERRQ(ierr);
247e5c89e4eSSatish Balay   ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
24896fc60bcSBarry Smith   while (first) {
2499db968c8SJed Brown     ierr = PetscStrcasecmp(first,"-prefix_push",&ispush);CHKERRQ(ierr);
2509db968c8SJed Brown     ierr = PetscStrcasecmp(first,"-prefix_pop",&ispop);CHKERRQ(ierr);
25196fc60bcSBarry Smith     ierr = PetscOptionsValidKey(first,&key);CHKERRQ(ierr);
2529db968c8SJed Brown     if (ispush) {
2539db968c8SJed Brown       ierr = PetscTokenFind(token,&second);CHKERRQ(ierr);
254c5929fdfSBarry Smith       ierr = PetscOptionsPrefixPush(options,second);CHKERRQ(ierr);
2559db968c8SJed Brown       ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
2569db968c8SJed Brown     } else if (ispop) {
257c5929fdfSBarry Smith       ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr);
2589db968c8SJed Brown       ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
2599db968c8SJed Brown     } else if (key) {
260e5c89e4eSSatish Balay       ierr = PetscTokenFind(token,&second);CHKERRQ(ierr);
26196fc60bcSBarry Smith       ierr = PetscOptionsValidKey(second,&key);CHKERRQ(ierr);
26296fc60bcSBarry Smith       if (!key) {
263c5929fdfSBarry Smith         ierr = PetscOptionsSetValue(options,first,second);CHKERRQ(ierr);
26496fc60bcSBarry Smith         ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
26596fc60bcSBarry Smith       } else {
266c5929fdfSBarry Smith         ierr  = PetscOptionsSetValue(options,first,NULL);CHKERRQ(ierr);
26796fc60bcSBarry Smith         first = second;
26896fc60bcSBarry Smith       }
26996fc60bcSBarry Smith     } else {
27096fc60bcSBarry Smith       ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
271e5c89e4eSSatish Balay     }
272e5c89e4eSSatish Balay   }
2738c74ee41SBarry Smith   ierr = PetscTokenDestroy(&token);CHKERRQ(ierr);
274e5c89e4eSSatish Balay   PetscFunctionReturn(0);
275e5c89e4eSSatish Balay }
276e5c89e4eSSatish Balay 
2773fc1eb6aSBarry Smith /*
2783fc1eb6aSBarry Smith     Returns a line (ended by a \n, \r or null character of any length. Result should be freed with free()
2793fc1eb6aSBarry Smith */
2805fa91da5SBarry Smith static char *Petscgetline(FILE * f)
2815fa91da5SBarry Smith {
2825fa91da5SBarry Smith   size_t size  = 0;
2835fa91da5SBarry Smith   size_t len   = 0;
2845fa91da5SBarry Smith   size_t last  = 0;
2850298fd71SBarry Smith   char   *buf  = NULL;
2865fa91da5SBarry Smith 
2875fa91da5SBarry Smith   if (feof(f)) return 0;
2885fa91da5SBarry Smith   do {
2895fa91da5SBarry Smith     size += 1024; /* BUFSIZ is defined as "the optimal read size for this platform" */
2906e0c8459SSatish Balay     buf   = (char*)realloc((void*)buf,size); /* realloc(NULL,n) is the same as malloc(n) */
2915fa91da5SBarry Smith     /* Actually do the read. Note that fgets puts a terminal '\0' on the
2925fa91da5SBarry Smith     end of the string, so we make sure we overwrite this */
29308ac41f7SSatish Balay     if (!fgets(buf+len,size,f)) buf[len]=0;
2945fa91da5SBarry Smith     PetscStrlen(buf,&len);
2955fa91da5SBarry Smith     last = len - 1;
2965fa91da5SBarry Smith   } while (!feof(f) && buf[last] != '\n' && buf[last] != '\r');
29708ac41f7SSatish Balay   if (len) return buf;
2985fa91da5SBarry Smith   free(buf);
2995fa91da5SBarry Smith   return 0;
3005fa91da5SBarry Smith }
3015fa91da5SBarry Smith 
302e5c89e4eSSatish Balay /*@C
303e5c89e4eSSatish Balay      PetscOptionsInsertFile - Inserts options into the database from a file.
304e5c89e4eSSatish Balay 
3054c48f4c1SBarry Smith      Collective on MPI_Comm
306e5c89e4eSSatish Balay 
307e5c89e4eSSatish Balay   Input Parameter:
3089b754dc9SBarry Smith +   comm - the processes that will share the options (usually PETSC_COMM_WORLD)
309c5929fdfSBarry Smith .   options - options database, use NULL for default global database
310e5c89e4eSSatish Balay .   file - name of file
3119b754dc9SBarry Smith -   require - if PETSC_TRUE will generate an error if the file does not exist
312e5c89e4eSSatish Balay 
313e5c89e4eSSatish Balay 
31495452b02SPatrick Sanan   Notes:
31595452b02SPatrick Sanan     Use  # for lines that are comments and which should be ignored.
3167c43ebc8SBarry Smith 
317f0feba65SBarry Smith    Usually, instead of using this command, one should list the file name in the call to PetscInitialize(), this insures that certain options
318609bdbeeSBarry 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
319f0feba65SBarry Smith    calls to XXXSetFromOptions() it should not be used for options listed under PetscInitialize().
320f0feba65SBarry Smith 
3213bcbd388SSean Farley   Level: developer
322e5c89e4eSSatish Balay 
32388c29154SBarry Smith .seealso: PetscOptionsSetValue(), PetscOptionsView(), PetscOptionsHasName(), PetscOptionsGetInt(),
324acfcf0e5SJed Brown           PetscOptionsGetReal(), PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(),
325e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
326e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
327acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
328a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
329e5c89e4eSSatish Balay 
330e5c89e4eSSatish Balay @*/
331c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsertFile(MPI_Comm comm,PetscOptions options,const char file[],PetscBool require)
332e5c89e4eSSatish Balay {
3333a018368SJed Brown   char           *string,fname[PETSC_MAX_PATH_LEN],*first,*second,*third,*vstring = 0,*astring = 0,*packed = 0;
334e5c89e4eSSatish Balay   PetscErrorCode ierr;
33513e3f751SJed Brown   size_t         i,len,bytes;
336e5c89e4eSSatish Balay   FILE           *fd;
3379c9d3cfdSBarry Smith   PetscToken     token;
338ed9cf6e9SBarry Smith   int            err;
3397c43ebc8SBarry Smith   char           cmt[1]={'#'},*cmatch;
3403a018368SJed Brown   PetscMPIInt    rank,cnt=0,acnt=0,counts[2];
341ad38b122SPatrick Sanan   PetscBool      isdir;
342e5c89e4eSSatish Balay 
343e5c89e4eSSatish Balay   PetscFunctionBegin;
34405c7dedfSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
34505c7dedfSBarry Smith   if (!rank) {
34666af5158SSatish Balay     cnt        = 0;
34766af5158SSatish Balay     acnt       = 0;
34805c7dedfSBarry Smith 
349e5c89e4eSSatish Balay     ierr = PetscFixFilename(file,fname);CHKERRQ(ierr);
350e5c89e4eSSatish Balay     fd   = fopen(fname,"r");
351ad38b122SPatrick Sanan     ierr = PetscTestDirectory(fname,'r',&isdir);CHKERRQ(ierr);
352ad38b122SPatrick Sanan     if (isdir && require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Specified options file %s is a directory",fname);
353ad38b122SPatrick Sanan     if (fd && !isdir) {
3543a018368SJed Brown       PetscSegBuffer vseg,aseg;
3553a018368SJed Brown       ierr = PetscSegBufferCreate(1,4000,&vseg);CHKERRQ(ierr);
3563a018368SJed Brown       ierr = PetscSegBufferCreate(1,2000,&aseg);CHKERRQ(ierr);
3573a018368SJed Brown 
3589b754dc9SBarry Smith       /* the following line will not work when opening initial files (like .petscrc) since info is not yet set */
3599b754dc9SBarry Smith       ierr = PetscInfo1(0,"Opened options file %s\n",file);CHKERRQ(ierr);
360e24ecc5dSJed Brown 
3615fa91da5SBarry Smith       while ((string = Petscgetline(fd))) {
3624704e885SBarry Smith         /* eliminate comments from each line */
3637c43ebc8SBarry Smith         for (i=0; i<1; i++) {
364a2ea699eSBarry Smith           ierr = PetscStrchr(string,cmt[i],&cmatch);CHKERRQ(ierr);
36590f79514SSatish Balay           if (cmatch) *cmatch = 0;
36690f79514SSatish Balay         }
367e5c89e4eSSatish Balay         ierr = PetscStrlen(string,&len);CHKERRQ(ierr);
3685981331cSSatish Balay         /* replace tabs, ^M, \n with " " */
369e5c89e4eSSatish Balay         for (i=0; i<len; i++) {
3705981331cSSatish Balay           if (string[i] == '\t' || string[i] == '\r' || string[i] == '\n') {
371e5c89e4eSSatish Balay             string[i] = ' ';
372e5c89e4eSSatish Balay           }
373e5c89e4eSSatish Balay         }
37490f79514SSatish Balay         ierr = PetscTokenCreate(string,' ',&token);CHKERRQ(ierr);
375e5c89e4eSSatish Balay         ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
37690f79514SSatish Balay         if (!first) {
37702b0d46eSSatish Balay           goto destroy;
37890f79514SSatish Balay         } else if (!first[0]) { /* if first token is empty spaces, redo first token */
37990f79514SSatish Balay           ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
38090f79514SSatish Balay         }
381e5c89e4eSSatish Balay         ierr = PetscTokenFind(token,&second);CHKERRQ(ierr);
3822662f744SSatish Balay         if (!first) {
3832662f744SSatish Balay           goto destroy;
3842662f744SSatish Balay         } else if (first[0] == '-') {
385e24ecc5dSJed Brown           ierr = PetscStrlen(first,&len);CHKERRQ(ierr);
38613e3f751SJed Brown           ierr = PetscSegBufferGet(vseg,len+1,&vstring);CHKERRQ(ierr);
387e24ecc5dSJed Brown           ierr = PetscMemcpy(vstring,first,len);CHKERRQ(ierr);
388e24ecc5dSJed Brown           vstring[len] = ' ';
38909192fe3SBarry Smith           if (second) {
390e24ecc5dSJed Brown             ierr = PetscStrlen(second,&len);CHKERRQ(ierr);
39113e3f751SJed Brown             ierr = PetscSegBufferGet(vseg,len+3,&vstring);CHKERRQ(ierr);
392e24ecc5dSJed Brown             vstring[0] = '"';
393e24ecc5dSJed Brown             ierr = PetscMemcpy(vstring+1,second,len);CHKERRQ(ierr);
394e24ecc5dSJed Brown             vstring[len+1] = '"';
395e24ecc5dSJed Brown             vstring[len+2] = ' ';
39609192fe3SBarry Smith           }
39790f79514SSatish Balay         } else {
398ace3abfcSBarry Smith           PetscBool match;
399e5c89e4eSSatish Balay 
400e5c89e4eSSatish Balay           ierr = PetscStrcasecmp(first,"alias",&match);CHKERRQ(ierr);
401e5c89e4eSSatish Balay           if (match) {
402e5c89e4eSSatish Balay             ierr = PetscTokenFind(token,&third);CHKERRQ(ierr);
403e32f2f54SBarry Smith             if (!third) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Error in options file:alias missing (%s)",second);
404e24ecc5dSJed Brown             ierr = PetscStrlen(second,&len);CHKERRQ(ierr);
40513e3f751SJed Brown             ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr);
406e24ecc5dSJed Brown             ierr = PetscMemcpy(astring,second,len);CHKERRQ(ierr);
407e24ecc5dSJed Brown             astring[len] = ' ';
408e24ecc5dSJed Brown 
409e24ecc5dSJed Brown             ierr = PetscStrlen(third,&len);CHKERRQ(ierr);
41013e3f751SJed Brown             ierr = PetscSegBufferGet(aseg,len+1,&astring);CHKERRQ(ierr);
411e24ecc5dSJed Brown             ierr = PetscMemcpy(astring,third,len);CHKERRQ(ierr);
412e24ecc5dSJed Brown             astring[len] = ' ';
413f23aa3ddSBarry Smith           } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown statement in options file: (%s)",string);
414e5c89e4eSSatish Balay         }
41502b0d46eSSatish Balay destroy:
4164b40f50bSBarry Smith         free(string);
4178c74ee41SBarry Smith         ierr = PetscTokenDestroy(&token);CHKERRQ(ierr);
418e5c89e4eSSatish Balay       }
419ed9cf6e9SBarry Smith       err = fclose(fd);
420e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
421e24ecc5dSJed Brown       ierr = PetscSegBufferGetSize(aseg,&bytes);CHKERRQ(ierr); /* size without null termination */
422e24ecc5dSJed Brown       ierr = PetscMPIIntCast(bytes,&acnt);CHKERRQ(ierr);
423e24ecc5dSJed Brown       ierr = PetscSegBufferGet(aseg,1,&astring);CHKERRQ(ierr);
424e24ecc5dSJed Brown       astring[0] = 0;
425e24ecc5dSJed Brown       ierr = PetscSegBufferGetSize(vseg,&bytes);CHKERRQ(ierr); /* size without null termination */
426e24ecc5dSJed Brown       ierr = PetscMPIIntCast(bytes,&cnt);CHKERRQ(ierr);
427e24ecc5dSJed Brown       ierr = PetscSegBufferGet(vseg,1,&vstring);CHKERRQ(ierr);
428e24ecc5dSJed Brown       vstring[0] = 0;
429854ce69bSBarry Smith       ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr);
4303a018368SJed Brown       ierr = PetscSegBufferExtractTo(aseg,packed);CHKERRQ(ierr);
4313a018368SJed Brown       ierr = PetscSegBufferExtractTo(vseg,packed+acnt+1);CHKERRQ(ierr);
4323a018368SJed Brown       ierr = PetscSegBufferDestroy(&aseg);CHKERRQ(ierr);
4333a018368SJed Brown       ierr = PetscSegBufferDestroy(&vseg);CHKERRQ(ierr);
434f23aa3ddSBarry Smith     } else if (require) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Unable to open Options File %s",fname);
4359b754dc9SBarry Smith   }
43605c7dedfSBarry Smith 
4373a018368SJed Brown   counts[0] = acnt;
4383a018368SJed Brown   counts[1] = cnt;
4393a018368SJed Brown   ierr = MPI_Bcast(counts,2,MPI_INT,0,comm);CHKERRQ(ierr);
4403a018368SJed Brown   acnt = counts[0];
4413a018368SJed Brown   cnt = counts[1];
4423a018368SJed Brown   if (rank) {
443854ce69bSBarry Smith     ierr = PetscMalloc1(2+acnt+cnt,&packed);CHKERRQ(ierr);
4443a018368SJed Brown   }
4453a018368SJed Brown   if (acnt || cnt) {
4463a018368SJed Brown     ierr = MPI_Bcast(packed,2+acnt+cnt,MPI_CHAR,0,comm);CHKERRQ(ierr);
4473a018368SJed Brown     astring = packed;
4483a018368SJed Brown     vstring = packed + acnt + 1;
4493a018368SJed Brown   }
4503a018368SJed Brown 
4519b754dc9SBarry Smith   if (acnt) {
4529b754dc9SBarry Smith     PetscToken token;
4539b754dc9SBarry Smith     char       *first,*second;
4549b754dc9SBarry Smith 
4559b754dc9SBarry Smith     ierr = PetscTokenCreate(astring,' ',&token);CHKERRQ(ierr);
4569b754dc9SBarry Smith     ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
4579b754dc9SBarry Smith     while (first) {
4589b754dc9SBarry Smith       ierr = PetscTokenFind(token,&second);CHKERRQ(ierr);
459c5929fdfSBarry Smith       ierr = PetscOptionsSetAlias(options,first,second);CHKERRQ(ierr);
4609b754dc9SBarry Smith       ierr = PetscTokenFind(token,&first);CHKERRQ(ierr);
4619b754dc9SBarry Smith     }
4628c74ee41SBarry Smith     ierr = PetscTokenDestroy(&token);CHKERRQ(ierr);
4639b754dc9SBarry Smith   }
4649b754dc9SBarry Smith 
4659b754dc9SBarry Smith   if (cnt) {
466c5929fdfSBarry Smith     ierr = PetscOptionsInsertString(options,vstring);CHKERRQ(ierr);
467e5c89e4eSSatish Balay   }
4683a018368SJed Brown   ierr = PetscFree(packed);CHKERRQ(ierr);
469e5c89e4eSSatish Balay   PetscFunctionReturn(0);
470e5c89e4eSSatish Balay }
471e5c89e4eSSatish Balay 
4722d747510SLisandro Dalcin static PetscErrorCode PetscOptionsInsertArgs(PetscOptions options,int argc,char *args[])
47385079163SJed Brown {
47485079163SJed Brown   PetscErrorCode ierr;
47585079163SJed Brown   int            left    = argc - 1;
47685079163SJed Brown   char           **eargs = args + 1;
47785079163SJed Brown 
47885079163SJed Brown   PetscFunctionBegin;
47985079163SJed Brown   while (left) {
480093de6efSBarry Smith     PetscBool isoptions_file,isprefixpush,isprefixpop,isp4,tisp4,isp4yourname,isp4rmrank,key;
48185079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-options_file",&isoptions_file);CHKERRQ(ierr);
4829db968c8SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-prefix_push",&isprefixpush);CHKERRQ(ierr);
4839db968c8SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-prefix_pop",&isprefixpop);CHKERRQ(ierr);
48485079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-p4pg",&isp4);CHKERRQ(ierr);
48585079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-p4yourname",&isp4yourname);CHKERRQ(ierr);
48685079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-p4rmrank",&isp4rmrank);CHKERRQ(ierr);
48785079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-p4wd",&tisp4);CHKERRQ(ierr);
488ace3abfcSBarry Smith     isp4 = (PetscBool) (isp4 || tisp4);
48985079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-np",&tisp4);CHKERRQ(ierr);
490ace3abfcSBarry Smith     isp4 = (PetscBool) (isp4 || tisp4);
49185079163SJed Brown     ierr = PetscStrcasecmp(eargs[0],"-p4amslave",&tisp4);CHKERRQ(ierr);
492093de6efSBarry Smith     ierr = PetscOptionsValidKey(eargs[0],&key);CHKERRQ(ierr);
49385079163SJed Brown 
494093de6efSBarry Smith     if (!key) {
49585079163SJed Brown       eargs++; left--;
49685079163SJed Brown     } else if (isoptions_file) {
49785079163SJed Brown       if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option");
49885079163SJed Brown       if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing filename for -options_file filename option");
499c5929fdfSBarry Smith       ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,eargs[1],PETSC_TRUE);CHKERRQ(ierr);
50085079163SJed Brown       eargs += 2; left -= 2;
5019db968c8SJed Brown     } else if (isprefixpush) {
5029db968c8SJed Brown       if (left <= 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option");
5039db968c8SJed Brown       if (eargs[1][0] == '-') SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Missing prefix for -prefix_push option (prefixes cannot start with '-')");
504c5929fdfSBarry Smith       ierr = PetscOptionsPrefixPush(options,eargs[1]);CHKERRQ(ierr);
5059db968c8SJed Brown       eargs += 2; left -= 2;
5069db968c8SJed Brown     } else if (isprefixpop) {
507c5929fdfSBarry Smith       ierr = PetscOptionsPrefixPop(options);CHKERRQ(ierr);
5089db968c8SJed Brown       eargs++; left--;
50985079163SJed Brown 
51085079163SJed Brown       /*
51185079163SJed Brown        These are "bad" options that MPICH, etc put on the command line
51285079163SJed Brown        we strip them out here.
51385079163SJed Brown        */
51485079163SJed Brown     } else if (tisp4 || isp4rmrank) {
51585079163SJed Brown       eargs += 1; left -= 1;
51685079163SJed Brown     } else if (isp4 || isp4yourname) {
51785079163SJed Brown       eargs += 2; left -= 2;
5187935c3d8SJed Brown     } else {
5197935c3d8SJed Brown       PetscBool nextiskey = PETSC_FALSE;
5207935c3d8SJed Brown       if (left >= 2) {ierr = PetscOptionsValidKey(eargs[1],&nextiskey);CHKERRQ(ierr);}
52198b6bf53SJed Brown       if (left < 2 || nextiskey) {
522c5929fdfSBarry Smith         ierr = PetscOptionsSetValue(options,eargs[0],NULL);CHKERRQ(ierr);
52385079163SJed Brown         eargs++; left--;
52485079163SJed Brown       } else {
525c5929fdfSBarry Smith         ierr = PetscOptionsSetValue(options,eargs[0],eargs[1]);CHKERRQ(ierr);
52685079163SJed Brown         eargs += 2; left -= 2;
52785079163SJed Brown       }
52885079163SJed Brown     }
5297935c3d8SJed Brown   }
53085079163SJed Brown   PetscFunctionReturn(0);
53185079163SJed Brown }
53285079163SJed Brown 
53385079163SJed Brown 
534e5c89e4eSSatish Balay /*@C
535e5c89e4eSSatish Balay    PetscOptionsInsert - Inserts into the options database from the command line,
536e5c89e4eSSatish Balay                    the environmental variable and a file.
537e5c89e4eSSatish Balay 
538e5c89e4eSSatish Balay    Input Parameters:
539c5929fdfSBarry Smith +  options - options database or NULL for the default global database
540c5929fdfSBarry Smith .  argc - count of number of command line arguments
541e5c89e4eSSatish Balay .  args - the command line arguments
542e5c89e4eSSatish Balay -  file - optional filename, defaults to ~username/.petscrc
543e5c89e4eSSatish Balay 
544e5c89e4eSSatish Balay    Note:
545e5c89e4eSSatish Balay    Since PetscOptionsInsert() is automatically called by PetscInitialize(),
546e5c89e4eSSatish Balay    the user does not typically need to call this routine. PetscOptionsInsert()
547e5c89e4eSSatish Balay    can be called several times, adding additional entries into the database.
548e5c89e4eSSatish Balay 
549081c24baSBoyana Norris    Options Database Keys:
550081c24baSBoyana Norris +   -options_monitor <optional filename> - print options names and values as they are set
551ec873e40SMatthew G Knepley .   -options_file <filename> - read options from a file
552081c24baSBoyana Norris 
553e5c89e4eSSatish Balay    Level: advanced
554e5c89e4eSSatish Balay 
555e5c89e4eSSatish Balay    Concepts: options database^adding
556e5c89e4eSSatish Balay 
5572d747510SLisandro Dalcin .seealso: PetscOptionsDestroy(), PetscOptionsView(), PetscOptionsInsertString(), PetscOptionsInsertFile(),
55896fc60bcSBarry Smith           PetscInitialize()
559e5c89e4eSSatish Balay @*/
560c5929fdfSBarry Smith PetscErrorCode PetscOptionsInsert(PetscOptions options,int *argc,char ***args,const char file[])
561e5c89e4eSSatish Balay {
562e5c89e4eSSatish Balay   PetscErrorCode ierr;
563e5c89e4eSSatish Balay   PetscMPIInt    rank;
5642d747510SLisandro Dalcin   char           filename[PETSC_MAX_PATH_LEN];
565ace3abfcSBarry Smith   PetscBool      flag = PETSC_FALSE;
566e5c89e4eSSatish Balay 
5678dea33a6SBarry Smith 
568e5c89e4eSSatish Balay   PetscFunctionBegin;
569e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
570e5c89e4eSSatish Balay 
5714b09e917SBarry Smith   if (file && file[0]) {
5722d747510SLisandro Dalcin     ierr = PetscStrreplace(PETSC_COMM_WORLD,file,filename,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5732d747510SLisandro Dalcin     ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_TRUE);CHKERRQ(ierr);
574321366bcSBarry Smith   }
57585079163SJed Brown   /*
57685079163SJed Brown      We want to be able to give -skip_petscrc on the command line, but need to parse it first.  Since the command line
57785079163SJed Brown      should take precedence, we insert it twice.  It would be sufficient to just scan for -skip_petscrc.
57885079163SJed Brown   */
5792d747510SLisandro Dalcin   if (argc && args && *argc) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);}
580c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-skip_petscrc",&flag,NULL);CHKERRQ(ierr);
581321366bcSBarry Smith   if (!flag) {
5822d747510SLisandro Dalcin     ierr = PetscGetHomeDirectory(filename,PETSC_MAX_PATH_LEN-16);CHKERRQ(ierr);
5831ea3218fSSatish Balay     /* PetscOptionsInsertFile() does a fopen() on rank0 only - so only rank0 HomeDir value is relavent */
5842d747510SLisandro Dalcin     if (filename[0]) { ierr = PetscStrcat(filename,"/.petscrc");CHKERRQ(ierr); }
5852d747510SLisandro Dalcin     ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,filename,PETSC_FALSE);CHKERRQ(ierr);
586c5929fdfSBarry Smith     ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,".petscrc",PETSC_FALSE);CHKERRQ(ierr);
587c5929fdfSBarry Smith     ierr = PetscOptionsInsertFile(PETSC_COMM_WORLD,options,"petscrc",PETSC_FALSE);CHKERRQ(ierr);
588e5c89e4eSSatish Balay   }
589e5c89e4eSSatish Balay 
5902d747510SLisandro Dalcin   /* insert environment options */
591e5c89e4eSSatish Balay   {
5922d747510SLisandro Dalcin     char   *eoptions = NULL;
593e5c89e4eSSatish Balay     size_t len       = 0;
594e5c89e4eSSatish Balay     if (!rank) {
595e5c89e4eSSatish Balay       eoptions = (char*)getenv("PETSC_OPTIONS");
596e5c89e4eSSatish Balay       ierr     = PetscStrlen(eoptions,&len);CHKERRQ(ierr);
59776434e50SSatish Balay       ierr     = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
598e5c89e4eSSatish Balay     } else {
59976434e50SSatish Balay       ierr = MPI_Bcast(&len,1,MPIU_SIZE_T,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
600e5c89e4eSSatish Balay       if (len) {
601854ce69bSBarry Smith         ierr = PetscMalloc1(len+1,&eoptions);CHKERRQ(ierr);
602e5c89e4eSSatish Balay       }
603e5c89e4eSSatish Balay     }
604e5c89e4eSSatish Balay     if (len) {
605e5c89e4eSSatish Balay       ierr = MPI_Bcast(eoptions,len,MPI_CHAR,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
60696fc60bcSBarry Smith       if (rank) eoptions[len] = 0;
607c5929fdfSBarry Smith       ierr = PetscOptionsInsertString(options,eoptions);CHKERRQ(ierr);
608e5c89e4eSSatish Balay       if (rank) {ierr = PetscFree(eoptions);CHKERRQ(ierr);}
609e5c89e4eSSatish Balay     }
610e5c89e4eSSatish Balay   }
611e5c89e4eSSatish Balay 
6123bcbd388SSean Farley #if defined(PETSC_HAVE_YAML)
61356a31166SBarry Smith   {
6143bcbd388SSean Farley     char      yaml_file[PETSC_MAX_PATH_LEN];
61556a31166SBarry Smith     PetscBool yaml_flg;
616c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-options_file_yaml",yaml_file,PETSC_MAX_PATH_LEN,&yaml_flg);CHKERRQ(ierr);
61756a31166SBarry Smith     if (yaml_flg) {
61856a31166SBarry Smith       ierr = PetscOptionsInsertFileYAML(PETSC_COMM_WORLD,yaml_file,PETSC_TRUE);CHKERRQ(ierr);
61956a31166SBarry Smith     }
62056a31166SBarry Smith   }
6213bcbd388SSean Farley #endif
6223bcbd388SSean Farley 
62385079163SJed Brown   /* insert command line options again because they take precedence over arguments in petscrc/environment */
6242d747510SLisandro Dalcin   if (argc && args && *argc) {ierr = PetscOptionsInsertArgs(options,*argc,*args);CHKERRQ(ierr);}
625e5c89e4eSSatish Balay   PetscFunctionReturn(0);
626e5c89e4eSSatish Balay }
627e5c89e4eSSatish Balay 
628e5c89e4eSSatish Balay /*@C
62988c29154SBarry Smith    PetscOptionsView - Prints the options that have been loaded. This is
630e5c89e4eSSatish Balay    useful for debugging purposes.
631e5c89e4eSSatish Balay 
632c139c21fSBarry Smith    Logically Collective on PetscViewer
633e5c89e4eSSatish Balay 
634e5c89e4eSSatish Balay    Input Parameter:
6355c9cc608SHong Zhang -  options - options database, use NULL for default global database
6365c9cc608SHong Zhang +  viewer - must be an PETSCVIEWERASCII viewer
637e5c89e4eSSatish Balay 
638e5c89e4eSSatish Balay    Options Database Key:
6391d1ba570SSatish Balay .  -options_table - Activates PetscOptionsView() within PetscFinalize()
640e5c89e4eSSatish Balay 
641e5c89e4eSSatish Balay    Level: advanced
642e5c89e4eSSatish Balay 
643e5c89e4eSSatish Balay    Concepts: options database^printing
644e5c89e4eSSatish Balay 
645e5c89e4eSSatish Balay .seealso: PetscOptionsAllUsed()
646e5c89e4eSSatish Balay @*/
647c5929fdfSBarry Smith PetscErrorCode PetscOptionsView(PetscOptions options,PetscViewer viewer)
648e5c89e4eSSatish Balay {
649e5c89e4eSSatish Balay   PetscErrorCode ierr;
650431c96f7SBarry Smith   PetscInt       i;
65188c29154SBarry Smith   PetscBool      isascii;
652e5c89e4eSSatish Balay 
653e5c89e4eSSatish Balay   PetscFunctionBegin;
6542d747510SLisandro Dalcin   if (viewer) PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
655c5929fdfSBarry Smith   options = options ? options : defaultoptions;
65688c29154SBarry Smith   if (!viewer) viewer = PETSC_VIEWER_STDOUT_WORLD;
657251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
658ce94432eSBarry Smith   if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Only supports ASCII viewer");
65988c29154SBarry Smith 
6602d747510SLisandro Dalcin   if (!options->N) {
66188c29154SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"#No PETSc Option Table entries\n");CHKERRQ(ierr);
6622d747510SLisandro Dalcin     PetscFunctionReturn(0);
66330694fe9SBarry Smith   }
6642d747510SLisandro Dalcin 
6652d747510SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"#PETSc Option Table entries:\n");CHKERRQ(ierr);
666e5c89e4eSSatish Balay   for (i=0; i<options->N; i++) {
667e5c89e4eSSatish Balay     if (options->values[i]) {
66888c29154SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"-%s %s\n",options->names[i],options->values[i]);CHKERRQ(ierr);
669e5c89e4eSSatish Balay     } else {
67088c29154SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"-%s\n",options->names[i]);CHKERRQ(ierr);
671e5c89e4eSSatish Balay     }
672e5c89e4eSSatish Balay   }
67388c29154SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"#End of PETSc Option Table entries\n");CHKERRQ(ierr);
674e5c89e4eSSatish Balay   PetscFunctionReturn(0);
675e5c89e4eSSatish Balay }
676e5c89e4eSSatish Balay 
677e11779c2SBarry Smith /*
678e11779c2SBarry Smith    Called by error handlers to print options used in run
679e11779c2SBarry Smith */
68095c0884eSLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsViewError(void)
681e11779c2SBarry Smith {
682e11779c2SBarry Smith   PetscInt     i;
6834416b707SBarry Smith   PetscOptions options = defaultoptions;
684e11779c2SBarry Smith 
685e11779c2SBarry Smith   PetscFunctionBegin;
686e11779c2SBarry Smith   if (options->N) {
687e11779c2SBarry Smith     (*PetscErrorPrintf)("PETSc Option Table entries:\n");
688e11779c2SBarry Smith   } else {
689e11779c2SBarry Smith     (*PetscErrorPrintf)("No PETSc Option Table entries\n");
690e11779c2SBarry Smith   }
691e11779c2SBarry Smith   for (i=0; i<options->N; i++) {
692e11779c2SBarry Smith     if (options->values[i]) {
693e11779c2SBarry Smith       (*PetscErrorPrintf)("-%s %s\n",options->names[i],options->values[i]);
694e11779c2SBarry Smith     } else {
695e11779c2SBarry Smith       (*PetscErrorPrintf)("-%s\n",options->names[i]);
696e11779c2SBarry Smith     }
697e11779c2SBarry Smith   }
698e11779c2SBarry Smith   PetscFunctionReturn(0);
699e11779c2SBarry Smith }
700e11779c2SBarry Smith 
701e5c89e4eSSatish Balay /*@C
70274e0666dSJed Brown    PetscOptionsPrefixPush - Designate a prefix to be used by all options insertions to follow.
70374e0666dSJed Brown 
70474e0666dSJed Brown    Not Collective, but prefix will only be applied on calling ranks
70574e0666dSJed Brown 
7069db968c8SJed Brown    Input Parameter:
707c5929fdfSBarry Smith +  options - options database, or NULL for the default global database
708c5929fdfSBarry Smith -  prefix - The string to append to the existing prefix
7099db968c8SJed Brown 
7109db968c8SJed Brown    Options Database Keys:
7119db968c8SJed Brown  +   -prefix_push <some_prefix_> - push the given prefix
7129db968c8SJed Brown  -   -prefix_pop - pop the last prefix
7139db968c8SJed Brown 
7149db968c8SJed Brown    Notes:
7159db968c8SJed Brown    It is common to use this in conjunction with -options_file as in
7169db968c8SJed Brown 
7179db968c8SJed Brown  $ -prefix_push system1_ -options_file system1rc -prefix_pop -prefix_push system2_ -options_file system2rc -prefix_pop
7189db968c8SJed Brown 
7199db968c8SJed Brown    where the files no longer require all options to be prefixed with -system2_.
72074e0666dSJed Brown 
72174e0666dSJed Brown Level: advanced
72274e0666dSJed Brown 
72374e0666dSJed Brown .seealso: PetscOptionsPrefixPop()
72474e0666dSJed Brown @*/
725c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPush(PetscOptions options,const char prefix[])
72674e0666dSJed Brown {
72774e0666dSJed Brown   PetscErrorCode ierr;
72874e0666dSJed Brown   size_t         n;
72974e0666dSJed Brown   PetscInt       start;
7302d747510SLisandro Dalcin   char           key[MAXOPTNAME+1];
7312d747510SLisandro Dalcin   PetscBool      valid;
73274e0666dSJed Brown 
73374e0666dSJed Brown   PetscFunctionBegin;
7349db968c8SJed Brown   PetscValidCharPointer(prefix,1);
735c5929fdfSBarry Smith   options = options ? options : defaultoptions;
73674e0666dSJed 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);
7372d747510SLisandro Dalcin   key[0] = '-'; /* keys must start with '-' */
7382d747510SLisandro Dalcin   ierr = PetscStrncpy(key+1,prefix,sizeof(key)-1);CHKERRQ(ierr);
7392d747510SLisandro Dalcin   ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr);
7402d747510SLisandro Dalcin   if (!valid) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_USER,"Given prefix \"%s\" not valid (the first character must be a letter, do not include leading '-')",prefix);
74174e0666dSJed Brown   start = options->prefixind ? options->prefixstack[options->prefixind-1] : 0;
74274e0666dSJed Brown   ierr = PetscStrlen(prefix,&n);CHKERRQ(ierr);
74374e0666dSJed Brown   if (n+1 > sizeof(options->prefix)-start) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Maximum prefix length %d exceeded",sizeof(options->prefix));
74474e0666dSJed Brown   ierr = PetscMemcpy(options->prefix+start,prefix,n+1);CHKERRQ(ierr);
74574e0666dSJed Brown   options->prefixstack[options->prefixind++] = start+n;
74674e0666dSJed Brown   PetscFunctionReturn(0);
74774e0666dSJed Brown }
74874e0666dSJed Brown 
749c5929fdfSBarry Smith /*@C
75074e0666dSJed Brown    PetscOptionsPrefixPop - Remove the latest options prefix, see PetscOptionsPrefixPush() for details
75174e0666dSJed Brown 
75274e0666dSJed Brown    Not  Collective, but prefix will only be popped on calling ranks
75374e0666dSJed Brown 
754c5929fdfSBarry Smith   Input Parameters:
755c5929fdfSBarry Smith .  options - options database, or NULL for the default global database
756c5929fdfSBarry Smith 
75774e0666dSJed Brown    Level: advanced
75874e0666dSJed Brown 
75974e0666dSJed Brown .seealso: PetscOptionsPrefixPush()
76074e0666dSJed Brown @*/
761c5929fdfSBarry Smith PetscErrorCode PetscOptionsPrefixPop(PetscOptions options)
76274e0666dSJed Brown {
76374e0666dSJed Brown   PetscInt offset;
76474e0666dSJed Brown 
76574e0666dSJed Brown   PetscFunctionBegin;
766c5929fdfSBarry Smith   options = options ? options : defaultoptions;
76774e0666dSJed Brown   if (options->prefixind < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"More prefixes popped than pushed");
76874e0666dSJed Brown   options->prefixind--;
76974e0666dSJed Brown   offset = options->prefixind ? options->prefixstack[options->prefixind-1] : 0;
77074e0666dSJed Brown   options->prefix[offset] = 0;
77174e0666dSJed Brown   PetscFunctionReturn(0);
77274e0666dSJed Brown }
77374e0666dSJed Brown 
774a542b6e8SBarry Smith /*@C
775a542b6e8SBarry Smith     PetscOptionsClear - Removes all options form the database leaving it empty.
776a542b6e8SBarry Smith 
777c5929fdfSBarry Smith   Input Parameters:
778c5929fdfSBarry Smith .  options - options database, use NULL for the default global database
779c5929fdfSBarry Smith 
780a542b6e8SBarry Smith    Level: developer
781a542b6e8SBarry Smith 
782a542b6e8SBarry Smith .seealso: PetscOptionsInsert()
783a542b6e8SBarry Smith @*/
784c5929fdfSBarry Smith PetscErrorCode PetscOptionsClear(PetscOptions options)
785a542b6e8SBarry Smith {
786a542b6e8SBarry Smith   PetscInt i;
787a542b6e8SBarry Smith 
788c5929fdfSBarry Smith   options = options ? options : defaultoptions;
7892d747510SLisandro Dalcin   if (!options) return 0;
7902d747510SLisandro Dalcin 
791a542b6e8SBarry Smith   for (i=0; i<options->N; i++) {
792a542b6e8SBarry Smith     if (options->names[i])  free(options->names[i]);
793a542b6e8SBarry Smith     if (options->values[i]) free(options->values[i]);
794a542b6e8SBarry Smith   }
7952d747510SLisandro Dalcin   options->N = 0;
7962d747510SLisandro Dalcin 
797a542b6e8SBarry Smith   for (i=0; i<options->Naliases; i++) {
798a542b6e8SBarry Smith     free(options->aliases1[i]);
799a542b6e8SBarry Smith     free(options->aliases2[i]);
800a542b6e8SBarry Smith   }
801a542b6e8SBarry Smith   options->Naliases = 0;
802a542b6e8SBarry Smith 
8032d747510SLisandro Dalcin   /* destroy hash table */
8042d747510SLisandro Dalcin   kh_destroy(HO,options->ht);
8052d747510SLisandro Dalcin   options->ht = NULL;
8060eb63584SBarry Smith 
8072d747510SLisandro Dalcin   options->prefixind = 0;
8082d747510SLisandro Dalcin   options->prefix[0] = 0;
8092d747510SLisandro Dalcin   options->help      = PETSC_FALSE;
8104416b707SBarry Smith   return 0;
8114416b707SBarry Smith }
8124416b707SBarry Smith 
8132d747510SLisandro Dalcin /*@C
8142d747510SLisandro Dalcin    PetscOptionsSetAlias - Makes a key and alias for another key
8152d747510SLisandro Dalcin 
8162d747510SLisandro Dalcin    Not Collective, but setting values on certain processors could cause problems
8172d747510SLisandro Dalcin    for parallel objects looking for options.
8182d747510SLisandro Dalcin 
8192d747510SLisandro Dalcin    Input Parameters:
8202d747510SLisandro Dalcin +  options - options database, or NULL for default global database
8212d747510SLisandro Dalcin .  newname - the alias
8222d747510SLisandro Dalcin -  oldname - the name that alias will refer to
8232d747510SLisandro Dalcin 
8242d747510SLisandro Dalcin    Level: advanced
8252d747510SLisandro Dalcin 
8262d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(),
8272d747510SLisandro Dalcin           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(),
8282d747510SLisandro Dalcin           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
8292d747510SLisandro Dalcin           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
8302d747510SLisandro Dalcin           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
8312d747510SLisandro Dalcin           PetscOptionsFList(), PetscOptionsEList()
8322d747510SLisandro Dalcin @*/
8332d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetAlias(PetscOptions options,const char newname[],const char oldname[])
8342d747510SLisandro Dalcin {
8352d747510SLisandro Dalcin   PetscInt       n;
8362d747510SLisandro Dalcin   size_t         len;
8372d747510SLisandro Dalcin   PetscErrorCode ierr;
8382d747510SLisandro Dalcin 
8392d747510SLisandro Dalcin   PetscFunctionBegin;
8402d747510SLisandro Dalcin   PetscValidCharPointer(newname,2);
8412d747510SLisandro Dalcin   PetscValidCharPointer(oldname,3);
8422d747510SLisandro Dalcin   options = options ? options : defaultoptions;
8432d747510SLisandro Dalcin   if (newname[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"aliased must start with '-': Instead %s",newname);
8442d747510SLisandro Dalcin   if (oldname[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"aliasee must start with '-': Instead %s",oldname);
8452d747510SLisandro Dalcin 
8462d747510SLisandro Dalcin   n = options->Naliases;
8472d747510SLisandro 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);
8482d747510SLisandro Dalcin 
8492d747510SLisandro Dalcin   newname++; oldname++;
8502d747510SLisandro Dalcin   ierr = PetscStrlen(newname,&len);CHKERRQ(ierr);
8512d747510SLisandro Dalcin   options->aliases1[n] = (char*)malloc((len+1)*sizeof(char));
8522d747510SLisandro Dalcin   ierr = PetscStrcpy(options->aliases1[n],newname);CHKERRQ(ierr);
8532d747510SLisandro Dalcin   ierr = PetscStrlen(oldname,&len);CHKERRQ(ierr);
8542d747510SLisandro Dalcin   options->aliases2[n] = (char*)malloc((len+1)*sizeof(char));
8552d747510SLisandro Dalcin   ierr = PetscStrcpy(options->aliases2[n],oldname);CHKERRQ(ierr);
8562d747510SLisandro Dalcin   options->Naliases++;
8572d747510SLisandro Dalcin   PetscFunctionReturn(0);
8582d747510SLisandro Dalcin }
8594416b707SBarry Smith 
860e5c89e4eSSatish Balay /*@C
861e5c89e4eSSatish Balay    PetscOptionsSetValue - Sets an option name-value pair in the options
862e5c89e4eSSatish Balay    database, overriding whatever is already present.
863e5c89e4eSSatish Balay 
8642d747510SLisandro Dalcin    Not Collective, but setting values on certain processors could cause problems
865e5c89e4eSSatish Balay    for parallel objects looking for options.
866e5c89e4eSSatish Balay 
867e5c89e4eSSatish Balay    Input Parameters:
868c5929fdfSBarry Smith +  options - options database, use NULL for the default global database
869c5929fdfSBarry Smith .  name - name of option, this SHOULD have the - prepended
8702d747510SLisandro Dalcin -  value - the option value (not used for all options, so can be NULL)
871e5c89e4eSSatish Balay 
872e5c89e4eSSatish Balay    Level: intermediate
873e5c89e4eSSatish Balay 
874e5c89e4eSSatish Balay    Note:
875d49172ceSBarry Smith    This function can be called BEFORE PetscInitialize()
876d49172ceSBarry Smith 
8772d747510SLisandro Dalcin    Developers Note: Uses malloc() directly because PETSc may not be initialized yet.
878b0250c70SBarry Smith 
879e5c89e4eSSatish Balay    Concepts: options database^adding option
880e5c89e4eSSatish Balay 
8812d747510SLisandro Dalcin .seealso: PetscOptionsInsert(), PetscOptionsClearValue()
882e5c89e4eSSatish Balay @*/
8832d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetValue(PetscOptions options,const char name[],const char value[])
884e5c89e4eSSatish Balay {
885e5c89e4eSSatish Balay   size_t         len;
8862d747510SLisandro Dalcin   int            N,n,i;
887e5c89e4eSSatish Balay   char           **names;
8882d747510SLisandro Dalcin   char           fullname[MAXOPTNAME] = "";
8892d747510SLisandro Dalcin   PetscErrorCode ierr;
890e5c89e4eSSatish Balay 
8912d747510SLisandro Dalcin   if (!options && !defaultoptions) {
8922d747510SLisandro Dalcin     ierr = PetscOptionsCreateDefault();if (ierr) return ierr;
893c5929fdfSBarry Smith   }
8942d747510SLisandro Dalcin   options = options ? options : defaultoptions;
8952d747510SLisandro Dalcin 
8962d747510SLisandro Dalcin   if (name[0] != '-') return PETSC_ERR_ARG_OUTOFRANGE;
897e5c89e4eSSatish Balay 
898d49172ceSBarry Smith   /* this is so that -h and -help are equivalent (p4 does not like -help)*/
8992d747510SLisandro Dalcin   if (!strcmp(name,"-h")) name = "-help";
9002d747510SLisandro Dalcin   if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_TRUE;
901e5c89e4eSSatish Balay 
9022d747510SLisandro Dalcin   name++; /* skip starting dash */
9032d747510SLisandro Dalcin 
90474e0666dSJed Brown   if (options->prefixind > 0) {
905d49172ceSBarry Smith     strncpy(fullname,options->prefix,sizeof(fullname));
9062d747510SLisandro Dalcin     fullname[sizeof(fullname)-1] = 0;
90789ae1891SBarry Smith     strncat(fullname,name,sizeof(fullname)-strlen(fullname)-1);
9082d747510SLisandro Dalcin     fullname[sizeof(fullname)-1] = 0;
90974e0666dSJed Brown     name = fullname;
91074e0666dSJed Brown   }
91174e0666dSJed Brown 
91274e0666dSJed Brown   /* check against aliases */
913e5c89e4eSSatish Balay   N = options->Naliases;
914e5c89e4eSSatish Balay   for (i=0; i<N; i++) {
9152d747510SLisandro Dalcin     int result = PetscOptNameCmp(options->aliases1[i],name);
9162d747510SLisandro Dalcin     if (!result) { name = options->aliases2[i]; break; }
917e5c89e4eSSatish Balay   }
918e5c89e4eSSatish Balay 
9192d747510SLisandro Dalcin   /* slow search */
9202d747510SLisandro Dalcin   N = n = options->N;
921e5c89e4eSSatish Balay   names = options->names;
922e5c89e4eSSatish Balay   for (i=0; i<N; i++) {
9232d747510SLisandro Dalcin     int result = PetscOptNameCmp(names[i],name);
9242d747510SLisandro Dalcin     if (!result) {
9252d747510SLisandro Dalcin       n = i; goto setvalue;
9262d747510SLisandro Dalcin     } else if (result > 0) {
9272d747510SLisandro Dalcin       n = i; break;
928e5c89e4eSSatish Balay     }
929e5c89e4eSSatish Balay   }
9302d747510SLisandro Dalcin   if (N >= MAXOPTIONS) return PETSC_ERR_MEM;
9312d747510SLisandro Dalcin   /* shift remaining values up 1 */
932e5c89e4eSSatish Balay   for (i=N; i>n; i--) {
9335e8c5e88SLisandro Dalcin     options->names[i]  = options->names[i-1];
934e5c89e4eSSatish Balay     options->values[i] = options->values[i-1];
935e5c89e4eSSatish Balay     options->used[i]   = options->used[i-1];
936e5c89e4eSSatish Balay   }
9372d747510SLisandro Dalcin   options->names[n]  = NULL;
9382d747510SLisandro Dalcin   options->values[n] = NULL;
9392d747510SLisandro Dalcin   options->used[n]   = PETSC_FALSE;
9402d747510SLisandro Dalcin   options->N++;
9412d747510SLisandro Dalcin 
9422d747510SLisandro Dalcin   /* destroy hash table */
9432d747510SLisandro Dalcin   kh_destroy(HO,options->ht);
9442d747510SLisandro Dalcin   options->ht = NULL;
9452d747510SLisandro Dalcin 
9462d747510SLisandro Dalcin   /* set new name */
94770d8d27cSBarry Smith   len = strlen(name);
9485e8c5e88SLisandro Dalcin   options->names[n] = (char*)malloc((len+1)*sizeof(char));
949d49172ceSBarry Smith   if (!options->names[n]) return PETSC_ERR_MEM;
950d49172ceSBarry Smith   strcpy(options->names[n],name);
9512d747510SLisandro Dalcin 
9522d747510SLisandro Dalcin setvalue:
9532d747510SLisandro Dalcin   /* set new value */
9542d747510SLisandro Dalcin   if (options->values[n]) free(options->values[n]);
955d49172ceSBarry Smith   len = value ? strlen(value) : 0;
9565e8c5e88SLisandro Dalcin   if (len) {
957e5c89e4eSSatish Balay     options->values[n] = (char*)malloc((len+1)*sizeof(char));
958d49172ceSBarry Smith     if (!options->values[n]) return PETSC_ERR_MEM;
959d49172ceSBarry Smith     strcpy(options->values[n],value);
9602d747510SLisandro Dalcin   } else {
9612d747510SLisandro Dalcin     options->values[n] = NULL;
9622d747510SLisandro Dalcin   }
9632d747510SLisandro Dalcin 
9642d747510SLisandro Dalcin   ierr = PetscOptionsMonitor(options,name,value?value:"");if (ierr) return ierr;
965d49172ceSBarry Smith   return 0;
966e5c89e4eSSatish Balay }
967e5c89e4eSSatish Balay 
968e5c89e4eSSatish Balay /*@C
969e5c89e4eSSatish Balay    PetscOptionsClearValue - Clears an option name-value pair in the options
970e5c89e4eSSatish Balay    database, overriding whatever is already present.
971e5c89e4eSSatish Balay 
972e5c89e4eSSatish Balay    Not Collective, but setting values on certain processors could cause problems
973e5c89e4eSSatish Balay    for parallel objects looking for options.
974e5c89e4eSSatish Balay 
975e5c89e4eSSatish Balay    Input Parameter:
976c5929fdfSBarry Smith +  options - options database, use NULL for the default global database
977e5c89e4eSSatish Balay .  name - name of option, this SHOULD have the - prepended
978e5c89e4eSSatish Balay 
979e5c89e4eSSatish Balay    Level: intermediate
980e5c89e4eSSatish Balay 
981e5c89e4eSSatish Balay    Concepts: options database^removing option
982e5c89e4eSSatish Balay .seealso: PetscOptionsInsert()
983e5c89e4eSSatish Balay @*/
9842d747510SLisandro Dalcin PetscErrorCode PetscOptionsClearValue(PetscOptions options,const char name[])
985e5c89e4eSSatish Balay {
9862d747510SLisandro Dalcin   int            N,n,i;
9872d747510SLisandro Dalcin   char           **names;
988e5c89e4eSSatish Balay   PetscErrorCode ierr;
989e5c89e4eSSatish Balay 
990e5c89e4eSSatish Balay   PetscFunctionBegin;
991c5929fdfSBarry Smith   options = options ? options : defaultoptions;
9922d747510SLisandro Dalcin   if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name);
993e5c89e4eSSatish Balay 
9942d747510SLisandro Dalcin   /* this is so that -h and -help are equivalent (p4 does not like -help)*/
9952d747510SLisandro Dalcin   if (!strcmp(name,"-h")) name = "-help";
9962d747510SLisandro Dalcin   if (!PetscOptNameCmp(name,"-help")) options->help = PETSC_FALSE;
9972d747510SLisandro Dalcin 
9982d747510SLisandro Dalcin   name++; /* skip starting dash */
9992d747510SLisandro Dalcin 
10002d747510SLisandro Dalcin   /* slow search */
10012d747510SLisandro Dalcin   N = n = options->N;
1002e5c89e4eSSatish Balay   names = options->names;
1003e5c89e4eSSatish Balay   for (i=0; i<N; i++) {
10042d747510SLisandro Dalcin     int result = PetscOptNameCmp(names[i],name);
10052d747510SLisandro Dalcin     if (!result) {
10062d747510SLisandro Dalcin       n = i; break;
10072d747510SLisandro Dalcin     } else if (result > 0) {
10082d747510SLisandro Dalcin       n = N; break;
1009e5c89e4eSSatish Balay     }
10102d747510SLisandro Dalcin   }
10112d747510SLisandro Dalcin   if (n == N) PetscFunctionReturn(0); /* it was not present */
1012e5c89e4eSSatish Balay 
10132d747510SLisandro Dalcin   /* remove name and value */
10142d747510SLisandro Dalcin   if (options->names[n])  free(options->names[n]);
10152d747510SLisandro Dalcin   if (options->values[n]) free(options->values[n]);
1016e5c89e4eSSatish Balay   /* shift remaining values down 1 */
1017e5c89e4eSSatish Balay   for (i=n; i<N-1; i++) {
10185e8c5e88SLisandro Dalcin     options->names[i]  = options->names[i+1];
1019e5c89e4eSSatish Balay     options->values[i] = options->values[i+1];
1020e5c89e4eSSatish Balay     options->used[i]   = options->used[i+1];
1021e5c89e4eSSatish Balay   }
1022e5c89e4eSSatish Balay   options->N--;
10232d747510SLisandro Dalcin 
10242d747510SLisandro Dalcin   /* destroy hash table */
10252d747510SLisandro Dalcin   kh_destroy(HO,options->ht);
10262d747510SLisandro Dalcin   options->ht = NULL;
10272d747510SLisandro Dalcin 
10282d747510SLisandro Dalcin   ierr = PetscOptionsMonitor(options,name,NULL);CHKERRQ(ierr);
1029e5c89e4eSSatish Balay   PetscFunctionReturn(0);
1030e5c89e4eSSatish Balay }
1031e5c89e4eSSatish Balay 
1032e5c89e4eSSatish Balay /*@C
10332d747510SLisandro Dalcin    PetscOptionsFindPair - Gets an option name-value pair from the options database.
1034e5c89e4eSSatish Balay 
10352d747510SLisandro Dalcin    Not Collective
1036e5c89e4eSSatish Balay 
1037e5c89e4eSSatish Balay    Input Parameters:
10382d747510SLisandro Dalcin +  options - options database, use NULL for the default global database
10392d747510SLisandro Dalcin .  pre - the string to prepend to the name or NULL, this SHOULD NOT have the "-" prepended
10402d747510SLisandro Dalcin -  name - name of option, this SHOULD have the "-" prepended
1041e5c89e4eSSatish Balay 
10422d747510SLisandro Dalcin    Output Parameters:
10432d747510SLisandro Dalcin +  value - the option value (optional, not used for all options)
10442d747510SLisandro Dalcin -  set - whether the option is set (optional)
1045e5c89e4eSSatish Balay 
10462d747510SLisandro Dalcin    Level: developer
10472d747510SLisandro Dalcin 
10482d747510SLisandro Dalcin   Concepts: options database^getting option
10492d747510SLisandro Dalcin 
10502d747510SLisandro Dalcin .seealso: PetscOptionsSetValue(), PetscOptionsClearValue()
1051e5c89e4eSSatish Balay @*/
10522d747510SLisandro Dalcin PetscErrorCode PetscOptionsFindPair(PetscOptions options,const char pre[],const char name[],const char *value[],PetscBool *set)
1053e5c89e4eSSatish Balay {
10542d747510SLisandro Dalcin   char           buf[MAXOPTNAME];
10552d747510SLisandro Dalcin   PetscBool      usehashtable = PETSC_TRUE;
10562d747510SLisandro Dalcin   PetscBool      matchnumbers = PETSC_TRUE;
1057e5c89e4eSSatish Balay   PetscErrorCode ierr;
1058e5c89e4eSSatish Balay 
1059e5c89e4eSSatish Balay   PetscFunctionBegin;
1060c5929fdfSBarry Smith   options = options ? options : defaultoptions;
10612d747510SLisandro Dalcin   if (pre && PetscUnlikely(pre[0] == '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre);
10622d747510SLisandro Dalcin   if (PetscUnlikely(name[0] != '-')) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name);
1063e5c89e4eSSatish Balay 
10642d747510SLisandro Dalcin   name++; /* skip starting dash */
1065e5c89e4eSSatish Balay 
10667cd08cecSJed Brown   /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */
10672d747510SLisandro Dalcin   if (pre && pre[0]) {
10682d747510SLisandro Dalcin     char *ptr = buf;
10692d747510SLisandro Dalcin     if (name[0] == '-') { *ptr++ = '-';  name++; }
10702d747510SLisandro Dalcin     ierr = PetscStrncpy(ptr,pre,buf+sizeof(buf)-ptr);CHKERRQ(ierr);
10712d747510SLisandro Dalcin     ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr);
10722d747510SLisandro Dalcin     name = buf;
10737cd08cecSJed Brown   }
10742d747510SLisandro Dalcin 
10752f828895SJed Brown #if defined(PETSC_USE_DEBUG)
10762f828895SJed Brown   {
10772f828895SJed Brown     PetscBool valid;
10782d747510SLisandro Dalcin     char      key[MAXOPTNAME+1] = "-";
10792d747510SLisandro Dalcin     ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr);
10802f828895SJed Brown     ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr);
10812f828895SJed 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);
10822f828895SJed Brown   }
10832f828895SJed Brown #endif
1084e5c89e4eSSatish Balay 
10852d747510SLisandro Dalcin   if (!options->ht && usehashtable) {
10862d747510SLisandro Dalcin     int i,ret;
10872d747510SLisandro Dalcin     khiter_t it;
10882d747510SLisandro Dalcin     khash_t(HO) *ht;
10892d747510SLisandro Dalcin     ht = kh_init(HO);
10902d747510SLisandro Dalcin     if (PetscUnlikely(!ht)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed");
10912d747510SLisandro Dalcin     ret = kh_resize(HO,ht,options->N*2); /* twice the required size to reduce risk of collisions */
10922d747510SLisandro Dalcin     if (PetscUnlikely(ret)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed");
10932d747510SLisandro Dalcin     for (i=0; i<options->N; i++) {
10942d747510SLisandro Dalcin       it = kh_put(HO,ht,options->names[i],&ret);
10952d747510SLisandro Dalcin       if (PetscUnlikely(ret != 1)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Hash table allocation failed");
10962d747510SLisandro Dalcin       kh_val(ht,it) = i;
10972d747510SLisandro Dalcin     }
10982d747510SLisandro Dalcin     options->ht = ht;
10992d747510SLisandro Dalcin   }
11002d747510SLisandro Dalcin 
11012d747510SLisandro Dalcin   if (usehashtable)
11022d747510SLisandro Dalcin   { /* fast search */
11032d747510SLisandro Dalcin     khash_t(HO) *ht = options->ht;
11042d747510SLisandro Dalcin     khiter_t it = kh_get(HO,ht,name);
11052d747510SLisandro Dalcin     if (it != kh_end(ht)) {
11062d747510SLisandro Dalcin       int i = kh_val(ht,it);
1107e5c89e4eSSatish Balay       options->used[i]  = PETSC_TRUE;
11082d747510SLisandro Dalcin       if (value) *value = options->values[i];
11092d747510SLisandro Dalcin       if (set)   *set   = PETSC_TRUE;
11102d747510SLisandro Dalcin       PetscFunctionReturn(0);
11112d747510SLisandro Dalcin     }
11122d747510SLisandro Dalcin   } else
11132d747510SLisandro Dalcin   { /* slow search */
11142d747510SLisandro Dalcin     int i, N = options->N;
11152d747510SLisandro Dalcin     for (i=0; i<N; i++) {
11162d747510SLisandro Dalcin       int result = PetscOptNameCmp(options->names[i],name);CHKERRQ(ierr);
11172d747510SLisandro Dalcin       if (!result) {
11182d747510SLisandro Dalcin         options->used[i]  = PETSC_TRUE;
11192d747510SLisandro Dalcin         if (value) *value = options->values[i];
11202d747510SLisandro Dalcin         if (set)   *set   = PETSC_TRUE;
11212d747510SLisandro Dalcin         PetscFunctionReturn(0);
11222d747510SLisandro Dalcin       } else if (result > 0) {
1123e5c89e4eSSatish Balay         break;
1124e5c89e4eSSatish Balay       }
1125e5c89e4eSSatish Balay     }
11262d747510SLisandro Dalcin   }
11272d747510SLisandro Dalcin 
11282d747510SLisandro Dalcin   /*
11292d747510SLisandro Dalcin    The following block slows down all lookups in the most frequent path (most lookups are unsuccessful).
11302d747510SLisandro Dalcin    Maybe this special lookup mode should be enabled on request with a push/pop API.
11312d747510SLisandro Dalcin    The feature of matching _%d_ used sparingly in the codebase.
11322d747510SLisandro Dalcin    */
11332d747510SLisandro Dalcin   if (matchnumbers) {
11342d747510SLisandro Dalcin     int i,j,cnt = 0,locs[16],loce[16];
1135e5c89e4eSSatish Balay     /* determine the location and number of all _%d_ in the key */
11362d747510SLisandro Dalcin     for (i=0; name[i]; i++) {
11372d747510SLisandro Dalcin       if (name[i] == '_') {
11382d747510SLisandro Dalcin         for (j=i+1; name[j]; j++) {
11392d747510SLisandro Dalcin           if (name[j] >= '0' && name[j] <= '9') continue;
11402d747510SLisandro Dalcin           if (name[j] == '_' && j > i+1) { /* found a number */
1141e5c89e4eSSatish Balay             locs[cnt]   = i+1;
1142e5c89e4eSSatish Balay             loce[cnt++] = j+1;
1143e5c89e4eSSatish Balay           }
11442d747510SLisandro Dalcin           i = j-1;
1145e5c89e4eSSatish Balay           break;
1146e5c89e4eSSatish Balay         }
1147e5c89e4eSSatish Balay       }
1148e5c89e4eSSatish Balay     }
1149e5c89e4eSSatish Balay     for (i=0; i<cnt; i++) {
11502d747510SLisandro Dalcin       PetscBool found;
11512d747510SLisandro Dalcin       char      opt[MAXOPTNAME+1] = "-", tmp[MAXOPTNAME];
11522d747510SLisandro Dalcin       ierr = PetscStrncpy(tmp,name,PetscMin((size_t)(locs[i]+1),sizeof(tmp)));CHKERRQ(ierr);
11532d747510SLisandro Dalcin       ierr = PetscStrlcat(opt,tmp,sizeof(opt));CHKERRQ(ierr);
11542d747510SLisandro Dalcin       ierr = PetscStrlcat(opt,name+loce[i],sizeof(opt));CHKERRQ(ierr);
11552d747510SLisandro Dalcin       ierr = PetscOptionsFindPair(options,NULL,opt,value,&found);CHKERRQ(ierr);
11562d747510SLisandro Dalcin       if (found) {if (set) *set = PETSC_TRUE; PetscFunctionReturn(0);}
1157e5c89e4eSSatish Balay     }
1158e5c89e4eSSatish Balay   }
11592d747510SLisandro Dalcin 
11602d747510SLisandro Dalcin   if (set) *set = PETSC_FALSE;
1161e5c89e4eSSatish Balay   PetscFunctionReturn(0);
1162e5c89e4eSSatish Balay }
1163e5c89e4eSSatish Balay 
11642d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions options,const char pre[], const char name[],const char *value[],PetscBool *set)
1165514bf10dSMatthew G Knepley {
11662d747510SLisandro Dalcin   char           buf[MAXOPTNAME];
1167514bf10dSMatthew G Knepley   PetscErrorCode ierr;
1168514bf10dSMatthew G Knepley 
1169514bf10dSMatthew G Knepley   PetscFunctionBegin;
1170c5929fdfSBarry Smith   options = options ? options : defaultoptions;
11712d747510SLisandro Dalcin   if (pre && pre[0] == '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Prefix cannot begin with '-': Instead %s",pre);
11722d747510SLisandro Dalcin   if (name[0] != '-') SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Name must begin with '-': Instead %s",name);
1173514bf10dSMatthew G Knepley 
11742d747510SLisandro Dalcin   name++; /* skip starting dash */
1175514bf10dSMatthew G Knepley 
1176514bf10dSMatthew G Knepley   /* append prefix to name, if prefix="foo_" and option='--bar", prefixed option is --foo_bar */
11772d747510SLisandro Dalcin   if (pre && pre[0]) {
11782d747510SLisandro Dalcin     char *ptr = buf;
11792d747510SLisandro Dalcin     if (name[0] == '-') { *ptr++ = '-';  name++; }
11802d747510SLisandro Dalcin     ierr = PetscStrncpy(ptr,pre,sizeof(buf)+(size_t)(ptr-buf));CHKERRQ(ierr);
11812d747510SLisandro Dalcin     ierr = PetscStrlcat(buf,name,sizeof(buf));CHKERRQ(ierr);
11822d747510SLisandro Dalcin     name = buf;
1183514bf10dSMatthew G Knepley   }
11842d747510SLisandro Dalcin 
1185514bf10dSMatthew G Knepley #if defined(PETSC_USE_DEBUG)
1186514bf10dSMatthew G Knepley   {
1187514bf10dSMatthew G Knepley     PetscBool valid;
11882d747510SLisandro Dalcin     char      key[MAXOPTNAME+1] = "-";
11892d747510SLisandro Dalcin     ierr = PetscStrncpy(key+1,name,sizeof(key)-1);CHKERRQ(ierr);
1190514bf10dSMatthew G Knepley     ierr = PetscOptionsValidKey(key,&valid);CHKERRQ(ierr);
1191514bf10dSMatthew 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);
1192514bf10dSMatthew G Knepley   }
1193514bf10dSMatthew G Knepley #endif
1194514bf10dSMatthew G Knepley 
11952d747510SLisandro Dalcin   { /* slow search */
11962d747510SLisandro Dalcin     int       i;
11972d747510SLisandro Dalcin     size_t    len;
11982d747510SLisandro Dalcin     PetscBool match;
11992d747510SLisandro Dalcin     ierr = PetscStrlen(name,&len);CHKERRQ(ierr);
12002d747510SLisandro Dalcin     for (i=0; i<options->N; i++) {
12012d747510SLisandro Dalcin       ierr = PetscStrncmp(options->names[i],name,len,&match);CHKERRQ(ierr);
1202514bf10dSMatthew G Knepley       if (match) {
1203514bf10dSMatthew G Knepley         options->used[i]  = PETSC_TRUE;
12042d747510SLisandro Dalcin         if (value) *value = options->values[i];
12052d747510SLisandro Dalcin         if (set)   *set   = PETSC_TRUE;
12062d747510SLisandro Dalcin         PetscFunctionReturn(0);
1207514bf10dSMatthew G Knepley       }
1208514bf10dSMatthew G Knepley     }
12092d747510SLisandro Dalcin   }
12102d747510SLisandro Dalcin 
12112d747510SLisandro Dalcin   if (set) *set = PETSC_FALSE;
1212514bf10dSMatthew G Knepley   PetscFunctionReturn(0);
1213514bf10dSMatthew G Knepley }
1214514bf10dSMatthew G Knepley 
1215e5c89e4eSSatish Balay /*@C
1216e5c89e4eSSatish Balay    PetscOptionsReject - Generates an error if a certain option is given.
1217e5c89e4eSSatish Balay 
1218e5c89e4eSSatish Balay    Not Collective, but setting values on certain processors could cause problems
1219e5c89e4eSSatish Balay    for parallel objects looking for options.
1220e5c89e4eSSatish Balay 
1221e5c89e4eSSatish Balay    Input Parameters:
12225c9cc608SHong Zhang +  options - options database, use NULL for default global database
12232d747510SLisandro Dalcin .  pre - the option prefix (may be NULL)
12242d747510SLisandro Dalcin .  name - the option name one is seeking
12250298fd71SBarry Smith -  mess - error message (may be NULL)
1226e5c89e4eSSatish Balay 
1227e5c89e4eSSatish Balay    Level: advanced
1228e5c89e4eSSatish Balay 
1229e5c89e4eSSatish Balay    Concepts: options database^rejecting option
1230e5c89e4eSSatish Balay 
1231e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),OptionsHasName(),
1232acfcf0e5SJed Brown           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
1233e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
1234e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
1235acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
1236a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
1237e5c89e4eSSatish Balay @*/
12382d747510SLisandro Dalcin PetscErrorCode PetscOptionsReject(PetscOptions options,const char pre[],const char name[],const char mess[])
1239e5c89e4eSSatish Balay {
1240e5c89e4eSSatish Balay   PetscErrorCode ierr;
1241ace3abfcSBarry Smith   PetscBool      flag = PETSC_FALSE;
1242e5c89e4eSSatish Balay 
1243e5c89e4eSSatish Balay   PetscFunctionBegin;
12442d747510SLisandro Dalcin   ierr = PetscOptionsHasName(options,pre,name,&flag);CHKERRQ(ierr);
1245e5c89e4eSSatish Balay   if (flag) {
12462d747510SLisandro 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);
12472d747510SLisandro Dalcin     else SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Program has disabled option: -%s%s",pre?pre:"",name+1);
1248e5c89e4eSSatish Balay   }
1249e5c89e4eSSatish Balay   PetscFunctionReturn(0);
1250e5c89e4eSSatish Balay }
1251e5c89e4eSSatish Balay 
1252e5c89e4eSSatish Balay /*@C
12532d747510SLisandro Dalcin    PetscOptionsHasHelp - Determines whether the "-help" option is in the database.
12542d747510SLisandro Dalcin 
12552d747510SLisandro Dalcin    Not Collective
12562d747510SLisandro Dalcin 
12572d747510SLisandro Dalcin    Input Parameters:
12582d747510SLisandro Dalcin .  options - options database, use NULL for default global database
12592d747510SLisandro Dalcin 
12602d747510SLisandro Dalcin    Output Parameters:
12612d747510SLisandro Dalcin .  set - PETSC_TRUE if found else PETSC_FALSE.
12622d747510SLisandro Dalcin 
12632d747510SLisandro Dalcin    Level: advanced
12642d747510SLisandro Dalcin 
12652d747510SLisandro Dalcin    Concepts: options database^help
12662d747510SLisandro Dalcin 
12672d747510SLisandro Dalcin .seealso: PetscOptionsHasName()
12682d747510SLisandro Dalcin @*/
12692d747510SLisandro Dalcin PetscErrorCode PetscOptionsHasHelp(PetscOptions options,PetscBool *set)
12702d747510SLisandro Dalcin {
12712d747510SLisandro Dalcin   PetscFunctionBegin;
12722d747510SLisandro Dalcin   PetscValidPointer(set,2);
12732d747510SLisandro Dalcin   options = options ? options : defaultoptions;
12742d747510SLisandro Dalcin   *set = options->help;
12752d747510SLisandro Dalcin   PetscFunctionReturn(0);
12762d747510SLisandro Dalcin }
12772d747510SLisandro Dalcin 
12782d747510SLisandro Dalcin /*@C
127990d69ab7SBarry 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
128090d69ab7SBarry Smith                       its value is set to false.
1281e5c89e4eSSatish Balay 
1282e5c89e4eSSatish Balay    Not Collective
1283e5c89e4eSSatish Balay 
1284e5c89e4eSSatish Balay    Input Parameters:
12855c9cc608SHong Zhang +  options - options database, use NULL for default global database
12863de71b31SHong Zhang .  pre - string to prepend to the name or NULL
12873de71b31SHong Zhang -  name - the option one is seeking
1288e5c89e4eSSatish Balay 
1289e5c89e4eSSatish Balay    Output Parameters:
129096ef3cdfSSatish Balay .  set - PETSC_TRUE if found else PETSC_FALSE.
1291e5c89e4eSSatish Balay 
1292e5c89e4eSSatish Balay    Level: beginner
1293e5c89e4eSSatish Balay 
1294e5c89e4eSSatish Balay    Concepts: options database^has option name
1295e5c89e4eSSatish Balay 
129695452b02SPatrick Sanan    Notes:
12972d747510SLisandro Dalcin    Name cannot be simply "-h".
1298431c96f7SBarry Smith 
1299acfcf0e5SJed Brown    In many cases you probably want to use PetscOptionsGetBool() instead of calling this, to allowing toggling values.
130090d69ab7SBarry Smith 
1301e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
1302f3e3d7dfSBarry Smith           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
1303e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
1304e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
1305acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
1306a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
1307e5c89e4eSSatish Balay @*/
1308c5929fdfSBarry Smith PetscErrorCode PetscOptionsHasName(PetscOptions options,const char pre[],const char name[],PetscBool *set)
1309e5c89e4eSSatish Balay {
13102d747510SLisandro Dalcin   const char     *value;
1311e5c89e4eSSatish Balay   PetscErrorCode ierr;
1312ace3abfcSBarry Smith   PetscBool      flag;
1313e5c89e4eSSatish Balay 
1314e5c89e4eSSatish Balay   PetscFunctionBegin;
13152d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr);
131696ef3cdfSSatish Balay   if (set) *set = flag;
1317e5c89e4eSSatish Balay   PetscFunctionReturn(0);
1318e5c89e4eSSatish Balay }
1319e5c89e4eSSatish Balay 
1320e5c89e4eSSatish Balay /*@C
13212d747510SLisandro Dalcin    PetscOptionsGetAll - Lists all the options the program was run with in a single string.
13222d747510SLisandro Dalcin 
13232d747510SLisandro Dalcin    Not Collective
13242d747510SLisandro Dalcin 
13252d747510SLisandro Dalcin    Input Paramter:
13262d747510SLisandro Dalcin .  options - the options database, use NULL for the default global database
13272d747510SLisandro Dalcin 
13282d747510SLisandro Dalcin    Output Parameter:
13292d747510SLisandro Dalcin .  copts - pointer where string pointer is stored
13302d747510SLisandro Dalcin 
13312d747510SLisandro Dalcin    Notes:
13322d747510SLisandro Dalcin     the array and each entry in the array should be freed with PetscFree()
13332d747510SLisandro Dalcin 
13342d747510SLisandro Dalcin    Level: advanced
13352d747510SLisandro Dalcin 
13362d747510SLisandro Dalcin    Concepts: options database^listing
13372d747510SLisandro Dalcin 
13382d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsView()
13392d747510SLisandro Dalcin @*/
13402d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetAll(PetscOptions options,char *copts[])
13412d747510SLisandro Dalcin {
13422d747510SLisandro Dalcin   PetscErrorCode ierr;
13432d747510SLisandro Dalcin   PetscInt       i;
13442d747510SLisandro Dalcin   size_t         len = 1,lent = 0;
13452d747510SLisandro Dalcin   char           *coptions = NULL;
13462d747510SLisandro Dalcin 
13472d747510SLisandro Dalcin   PetscFunctionBegin;
13482d747510SLisandro Dalcin   PetscValidPointer(copts,2);
13492d747510SLisandro Dalcin   options = options ? options : defaultoptions;
13502d747510SLisandro Dalcin   /* count the length of the required string */
13512d747510SLisandro Dalcin   for (i=0; i<options->N; i++) {
13522d747510SLisandro Dalcin     ierr = PetscStrlen(options->names[i],&lent);CHKERRQ(ierr);
13532d747510SLisandro Dalcin     len += 2 + lent;
13542d747510SLisandro Dalcin     if (options->values[i]) {
13552d747510SLisandro Dalcin       ierr = PetscStrlen(options->values[i],&lent);CHKERRQ(ierr);
13562d747510SLisandro Dalcin       len += 1 + lent;
13572d747510SLisandro Dalcin     }
13582d747510SLisandro Dalcin   }
13592d747510SLisandro Dalcin   ierr = PetscMalloc1(len,&coptions);CHKERRQ(ierr);
13602d747510SLisandro Dalcin   coptions[0] = 0;
13612d747510SLisandro Dalcin   for (i=0; i<options->N; i++) {
13622d747510SLisandro Dalcin     ierr = PetscStrcat(coptions,"-");CHKERRQ(ierr);
13632d747510SLisandro Dalcin     ierr = PetscStrcat(coptions,options->names[i]);CHKERRQ(ierr);
13642d747510SLisandro Dalcin     ierr = PetscStrcat(coptions," ");CHKERRQ(ierr);
13652d747510SLisandro Dalcin     if (options->values[i]) {
13662d747510SLisandro Dalcin       ierr = PetscStrcat(coptions,options->values[i]);CHKERRQ(ierr);
13672d747510SLisandro Dalcin       ierr = PetscStrcat(coptions," ");CHKERRQ(ierr);
13682d747510SLisandro Dalcin     }
13692d747510SLisandro Dalcin   }
13702d747510SLisandro Dalcin   *copts = coptions;
13712d747510SLisandro Dalcin   PetscFunctionReturn(0);
13722d747510SLisandro Dalcin }
13732d747510SLisandro Dalcin 
13742d747510SLisandro Dalcin /*@C
13752d747510SLisandro Dalcin    PetscOptionsUsed - Indicates if PETSc has used a particular option set in the database
13762d747510SLisandro Dalcin 
13772d747510SLisandro Dalcin    Not Collective
13782d747510SLisandro Dalcin 
13792d747510SLisandro Dalcin    Input Parameter:
13802d747510SLisandro Dalcin +  options - options database, use NULL for default global database
13812d747510SLisandro Dalcin -  name - string name of option
13822d747510SLisandro Dalcin 
13832d747510SLisandro Dalcin    Output Parameter:
13842d747510SLisandro Dalcin .  used - PETSC_TRUE if the option was used, otherwise false, including if option was not found in options database
13852d747510SLisandro Dalcin 
13862d747510SLisandro Dalcin    Level: advanced
13872d747510SLisandro Dalcin 
13882d747510SLisandro Dalcin .seealso: PetscOptionsView(), PetscOptionsLeft(), PetscOptionsAllUsed()
13892d747510SLisandro Dalcin @*/
13902d747510SLisandro Dalcin PetscErrorCode PetscOptionsUsed(PetscOptions options,const char *name,PetscBool *used)
13912d747510SLisandro Dalcin {
13922d747510SLisandro Dalcin   PetscInt       i;
13932d747510SLisandro Dalcin   PetscErrorCode ierr;
13942d747510SLisandro Dalcin 
13952d747510SLisandro Dalcin   PetscFunctionBegin;
13962d747510SLisandro Dalcin   PetscValidCharPointer(name,2);
13972d747510SLisandro Dalcin   PetscValidPointer(used,3);
13982d747510SLisandro Dalcin   options = options ? options : defaultoptions;
13992d747510SLisandro Dalcin   *used = PETSC_FALSE;
14002d747510SLisandro Dalcin   for (i=0; i<options->N; i++) {
14012d747510SLisandro Dalcin     ierr = PetscStrcmp(options->names[i],name,used);CHKERRQ(ierr);
14022d747510SLisandro Dalcin     if (*used) {
14032d747510SLisandro Dalcin       *used = options->used[i];
14042d747510SLisandro Dalcin       break;
14052d747510SLisandro Dalcin     }
14062d747510SLisandro Dalcin   }
14072d747510SLisandro Dalcin   PetscFunctionReturn(0);
14082d747510SLisandro Dalcin }
14092d747510SLisandro Dalcin 
14102d747510SLisandro Dalcin /*@C
14112d747510SLisandro Dalcin    PetscOptionsAllUsed - Returns a count of the number of options in the
14122d747510SLisandro Dalcin    database that have never been selected.
14132d747510SLisandro Dalcin 
14142d747510SLisandro Dalcin    Not Collective
14152d747510SLisandro Dalcin 
14162d747510SLisandro Dalcin    Input Parameter:
14172d747510SLisandro Dalcin .  options - options database, use NULL for default global database
14182d747510SLisandro Dalcin 
14192d747510SLisandro Dalcin    Output Parameter:
14202d747510SLisandro Dalcin .  N - count of options not used
14212d747510SLisandro Dalcin 
14222d747510SLisandro Dalcin    Level: advanced
14232d747510SLisandro Dalcin 
14242d747510SLisandro Dalcin .seealso: PetscOptionsView()
14252d747510SLisandro Dalcin @*/
14262d747510SLisandro Dalcin PetscErrorCode PetscOptionsAllUsed(PetscOptions options,PetscInt *N)
14272d747510SLisandro Dalcin {
14282d747510SLisandro Dalcin   PetscInt     i,n = 0;
14292d747510SLisandro Dalcin 
14302d747510SLisandro Dalcin   PetscFunctionBegin;
14312d747510SLisandro Dalcin   PetscValidIntPointer(N,2);
14322d747510SLisandro Dalcin   options = options ? options : defaultoptions;
14332d747510SLisandro Dalcin   for (i=0; i<options->N; i++) {
14342d747510SLisandro Dalcin     if (!options->used[i]) n++;
14352d747510SLisandro Dalcin   }
14362d747510SLisandro Dalcin   *N = n;
14372d747510SLisandro Dalcin   PetscFunctionReturn(0);
14382d747510SLisandro Dalcin }
14392d747510SLisandro Dalcin 
14402d747510SLisandro Dalcin /*@C
14412d747510SLisandro Dalcin    PetscOptionsLeft - Prints to screen any options that were set and never used.
14422d747510SLisandro Dalcin 
14432d747510SLisandro Dalcin    Not Collective
14442d747510SLisandro Dalcin 
14452d747510SLisandro Dalcin    Input Parameter:
14462d747510SLisandro Dalcin .  options - options database; use NULL for default global database
14472d747510SLisandro Dalcin 
14482d747510SLisandro Dalcin    Options Database Key:
14492d747510SLisandro Dalcin .  -options_left - Activates OptionsAllUsed() within PetscFinalize()
14502d747510SLisandro Dalcin 
14512d747510SLisandro Dalcin    Level: advanced
14522d747510SLisandro Dalcin 
14532d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed()
14542d747510SLisandro Dalcin @*/
14552d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeft(PetscOptions options)
14562d747510SLisandro Dalcin {
14572d747510SLisandro Dalcin   PetscErrorCode ierr;
14582d747510SLisandro Dalcin   PetscInt       i;
14592d747510SLisandro Dalcin 
14602d747510SLisandro Dalcin   PetscFunctionBegin;
14612d747510SLisandro Dalcin   options = options ? options : defaultoptions;
14622d747510SLisandro Dalcin   for (i=0; i<options->N; i++) {
14632d747510SLisandro Dalcin     if (!options->used[i]) {
14642d747510SLisandro Dalcin       if (options->values[i]) {
14652d747510SLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s value: %s\n",options->names[i],options->values[i]);CHKERRQ(ierr);
14662d747510SLisandro Dalcin       } else {
14672d747510SLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"Option left: name:-%s (no value)\n",options->names[i]);CHKERRQ(ierr);
14682d747510SLisandro Dalcin       }
14692d747510SLisandro Dalcin     }
14702d747510SLisandro Dalcin   }
14712d747510SLisandro Dalcin   PetscFunctionReturn(0);
14722d747510SLisandro Dalcin }
14732d747510SLisandro Dalcin 
14742d747510SLisandro Dalcin /*@C
14752d747510SLisandro Dalcin    PetscOptionsLeftGet - Returns all options that were set and never used.
14762d747510SLisandro Dalcin 
14772d747510SLisandro Dalcin    Not Collective
14782d747510SLisandro Dalcin 
14792d747510SLisandro Dalcin    Input Parameter:
14802d747510SLisandro Dalcin .  options - options database, use NULL for default global database
14812d747510SLisandro Dalcin 
14822d747510SLisandro Dalcin    Output Parameter:
14832d747510SLisandro Dalcin .  N - count of options not used
14842d747510SLisandro Dalcin .  names - names of options not used
14852d747510SLisandro Dalcin .  values - values of options not used
14862d747510SLisandro Dalcin 
14872d747510SLisandro Dalcin    Level: advanced
14882d747510SLisandro Dalcin 
14892d747510SLisandro Dalcin    Notes:
14902d747510SLisandro Dalcin    Users should call PetscOptionsLeftRestore() to free the memory allocated in this routine
14912d747510SLisandro Dalcin 
14922d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft()
14932d747510SLisandro Dalcin @*/
14942d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftGet(PetscOptions options,PetscInt *N,char **names[],char **values[])
14952d747510SLisandro Dalcin {
14962d747510SLisandro Dalcin   PetscErrorCode ierr;
14972d747510SLisandro Dalcin   PetscInt       i,n;
14982d747510SLisandro Dalcin 
14992d747510SLisandro Dalcin   PetscFunctionBegin;
15002d747510SLisandro Dalcin   if (N) PetscValidIntPointer(N,2);
15012d747510SLisandro Dalcin   if (names) PetscValidPointer(names,3);
15022d747510SLisandro Dalcin   if (values) PetscValidPointer(values,4);
15032d747510SLisandro Dalcin   options = options ? options : defaultoptions;
15042d747510SLisandro Dalcin 
15052d747510SLisandro Dalcin   /* The number of unused PETSc options */
15062d747510SLisandro Dalcin   n = 0;
15072d747510SLisandro Dalcin   for (i=0; i<options->N; i++) {
15082d747510SLisandro Dalcin     if (!options->used[i]) n++;
15092d747510SLisandro Dalcin   }
15102d747510SLisandro Dalcin   if (N) { *N = n; }
15112d747510SLisandro Dalcin   if (names)  { ierr = PetscMalloc1(n,names);CHKERRQ(ierr); }
15122d747510SLisandro Dalcin   if (values) { ierr = PetscMalloc1(n,values);CHKERRQ(ierr); }
15132d747510SLisandro Dalcin 
15142d747510SLisandro Dalcin   n = 0;
15152d747510SLisandro Dalcin   if (names || values) {
15162d747510SLisandro Dalcin     for (i=0; i<options->N; i++) {
15172d747510SLisandro Dalcin       if (!options->used[i]) {
15182d747510SLisandro Dalcin         if (names)  (*names)[n]  = options->names[i];
15192d747510SLisandro Dalcin         if (values) (*values)[n] = options->values[i];
15202d747510SLisandro Dalcin         n++;
15212d747510SLisandro Dalcin       }
15222d747510SLisandro Dalcin     }
15232d747510SLisandro Dalcin   }
15242d747510SLisandro Dalcin   PetscFunctionReturn(0);
15252d747510SLisandro Dalcin }
15262d747510SLisandro Dalcin 
15272d747510SLisandro Dalcin /*@C
15282d747510SLisandro Dalcin    PetscOptionsLeftRestore - Free memory for the unused PETSc options obtained using PetscOptionsLeftGet.
15292d747510SLisandro Dalcin 
15302d747510SLisandro Dalcin    Not Collective
15312d747510SLisandro Dalcin 
15322d747510SLisandro Dalcin    Input Parameter:
15332d747510SLisandro Dalcin .  options - options database, use NULL for default global database
15342d747510SLisandro Dalcin .  names - names of options not used
15352d747510SLisandro Dalcin .  values - values of options not used
15362d747510SLisandro Dalcin 
15372d747510SLisandro Dalcin    Level: advanced
15382d747510SLisandro Dalcin 
15392d747510SLisandro Dalcin .seealso: PetscOptionsAllUsed(), PetscOptionsLeft(), PetscOptionsLeftGet()
15402d747510SLisandro Dalcin @*/
15412d747510SLisandro Dalcin PetscErrorCode PetscOptionsLeftRestore(PetscOptions options,PetscInt *N,char **names[],char **values[])
15422d747510SLisandro Dalcin {
15432d747510SLisandro Dalcin   PetscErrorCode ierr;
15442d747510SLisandro Dalcin 
15452d747510SLisandro Dalcin   PetscFunctionBegin;
15462d747510SLisandro Dalcin   if (N) PetscValidIntPointer(N,2);
15472d747510SLisandro Dalcin   if (names) PetscValidPointer(names,3);
15482d747510SLisandro Dalcin   if (values) PetscValidPointer(values,4);
15492d747510SLisandro Dalcin   if (N) { *N = 0; }
15502d747510SLisandro Dalcin   if (names)  { ierr = PetscFree(*names);CHKERRQ(ierr); }
15512d747510SLisandro Dalcin   if (values) { ierr = PetscFree(*values);CHKERRQ(ierr); }
15522d747510SLisandro Dalcin   PetscFunctionReturn(0);
15532d747510SLisandro Dalcin }
15542d747510SLisandro Dalcin 
15552d747510SLisandro Dalcin /*@C
15562d747510SLisandro Dalcin    PetscOptionsSetFromOptions - Sets options related to the handling of options in PETSc
15572d747510SLisandro Dalcin 
15582d747510SLisandro Dalcin    Collective on PETSC_COMM_WORLD
15592d747510SLisandro Dalcin 
15602d747510SLisandro Dalcin    Input Parameter:
15612d747510SLisandro Dalcin .  options - options database, use NULL for default global database
15622d747510SLisandro Dalcin 
15632d747510SLisandro Dalcin    Options Database Keys:
15642d747510SLisandro Dalcin +  -options_monitor <optional filename> - prints the names and values of all runtime options as they are set. The monitor functionality is not
15652d747510SLisandro Dalcin                 available for options set through a file, environment variable, or on
15662d747510SLisandro Dalcin                 the command line. Only options set after PetscInitialize() completes will
15672d747510SLisandro Dalcin                 be monitored.
15682d747510SLisandro Dalcin .  -options_monitor_cancel - cancel all options database monitors
15692d747510SLisandro Dalcin 
15702d747510SLisandro Dalcin    Notes:
15712d747510SLisandro Dalcin    To see all options, run your program with the -help option or consult Users-Manual: sec_gettingstarted
15722d747510SLisandro Dalcin 
15732d747510SLisandro Dalcin    Level: intermediate
15742d747510SLisandro Dalcin 
15752d747510SLisandro Dalcin .keywords: set, options, database
15762d747510SLisandro Dalcin @*/
15772d747510SLisandro Dalcin PetscErrorCode PetscOptionsSetFromOptions(PetscOptions options)
15782d747510SLisandro Dalcin {
15792d747510SLisandro Dalcin   PetscBool      flgc = PETSC_FALSE,flgm;
15802d747510SLisandro Dalcin   PetscErrorCode ierr;
15812d747510SLisandro Dalcin   char           monfilename[PETSC_MAX_PATH_LEN];
15822d747510SLisandro Dalcin   PetscViewer    monviewer;
15832d747510SLisandro Dalcin 
15842d747510SLisandro Dalcin   PetscFunctionBegin;
15852d747510SLisandro Dalcin   /*
15862d747510SLisandro Dalcin      The options argument is currently ignored since we currently maintain only a single options database
15872d747510SLisandro Dalcin 
15882d747510SLisandro Dalcin      options = options ? options : defaultoptions;
15892d747510SLisandro Dalcin   */
15902d747510SLisandro Dalcin   ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"Options for handling options","PetscOptions");CHKERRQ(ierr);
15912d747510SLisandro Dalcin   ierr = PetscOptionsString("-options_monitor","Monitor options database","PetscOptionsMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flgm);CHKERRQ(ierr);
15922d747510SLisandro Dalcin   ierr = PetscOptionsBool("-options_monitor_cancel","Cancel all options database monitors","PetscOptionsMonitorCancel",flgc,&flgc,NULL);CHKERRQ(ierr);
15932d747510SLisandro Dalcin   ierr = PetscOptionsEnd();CHKERRQ(ierr);
15942d747510SLisandro Dalcin   if (flgm) {
15952d747510SLisandro Dalcin     ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,monfilename,&monviewer);CHKERRQ(ierr);
15962d747510SLisandro Dalcin     ierr = PetscOptionsMonitorSet(PetscOptionsMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
15972d747510SLisandro Dalcin   }
15982d747510SLisandro Dalcin   if (flgc) { ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr); }
15992d747510SLisandro Dalcin   PetscFunctionReturn(0);
16002d747510SLisandro Dalcin }
16012d747510SLisandro Dalcin 
16022d747510SLisandro Dalcin /*@C
16032d747510SLisandro Dalcin    PetscOptionsMonitorDefault - Print all options set value events.
16042d747510SLisandro Dalcin 
16052d747510SLisandro Dalcin    Logically Collective on PETSC_COMM_WORLD
16062d747510SLisandro Dalcin 
16072d747510SLisandro Dalcin    Input Parameters:
16082d747510SLisandro Dalcin +  name  - option name string
16092d747510SLisandro Dalcin .  value - option value string
16102d747510SLisandro Dalcin -  ctx - an ASCII viewer
16112d747510SLisandro Dalcin 
16122d747510SLisandro Dalcin    Level: intermediate
16132d747510SLisandro Dalcin 
16142d747510SLisandro Dalcin .keywords: PetscOptions, default, monitor
16152d747510SLisandro Dalcin 
16162d747510SLisandro Dalcin .seealso: PetscOptionsMonitorSet()
16172d747510SLisandro Dalcin @*/
16182d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorDefault(const char name[],const char value[],void *ctx)
16192d747510SLisandro Dalcin {
16202d747510SLisandro Dalcin   PetscErrorCode ierr;
16212d747510SLisandro Dalcin   PetscViewer    viewer = (PetscViewer)ctx;
16222d747510SLisandro Dalcin 
16232d747510SLisandro Dalcin   PetscFunctionBegin;
16242d747510SLisandro Dalcin   if (!value) {
16252d747510SLisandro Dalcin     ierr = PetscViewerASCIIPrintf(viewer,"Removing option: %s\n",name,value);CHKERRQ(ierr);
16262d747510SLisandro Dalcin   } else if (!value[0]) {
16272d747510SLisandro Dalcin     ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s (no value)\n",name);CHKERRQ(ierr);
16282d747510SLisandro Dalcin   } else {
16292d747510SLisandro Dalcin     ierr = PetscViewerASCIIPrintf(viewer,"Setting option: %s = %s\n",name,value);CHKERRQ(ierr);
16302d747510SLisandro Dalcin   }
16312d747510SLisandro Dalcin   PetscFunctionReturn(0);
16322d747510SLisandro Dalcin }
16332d747510SLisandro Dalcin 
16342d747510SLisandro Dalcin /*@C
16352d747510SLisandro Dalcin    PetscOptionsMonitorSet - Sets an ADDITIONAL function to be called at every method that
16362d747510SLisandro Dalcin    modified the PETSc options database.
16372d747510SLisandro Dalcin 
16382d747510SLisandro Dalcin    Not Collective
16392d747510SLisandro Dalcin 
16402d747510SLisandro Dalcin    Input Parameters:
16412d747510SLisandro Dalcin +  monitor - pointer to function (if this is NULL, it turns off monitoring
16422d747510SLisandro Dalcin .  mctx    - [optional] context for private data for the
16432d747510SLisandro Dalcin              monitor routine (use NULL if no context is desired)
16442d747510SLisandro Dalcin -  monitordestroy - [optional] routine that frees monitor context
16452d747510SLisandro Dalcin           (may be NULL)
16462d747510SLisandro Dalcin 
16472d747510SLisandro Dalcin    Calling Sequence of monitor:
16482d747510SLisandro Dalcin $     monitor (const char name[], const char value[], void *mctx)
16492d747510SLisandro Dalcin 
16502d747510SLisandro Dalcin +  name - option name string
16512d747510SLisandro Dalcin .  value - option value string
16522d747510SLisandro Dalcin -  mctx  - optional monitoring context, as set by PetscOptionsMonitorSet()
16532d747510SLisandro Dalcin 
16542d747510SLisandro Dalcin    Options Database Keys:
16552d747510SLisandro Dalcin +    -options_monitor    - sets PetscOptionsMonitorDefault()
16562d747510SLisandro Dalcin -    -options_monitor_cancel - cancels all monitors that have
16572d747510SLisandro Dalcin                           been hardwired into a code by
16582d747510SLisandro Dalcin                           calls to PetscOptionsMonitorSet(), but
16592d747510SLisandro Dalcin                           does not cancel those set via
16602d747510SLisandro Dalcin                           the options database.
16612d747510SLisandro Dalcin 
16622d747510SLisandro Dalcin    Notes:
16632d747510SLisandro Dalcin    The default is to do nothing.  To print the name and value of options
16642d747510SLisandro Dalcin    being inserted into the database, use PetscOptionsMonitorDefault() as the monitoring routine,
16652d747510SLisandro Dalcin    with a null monitoring context.
16662d747510SLisandro Dalcin 
16672d747510SLisandro Dalcin    Several different monitoring routines may be set by calling
16682d747510SLisandro Dalcin    PetscOptionsMonitorSet() multiple times; all will be called in the
16692d747510SLisandro Dalcin    order in which they were set.
16702d747510SLisandro Dalcin 
16712d747510SLisandro Dalcin    Level: beginner
16722d747510SLisandro Dalcin 
16732d747510SLisandro Dalcin .keywords: PetscOptions, set, monitor
16742d747510SLisandro Dalcin 
16752d747510SLisandro Dalcin .seealso: PetscOptionsMonitorDefault(), PetscOptionsMonitorCancel()
16762d747510SLisandro Dalcin @*/
16772d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
16782d747510SLisandro Dalcin {
16792d747510SLisandro Dalcin   PetscOptions options = defaultoptions;
16802d747510SLisandro Dalcin 
16812d747510SLisandro Dalcin   PetscFunctionBegin;
16822d747510SLisandro Dalcin   if (options->numbermonitors >= MAXOPTIONSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many PetscOptions monitors set");
16832d747510SLisandro Dalcin   options->monitor[options->numbermonitors]          = monitor;
16842d747510SLisandro Dalcin   options->monitordestroy[options->numbermonitors]   = monitordestroy;
16852d747510SLisandro Dalcin   options->monitorcontext[options->numbermonitors++] = (void*)mctx;
16862d747510SLisandro Dalcin   PetscFunctionReturn(0);
16872d747510SLisandro Dalcin }
16882d747510SLisandro Dalcin 
16892d747510SLisandro Dalcin /*@
16902d747510SLisandro Dalcin    PetscOptionsMonitorCancel - Clears all monitors for a PetscOptions object.
16912d747510SLisandro Dalcin 
16922d747510SLisandro Dalcin    Not Collective
16932d747510SLisandro Dalcin 
16942d747510SLisandro Dalcin    Options Database Key:
16952d747510SLisandro Dalcin .  -options_monitor_cancel - Cancels all monitors that have
16962d747510SLisandro Dalcin     been hardwired into a code by calls to PetscOptionsMonitorSet(),
16972d747510SLisandro Dalcin     but does not cancel those set via the options database.
16982d747510SLisandro Dalcin 
16992d747510SLisandro Dalcin    Level: intermediate
17002d747510SLisandro Dalcin 
17012d747510SLisandro Dalcin .keywords: PetscOptions, set, monitor
17022d747510SLisandro Dalcin 
17032d747510SLisandro Dalcin .seealso: PetscOptionsMonitorDefault(), PetscOptionsMonitorSet()
17042d747510SLisandro Dalcin @*/
17052d747510SLisandro Dalcin PetscErrorCode PetscOptionsMonitorCancel(void)
17062d747510SLisandro Dalcin {
17072d747510SLisandro Dalcin   PetscErrorCode ierr;
17082d747510SLisandro Dalcin   PetscInt       i;
17092d747510SLisandro Dalcin   PetscOptions   options = defaultoptions;
17102d747510SLisandro Dalcin 
17112d747510SLisandro Dalcin   PetscFunctionBegin;
17122d747510SLisandro Dalcin   for (i=0; i<options->numbermonitors; i++) {
17132d747510SLisandro Dalcin     if (options->monitordestroy[i]) {
17142d747510SLisandro Dalcin       ierr = (*options->monitordestroy[i])(&options->monitorcontext[i]);CHKERRQ(ierr);
17152d747510SLisandro Dalcin     }
17162d747510SLisandro Dalcin   }
17172d747510SLisandro Dalcin   options->numbermonitors = 0;
17182d747510SLisandro Dalcin   PetscFunctionReturn(0);
17192d747510SLisandro Dalcin }
17202d747510SLisandro Dalcin 
17212d747510SLisandro Dalcin /*
17222d747510SLisandro Dalcin    PetscOptionsStringToBool - Converts string to PetscBool , handles cases like "yes", "no", "true", "false", "0", "1", "off", "on".
17232d747510SLisandro Dalcin */
17242d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToBool(const char value[],PetscBool *a)
17252d747510SLisandro Dalcin {
17262d747510SLisandro Dalcin   PetscBool      istrue,isfalse;
17272d747510SLisandro Dalcin   size_t         len;
17282d747510SLisandro Dalcin   PetscErrorCode ierr;
17292d747510SLisandro Dalcin 
17302d747510SLisandro Dalcin   PetscFunctionBegin;
17312d747510SLisandro Dalcin   ierr = PetscStrlen(value,&len);CHKERRQ(ierr);
17322d747510SLisandro Dalcin   if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Character string of length zero has no logical value");
17332d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"TRUE",&istrue);CHKERRQ(ierr);
17342d747510SLisandro Dalcin   if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);}
17352d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"YES",&istrue);CHKERRQ(ierr);
17362d747510SLisandro Dalcin   if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);}
17372d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"1",&istrue);CHKERRQ(ierr);
17382d747510SLisandro Dalcin   if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);}
17392d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"on",&istrue);CHKERRQ(ierr);
17402d747510SLisandro Dalcin   if (istrue) {*a = PETSC_TRUE; PetscFunctionReturn(0);}
17412d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"FALSE",&isfalse);CHKERRQ(ierr);
17422d747510SLisandro Dalcin   if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);}
17432d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"NO",&isfalse);CHKERRQ(ierr);
17442d747510SLisandro Dalcin   if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);}
17452d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"0",&isfalse);CHKERRQ(ierr);
17462d747510SLisandro Dalcin   if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);}
17472d747510SLisandro Dalcin   ierr = PetscStrcasecmp(value,"off",&isfalse);CHKERRQ(ierr);
17482d747510SLisandro Dalcin   if (isfalse) {*a = PETSC_FALSE; PetscFunctionReturn(0);}
17492d747510SLisandro Dalcin   SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Unknown logical value: %s",value);
17502d747510SLisandro Dalcin }
17512d747510SLisandro Dalcin 
17522d747510SLisandro Dalcin /*
17532d747510SLisandro Dalcin    PetscOptionsStringToInt - Converts a string to an integer value. Handles special cases such as "default" and "decide"
17542d747510SLisandro Dalcin */
17552d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToInt(const char name[],PetscInt *a)
17562d747510SLisandro Dalcin {
17572d747510SLisandro Dalcin   PetscErrorCode ierr;
17582d747510SLisandro Dalcin   size_t         len;
17592d747510SLisandro Dalcin   PetscBool      decide,tdefault,mouse;
17602d747510SLisandro Dalcin 
17612d747510SLisandro Dalcin   PetscFunctionBegin;
17622d747510SLisandro Dalcin   ierr = PetscStrlen(name,&len);CHKERRQ(ierr);
17632d747510SLisandro Dalcin   if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value");
17642d747510SLisandro Dalcin 
17652d747510SLisandro Dalcin   ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&tdefault);CHKERRQ(ierr);
17662d747510SLisandro Dalcin   if (!tdefault) {
17672d747510SLisandro Dalcin     ierr = PetscStrcasecmp(name,"DEFAULT",&tdefault);CHKERRQ(ierr);
17682d747510SLisandro Dalcin   }
17692d747510SLisandro Dalcin   ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&decide);CHKERRQ(ierr);
17702d747510SLisandro Dalcin   if (!decide) {
17712d747510SLisandro Dalcin     ierr = PetscStrcasecmp(name,"DECIDE",&decide);CHKERRQ(ierr);
17722d747510SLisandro Dalcin   }
17732d747510SLisandro Dalcin   ierr = PetscStrcasecmp(name,"mouse",&mouse);CHKERRQ(ierr);
17742d747510SLisandro Dalcin 
17752d747510SLisandro Dalcin   if (tdefault)    *a = PETSC_DEFAULT;
17762d747510SLisandro Dalcin   else if (decide) *a = PETSC_DECIDE;
17772d747510SLisandro Dalcin   else if (mouse)  *a = -1;
17782d747510SLisandro Dalcin   else {
17792d747510SLisandro Dalcin     char *endptr;
17802d747510SLisandro Dalcin     long strtolval;
17812d747510SLisandro Dalcin 
17822d747510SLisandro Dalcin     strtolval = strtol(name,&endptr,10);
17832d747510SLisandro 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);
17842d747510SLisandro Dalcin 
17852d747510SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE_ATOLL)
17862d747510SLisandro Dalcin     (void) strtolval;
17872d747510SLisandro Dalcin     *a = atoll(name);
17882d747510SLisandro Dalcin #elif defined(PETSC_USE_64BIT_INDICES) && defined(PETSC_HAVE___INT64)
17892d747510SLisandro Dalcin     (void) strtolval;
17902d747510SLisandro Dalcin     *a = _atoi64(name);
17912d747510SLisandro Dalcin #else
17922d747510SLisandro Dalcin     *a = (PetscInt)strtolval;
17932d747510SLisandro Dalcin #endif
17942d747510SLisandro Dalcin   }
17952d747510SLisandro Dalcin   PetscFunctionReturn(0);
17962d747510SLisandro Dalcin }
17972d747510SLisandro Dalcin 
17982d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128)
17992d747510SLisandro Dalcin #include <quadmath.h>
18002d747510SLisandro Dalcin #endif
18012d747510SLisandro Dalcin 
18022d747510SLisandro Dalcin static PetscErrorCode PetscStrtod(const char name[],PetscReal *a,char **endptr)
18032d747510SLisandro Dalcin {
18042d747510SLisandro Dalcin   PetscFunctionBegin;
18052d747510SLisandro Dalcin #if defined(PETSC_USE_REAL___FLOAT128)
18062d747510SLisandro Dalcin   *a = strtoflt128(name,endptr);
18072d747510SLisandro Dalcin #else
18082d747510SLisandro Dalcin   *a = (PetscReal)strtod(name,endptr);
18092d747510SLisandro Dalcin #endif
18102d747510SLisandro Dalcin   PetscFunctionReturn(0);
18112d747510SLisandro Dalcin }
18122d747510SLisandro Dalcin 
18132d747510SLisandro Dalcin static PetscErrorCode PetscStrtoz(const char name[],PetscScalar *a,char **endptr,PetscBool *isImaginary)
18142d747510SLisandro Dalcin {
18152d747510SLisandro Dalcin   PetscBool      hasi = PETSC_FALSE;
18162d747510SLisandro Dalcin   char           *ptr;
18172d747510SLisandro Dalcin   PetscReal      strtoval;
18182d747510SLisandro Dalcin   PetscErrorCode ierr;
18192d747510SLisandro Dalcin 
18202d747510SLisandro Dalcin   PetscFunctionBegin;
18212d747510SLisandro Dalcin   ierr = PetscStrtod(name,&strtoval,&ptr);CHKERRQ(ierr);
18222d747510SLisandro Dalcin   if (ptr == name) {
18232d747510SLisandro Dalcin     strtoval = 1.;
18242d747510SLisandro Dalcin     hasi = PETSC_TRUE;
18252d747510SLisandro Dalcin     if (name[0] == 'i') {
18262d747510SLisandro Dalcin       ptr++;
18272d747510SLisandro Dalcin     } else if (name[0] == '+' && name[1] == 'i') {
18282d747510SLisandro Dalcin       ptr += 2;
18292d747510SLisandro Dalcin     } else if (name[0] == '-' && name[1] == 'i') {
18302d747510SLisandro Dalcin       strtoval = -1.;
18312d747510SLisandro Dalcin       ptr += 2;
18322d747510SLisandro Dalcin     }
18332d747510SLisandro Dalcin   } else if (*ptr == 'i') {
18342d747510SLisandro Dalcin     hasi = PETSC_TRUE;
18352d747510SLisandro Dalcin     ptr++;
18362d747510SLisandro Dalcin   }
18372d747510SLisandro Dalcin   *endptr = ptr;
18382d747510SLisandro Dalcin   *isImaginary = hasi;
18392d747510SLisandro Dalcin   if (hasi) {
18402d747510SLisandro Dalcin #if !defined(PETSC_USE_COMPLEX)
18412d747510SLisandro Dalcin     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s contains imaginary but complex not supported ",name);
18422d747510SLisandro Dalcin #else
18432d747510SLisandro Dalcin     *a = PetscCMPLX(0.,strtoval);
18442d747510SLisandro Dalcin #endif
18452d747510SLisandro Dalcin   } else {
18462d747510SLisandro Dalcin     *a = strtoval;
18472d747510SLisandro Dalcin   }
18482d747510SLisandro Dalcin   PetscFunctionReturn(0);
18492d747510SLisandro Dalcin }
18502d747510SLisandro Dalcin 
18512d747510SLisandro Dalcin /*
18522d747510SLisandro Dalcin    Converts a string to PetscReal value. Handles special cases like "default" and "decide"
18532d747510SLisandro Dalcin */
18542d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToReal(const char name[],PetscReal *a)
18552d747510SLisandro Dalcin {
18562d747510SLisandro Dalcin   size_t         len;
18572d747510SLisandro Dalcin   PetscBool      match;
18582d747510SLisandro Dalcin   char           *endptr;
18592d747510SLisandro Dalcin   PetscErrorCode ierr;
18602d747510SLisandro Dalcin 
18612d747510SLisandro Dalcin   PetscFunctionBegin;
18622d747510SLisandro Dalcin   ierr = PetscStrlen(name,&len);CHKERRQ(ierr);
18632d747510SLisandro Dalcin   if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"String of length zero has no numerical value");
18642d747510SLisandro Dalcin 
18652d747510SLisandro Dalcin   ierr = PetscStrcasecmp(name,"PETSC_DEFAULT",&match);CHKERRQ(ierr);
18662d747510SLisandro Dalcin   if (!match) {
18672d747510SLisandro Dalcin     ierr = PetscStrcasecmp(name,"DEFAULT",&match);CHKERRQ(ierr);
18682d747510SLisandro Dalcin   }
18692d747510SLisandro Dalcin   if (match) {*a = PETSC_DEFAULT; PetscFunctionReturn(0);}
18702d747510SLisandro Dalcin 
18712d747510SLisandro Dalcin   ierr = PetscStrcasecmp(name,"PETSC_DECIDE",&match);CHKERRQ(ierr);
18722d747510SLisandro Dalcin   if (!match) {
18732d747510SLisandro Dalcin     ierr = PetscStrcasecmp(name,"DECIDE",&match);CHKERRQ(ierr);
18742d747510SLisandro Dalcin   }
18752d747510SLisandro Dalcin   if (match) {*a = PETSC_DECIDE; PetscFunctionReturn(0);}
18762d747510SLisandro Dalcin 
18772d747510SLisandro Dalcin   ierr = PetscStrtod(name,a,&endptr);CHKERRQ(ierr);
18782d747510SLisandro Dalcin   if ((size_t) (endptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value",name);
18792d747510SLisandro Dalcin   PetscFunctionReturn(0);
18802d747510SLisandro Dalcin }
18812d747510SLisandro Dalcin 
18822d747510SLisandro Dalcin PetscErrorCode PetscOptionsStringToScalar(const char name[],PetscScalar *a)
18832d747510SLisandro Dalcin {
18842d747510SLisandro Dalcin   PetscBool      imag1;
18852d747510SLisandro Dalcin   size_t         len;
18862d747510SLisandro Dalcin   PetscScalar    val = 0.;
18872d747510SLisandro Dalcin   char           *ptr = NULL;
18882d747510SLisandro Dalcin   PetscErrorCode ierr;
18892d747510SLisandro Dalcin 
18902d747510SLisandro Dalcin   PetscFunctionBegin;
18912d747510SLisandro Dalcin   ierr = PetscStrlen(name,&len);CHKERRQ(ierr);
18922d747510SLisandro Dalcin   if (!len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"character string of length zero has no numerical value");
18932d747510SLisandro Dalcin   ierr = PetscStrtoz(name,&val,&ptr,&imag1);CHKERRQ(ierr);
18942d747510SLisandro Dalcin #if defined(PETSC_USE_COMPLEX)
18952d747510SLisandro Dalcin   if ((size_t) (ptr - name) < len) {
18962d747510SLisandro Dalcin     PetscBool   imag2;
18972d747510SLisandro Dalcin     PetscScalar val2;
18982d747510SLisandro Dalcin 
18992d747510SLisandro Dalcin     ierr = PetscStrtoz(ptr,&val2,&ptr,&imag2);CHKERRQ(ierr);
19002d747510SLisandro Dalcin     if (imag1 || !imag2) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s: must specify imaginary component second",name);
19012d747510SLisandro Dalcin     val = PetscCMPLX(PetscRealPart(val),PetscImaginaryPart(val2));
19022d747510SLisandro Dalcin   }
19032d747510SLisandro Dalcin #endif
19042d747510SLisandro Dalcin   if ((size_t) (ptr - name) != len) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Input string %s has no numeric value ",name);
19052d747510SLisandro Dalcin   *a = val;
19062d747510SLisandro Dalcin   PetscFunctionReturn(0);
19072d747510SLisandro Dalcin }
19082d747510SLisandro Dalcin 
19092d747510SLisandro Dalcin /*@C
19102d747510SLisandro Dalcin    PetscOptionsGetBool - Gets the Logical (true or false) value for a particular
19112d747510SLisandro Dalcin             option in the database.
1912e5c89e4eSSatish Balay 
1913e5c89e4eSSatish Balay    Not Collective
1914e5c89e4eSSatish Balay 
1915e5c89e4eSSatish Balay    Input Parameters:
19165c9cc608SHong Zhang +  options - options database, use NULL for default global database
1917c5929fdfSBarry Smith .  pre - the string to prepend to the name or NULL
1918e5c89e4eSSatish Balay -  name - the option one is seeking
1919e5c89e4eSSatish Balay 
1920e5c89e4eSSatish Balay    Output Parameter:
19212d747510SLisandro Dalcin +  ivalue - the logical value to return
192296ef3cdfSSatish Balay -  set - PETSC_TRUE  if found, else PETSC_FALSE
1923e5c89e4eSSatish Balay 
1924e5c89e4eSSatish Balay    Level: beginner
1925e5c89e4eSSatish Balay 
192695452b02SPatrick Sanan    Notes:
19272d747510SLisandro Dalcin        TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE
19282d747510SLisandro Dalcin        FALSE, false, NO, no, and 0 all translate to PETSC_FALSE
19292d747510SLisandro Dalcin 
19302d747510SLisandro 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
19312d747510SLisandro Dalcin      is equivalent to -requested_bool true
19322d747510SLisandro Dalcin 
19332d747510SLisandro Dalcin        If the user does not supply the option at all ivalue is NOT changed. Thus
19342efd9cb1SBarry Smith      you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.
19352efd9cb1SBarry Smith 
19362d747510SLisandro Dalcin    Concepts: options database^has logical
1937e5c89e4eSSatish Balay 
1938e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
19392d747510SLisandro Dalcin           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetInt(), PetscOptionsBool(),
1940e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
1941e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
1942acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
1943a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
1944e5c89e4eSSatish Balay @*/
19452d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBool(PetscOptions options,const char pre[],const char name[],PetscBool *ivalue,PetscBool *set)
1946e5c89e4eSSatish Balay {
19472d747510SLisandro Dalcin   const char     *value;
1948ace3abfcSBarry Smith   PetscBool      flag;
19492d747510SLisandro Dalcin   PetscErrorCode ierr;
1950e5c89e4eSSatish Balay 
1951e5c89e4eSSatish Balay   PetscFunctionBegin;
19522d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
19532d747510SLisandro Dalcin   if (ivalue) PetscValidIntPointer(ivalue,4);
19542d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr);
1955e5c89e4eSSatish Balay   if (flag) {
195696ef3cdfSSatish Balay     if (set) *set = PETSC_TRUE;
19572d747510SLisandro Dalcin     if (!value) {
19582d747510SLisandro Dalcin       if (ivalue) *ivalue = PETSC_TRUE;
19592d747510SLisandro Dalcin     } else {
19602d747510SLisandro Dalcin       ierr = PetscOptionsStringToBool(value, &flag);CHKERRQ(ierr);
19612d747510SLisandro Dalcin       if (ivalue) *ivalue = flag;
1962e5c89e4eSSatish Balay     }
1963e5c89e4eSSatish Balay   } else {
196496ef3cdfSSatish Balay     if (set) *set = PETSC_FALSE;
1965e5c89e4eSSatish Balay   }
1966e5c89e4eSSatish Balay   PetscFunctionReturn(0);
1967e5c89e4eSSatish Balay }
1968e5c89e4eSSatish Balay 
1969e5c89e4eSSatish Balay /*@C
1970e5c89e4eSSatish Balay    PetscOptionsGetEList - Puts a list of option values that a single one may be selected from
1971e5c89e4eSSatish Balay 
1972e5c89e4eSSatish Balay    Not Collective
1973e5c89e4eSSatish Balay 
1974e5c89e4eSSatish Balay    Input Parameters:
19755c9cc608SHong Zhang +  options - options database, use NULL for default global database
1976c5929fdfSBarry Smith .  pre - the string to prepend to the name or NULL
1977e5c89e4eSSatish Balay .  opt - option name
1978a264d7a6SBarry Smith .  list - the possible choices (one of these must be selected, anything else is invalid)
1979e5c89e4eSSatish Balay .  ntext - number of choices
1980e5c89e4eSSatish Balay 
1981e5c89e4eSSatish Balay    Output Parameter:
19822efd9cb1SBarry Smith +  value - the index of the value to return (defaults to zero if the option name is given but no choice is listed)
1983e5c89e4eSSatish Balay -  set - PETSC_TRUE if found, else PETSC_FALSE
1984e5c89e4eSSatish Balay 
1985e5c89e4eSSatish Balay    Level: intermediate
1986e5c89e4eSSatish Balay 
198795452b02SPatrick Sanan    Notes:
198895452b02SPatrick Sanan     If the user does not supply the option value is NOT changed. Thus
19892efd9cb1SBarry Smith      you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.
19902efd9cb1SBarry Smith 
1991a264d7a6SBarry Smith    See PetscOptionsFList() for when the choices are given in a PetscFunctionList()
1992e5c89e4eSSatish Balay 
1993e5c89e4eSSatish Balay    Concepts: options database^list
1994e5c89e4eSSatish Balay 
1995e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
1996acfcf0e5SJed Brown           PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
1997e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
1998e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
1999acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2000a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
2001e5c89e4eSSatish Balay @*/
2002c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEList(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscInt ntext,PetscInt *value,PetscBool *set)
2003e5c89e4eSSatish Balay {
2004e5c89e4eSSatish Balay   PetscErrorCode ierr;
2005e5c89e4eSSatish Balay   size_t         alen,len = 0;
2006e5c89e4eSSatish Balay   char           *svalue;
2007ace3abfcSBarry Smith   PetscBool      aset,flg = PETSC_FALSE;
2008e5c89e4eSSatish Balay   PetscInt       i;
2009e5c89e4eSSatish Balay 
2010e5c89e4eSSatish Balay   PetscFunctionBegin;
20112d747510SLisandro Dalcin   PetscValidCharPointer(opt,3);
2012e5c89e4eSSatish Balay   for (i=0; i<ntext; i++) {
2013e5c89e4eSSatish Balay     ierr = PetscStrlen(list[i],&alen);CHKERRQ(ierr);
2014e5c89e4eSSatish Balay     if (alen > len) len = alen;
2015e5c89e4eSSatish Balay   }
2016e5c89e4eSSatish Balay   len += 5; /* a little extra space for user mistypes */
2017785e854fSJed Brown   ierr = PetscMalloc1(len,&svalue);CHKERRQ(ierr);
2018c5929fdfSBarry Smith   ierr = PetscOptionsGetString(options,pre,opt,svalue,len,&aset);CHKERRQ(ierr);
2019e5c89e4eSSatish Balay   if (aset) {
2020fbedd5e0SJed Brown     ierr = PetscEListFind(ntext,list,svalue,value,&flg);CHKERRQ(ierr);
2021e32f2f54SBarry Smith     if (!flg) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown option %s for -%s%s",svalue,pre ? pre : "",opt+1);
2022fbedd5e0SJed Brown     if (set) *set = PETSC_TRUE;
2023a297a907SKarl Rupp   } else if (set) *set = PETSC_FALSE;
2024e5c89e4eSSatish Balay   ierr = PetscFree(svalue);CHKERRQ(ierr);
2025e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2026e5c89e4eSSatish Balay }
2027e5c89e4eSSatish Balay 
2028e5c89e4eSSatish Balay /*@C
2029e5c89e4eSSatish Balay    PetscOptionsGetEnum - Gets the enum value for a particular option in the database.
2030e5c89e4eSSatish Balay 
2031e5c89e4eSSatish Balay    Not Collective
2032e5c89e4eSSatish Balay 
2033e5c89e4eSSatish Balay    Input Parameters:
20345c9cc608SHong Zhang +  options - options database, use NULL for default global database
2035c5929fdfSBarry Smith .  pre - option prefix or NULL
2036e5c89e4eSSatish Balay .  opt - option name
2037e5c89e4eSSatish Balay .  list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null
2038e5c89e4eSSatish Balay -  defaultv - the default (current) value
2039e5c89e4eSSatish Balay 
2040e5c89e4eSSatish Balay    Output Parameter:
2041e5c89e4eSSatish Balay +  value - the  value to return
204296ef3cdfSSatish Balay -  set - PETSC_TRUE if found, else PETSC_FALSE
2043e5c89e4eSSatish Balay 
2044e5c89e4eSSatish Balay    Level: beginner
2045e5c89e4eSSatish Balay 
2046e5c89e4eSSatish Balay    Concepts: options database
2047e5c89e4eSSatish Balay 
204895452b02SPatrick Sanan    Notes:
204995452b02SPatrick Sanan     If the user does not supply the option value is NOT changed. Thus
20502efd9cb1SBarry Smith      you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.
2051e5c89e4eSSatish Balay 
20522efd9cb1SBarry Smith           List is usually something like PCASMTypes or some other predefined list of enum names
2053e5c89e4eSSatish Balay 
2054e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
2055acfcf0e5SJed Brown           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
2056acfcf0e5SJed Brown           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
2057e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
2058e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
2059acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2060a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum()
2061e5c89e4eSSatish Balay @*/
2062c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set)
2063e5c89e4eSSatish Balay {
2064e5c89e4eSSatish Balay   PetscErrorCode ierr;
206569a24498SJed Brown   PetscInt       ntext = 0,tval;
2066ace3abfcSBarry Smith   PetscBool      fset;
2067e5c89e4eSSatish Balay 
2068e5c89e4eSSatish Balay   PetscFunctionBegin;
20692d747510SLisandro Dalcin   PetscValidCharPointer(opt,3);
2070e5c89e4eSSatish Balay   while (list[ntext++]) {
2071e32f2f54SBarry Smith     if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries");
2072e5c89e4eSSatish Balay   }
2073e32f2f54SBarry Smith   if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix");
2074e5c89e4eSSatish Balay   ntext -= 3;
2075c5929fdfSBarry Smith   ierr = PetscOptionsGetEList(options,pre,opt,list,ntext,&tval,&fset);CHKERRQ(ierr);
207669a24498SJed Brown   /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */
2077809ceb46SBarry Smith   if (fset) *value = (PetscEnum)tval;
2078809ceb46SBarry Smith   if (set) *set = fset;
2079e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2080e5c89e4eSSatish Balay }
2081e5c89e4eSSatish Balay 
2082e5c89e4eSSatish Balay /*@C
20832d747510SLisandro Dalcin    PetscOptionsGetInt - Gets the integer value for a particular option in the database.
2084e5c89e4eSSatish Balay 
2085e5c89e4eSSatish Balay    Not Collective
2086e5c89e4eSSatish Balay 
2087e5c89e4eSSatish Balay    Input Parameters:
20885c9cc608SHong Zhang +  options - options database, use NULL for default global database
2089c5929fdfSBarry Smith .  pre - the string to prepend to the name or NULL
2090e5c89e4eSSatish Balay -  name - the option one is seeking
2091e5c89e4eSSatish Balay 
2092e5c89e4eSSatish Balay    Output Parameter:
20932d747510SLisandro Dalcin +  ivalue - the integer value to return
209496ef3cdfSSatish Balay -  set - PETSC_TRUE if found, else PETSC_FALSE
2095e5c89e4eSSatish Balay 
2096e5c89e4eSSatish Balay    Level: beginner
2097e5c89e4eSSatish Balay 
2098e5c89e4eSSatish Balay    Notes:
20992d747510SLisandro Dalcin    If the user does not supply the option ivalue is NOT changed. Thus
21002efd9cb1SBarry Smith    you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.
21015c07ccb8SBarry Smith 
21022d747510SLisandro Dalcin    Concepts: options database^has int
2103e5c89e4eSSatish Balay 
2104e5c89e4eSSatish Balay .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
21052d747510SLisandro Dalcin           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
21062d747510SLisandro Dalcin           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
2107e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
2108e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
2109acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2110a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
2111e5c89e4eSSatish Balay @*/
21122d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetInt(PetscOptions options,const char pre[],const char name[],PetscInt *ivalue,PetscBool *set)
2113e5c89e4eSSatish Balay {
21142d747510SLisandro Dalcin   const char     *value;
2115e5c89e4eSSatish Balay   PetscErrorCode ierr;
21162d747510SLisandro Dalcin   PetscBool      flag;
2117e5c89e4eSSatish Balay 
2118e5c89e4eSSatish Balay   PetscFunctionBegin;
21192d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
21202d747510SLisandro Dalcin   PetscValidIntPointer(ivalue,4);
21212d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr);
2122e5c89e4eSSatish Balay   if (flag) {
212334a9cc2cSBarry Smith     if (!value) {
21242d747510SLisandro Dalcin       if (set) *set = PETSC_FALSE;
212534a9cc2cSBarry Smith     } else {
21262d747510SLisandro Dalcin       if (set) *set = PETSC_TRUE;
21272d747510SLisandro Dalcin       ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr);
2128e5c89e4eSSatish Balay     }
2129e5c89e4eSSatish Balay   } else {
213096ef3cdfSSatish Balay     if (set) *set = PETSC_FALSE;
2131e5c89e4eSSatish Balay   }
2132e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2133e5c89e4eSSatish Balay }
2134e5c89e4eSSatish Balay 
2135e2446a98SMatthew Knepley /*@C
2136e5c89e4eSSatish Balay    PetscOptionsGetReal - Gets the double precision value for a particular
2137e5c89e4eSSatish Balay    option in the database.
2138e5c89e4eSSatish Balay 
2139e5c89e4eSSatish Balay    Not Collective
2140e5c89e4eSSatish Balay 
2141e5c89e4eSSatish Balay    Input Parameters:
21425c9cc608SHong Zhang +  options - options database, use NULL for default global database
2143c5929fdfSBarry Smith .  pre - string to prepend to each name or NULL
2144e5c89e4eSSatish Balay -  name - the option one is seeking
2145e5c89e4eSSatish Balay 
2146e5c89e4eSSatish Balay    Output Parameter:
2147e5c89e4eSSatish Balay +  dvalue - the double value to return
214896ef3cdfSSatish Balay -  set - PETSC_TRUE if found, PETSC_FALSE if not found
2149e5c89e4eSSatish Balay 
215095452b02SPatrick Sanan    Notes:
215195452b02SPatrick Sanan     If the user does not supply the option dvalue is NOT changed. Thus
21522efd9cb1SBarry Smith      you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.
2153e4974155SBarry Smith 
2154e5c89e4eSSatish Balay    Level: beginner
2155e5c89e4eSSatish Balay 
2156e5c89e4eSSatish Balay    Concepts: options database^has double
2157e5c89e4eSSatish Balay 
2158e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(),
2159acfcf0e5SJed Brown           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(),PetscOptionsBool(),
2160e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
2161e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
2162acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2163a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
2164e5c89e4eSSatish Balay @*/
2165c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetReal(PetscOptions options,const char pre[],const char name[],PetscReal *dvalue,PetscBool *set)
2166e5c89e4eSSatish Balay {
21672d747510SLisandro Dalcin   const char     *value;
2168ace3abfcSBarry Smith   PetscBool      flag;
21692d747510SLisandro Dalcin   PetscErrorCode ierr;
2170e5c89e4eSSatish Balay 
2171e5c89e4eSSatish Balay   PetscFunctionBegin;
21722d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
21732d747510SLisandro Dalcin   PetscValidRealPointer(dvalue,4);
21742d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr);
2175e5c89e4eSSatish Balay   if (flag) {
2176a297a907SKarl Rupp     if (!value) {
2177a297a907SKarl Rupp       if (set) *set = PETSC_FALSE;
2178a297a907SKarl Rupp     } else {
2179a297a907SKarl Rupp       if (set) *set = PETSC_TRUE;
2180a297a907SKarl Rupp       ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr);
2181a297a907SKarl Rupp     }
2182e5c89e4eSSatish Balay   } else {
218396ef3cdfSSatish Balay     if (set) *set = PETSC_FALSE;
2184e5c89e4eSSatish Balay   }
2185e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2186e5c89e4eSSatish Balay }
2187e5c89e4eSSatish Balay 
2188e5c89e4eSSatish Balay /*@C
2189e5c89e4eSSatish Balay    PetscOptionsGetScalar - Gets the scalar value for a particular
2190e5c89e4eSSatish Balay    option in the database.
2191e5c89e4eSSatish Balay 
2192e5c89e4eSSatish Balay    Not Collective
2193e5c89e4eSSatish Balay 
2194e5c89e4eSSatish Balay    Input Parameters:
21955c9cc608SHong Zhang +  options - options database, use NULL for default global database
2196c5929fdfSBarry Smith .  pre - string to prepend to each name or NULL
2197e5c89e4eSSatish Balay -  name - the option one is seeking
2198e5c89e4eSSatish Balay 
2199e5c89e4eSSatish Balay    Output Parameter:
2200e5c89e4eSSatish Balay +  dvalue - the double value to return
220196ef3cdfSSatish Balay -  set - PETSC_TRUE if found, else PETSC_FALSE
2202e5c89e4eSSatish Balay 
2203e5c89e4eSSatish Balay    Level: beginner
2204e5c89e4eSSatish Balay 
2205e5c89e4eSSatish Balay    Usage:
2206eb4ae41dSBarry Smith    A complex number 2+3i must be specified with NO spaces
2207e5c89e4eSSatish Balay 
220895452b02SPatrick Sanan    Notes:
220995452b02SPatrick Sanan     If the user does not supply the option dvalue is NOT changed. Thus
22102efd9cb1SBarry Smith      you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.
2211e4974155SBarry Smith 
2212e5c89e4eSSatish Balay    Concepts: options database^has scalar
2213e5c89e4eSSatish Balay 
2214e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsHasName(),
2215acfcf0e5SJed Brown           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
2216e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
2217e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
2218acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2219a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
2220e5c89e4eSSatish Balay @*/
2221c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetScalar(PetscOptions options,const char pre[],const char name[],PetscScalar *dvalue,PetscBool *set)
2222e5c89e4eSSatish Balay {
22232d747510SLisandro Dalcin   const char     *value;
2224ace3abfcSBarry Smith   PetscBool      flag;
2225e5c89e4eSSatish Balay   PetscErrorCode ierr;
2226e5c89e4eSSatish Balay 
2227e5c89e4eSSatish Balay   PetscFunctionBegin;
22282d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
22292d747510SLisandro Dalcin   PetscValidScalarPointer(dvalue,4);
22302d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr);
2231e5c89e4eSSatish Balay   if (flag) {
2232e5c89e4eSSatish Balay     if (!value) {
223396ef3cdfSSatish Balay       if (set) *set = PETSC_FALSE;
2234e5c89e4eSSatish Balay     } else {
2235e5c89e4eSSatish Balay #if !defined(PETSC_USE_COMPLEX)
2236cfbddea1SSatish Balay       ierr = PetscOptionsStringToReal(value,dvalue);CHKERRQ(ierr);
2237e5c89e4eSSatish Balay #else
2238eb4ae41dSBarry Smith       ierr = PetscOptionsStringToScalar(value,dvalue);CHKERRQ(ierr);
2239e5c89e4eSSatish Balay #endif
224096ef3cdfSSatish Balay       if (set) *set = PETSC_TRUE;
2241e5c89e4eSSatish Balay     }
2242e5c89e4eSSatish Balay   } else { /* flag */
224396ef3cdfSSatish Balay     if (set) *set = PETSC_FALSE;
2244e5c89e4eSSatish Balay   }
2245e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2246e5c89e4eSSatish Balay }
2247e5c89e4eSSatish Balay 
2248e5c89e4eSSatish Balay /*@C
2249e5c89e4eSSatish Balay    PetscOptionsGetString - Gets the string value for a particular option in
2250e5c89e4eSSatish Balay    the database.
2251e5c89e4eSSatish Balay 
2252e5c89e4eSSatish Balay    Not Collective
2253e5c89e4eSSatish Balay 
2254e5c89e4eSSatish Balay    Input Parameters:
22555c9cc608SHong Zhang +  options - options database, use NULL for default global database
2256c5929fdfSBarry Smith .  pre - string to prepend to name or NULL
2257e5c89e4eSSatish Balay .  name - the option one is seeking
2258bcbf2dc5SJed Brown -  len - maximum length of the string including null termination
2259e5c89e4eSSatish Balay 
2260e5c89e4eSSatish Balay    Output Parameters:
2261e5c89e4eSSatish Balay +  string - location to copy string
226296ef3cdfSSatish Balay -  set - PETSC_TRUE if found, else PETSC_FALSE
2263e5c89e4eSSatish Balay 
2264e5c89e4eSSatish Balay    Level: beginner
2265e5c89e4eSSatish Balay 
2266e5c89e4eSSatish Balay    Fortran Note:
2267e5c89e4eSSatish Balay    The Fortran interface is slightly different from the C/C++
2268e5c89e4eSSatish Balay    interface (len is not used).  Sample usage in Fortran follows
2269e5c89e4eSSatish Balay .vb
2270e5c89e4eSSatish Balay       character *20    string
227193e6ba5cSBarry Smith       PetscErrorCode   ierr
227293e6ba5cSBarry Smith       PetscBool        set
22731b266c99SBarry Smith       call PetscOptionsGetString(PETSC_NULL_OPTIONS,PETSC_NULL_CHARACTER,'-s',string,set,ierr)
2274e5c89e4eSSatish Balay .ve
2275e5c89e4eSSatish Balay 
227695452b02SPatrick Sanan    Notes:
227795452b02SPatrick 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
2278e4974155SBarry Smith 
22792efd9cb1SBarry Smith            If the user does not use the option then the string is not changed. Thus
22802efd9cb1SBarry Smith            you should ALWAYS initialize the string if you access it without first checking if the set flag is true.
22812efd9cb1SBarry Smith 
2282e5c89e4eSSatish Balay    Concepts: options database^string
2283e5c89e4eSSatish Balay 
2284f3dea69dSBarry Smith     Note:
2285f3dea69dSBarry 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).
2286f3dea69dSBarry Smith 
2287e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
2288acfcf0e5SJed Brown           PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
2289e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
2290e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
2291acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2292a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
2293e5c89e4eSSatish Balay @*/
2294c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetString(PetscOptions options,const char pre[],const char name[],char string[],size_t len,PetscBool *set)
2295e5c89e4eSSatish Balay {
22962d747510SLisandro Dalcin   const char     *value;
2297ace3abfcSBarry Smith   PetscBool      flag;
22982d747510SLisandro Dalcin   PetscErrorCode ierr;
2299e5c89e4eSSatish Balay 
2300e5c89e4eSSatish Balay   PetscFunctionBegin;
23012d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
23022d747510SLisandro Dalcin   PetscValidCharPointer(string,4);
23032d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);CHKERRQ(ierr);
2304e5c89e4eSSatish Balay   if (!flag) {
230596ef3cdfSSatish Balay     if (set) *set = PETSC_FALSE;
2306e5c89e4eSSatish Balay   } else {
230796ef3cdfSSatish Balay     if (set) *set = PETSC_TRUE;
2308e5c89e4eSSatish Balay     if (value) {
2309e5c89e4eSSatish Balay       ierr = PetscStrncpy(string,value,len);CHKERRQ(ierr);
2310e5c89e4eSSatish Balay     } else {
2311e5c89e4eSSatish Balay       ierr = PetscMemzero(string,len);CHKERRQ(ierr);
2312e5c89e4eSSatish Balay     }
2313e5c89e4eSSatish Balay   }
2314e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2315e5c89e4eSSatish Balay }
2316e5c89e4eSSatish Balay 
2317c5929fdfSBarry Smith char *PetscOptionsGetStringMatlab(PetscOptions options,const char pre[],const char name[])
231814ce751eSBarry Smith {
23192d747510SLisandro Dalcin   const char     *value;
232014ce751eSBarry Smith   PetscBool      flag;
23212d747510SLisandro Dalcin   PetscErrorCode ierr;
232214ce751eSBarry Smith 
232314ce751eSBarry Smith   PetscFunctionBegin;
23242d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&value,&flag);if (ierr) PetscFunctionReturn(0);
23252d747510SLisandro Dalcin   if (flag) PetscFunctionReturn((char*)value);
232614ce751eSBarry Smith   else PetscFunctionReturn(0);
232714ce751eSBarry Smith }
232814ce751eSBarry Smith 
23292d747510SLisandro Dalcin /*@C
23302d747510SLisandro Dalcin    PetscOptionsGetBoolArray - Gets an array of Logical (true or false) values for a particular
23312d747510SLisandro Dalcin    option in the database.  The values must be separated with commas with
23322d747510SLisandro Dalcin    no intervening spaces.
23332d747510SLisandro Dalcin 
23342d747510SLisandro Dalcin    Not Collective
23352d747510SLisandro Dalcin 
23362d747510SLisandro Dalcin    Input Parameters:
23372d747510SLisandro Dalcin +  options - options database, use NULL for default global database
23382d747510SLisandro Dalcin .  pre - string to prepend to each name or NULL
23392d747510SLisandro Dalcin .  name - the option one is seeking
23402d747510SLisandro Dalcin -  nmax - maximum number of values to retrieve
23412d747510SLisandro Dalcin 
23422d747510SLisandro Dalcin    Output Parameter:
23432d747510SLisandro Dalcin +  dvalue - the integer values to return
23442d747510SLisandro Dalcin .  nmax - actual number of values retreived
23452d747510SLisandro Dalcin -  set - PETSC_TRUE if found, else PETSC_FALSE
23462d747510SLisandro Dalcin 
23472d747510SLisandro Dalcin    Level: beginner
23482d747510SLisandro Dalcin 
23492d747510SLisandro Dalcin    Concepts: options database^array of ints
23502d747510SLisandro Dalcin 
23512d747510SLisandro Dalcin    Notes:
23522d747510SLisandro Dalcin        TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE
23532d747510SLisandro Dalcin        FALSE, false, NO, no, and 0 all translate to PETSC_FALSE
23542d747510SLisandro Dalcin 
23552d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(),
23562d747510SLisandro Dalcin           PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(),
23572d747510SLisandro Dalcin           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
23582d747510SLisandro Dalcin           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
23592d747510SLisandro Dalcin           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
23602d747510SLisandro Dalcin           PetscOptionsFList(), PetscOptionsEList()
23612d747510SLisandro Dalcin @*/
23622d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetBoolArray(PetscOptions options,const char pre[],const char name[],PetscBool dvalue[],PetscInt *nmax,PetscBool *set)
23632d747510SLisandro Dalcin {
23642d747510SLisandro Dalcin   const char     *svalue;
23652d747510SLisandro Dalcin   char           *value;
23662d747510SLisandro Dalcin   PetscErrorCode ierr;
23672d747510SLisandro Dalcin   PetscInt       n = 0;
23682d747510SLisandro Dalcin   PetscBool      flag;
23692d747510SLisandro Dalcin   PetscToken     token;
23702d747510SLisandro Dalcin 
23712d747510SLisandro Dalcin   PetscFunctionBegin;
23722d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
23732d747510SLisandro Dalcin   PetscValidIntPointer(dvalue,4);
23742d747510SLisandro Dalcin   PetscValidIntPointer(nmax,5);
23752d747510SLisandro Dalcin 
23762d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr);
23772d747510SLisandro Dalcin   if (!flag || !svalue)  { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);}
23782d747510SLisandro Dalcin   if (set) *set = PETSC_TRUE;
23792d747510SLisandro Dalcin   ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr);
23802d747510SLisandro Dalcin   ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
23812d747510SLisandro Dalcin   while (value && n < *nmax) {
23822d747510SLisandro Dalcin     ierr = PetscOptionsStringToBool(value,dvalue);CHKERRQ(ierr);
23832d747510SLisandro Dalcin     ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
23842d747510SLisandro Dalcin     dvalue++;
23852d747510SLisandro Dalcin     n++;
23862d747510SLisandro Dalcin   }
23872d747510SLisandro Dalcin   ierr  = PetscTokenDestroy(&token);CHKERRQ(ierr);
23882d747510SLisandro Dalcin   *nmax = n;
23892d747510SLisandro Dalcin   PetscFunctionReturn(0);
23902d747510SLisandro Dalcin }
23912d747510SLisandro Dalcin 
23922d747510SLisandro Dalcin /*@C
23932d747510SLisandro Dalcin    PetscOptionsGetEnumArray - Gets an array of enum values for a particular option in the database.
23942d747510SLisandro Dalcin 
23952d747510SLisandro Dalcin    Not Collective
23962d747510SLisandro Dalcin 
23972d747510SLisandro Dalcin    Input Parameters:
23982d747510SLisandro Dalcin +  options - options database, use NULL for default global database
23992d747510SLisandro Dalcin .  pre - option prefix or NULL
24002d747510SLisandro Dalcin .  name - option name
24012d747510SLisandro Dalcin .  list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null
24022d747510SLisandro Dalcin -  nmax - maximum number of values to retrieve
24032d747510SLisandro Dalcin 
24042d747510SLisandro Dalcin    Output Parameters:
24052d747510SLisandro Dalcin +  ivalue - the  enum values to return
24062d747510SLisandro Dalcin .  nmax - actual number of values retreived
24072d747510SLisandro Dalcin -  set - PETSC_TRUE if found, else PETSC_FALSE
24082d747510SLisandro Dalcin 
24092d747510SLisandro Dalcin    Level: beginner
24102d747510SLisandro Dalcin 
24112d747510SLisandro Dalcin    Concepts: options database
24122d747510SLisandro Dalcin 
24132d747510SLisandro Dalcin    Notes:
24142d747510SLisandro Dalcin    The array must be passed as a comma separated list.
24152d747510SLisandro Dalcin 
24162d747510SLisandro Dalcin    There must be no intervening spaces between the values.
24172d747510SLisandro Dalcin 
24182d747510SLisandro Dalcin    list is usually something like PCASMTypes or some other predefined list of enum names.
24192d747510SLisandro Dalcin 
24202d747510SLisandro Dalcin .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
24212d747510SLisandro Dalcin           PetscOptionsGetEnum(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
24222d747510SLisandro Dalcin           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(),
24232d747510SLisandro Dalcin           PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(),
24242d747510SLisandro Dalcin           PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
24252d747510SLisandro Dalcin           PetscOptionsFList(), PetscOptionsEList(), PetscOptionsGetEList(), PetscOptionsEnum()
24262d747510SLisandro Dalcin @*/
24272d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetEnumArray(PetscOptions options,const char pre[],const char name[],const char *const *list,PetscEnum ivalue[],PetscInt *nmax,PetscBool *set)
24282d747510SLisandro Dalcin {
24292d747510SLisandro Dalcin   const char     *svalue;
24302d747510SLisandro Dalcin   char           *value;
24312d747510SLisandro Dalcin   PetscInt       n = 0;
24322d747510SLisandro Dalcin   PetscEnum      evalue;
24332d747510SLisandro Dalcin   PetscBool      flag;
24342d747510SLisandro Dalcin   PetscToken     token;
24352d747510SLisandro Dalcin   PetscErrorCode ierr;
24362d747510SLisandro Dalcin 
24372d747510SLisandro Dalcin   PetscFunctionBegin;
24382d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
24392d747510SLisandro Dalcin   PetscValidPointer(list,4);
24402d747510SLisandro Dalcin   PetscValidPointer(ivalue,5);
24412d747510SLisandro Dalcin   PetscValidIntPointer(nmax,6);
24422d747510SLisandro Dalcin 
24432d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr);
24442d747510SLisandro Dalcin   if (!flag || !svalue)  { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);}
24452d747510SLisandro Dalcin   if (set) *set = PETSC_TRUE;
24462d747510SLisandro Dalcin   ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr);
24472d747510SLisandro Dalcin   ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
24482d747510SLisandro Dalcin   while (value && n < *nmax) {
24492d747510SLisandro Dalcin     ierr = PetscEnumFind(list,value,&evalue,&flag);CHKERRQ(ierr);
24502d747510SLisandro Dalcin     if (!flag) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_USER,"Unknown enum value '%s' for -%s%s",svalue,pre ? pre : "",name+1);
24512d747510SLisandro Dalcin     ivalue[n++] = evalue;
24522d747510SLisandro Dalcin     ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
24532d747510SLisandro Dalcin   }
24542d747510SLisandro Dalcin   ierr = PetscTokenDestroy(&token);CHKERRQ(ierr);
24552d747510SLisandro Dalcin   *nmax = n;
24562d747510SLisandro Dalcin   PetscFunctionReturn(0);
24572d747510SLisandro Dalcin }
24582d747510SLisandro Dalcin 
24592d747510SLisandro Dalcin /*@C
24602d747510SLisandro Dalcin    PetscOptionsGetIntArray - Gets an array of integer values for a particular
24612d747510SLisandro Dalcin    option in the database.
24622d747510SLisandro Dalcin 
24632d747510SLisandro Dalcin    Not Collective
24642d747510SLisandro Dalcin 
24652d747510SLisandro Dalcin    Input Parameters:
24662d747510SLisandro Dalcin +  options - options database, use NULL for default global database
24672d747510SLisandro Dalcin .  pre - string to prepend to each name or NULL
24682d747510SLisandro Dalcin .  name - the option one is seeking
24692d747510SLisandro Dalcin -  nmax - maximum number of values to retrieve
24702d747510SLisandro Dalcin 
24712d747510SLisandro Dalcin    Output Parameter:
24722d747510SLisandro Dalcin +  ivalue - the integer values to return
24732d747510SLisandro Dalcin .  nmax - actual number of values retreived
24742d747510SLisandro Dalcin -  set - PETSC_TRUE if found, else PETSC_FALSE
24752d747510SLisandro Dalcin 
24762d747510SLisandro Dalcin    Level: beginner
24772d747510SLisandro Dalcin 
24782d747510SLisandro Dalcin    Notes:
24792d747510SLisandro Dalcin    The array can be passed as
24802d747510SLisandro Dalcin    a comma separated list:                                 0,1,2,3,4,5,6,7
24812d747510SLisandro Dalcin    a range (start-end+1):                                  0-8
24822d747510SLisandro Dalcin    a range with given increment (start-end+1:inc):         0-7:2
24832d747510SLisandro Dalcin    a combination of values and ranges separated by commas: 0,1-8,8-15:2
24842d747510SLisandro Dalcin 
24852d747510SLisandro Dalcin    There must be no intervening spaces between the values.
24862d747510SLisandro Dalcin 
24872d747510SLisandro Dalcin    Concepts: options database^array of ints
24882d747510SLisandro Dalcin 
24892d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(),
24902d747510SLisandro Dalcin           PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(),
24912d747510SLisandro Dalcin           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
24922d747510SLisandro Dalcin           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
24932d747510SLisandro Dalcin           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
24942d747510SLisandro Dalcin           PetscOptionsFList(), PetscOptionsEList()
24952d747510SLisandro Dalcin @*/
24962d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetIntArray(PetscOptions options,const char pre[],const char name[],PetscInt ivalue[],PetscInt *nmax,PetscBool *set)
24972d747510SLisandro Dalcin {
24982d747510SLisandro Dalcin   const char     *svalue;
24992d747510SLisandro Dalcin   char           *value;
25002d747510SLisandro Dalcin   PetscErrorCode ierr;
25012d747510SLisandro Dalcin   PetscInt       n = 0,i,j,start,end,inc,nvalues;
25022d747510SLisandro Dalcin   size_t         len;
25032d747510SLisandro Dalcin   PetscBool      flag,foundrange;
25042d747510SLisandro Dalcin   PetscToken     token;
25052d747510SLisandro Dalcin 
25062d747510SLisandro Dalcin   PetscFunctionBegin;
25072d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
25082d747510SLisandro Dalcin   PetscValidIntPointer(ivalue,4);
25092d747510SLisandro Dalcin   PetscValidIntPointer(nmax,5);
25102d747510SLisandro Dalcin 
25112d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr);
25122d747510SLisandro Dalcin   if (!flag || !svalue)  { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);}
25132d747510SLisandro Dalcin   if (set) *set = PETSC_TRUE;
25142d747510SLisandro Dalcin   ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr);
25152d747510SLisandro Dalcin   ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
25162d747510SLisandro Dalcin   while (value && n < *nmax) {
25172d747510SLisandro Dalcin     /* look for form  d-D where d and D are integers */
25182d747510SLisandro Dalcin     foundrange = PETSC_FALSE;
25192d747510SLisandro Dalcin     ierr       = PetscStrlen(value,&len);CHKERRQ(ierr);
25202d747510SLisandro Dalcin     if (value[0] == '-') i=2;
25212d747510SLisandro Dalcin     else i=1;
25222d747510SLisandro Dalcin     for (;i<(int)len; i++) {
25232d747510SLisandro Dalcin       if (value[i] == '-') {
25242d747510SLisandro Dalcin         if (i == (int)len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value);
25252d747510SLisandro Dalcin         value[i] = 0;
25262d747510SLisandro Dalcin 
25272d747510SLisandro Dalcin         ierr = PetscOptionsStringToInt(value,&start);CHKERRQ(ierr);
25282d747510SLisandro Dalcin         inc  = 1;
25292d747510SLisandro Dalcin         j    = i+1;
25302d747510SLisandro Dalcin         for (;j<(int)len; j++) {
25312d747510SLisandro Dalcin           if (value[j] == ':') {
25322d747510SLisandro Dalcin             value[j] = 0;
25332d747510SLisandro Dalcin 
25342d747510SLisandro Dalcin             ierr = PetscOptionsStringToInt(value+j+1,&inc);CHKERRQ(ierr);
25352d747510SLisandro 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);
25362d747510SLisandro Dalcin             break;
25372d747510SLisandro Dalcin           }
25382d747510SLisandro Dalcin         }
25392d747510SLisandro Dalcin         ierr = PetscOptionsStringToInt(value+i+1,&end);CHKERRQ(ierr);
25402d747510SLisandro 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);
25412d747510SLisandro Dalcin         nvalues = (end-start)/inc + (end-start)%inc;
25422d747510SLisandro 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);
25432d747510SLisandro Dalcin         for (;start<end; start+=inc) {
25442d747510SLisandro Dalcin           *ivalue = start; ivalue++;n++;
25452d747510SLisandro Dalcin         }
25462d747510SLisandro Dalcin         foundrange = PETSC_TRUE;
25472d747510SLisandro Dalcin         break;
25482d747510SLisandro Dalcin       }
25492d747510SLisandro Dalcin     }
25502d747510SLisandro Dalcin     if (!foundrange) {
25512d747510SLisandro Dalcin       ierr = PetscOptionsStringToInt(value,ivalue);CHKERRQ(ierr);
25522d747510SLisandro Dalcin       ivalue++;
25532d747510SLisandro Dalcin       n++;
25542d747510SLisandro Dalcin     }
25552d747510SLisandro Dalcin     ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
25562d747510SLisandro Dalcin   }
25572d747510SLisandro Dalcin   ierr  = PetscTokenDestroy(&token);CHKERRQ(ierr);
25582d747510SLisandro Dalcin   *nmax = n;
25592d747510SLisandro Dalcin   PetscFunctionReturn(0);
25602d747510SLisandro Dalcin }
25612d747510SLisandro Dalcin 
25622d747510SLisandro Dalcin /*@C
25632d747510SLisandro Dalcin    PetscOptionsGetRealArray - Gets an array of double precision values for a
25642d747510SLisandro Dalcin    particular option in the database.  The values must be separated with
25652d747510SLisandro Dalcin    commas with no intervening spaces.
25662d747510SLisandro Dalcin 
25672d747510SLisandro Dalcin    Not Collective
25682d747510SLisandro Dalcin 
25692d747510SLisandro Dalcin    Input Parameters:
25702d747510SLisandro Dalcin +  options - options database, use NULL for default global database
25712d747510SLisandro Dalcin .  pre - string to prepend to each name or NULL
25722d747510SLisandro Dalcin .  name - the option one is seeking
25732d747510SLisandro Dalcin -  nmax - maximum number of values to retrieve
25742d747510SLisandro Dalcin 
25752d747510SLisandro Dalcin    Output Parameters:
25762d747510SLisandro Dalcin +  dvalue - the double values to return
25772d747510SLisandro Dalcin .  nmax - actual number of values retreived
25782d747510SLisandro Dalcin -  set - PETSC_TRUE if found, else PETSC_FALSE
25792d747510SLisandro Dalcin 
25802d747510SLisandro Dalcin    Level: beginner
25812d747510SLisandro Dalcin 
25822d747510SLisandro Dalcin    Concepts: options database^array of doubles
25832d747510SLisandro Dalcin 
25842d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(),
25852d747510SLisandro Dalcin           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(),
25862d747510SLisandro Dalcin           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
25872d747510SLisandro Dalcin           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
25882d747510SLisandro Dalcin           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
25892d747510SLisandro Dalcin           PetscOptionsFList(), PetscOptionsEList()
25902d747510SLisandro Dalcin @*/
25912d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetRealArray(PetscOptions options,const char pre[],const char name[],PetscReal dvalue[],PetscInt *nmax,PetscBool *set)
25922d747510SLisandro Dalcin {
25932d747510SLisandro Dalcin   const char     *svalue;
25942d747510SLisandro Dalcin   char           *value;
25952d747510SLisandro Dalcin   PetscErrorCode ierr;
25962d747510SLisandro Dalcin   PetscInt       n = 0;
25972d747510SLisandro Dalcin   PetscBool      flag;
25982d747510SLisandro Dalcin   PetscToken     token;
25992d747510SLisandro Dalcin 
26002d747510SLisandro Dalcin   PetscFunctionBegin;
26012d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
26022d747510SLisandro Dalcin   PetscValidRealPointer(dvalue,4);
26032d747510SLisandro Dalcin   PetscValidIntPointer(nmax,5);
26042d747510SLisandro Dalcin 
26052d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr);
26062d747510SLisandro Dalcin   if (!flag || !svalue)  { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);}
26072d747510SLisandro Dalcin   if (set) *set = PETSC_TRUE;
26082d747510SLisandro Dalcin   ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr);
26092d747510SLisandro Dalcin   ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
26102d747510SLisandro Dalcin   while (value && n < *nmax) {
26112d747510SLisandro Dalcin     ierr = PetscOptionsStringToReal(value,dvalue++);CHKERRQ(ierr);
26122d747510SLisandro Dalcin     ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
26132d747510SLisandro Dalcin     n++;
26142d747510SLisandro Dalcin   }
26152d747510SLisandro Dalcin   ierr  = PetscTokenDestroy(&token);CHKERRQ(ierr);
26162d747510SLisandro Dalcin   *nmax = n;
26172d747510SLisandro Dalcin   PetscFunctionReturn(0);
26182d747510SLisandro Dalcin }
26192d747510SLisandro Dalcin 
26202d747510SLisandro Dalcin /*@C
26212d747510SLisandro Dalcin    PetscOptionsGetScalarArray - Gets an array of scalars for a
26222d747510SLisandro Dalcin    particular option in the database.  The values must be separated with
26232d747510SLisandro Dalcin    commas with no intervening spaces.
26242d747510SLisandro Dalcin 
26252d747510SLisandro Dalcin    Not Collective
26262d747510SLisandro Dalcin 
26272d747510SLisandro Dalcin    Input Parameters:
26282d747510SLisandro Dalcin +  options - options database, use NULL for default global database
26292d747510SLisandro Dalcin .  pre - string to prepend to each name or NULL
26302d747510SLisandro Dalcin .  name - the option one is seeking
26312d747510SLisandro Dalcin -  nmax - maximum number of values to retrieve
26322d747510SLisandro Dalcin 
26332d747510SLisandro Dalcin    Output Parameters:
26342d747510SLisandro Dalcin +  dvalue - the scalar values to return
26352d747510SLisandro Dalcin .  nmax - actual number of values retreived
26362d747510SLisandro Dalcin -  set - PETSC_TRUE if found, else PETSC_FALSE
26372d747510SLisandro Dalcin 
26382d747510SLisandro Dalcin    Level: beginner
26392d747510SLisandro Dalcin 
26402d747510SLisandro Dalcin    Concepts: options database^array of doubles
26412d747510SLisandro Dalcin 
26422d747510SLisandro Dalcin .seealso: PetscOptionsGetInt(), PetscOptionsHasName(),
26432d747510SLisandro Dalcin           PetscOptionsGetString(), PetscOptionsGetIntArray(), PetscOptionsBool(),
26442d747510SLisandro Dalcin           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
26452d747510SLisandro Dalcin           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
26462d747510SLisandro Dalcin           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
26472d747510SLisandro Dalcin           PetscOptionsFList(), PetscOptionsEList()
26482d747510SLisandro Dalcin @*/
26492d747510SLisandro Dalcin PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set)
26502d747510SLisandro Dalcin {
26512d747510SLisandro Dalcin   const char     *svalue;
26522d747510SLisandro Dalcin   char           *value;
26532d747510SLisandro Dalcin   PetscErrorCode ierr;
26542d747510SLisandro Dalcin   PetscInt       n = 0;
26552d747510SLisandro Dalcin   PetscBool      flag;
26562d747510SLisandro Dalcin   PetscToken     token;
26572d747510SLisandro Dalcin 
26582d747510SLisandro Dalcin   PetscFunctionBegin;
26592d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
26602d747510SLisandro Dalcin   PetscValidRealPointer(dvalue,4);
26612d747510SLisandro Dalcin   PetscValidIntPointer(nmax,5);
26622d747510SLisandro Dalcin 
26632d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr);
26642d747510SLisandro Dalcin   if (!flag || !svalue)  { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);}
26652d747510SLisandro Dalcin   if (set) *set = PETSC_TRUE;
26662d747510SLisandro Dalcin   ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr);
26672d747510SLisandro Dalcin   ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
26682d747510SLisandro Dalcin   while (value && n < *nmax) {
26692d747510SLisandro Dalcin     ierr = PetscOptionsStringToScalar(value,dvalue++);CHKERRQ(ierr);
26702d747510SLisandro Dalcin     ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
26712d747510SLisandro Dalcin     n++;
26722d747510SLisandro Dalcin   }
26732d747510SLisandro Dalcin   ierr  = PetscTokenDestroy(&token);CHKERRQ(ierr);
26742d747510SLisandro Dalcin   *nmax = n;
26752d747510SLisandro Dalcin   PetscFunctionReturn(0);
26762d747510SLisandro Dalcin }
267714ce751eSBarry Smith 
2678e5c89e4eSSatish Balay /*@C
2679e5c89e4eSSatish Balay    PetscOptionsGetStringArray - Gets an array of string values for a particular
2680e5c89e4eSSatish Balay    option in the database. The values must be separated with commas with
2681e5c89e4eSSatish Balay    no intervening spaces.
2682e5c89e4eSSatish Balay 
2683e5c89e4eSSatish Balay    Not Collective
2684e5c89e4eSSatish Balay 
2685e5c89e4eSSatish Balay    Input Parameters:
26865c9cc608SHong Zhang +  options - options database, use NULL for default global database
2687c5929fdfSBarry Smith .  pre - string to prepend to name or NULL
2688e5c89e4eSSatish Balay .  name - the option one is seeking
2689e5c89e4eSSatish Balay -  nmax - maximum number of strings
2690e5c89e4eSSatish Balay 
2691e5c89e4eSSatish Balay    Output Parameter:
2692e5c89e4eSSatish Balay +  strings - location to copy strings
269396ef3cdfSSatish Balay -  set - PETSC_TRUE if found, else PETSC_FALSE
2694e5c89e4eSSatish Balay 
2695e5c89e4eSSatish Balay    Level: beginner
2696e5c89e4eSSatish Balay 
2697e5c89e4eSSatish Balay    Notes:
2698e5c89e4eSSatish Balay    The user should pass in an array of pointers to char, to hold all the
2699e5c89e4eSSatish Balay    strings returned by this function.
2700e5c89e4eSSatish Balay 
2701e5c89e4eSSatish Balay    The user is responsible for deallocating the strings that are
2702e5c89e4eSSatish Balay    returned. The Fortran interface for this routine is not supported.
2703e5c89e4eSSatish Balay 
2704e5c89e4eSSatish Balay    Contributed by Matthew Knepley.
2705e5c89e4eSSatish Balay 
2706e5c89e4eSSatish Balay    Concepts: options database^array of strings
2707e5c89e4eSSatish Balay 
2708e5c89e4eSSatish Balay .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
2709acfcf0e5SJed Brown           PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
2710e5c89e4eSSatish Balay           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
2711e5c89e4eSSatish Balay           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
2712acfcf0e5SJed Brown           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
2713a264d7a6SBarry Smith           PetscOptionsFList(), PetscOptionsEList()
2714e5c89e4eSSatish Balay @*/
2715c5929fdfSBarry Smith PetscErrorCode PetscOptionsGetStringArray(PetscOptions options,const char pre[],const char name[],char *strings[],PetscInt *nmax,PetscBool *set)
2716e5c89e4eSSatish Balay {
27172d747510SLisandro Dalcin   const char     *svalue;
2718e5c89e4eSSatish Balay   char           *value;
2719e5c89e4eSSatish Balay   PetscErrorCode ierr;
27202d747510SLisandro Dalcin   PetscInt       n = 0;
2721ace3abfcSBarry Smith   PetscBool      flag;
27229c9d3cfdSBarry Smith   PetscToken     token;
2723e5c89e4eSSatish Balay 
2724e5c89e4eSSatish Balay   PetscFunctionBegin;
27252d747510SLisandro Dalcin   PetscValidCharPointer(name,3);
27262d747510SLisandro Dalcin   PetscValidPointer(strings,4);
27272d747510SLisandro Dalcin   PetscValidIntPointer(nmax,5);
2728e5c89e4eSSatish Balay 
27292d747510SLisandro Dalcin   ierr = PetscOptionsFindPair(options,pre,name,&svalue,&flag);CHKERRQ(ierr);
27302d747510SLisandro Dalcin   if (!flag || !svalue)  { if (set) *set = PETSC_FALSE; *nmax = 0; PetscFunctionReturn(0);}
27312d747510SLisandro Dalcin   if (set) *set = PETSC_TRUE;
27322d747510SLisandro Dalcin   ierr = PetscTokenCreate(svalue,',',&token);CHKERRQ(ierr);
2733e5c89e4eSSatish Balay   ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
27342d747510SLisandro Dalcin   while (value && n < *nmax) {
2735e5c89e4eSSatish Balay     ierr = PetscStrallocpy(value,&strings[n]);CHKERRQ(ierr);
2736e5c89e4eSSatish Balay     ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
2737e5c89e4eSSatish Balay     n++;
2738e5c89e4eSSatish Balay   }
27398c74ee41SBarry Smith   ierr  = PetscTokenDestroy(&token);CHKERRQ(ierr);
2740e5c89e4eSSatish Balay   *nmax = n;
2741e5c89e4eSSatish Balay   PetscFunctionReturn(0);
2742e5c89e4eSSatish Balay }
274306824ed3SPatrick Sanan 
274406824ed3SPatrick Sanan /*@C
274506824ed3SPatrick Sanan    PetscOptionsDeprecated - mark an option as deprecated, optionally replacing it with a new one
274606824ed3SPatrick Sanan 
274706824ed3SPatrick Sanan    Prints a deprecation warning, unless an option is supplied to suppress.
274806824ed3SPatrick Sanan 
274906824ed3SPatrick Sanan    Not Collective
275006824ed3SPatrick Sanan 
275106824ed3SPatrick Sanan    Input Parameters:
27529503aa97SPatrick Sanan +  pre - string to prepend to name or NULL
275306824ed3SPatrick Sanan .  oldname - the old, deprecated option
275406824ed3SPatrick Sanan .  newname - the new option, or NULL if option is purely removed
27559f3a6782SPatrick Sanan .  version - a string describing the version of first deprecation, e.g. "3.9"
27569f3a6782SPatrick Sanan -  info - additional information string, or NULL.
275706824ed3SPatrick Sanan 
275806824ed3SPatrick Sanan    Options Database Keys:
275906824ed3SPatrick Sanan . -options_suppress_deprecated_warnings - do not print deprecation warnings
276006824ed3SPatrick Sanan 
276106824ed3SPatrick Sanan    Notes:
2762b40114eaSPatrick Sanan    Must be called between PetscOptionsBegin() and PetscOptionsEnd().
2763b40114eaSPatrick Sanan    If newname is provided, the old option is replaced. Otherwise, it remains
2764b40114eaSPatrick Sanan    in the options database.
27659f3a6782SPatrick Sanan    If an option is not replaced, the info argument should be used to advise the user
27669f3a6782SPatrick Sanan    on how to proceed.
27679f3a6782SPatrick Sanan    There is a limit on the length of the warning printed, so very long strings
27689f3a6782SPatrick Sanan    provided as info may be truncated.
276906824ed3SPatrick Sanan 
277006824ed3SPatrick Sanan    Level: developer
277106824ed3SPatrick Sanan 
277206824ed3SPatrick Sanan .seealso: PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsScalar(), PetscOptionsBool(), PetscOptionsString(), PetscOptionsSetValue()
277306824ed3SPatrick Sanan 
277406824ed3SPatrick Sanan @*/
27759f3a6782SPatrick Sanan PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems *PetscOptionsObject,const char oldname[],const char newname[],const char version[],const char info[])
277606824ed3SPatrick Sanan {
277706824ed3SPatrick Sanan   PetscErrorCode     ierr;
277806824ed3SPatrick Sanan   PetscBool          found,quiet;
277906824ed3SPatrick Sanan   const char         *value;
278006824ed3SPatrick Sanan   const char * const quietopt="-options_suppress_deprecated_warnings";
27819f3a6782SPatrick Sanan   char               msg[4096];
278206824ed3SPatrick Sanan 
278306824ed3SPatrick Sanan   PetscFunctionBegin;
278406824ed3SPatrick Sanan   PetscValidCharPointer(oldname,2);
278506824ed3SPatrick Sanan   PetscValidCharPointer(version,4);
278606824ed3SPatrick Sanan 
278706824ed3SPatrick Sanan   ierr = PetscOptionsFindPair(PetscOptionsObject->options,PetscOptionsObject->prefix,oldname,&value,&found);CHKERRQ(ierr);
278806824ed3SPatrick Sanan   if (found) {
278906824ed3SPatrick Sanan     if (newname) {
2790*d255429eSPatrick Sanan       if (PetscOptionsObject->prefix) {
279106824ed3SPatrick Sanan         ierr = PetscOptionsPrefixPush(PetscOptionsObject->options,PetscOptionsObject->prefix);CHKERRQ(ierr);
2792*d255429eSPatrick Sanan       }
279306824ed3SPatrick Sanan       ierr = PetscOptionsSetValue(PetscOptionsObject->options,newname,value);CHKERRQ(ierr);
2794*d255429eSPatrick Sanan       if (PetscOptionsObject->prefix) {
279506824ed3SPatrick Sanan         ierr = PetscOptionsPrefixPop(PetscOptionsObject->options);CHKERRQ(ierr);
2796*d255429eSPatrick Sanan       }
279706824ed3SPatrick Sanan       ierr = PetscOptionsClearValue(PetscOptionsObject->options,oldname);CHKERRQ(ierr);
2798b40114eaSPatrick Sanan     }
279906824ed3SPatrick Sanan     quiet = PETSC_FALSE;
280006824ed3SPatrick Sanan     ierr = PetscOptionsGetBool(PetscOptionsObject->options,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr);
280106824ed3SPatrick Sanan     if (!quiet) {
28029f3a6782SPatrick Sanan       ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr);
28039f3a6782SPatrick Sanan       ierr = PetscStrcat(msg,newname);CHKERRQ(ierr);
28049f3a6782SPatrick Sanan       ierr = PetscStrcat(msg," is deprecated as of version ");
28059f3a6782SPatrick Sanan       ierr = PetscStrcat(msg,version);CHKERRQ(ierr);
28069f3a6782SPatrick Sanan       ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr);
280706824ed3SPatrick Sanan       if (newname) {
28089f3a6782SPatrick Sanan         ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr);
28099f3a6782SPatrick Sanan         ierr = PetscStrcat(msg,newname);CHKERRQ(ierr);
28109f3a6782SPatrick Sanan         ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr);
281106824ed3SPatrick Sanan       }
28129f3a6782SPatrick Sanan       if (info) {
28139f3a6782SPatrick Sanan         ierr = PetscStrcat(msg," ");CHKERRQ(ierr);
28149f3a6782SPatrick Sanan         ierr = PetscStrcat(msg,info);CHKERRQ(ierr);
28159f3a6782SPatrick Sanan       }
28169f3a6782SPatrick Sanan       ierr = PetscStrcat(msg," (Silence this warning with");CHKERRQ(ierr);
28179f3a6782SPatrick Sanan       ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr);
28189f3a6782SPatrick Sanan       ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr);
28199f3a6782SPatrick Sanan       ierr = PetscPrintf(PetscOptionsObject->comm,msg);CHKERRQ(ierr);
282006824ed3SPatrick Sanan     }
282106824ed3SPatrick Sanan   }
282206824ed3SPatrick Sanan   PetscFunctionReturn(0);
282306824ed3SPatrick Sanan }
2824