xref: /petsc/src/sys/objects/aoptions.c (revision b35069460922d961ba8e1d6962339587123d7b53)
153acd3b1SBarry Smith #define PETSC_DLL
253acd3b1SBarry Smith /*
33fc1eb6aSBarry Smith    Implements the higher-level options database querying methods. These are self-documenting and can attach at runtime to
43fc1eb6aSBarry Smith    GUI code to display the options and get values from the users.
553acd3b1SBarry Smith 
653acd3b1SBarry Smith */
753acd3b1SBarry Smith 
8d382aafbSBarry Smith #include "petscsys.h"        /*I  "petscsys.h"   I*/
953acd3b1SBarry Smith #if defined(PETSC_HAVE_STDLIB_H)
1053acd3b1SBarry Smith #include <stdlib.h>
1153acd3b1SBarry Smith #endif
1253acd3b1SBarry Smith 
1353acd3b1SBarry Smith /*
1453acd3b1SBarry Smith     Keep a linked list of options that have been posted and we are waiting for
153fc1eb6aSBarry Smith    user selection. See the manual page for PetscOptionsBegin()
1653acd3b1SBarry Smith 
1753acd3b1SBarry Smith     Eventually we'll attach this beast to a MPI_Comm
1853acd3b1SBarry Smith */
19f8d0b74dSMatthew Knepley PetscOptionsObjectType PetscOptionsObject;
2053acd3b1SBarry Smith PetscInt               PetscOptionsPublishCount = 0;
2153acd3b1SBarry Smith 
2253acd3b1SBarry Smith #undef __FUNCT__
2353acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsBegin_Private"
2453acd3b1SBarry Smith /*
2553acd3b1SBarry Smith     Handles setting up the data structure in a call to PetscOptionsBegin()
2653acd3b1SBarry Smith */
2753acd3b1SBarry Smith PetscErrorCode PetscOptionsBegin_Private(MPI_Comm comm,const char prefix[],const char title[],const char mansec[])
2853acd3b1SBarry Smith {
2953acd3b1SBarry Smith   PetscErrorCode ierr;
3053acd3b1SBarry Smith 
3153acd3b1SBarry Smith   PetscFunctionBegin;
3253acd3b1SBarry Smith   PetscOptionsObject.next          = 0;
3353acd3b1SBarry Smith   PetscOptionsObject.comm          = comm;
346356e834SBarry Smith   PetscOptionsObject.changedmethod = PETSC_FALSE;
35f8d0b74dSMatthew Knepley   if (PetscOptionsObject.prefix) {
36503cfb0cSBarry Smith     ierr = PetscFree(PetscOptionsObject.prefix);CHKERRQ(ierr); PetscOptionsObject.prefix = 0;
37f8d0b74dSMatthew Knepley   }
3853acd3b1SBarry Smith   ierr = PetscStrallocpy(prefix,&PetscOptionsObject.prefix);CHKERRQ(ierr);
39f8d0b74dSMatthew Knepley   if (PetscOptionsObject.title) {
40503cfb0cSBarry Smith     ierr = PetscFree(PetscOptionsObject.title);CHKERRQ(ierr); PetscOptionsObject.title  = 0;
41f8d0b74dSMatthew Knepley   }
4253acd3b1SBarry Smith   ierr = PetscStrallocpy(title,&PetscOptionsObject.title);CHKERRQ(ierr);
4353acd3b1SBarry Smith 
4453acd3b1SBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&PetscOptionsObject.printhelp);CHKERRQ(ierr);
4553acd3b1SBarry Smith   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1) {
4661b37b28SSatish Balay     if (!PetscOptionsObject.alreadyprinted) {
4753acd3b1SBarry Smith       ierr = (*PetscHelpPrintf)(comm,"%s -------------------------------------------------\n",title);CHKERRQ(ierr);
4853acd3b1SBarry Smith     }
4961b37b28SSatish Balay   }
5053acd3b1SBarry Smith   PetscFunctionReturn(0);
5153acd3b1SBarry Smith }
5253acd3b1SBarry Smith 
5353acd3b1SBarry Smith /*
5453acd3b1SBarry Smith      Handles adding another option to the list of options within this particular PetscOptionsBegin() PetscOptionsEnd()
5553acd3b1SBarry Smith */
5653acd3b1SBarry Smith #undef __FUNCT__
5753acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsCreate_Private"
58e3ed6ec8SBarry Smith static int PetscOptionsCreate_Private(const char opt[],const char text[],const char man[],PetscOptionType t,PetscOptions *amsopt)
5953acd3b1SBarry Smith {
6053acd3b1SBarry Smith   int          ierr;
6153acd3b1SBarry Smith   PetscOptions next;
6253acd3b1SBarry Smith 
6353acd3b1SBarry Smith   PetscFunctionBegin;
64e3ed6ec8SBarry Smith   ierr             = PetscNew(struct _p_PetscOptions,amsopt);CHKERRQ(ierr);
6553acd3b1SBarry Smith   (*amsopt)->next  = 0;
6653acd3b1SBarry Smith   (*amsopt)->set   = PETSC_FALSE;
676356e834SBarry Smith   (*amsopt)->type  = t;
6853acd3b1SBarry Smith   (*amsopt)->data  = 0;
6961b37b28SSatish Balay 
7053acd3b1SBarry Smith   ierr             = PetscStrallocpy(text,&(*amsopt)->text);CHKERRQ(ierr);
7153acd3b1SBarry Smith   ierr             = PetscStrallocpy(opt,&(*amsopt)->option);CHKERRQ(ierr);
726356e834SBarry Smith   ierr             = PetscStrallocpy(man,&(*amsopt)->man);CHKERRQ(ierr);
7353acd3b1SBarry Smith 
7453acd3b1SBarry Smith   if (!PetscOptionsObject.next) {
7553acd3b1SBarry Smith     PetscOptionsObject.next = *amsopt;
7653acd3b1SBarry Smith   } else {
7753acd3b1SBarry Smith     next = PetscOptionsObject.next;
7853acd3b1SBarry Smith     while (next->next) next = next->next;
7953acd3b1SBarry Smith     next->next = *amsopt;
8053acd3b1SBarry Smith   }
8153acd3b1SBarry Smith   PetscFunctionReturn(0);
8253acd3b1SBarry Smith }
8353acd3b1SBarry Smith 
8453acd3b1SBarry Smith #undef __FUNCT__
85aee2cecaSBarry Smith #define __FUNCT__ "PetscScanString"
86aee2cecaSBarry Smith /*
873fc1eb6aSBarry Smith     PetscScanString -  Gets user input via stdin from process and broadcasts to all processes
883fc1eb6aSBarry Smith 
893fc1eb6aSBarry Smith     Collective on MPI_Comm
903fc1eb6aSBarry Smith 
913fc1eb6aSBarry Smith    Input Parameters:
923fc1eb6aSBarry Smith +     commm - communicator for the broadcast, must be PETSC_COMM_WORLD
933fc1eb6aSBarry Smith .     n - length of the string, must be the same on all processes
943fc1eb6aSBarry Smith -     str - location to store input
95aee2cecaSBarry Smith 
96aee2cecaSBarry Smith     Bugs:
97aee2cecaSBarry Smith .   Assumes process 0 of the given communicator has access to stdin
98aee2cecaSBarry Smith 
99aee2cecaSBarry Smith */
1003fc1eb6aSBarry Smith static PetscErrorCode PetscScanString(MPI_Comm comm,size_t n,char str[])
101aee2cecaSBarry Smith {
102330cf3c9SBarry Smith   size_t         i;
103aee2cecaSBarry Smith   char           c;
1043fc1eb6aSBarry Smith   PetscMPIInt    rank,nm;
105aee2cecaSBarry Smith   PetscErrorCode ierr;
106aee2cecaSBarry Smith 
107aee2cecaSBarry Smith   PetscFunctionBegin;
108aee2cecaSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
109aee2cecaSBarry Smith   if (!rank) {
110aee2cecaSBarry Smith     c = (char) getchar();
111aee2cecaSBarry Smith     i = 0;
112aee2cecaSBarry Smith     while ( c != '\n' && i < n-1) {
113aee2cecaSBarry Smith       str[i++] = c;
114aee2cecaSBarry Smith       c = (char) getchar();
115aee2cecaSBarry Smith     }
116aee2cecaSBarry Smith     str[i] = 0;
117aee2cecaSBarry Smith   }
1183fc1eb6aSBarry Smith   nm   = PetscMPIIntCast(n);
1193fc1eb6aSBarry Smith   ierr = MPI_Bcast(str,nm,MPI_CHAR,0,comm);CHKERRQ(ierr);
120aee2cecaSBarry Smith   PetscFunctionReturn(0);
121aee2cecaSBarry Smith }
122aee2cecaSBarry Smith 
123aee2cecaSBarry Smith #undef __FUNCT__
124aee2cecaSBarry Smith #define __FUNCT__ "PetscOptionsGetFromTextInput"
125aee2cecaSBarry Smith /*
1263cc1e11dSBarry Smith     PetscOptionsGetFromTextInput - Presents all the PETSc Options processed by the program so the user may change them at runtime
127aee2cecaSBarry Smith 
128aee2cecaSBarry Smith     Notes: this isn't really practical, it is just to demonstrate the principle
129aee2cecaSBarry Smith 
130aee2cecaSBarry Smith     Bugs:
131aee2cecaSBarry Smith +    All processes must traverse through the exact same set of option queries do to the call to PetscScanString()
1323cc1e11dSBarry Smith .    Internal strings have arbitrary length and string copies are not checked that they fit into string space
133aee2cecaSBarry Smith -    Only works for PetscInt == int, PetscReal == double etc
134aee2cecaSBarry Smith 
1353cc1e11dSBarry Smith     Developer Notes: Normally the GUI that presents the options the user and retrieves the values would be running in a different
1363cc1e11dSBarry Smith      address space and communicating with the PETSc program
1373cc1e11dSBarry Smith 
138aee2cecaSBarry Smith */
139aee2cecaSBarry Smith PetscErrorCode PetscOptionsGetFromTextInput()
1406356e834SBarry Smith {
1416356e834SBarry Smith   PetscErrorCode ierr;
1426356e834SBarry Smith   PetscOptions   next = PetscOptionsObject.next;
1436356e834SBarry Smith   char           str[512];
144a4404d99SBarry Smith   PetscInt       id;
145a4404d99SBarry Smith   PetscReal      ir,*valr;
146330cf3c9SBarry Smith   PetscInt       *vald;
147330cf3c9SBarry Smith   size_t         i;
1486356e834SBarry Smith 
149e26ddf31SBarry Smith   ierr = (*PetscPrintf)(PETSC_COMM_WORLD,"%s -------------------------------------------------\n",PetscOptionsObject.title);CHKERRQ(ierr);
1506356e834SBarry Smith   while (next) {
1516356e834SBarry Smith     switch (next->type) {
1526356e834SBarry Smith       case OPTION_HEAD:
1536356e834SBarry Smith         break;
154e26ddf31SBarry Smith       case OPTION_INT_ARRAY:
155e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",next->option+1);CHKERRQ(ierr);
156e26ddf31SBarry Smith         vald = (PetscInt*) next->data;
157e26ddf31SBarry Smith         for (i=0; i<next->arraylength; i++) {
158e26ddf31SBarry Smith           ierr = PetscPrintf(PETSC_COMM_WORLD,"%d",vald[i]);CHKERRQ(ierr);
159e26ddf31SBarry Smith           if (i < next->arraylength-1) {
160e26ddf31SBarry Smith             ierr = PetscPrintf(PETSC_COMM_WORLD,",");CHKERRQ(ierr);
161e26ddf31SBarry Smith           }
162e26ddf31SBarry Smith         }
163e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,">: %s (%s)",next->text,next->man);CHKERRQ(ierr);
164e26ddf31SBarry Smith         ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr);
165e26ddf31SBarry Smith         if (str[0]) {
166e26ddf31SBarry Smith           PetscToken token;
167e26ddf31SBarry Smith           PetscInt   n=0,nmax = next->arraylength,*dvalue = (PetscInt*)next->data,start,end;
168e26ddf31SBarry Smith           size_t     len;
169e26ddf31SBarry Smith           char*      value;
170e26ddf31SBarry Smith           PetscTruth foundrange;
171e26ddf31SBarry Smith 
172e26ddf31SBarry Smith           next->set = PETSC_TRUE;
173e26ddf31SBarry Smith           value = str;
174e26ddf31SBarry Smith 	  ierr = PetscTokenCreate(value,',',&token);CHKERRQ(ierr);
175e26ddf31SBarry Smith 	  ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
176e26ddf31SBarry Smith 	  while (n < nmax) {
177e26ddf31SBarry Smith 	    if (!value) break;
178e26ddf31SBarry Smith 
179e26ddf31SBarry Smith 	    /* look for form  d-D where d and D are integers */
180e26ddf31SBarry Smith 	    foundrange = PETSC_FALSE;
181e26ddf31SBarry Smith 	    ierr      = PetscStrlen(value,&len);CHKERRQ(ierr);
182e26ddf31SBarry Smith 	    if (value[0] == '-') i=2;
183e26ddf31SBarry Smith 	    else i=1;
184330cf3c9SBarry Smith 	    for (;i<len; i++) {
185e26ddf31SBarry Smith 	      if (value[i] == '-') {
186e32f2f54SBarry Smith 		if (i == len-1) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry %s\n",n,value);
187e26ddf31SBarry Smith 		value[i] = 0;
188e26ddf31SBarry Smith 		ierr     = PetscOptionsAtoi(value,&start);CHKERRQ(ierr);
189e26ddf31SBarry Smith 		ierr     = PetscOptionsAtoi(value+i+1,&end);CHKERRQ(ierr);
190e32f2f54SBarry Smith 		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);
191e32f2f54SBarry Smith 		if (n + end - start - 1 >= nmax) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_USER,"Error in %D-th array entry, not enough space in left in array (%D) to contain entire range from %D to %D",n,nmax-n,start,end);
192e26ddf31SBarry Smith 		for (;start<end; start++) {
193e26ddf31SBarry Smith 		  *dvalue = start; dvalue++;n++;
194e26ddf31SBarry Smith 		}
195e26ddf31SBarry Smith 		foundrange = PETSC_TRUE;
196e26ddf31SBarry Smith 		break;
197e26ddf31SBarry Smith 	      }
198e26ddf31SBarry Smith 	    }
199e26ddf31SBarry Smith 	    if (!foundrange) {
200e26ddf31SBarry Smith 	      ierr      = PetscOptionsAtoi(value,dvalue);CHKERRQ(ierr);
201e26ddf31SBarry Smith 	      dvalue++;
202e26ddf31SBarry Smith 	      n++;
203e26ddf31SBarry Smith 	    }
204e26ddf31SBarry Smith 	    ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
205e26ddf31SBarry Smith 	  }
206e26ddf31SBarry Smith 	  ierr = PetscTokenDestroy(token);CHKERRQ(ierr);
207e26ddf31SBarry Smith         }
208e26ddf31SBarry Smith         break;
209e26ddf31SBarry Smith       case OPTION_REAL_ARRAY:
210e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",next->option+1);CHKERRQ(ierr);
211e26ddf31SBarry Smith         valr = (PetscReal*) next->data;
212e26ddf31SBarry Smith         for (i=0; i<next->arraylength; i++) {
213e26ddf31SBarry Smith           ierr = PetscPrintf(PETSC_COMM_WORLD,"%g",valr[i]);CHKERRQ(ierr);
214e26ddf31SBarry Smith           if (i < next->arraylength-1) {
215e26ddf31SBarry Smith             ierr = PetscPrintf(PETSC_COMM_WORLD,",");CHKERRQ(ierr);
216e26ddf31SBarry Smith           }
217e26ddf31SBarry Smith         }
218e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,">: %s (%s)",next->text,next->man);CHKERRQ(ierr);
219e26ddf31SBarry Smith         ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr);
220e26ddf31SBarry Smith         if (str[0]) {
221e26ddf31SBarry Smith           PetscToken token;
222e26ddf31SBarry Smith           PetscInt   n=0,nmax = next->arraylength;
223e26ddf31SBarry Smith           PetscReal   *dvalue = (PetscReal*)next->data;
224e26ddf31SBarry Smith           char*      value;
225e26ddf31SBarry Smith 
226e26ddf31SBarry Smith           next->set = PETSC_TRUE;
227e26ddf31SBarry Smith           value = str;
228e26ddf31SBarry Smith 	  ierr = PetscTokenCreate(value,',',&token);CHKERRQ(ierr);
229e26ddf31SBarry Smith 	  ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
230e26ddf31SBarry Smith 	  while (n < nmax) {
231e26ddf31SBarry Smith 	    if (!value) break;
232e26ddf31SBarry Smith             ierr      = PetscOptionsAtod(value,dvalue);CHKERRQ(ierr);
233e26ddf31SBarry Smith 	    dvalue++;
234e26ddf31SBarry Smith 	    n++;
235e26ddf31SBarry Smith 	    ierr = PetscTokenFind(token,&value);CHKERRQ(ierr);
236e26ddf31SBarry Smith 	  }
237e26ddf31SBarry Smith 	  ierr = PetscTokenDestroy(token);CHKERRQ(ierr);
238e26ddf31SBarry Smith         }
239e26ddf31SBarry Smith         break;
2406356e834SBarry Smith       case OPTION_INT:
241e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%d>: %s (%s)",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",next->option+1,*(int*)next->data,next->text,next->man);CHKERRQ(ierr);
2423fc1eb6aSBarry Smith         ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr);
2433fc1eb6aSBarry Smith         if (str[0]) {
244c272547aSJed Brown #if defined(PETSC_USE_64BIT_INDICES)
245c272547aSJed Brown           sscanf(str,"%lld",&id);
246c272547aSJed Brown #else
247aee2cecaSBarry Smith           sscanf(str,"%d",&id);
248c272547aSJed Brown #endif
249aee2cecaSBarry Smith           next->set = PETSC_TRUE;
250aee2cecaSBarry Smith           *((PetscInt*)next->data) = id;
251aee2cecaSBarry Smith         }
252aee2cecaSBarry Smith         break;
253aee2cecaSBarry Smith       case OPTION_REAL:
254e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%g>: %s (%s)",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",next->option+1,*(double*)next->data,next->text,next->man);CHKERRQ(ierr);
2553fc1eb6aSBarry Smith         ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr);
2563fc1eb6aSBarry Smith         if (str[0]) {
257a4404d99SBarry Smith #if defined(PETSC_USE_SCALAR_SINGLE)
258a4404d99SBarry Smith           sscanf(str,"%e",&ir);
259a4404d99SBarry Smith #else
260aee2cecaSBarry Smith           sscanf(str,"%le",&ir);
261a4404d99SBarry Smith #endif
262aee2cecaSBarry Smith           next->set = PETSC_TRUE;
263aee2cecaSBarry Smith           *((PetscReal*)next->data) = ir;
264aee2cecaSBarry Smith         }
265aee2cecaSBarry Smith         break;
266aee2cecaSBarry Smith       case OPTION_LOGICAL:
267aee2cecaSBarry Smith       case OPTION_STRING:
268e26ddf31SBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"-%s%s <%s>: %s (%s)",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",next->option+1,(char*)next->data,next->text,next->man);CHKERRQ(ierr);
2693fc1eb6aSBarry Smith         ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr);
2703fc1eb6aSBarry Smith         if (str[0]) {
271aee2cecaSBarry Smith           next->set = PETSC_TRUE;
272330cf3c9SBarry Smith           ierr = PetscStrcpy((char*)next->data,str);CHKERRQ(ierr);
2736356e834SBarry Smith         }
2746356e834SBarry Smith         break;
2753cc1e11dSBarry Smith       case OPTION_LIST:
2763cc1e11dSBarry Smith         ierr = PetscFListPrintTypes(PETSC_COMM_WORLD,stdout,PetscOptionsObject.prefix,next->option,next->text,next->man,next->flist,(char*)next->data);CHKERRQ(ierr);
2773cc1e11dSBarry Smith         ierr = PetscScanString(PETSC_COMM_WORLD,512,str);CHKERRQ(ierr);
2783cc1e11dSBarry Smith         if (str[0]) {
2793cc1e11dSBarry Smith 	  PetscOptionsObject.changedmethod = PETSC_TRUE;
2803cc1e11dSBarry Smith           next->set = PETSC_TRUE;
281330cf3c9SBarry Smith           ierr = PetscStrcpy((char*)next->data,str);CHKERRQ(ierr);
2823cc1e11dSBarry Smith         }
2833cc1e11dSBarry Smith         break;
284b432afdaSMatthew Knepley     default:
285b432afdaSMatthew Knepley       break;
2866356e834SBarry Smith     }
2876356e834SBarry Smith     next = next->next;
2886356e834SBarry Smith   }
2896356e834SBarry Smith   PetscFunctionReturn(0);
2906356e834SBarry Smith }
2916356e834SBarry Smith 
292*b3506946SBarry Smith #if defined(PETSC_HAVE_AMS)
293*b3506946SBarry Smith #undef __FUNCT__
294*b3506946SBarry Smith #define __FUNCT__ "PetscOptionsGetFromAMSInput"
295*b3506946SBarry Smith /*
296*b3506946SBarry Smith     PetscOptionsGetFromAMSInput - Presents all the PETSc Options processed by the program so the user may change them at runtime using the AMS
297*b3506946SBarry Smith 
298*b3506946SBarry Smith     Bugs:
299*b3506946SBarry Smith +    All processes must traverse through the exact same set of option queries do to the call to PetscScanString()
300*b3506946SBarry Smith .    Internal strings have arbitrary length and string copies are not checked that they fit into string space
301*b3506946SBarry Smith -    Only works for PetscInt == int, PetscReal == double etc
302*b3506946SBarry Smith 
303*b3506946SBarry Smith 
304*b3506946SBarry Smith */
305*b3506946SBarry Smith PetscErrorCode PetscOptionsGetFromAMSInput()
306*b3506946SBarry Smith {
307*b3506946SBarry Smith   PetscErrorCode ierr;
308*b3506946SBarry Smith   PetscOptions   next = PetscOptionsObject.next;
309*b3506946SBarry Smith   char           str[512];
310*b3506946SBarry Smith   PetscInt       id;
311*b3506946SBarry Smith   PetscReal      ir,*valr;
312*b3506946SBarry Smith   PetscInt       *vald;
313*b3506946SBarry Smith   size_t         i;
314*b3506946SBarry Smith   static int     count = 0;
315*b3506946SBarry Smith   char           options[16];
316*b3506946SBarry Smith   AMS_Comm       acomm = -1;
317*b3506946SBarry Smith   AMS_Memory     amem = -1;
318*b3506946SBarry Smith   PetscTruth     changedmethod = PETSC_FALSE;
319*b3506946SBarry Smith 
320*b3506946SBarry Smith   /* the next line is a bug, this will only work if all processors are here, the comm passed in is ignored!!! */
321*b3506946SBarry Smith   ierr = PetscViewerAMSGetAMSComm(PETSC_VIEWER_AMS_(PETSC_COMM_WORLD),&acomm);CHKERRQ(ierr);
322*b3506946SBarry Smith   sprintf(options,"Options_%d",count++);
323*b3506946SBarry Smith   ierr = AMS_Memory_create(acomm,options,&amem);CHKERRQ(ierr);
324*b3506946SBarry Smith   ierr = AMS_Memory_take_access(amem);CHKERRQ(ierr);
325*b3506946SBarry Smith   ierr = AMS_Memory_add_field(amem,PetscOptionsObject.title,&PetscOptionsObject.prefix,1,AMS_STRING,AMS_READ,AMS_COMMON,AMS_REDUCT_UNDEF);CHKERRQ(ierr);
326*b3506946SBarry Smith   ierr = AMS_Memory_add_field(amem,"mansec",&PetscOptionsObject.prefix,1,AMS_STRING,AMS_READ,AMS_COMMON,AMS_REDUCT_UNDEF);CHKERRQ(ierr);
327*b3506946SBarry Smith   ierr = AMS_Memory_add_field(amem,"ChangedMethod",&changedmethod,1,AMS_BOOLEAN,AMS_WRITE,AMS_COMMON,AMS_REDUCT_UNDEF);CHKERRQ(ierr);
328*b3506946SBarry Smith 
329*b3506946SBarry Smith   while (next) {
330*b3506946SBarry Smith     switch (next->type) {
331*b3506946SBarry Smith       case OPTION_HEAD:
332*b3506946SBarry Smith         break;
333*b3506946SBarry Smith       case OPTION_INT_ARRAY:
334*b3506946SBarry Smith         break;
335*b3506946SBarry Smith       case OPTION_REAL_ARRAY:
336*b3506946SBarry Smith         break;
337*b3506946SBarry Smith       case OPTION_INT:
338*b3506946SBarry Smith         break;
339*b3506946SBarry Smith       case OPTION_REAL:
340*b3506946SBarry Smith         break;
341*b3506946SBarry Smith       case OPTION_LOGICAL:
342*b3506946SBarry Smith       case OPTION_STRING:
343*b3506946SBarry Smith         break;
344*b3506946SBarry Smith       case OPTION_LIST:
345*b3506946SBarry Smith         break;
346*b3506946SBarry Smith     default:
347*b3506946SBarry Smith       break;
348*b3506946SBarry Smith     }
349*b3506946SBarry Smith     next = next->next;
350*b3506946SBarry Smith   }
351*b3506946SBarry Smith 
352*b3506946SBarry Smith   ierr = AMS_Memory_publish(amem);CHKERRQ(ierr);
353*b3506946SBarry Smith   ierr = AMS_Memory_grant_access(amem);CHKERRQ(ierr);
354*b3506946SBarry Smith   /* wait until accessor has unlocked the memory */
355*b3506946SBarry Smith   ierr = AMS_Memory_lock(amem,0);CHKERRQ(ierr);
356*b3506946SBarry Smith   ierr = AMS_Memory_take_access(amem);CHKERRQ(ierr);
357*b3506946SBarry Smith 
358*b3506946SBarry Smith   /* reset counter to -2; this updates the screen with the new options for the selected method */
359*b3506946SBarry Smith   if (changedmethod) PetscOptionsPublishCount = -2;
360*b3506946SBarry Smith 
361*b3506946SBarry Smith   ierr = AMS_Memory_grant_access(amem);CHKERRQ(ierr);
362*b3506946SBarry Smith   ierr = AMS_Memory_destroy(amem);CHKERRQ(ierr);
363*b3506946SBarry Smith   PetscFunctionReturn(0);
364*b3506946SBarry Smith }
365*b3506946SBarry Smith #endif
366*b3506946SBarry Smith 
3676356e834SBarry Smith #undef __FUNCT__
36853acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsEnd_Private"
36953acd3b1SBarry Smith PetscErrorCode PetscOptionsEnd_Private(void)
37053acd3b1SBarry Smith {
37153acd3b1SBarry Smith   PetscErrorCode ierr;
3726356e834SBarry Smith   PetscOptions   last;
3736356e834SBarry Smith   char           option[256],value[1024],tmp[32];
374330cf3c9SBarry Smith   size_t         j;
37553acd3b1SBarry Smith 
37653acd3b1SBarry Smith   PetscFunctionBegin;
3776356e834SBarry Smith 
378aee2cecaSBarry Smith   if (PetscOptionsObject.next) {
379*b3506946SBarry Smith     if (!PetscOptionsPublishCount) {
380*b3506946SBarry Smith #if defined(PETSC_HAVE_AMS)
381*b3506946SBarry Smith       ierr = PetscOptionsGetFromAMSInput();
382*b3506946SBarry Smith #else
383aee2cecaSBarry Smith       ierr = PetscOptionsGetFromTextInput();
384*b3506946SBarry Smith #endif
385aee2cecaSBarry Smith     }
386aee2cecaSBarry Smith   }
3876356e834SBarry Smith 
388503cfb0cSBarry Smith   ierr = PetscFree(PetscOptionsObject.title);CHKERRQ(ierr); PetscOptionsObject.title  = 0;
389503cfb0cSBarry Smith   ierr = PetscFree(PetscOptionsObject.prefix);CHKERRQ(ierr); PetscOptionsObject.prefix = 0;
3906356e834SBarry Smith 
3916356e834SBarry Smith   /* reset counter to -2; this updates the screen with the new options for the selected method */
3926356e834SBarry Smith   if (PetscOptionsObject.changedmethod) PetscOptionsPublishCount = -2;
39361b37b28SSatish Balay   /* reset alreadyprinted flag */
39461b37b28SSatish Balay   PetscOptionsObject.alreadyprinted = PETSC_FALSE;
3956356e834SBarry Smith 
3966356e834SBarry Smith   while (PetscOptionsObject.next) {
3976356e834SBarry Smith     if (PetscOptionsObject.next->set) {
3986356e834SBarry Smith       if (PetscOptionsObject.prefix) {
3996356e834SBarry Smith         ierr = PetscStrcpy(option,"-");CHKERRQ(ierr);
4006356e834SBarry Smith         ierr = PetscStrcat(option,PetscOptionsObject.prefix);CHKERRQ(ierr);
4016356e834SBarry Smith         ierr = PetscStrcat(option,PetscOptionsObject.next->option+1);CHKERRQ(ierr);
4026356e834SBarry Smith       } else {
4036356e834SBarry Smith         ierr = PetscStrcpy(option,PetscOptionsObject.next->option);CHKERRQ(ierr);
4046356e834SBarry Smith       }
4056356e834SBarry Smith 
4066356e834SBarry Smith       switch (PetscOptionsObject.next->type) {
4076356e834SBarry Smith         case OPTION_HEAD:
4086356e834SBarry Smith           break;
409e26ddf31SBarry Smith         case OPTION_INT_ARRAY:
410e26ddf31SBarry Smith           sprintf(value,"%d",(int)((PetscInt*)PetscOptionsObject.next->data)[0]);
411e26ddf31SBarry Smith           for (j=1; j<PetscOptionsObject.next->arraylength; j++) {
412e26ddf31SBarry Smith             sprintf(tmp,"%d",(int)((PetscInt*)PetscOptionsObject.next->data)[j]);
413e26ddf31SBarry Smith             ierr = PetscStrcat(value,",");CHKERRQ(ierr);
414e26ddf31SBarry Smith             ierr = PetscStrcat(value,tmp);CHKERRQ(ierr);
415e26ddf31SBarry Smith           }
416e26ddf31SBarry Smith           break;
4176356e834SBarry Smith         case OPTION_INT:
4187a72a596SBarry Smith           sprintf(value,"%d",(int) *(PetscInt*)PetscOptionsObject.next->data);
4196356e834SBarry Smith           break;
4206356e834SBarry Smith         case OPTION_REAL:
4217a72a596SBarry Smith           sprintf(value,"%g",(double) *(PetscReal*)PetscOptionsObject.next->data);
4226356e834SBarry Smith           break;
4236356e834SBarry Smith         case OPTION_REAL_ARRAY:
4247a72a596SBarry Smith           sprintf(value,"%g",(double)((PetscReal*)PetscOptionsObject.next->data)[0]);
4256356e834SBarry Smith           for (j=1; j<PetscOptionsObject.next->arraylength; j++) {
4267a72a596SBarry Smith             sprintf(tmp,"%g",(double)((PetscReal*)PetscOptionsObject.next->data)[j]);
4276356e834SBarry Smith             ierr = PetscStrcat(value,",");CHKERRQ(ierr);
4286356e834SBarry Smith             ierr = PetscStrcat(value,tmp);CHKERRQ(ierr);
4296356e834SBarry Smith           }
4306356e834SBarry Smith           break;
4316356e834SBarry Smith         case OPTION_LOGICAL:
432aee2cecaSBarry Smith           ierr = PetscStrcpy(value,(char*)PetscOptionsObject.next->data);CHKERRQ(ierr);
4336356e834SBarry Smith           break;
4346356e834SBarry Smith         case OPTION_LIST:
435aee2cecaSBarry Smith           ierr = PetscStrcpy(value,(char*)PetscOptionsObject.next->data);CHKERRQ(ierr);
4366356e834SBarry Smith           break;
4376356e834SBarry Smith         case OPTION_STRING: /* also handles string arrays */
438aee2cecaSBarry Smith           ierr = PetscStrcpy(value,(char*)PetscOptionsObject.next->data);CHKERRQ(ierr);
4396356e834SBarry Smith           break;
4406356e834SBarry Smith       }
4416356e834SBarry Smith       ierr = PetscOptionsSetValue(option,value);CHKERRQ(ierr);
4426356e834SBarry Smith     }
443503cfb0cSBarry Smith     ierr   = PetscFree(PetscOptionsObject.next->text);CHKERRQ(ierr);
444503cfb0cSBarry Smith     ierr   = PetscFree(PetscOptionsObject.next->option);CHKERRQ(ierr);
4456356e834SBarry Smith     ierr   = PetscFree(PetscOptionsObject.next->man);CHKERRQ(ierr);
44605b42c5fSBarry Smith     ierr   = PetscFree(PetscOptionsObject.next->data);CHKERRQ(ierr);
4476356e834SBarry Smith     last                    = PetscOptionsObject.next;
4486356e834SBarry Smith     PetscOptionsObject.next = PetscOptionsObject.next->next;
4496356e834SBarry Smith     ierr                    = PetscFree(last);CHKERRQ(ierr);
4506356e834SBarry Smith   }
4516356e834SBarry Smith   PetscOptionsObject.next = 0;
45253acd3b1SBarry Smith   PetscFunctionReturn(0);
45353acd3b1SBarry Smith }
45453acd3b1SBarry Smith 
45553acd3b1SBarry Smith #undef __FUNCT__
45653acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsEnum"
45753acd3b1SBarry Smith /*@C
45853acd3b1SBarry Smith    PetscOptionsEnum - Gets the enum value for a particular option in the database.
45953acd3b1SBarry Smith 
46053acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
46153acd3b1SBarry Smith 
46253acd3b1SBarry Smith    Input Parameters:
46353acd3b1SBarry Smith +  opt - option name
46453acd3b1SBarry Smith .  text - short string that describes the option
46553acd3b1SBarry Smith .  man - manual page with additional information on option
46653acd3b1SBarry Smith .  list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null
46753acd3b1SBarry Smith -  defaultv - the default (current) value
46853acd3b1SBarry Smith 
46953acd3b1SBarry Smith    Output Parameter:
47053acd3b1SBarry Smith +  value - the  value to return
47153acd3b1SBarry Smith -  flg - PETSC_TRUE if found, else PETSC_FALSE
47253acd3b1SBarry Smith 
47353acd3b1SBarry Smith    Level: beginner
47453acd3b1SBarry Smith 
47553acd3b1SBarry Smith    Concepts: options database
47653acd3b1SBarry Smith 
47753acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
47853acd3b1SBarry Smith 
47953acd3b1SBarry Smith           list is usually something like PCASMTypes or some other predefined list of enum names
48053acd3b1SBarry Smith 
48153acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
48253acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
48353acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
48453acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
48553acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
48653acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
48753acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
48853acd3b1SBarry Smith @*/
4892ae9f97cSJed Brown PetscErrorCode PETSC_DLLEXPORT PetscOptionsEnum(const char opt[],const char text[],const char man[],const char *const*list,PetscEnum defaultv,PetscEnum *value,PetscTruth *set)
49053acd3b1SBarry Smith {
49153acd3b1SBarry Smith   PetscErrorCode ierr;
49253acd3b1SBarry Smith   PetscInt       ntext = 0;
493aa5bb8c0SSatish Balay   PetscInt       tval;
494aa5bb8c0SSatish Balay   PetscTruth     tflg;
49553acd3b1SBarry Smith 
49653acd3b1SBarry Smith   PetscFunctionBegin;
49753acd3b1SBarry Smith   while (list[ntext++]) {
498e32f2f54SBarry Smith     if (ntext > 50) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument appears to be wrong or have more than 50 entries");
49953acd3b1SBarry Smith   }
500e32f2f54SBarry Smith   if (ntext < 3) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"List argument must have at least two entries: typename and type prefix");
50153acd3b1SBarry Smith   ntext -= 3;
502aa5bb8c0SSatish Balay   ierr = PetscOptionsEList(opt,text,man,list,ntext,list[defaultv],&tval,&tflg);CHKERRQ(ierr);
503aa5bb8c0SSatish Balay   /* with PETSC_USE_64BIT_INDICES sizeof(PetscInt) != sizeof(PetscEnum) */
504aa5bb8c0SSatish Balay   if (tflg) *value = (PetscEnum)tval;
505aa5bb8c0SSatish Balay   if (set)  *set   = tflg;
50653acd3b1SBarry Smith   PetscFunctionReturn(0);
50753acd3b1SBarry Smith }
50853acd3b1SBarry Smith 
50953acd3b1SBarry Smith /* -------------------------------------------------------------------------------------------------------------*/
51053acd3b1SBarry Smith #undef __FUNCT__
51153acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsInt"
51253acd3b1SBarry Smith /*@C
51353acd3b1SBarry Smith    PetscOptionsInt - Gets the integer value for a particular option in the database.
51453acd3b1SBarry Smith 
51553acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
51653acd3b1SBarry Smith 
51753acd3b1SBarry Smith    Input Parameters:
51853acd3b1SBarry Smith +  opt - option name
51953acd3b1SBarry Smith .  text - short string that describes the option
52053acd3b1SBarry Smith .  man - manual page with additional information on option
52153acd3b1SBarry Smith -  defaultv - the default (current) value
52253acd3b1SBarry Smith 
52353acd3b1SBarry Smith    Output Parameter:
52453acd3b1SBarry Smith +  value - the integer value to return
52553acd3b1SBarry Smith -  flg - PETSC_TRUE if found, else PETSC_FALSE
52653acd3b1SBarry Smith 
52753acd3b1SBarry Smith    Level: beginner
52853acd3b1SBarry Smith 
52953acd3b1SBarry Smith    Concepts: options database^has int
53053acd3b1SBarry Smith 
53153acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
53253acd3b1SBarry Smith 
53353acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
53453acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
53553acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
53653acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
53753acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
53853acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
53953acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
54053acd3b1SBarry Smith @*/
54153acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsInt(const char opt[],const char text[],const char man[],PetscInt defaultv,PetscInt *value,PetscTruth *set)
54253acd3b1SBarry Smith {
54353acd3b1SBarry Smith   PetscErrorCode ierr;
5446356e834SBarry Smith   PetscOptions   amsopt;
54553acd3b1SBarry Smith 
54653acd3b1SBarry Smith   PetscFunctionBegin;
547*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
5486356e834SBarry Smith     ierr = PetscOptionsCreate_Private(opt,text,man,OPTION_INT,&amsopt);CHKERRQ(ierr);
5496356e834SBarry Smith     ierr = PetscMalloc(sizeof(PetscInt),&amsopt->data);CHKERRQ(ierr);
5506356e834SBarry Smith     *(PetscInt*)amsopt->data = defaultv;
551af6d86caSBarry Smith   }
55253acd3b1SBarry Smith   ierr = PetscOptionsGetInt(PetscOptionsObject.prefix,opt,value,set);CHKERRQ(ierr);
55361b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
55453acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%d>: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,defaultv,text,man);CHKERRQ(ierr);
55553acd3b1SBarry Smith   }
55653acd3b1SBarry Smith   PetscFunctionReturn(0);
55753acd3b1SBarry Smith }
55853acd3b1SBarry Smith 
55953acd3b1SBarry Smith #undef __FUNCT__
56053acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsString"
56153acd3b1SBarry Smith /*@C
56253acd3b1SBarry Smith    PetscOptionsString - Gets the string value for a particular option in the database.
56353acd3b1SBarry Smith 
56453acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
56553acd3b1SBarry Smith 
56653acd3b1SBarry Smith    Input Parameters:
56753acd3b1SBarry Smith +  opt - option name
56853acd3b1SBarry Smith .  text - short string that describes the option
56953acd3b1SBarry Smith .  man - manual page with additional information on option
57053acd3b1SBarry Smith -  defaultv - the default (current) value
57153acd3b1SBarry Smith 
57253acd3b1SBarry Smith    Output Parameter:
57353acd3b1SBarry Smith +  value - the value to return
57453acd3b1SBarry Smith -  flg - PETSC_TRUE if found, else PETSC_FALSE
57553acd3b1SBarry Smith 
57653acd3b1SBarry Smith    Level: beginner
57753acd3b1SBarry Smith 
57853acd3b1SBarry Smith    Concepts: options database^has int
57953acd3b1SBarry Smith 
58053acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
58153acd3b1SBarry Smith 
58253acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
58353acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
58453acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
58553acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
58653acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
58753acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
58853acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
58953acd3b1SBarry Smith @*/
59053acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsString(const char opt[],const char text[],const char man[],const char defaultv[],char value[],size_t len,PetscTruth *set)
59153acd3b1SBarry Smith {
59253acd3b1SBarry Smith   PetscErrorCode ierr;
593aee2cecaSBarry Smith   PetscOptions   amsopt;
59453acd3b1SBarry Smith 
59553acd3b1SBarry Smith   PetscFunctionBegin;
596*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
597aee2cecaSBarry Smith     ierr = PetscOptionsCreate_Private(opt,text,man,OPTION_STRING,&amsopt);CHKERRQ(ierr);
598aee2cecaSBarry Smith     ierr = PetscMalloc(len*sizeof(char),&amsopt->data);CHKERRQ(ierr);
599aee2cecaSBarry Smith     ierr = PetscStrcpy((char*)amsopt->data,defaultv);CHKERRQ(ierr);
600af6d86caSBarry Smith   }
60153acd3b1SBarry Smith   ierr = PetscOptionsGetString(PetscOptionsObject.prefix,opt,value,len,set);CHKERRQ(ierr);
60261b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
60353acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%s>: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,defaultv,text,man);CHKERRQ(ierr);
60453acd3b1SBarry Smith   }
60553acd3b1SBarry Smith   PetscFunctionReturn(0);
60653acd3b1SBarry Smith }
60753acd3b1SBarry Smith 
60853acd3b1SBarry Smith #undef __FUNCT__
60953acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsReal"
61053acd3b1SBarry Smith /*@C
61153acd3b1SBarry Smith    PetscOptionsReal - Gets the PetscReal value for a particular option in the database.
61253acd3b1SBarry Smith 
61353acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
61453acd3b1SBarry Smith 
61553acd3b1SBarry Smith    Input Parameters:
61653acd3b1SBarry Smith +  opt - option name
61753acd3b1SBarry Smith .  text - short string that describes the option
61853acd3b1SBarry Smith .  man - manual page with additional information on option
61953acd3b1SBarry Smith -  defaultv - the default (current) value
62053acd3b1SBarry Smith 
62153acd3b1SBarry Smith    Output Parameter:
62253acd3b1SBarry Smith +  value - the value to return
62353acd3b1SBarry Smith -  flg - PETSC_TRUE if found, else PETSC_FALSE
62453acd3b1SBarry Smith 
62553acd3b1SBarry Smith    Level: beginner
62653acd3b1SBarry Smith 
62753acd3b1SBarry Smith    Concepts: options database^has int
62853acd3b1SBarry Smith 
62953acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
63053acd3b1SBarry Smith 
63153acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
63253acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
63353acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
63453acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
63553acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
63653acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
63753acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
63853acd3b1SBarry Smith @*/
63953acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsReal(const char opt[],const char text[],const char man[],PetscReal defaultv,PetscReal *value,PetscTruth *set)
64053acd3b1SBarry Smith {
64153acd3b1SBarry Smith   PetscErrorCode ierr;
642538aa990SBarry Smith   PetscOptions   amsopt;
64353acd3b1SBarry Smith 
64453acd3b1SBarry Smith   PetscFunctionBegin;
645*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
646538aa990SBarry Smith     ierr = PetscOptionsCreate_Private(opt,text,man,OPTION_REAL,&amsopt);CHKERRQ(ierr);
647538aa990SBarry Smith     ierr = PetscMalloc(sizeof(PetscReal),&amsopt->data);CHKERRQ(ierr);
648538aa990SBarry Smith     *(PetscReal*)amsopt->data = defaultv;
649538aa990SBarry Smith   }
65053acd3b1SBarry Smith   ierr = PetscOptionsGetReal(PetscOptionsObject.prefix,opt,value,set);CHKERRQ(ierr);
65161b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
652a83599f4SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%G>: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,defaultv,text,man);CHKERRQ(ierr);
65353acd3b1SBarry Smith   }
65453acd3b1SBarry Smith   PetscFunctionReturn(0);
65553acd3b1SBarry Smith }
65653acd3b1SBarry Smith 
65753acd3b1SBarry Smith #undef __FUNCT__
65853acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsScalar"
65953acd3b1SBarry Smith /*@C
66053acd3b1SBarry Smith    PetscOptionsScalar - Gets the scalar value for a particular option in the database.
66153acd3b1SBarry Smith 
66253acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
66353acd3b1SBarry Smith 
66453acd3b1SBarry Smith    Input Parameters:
66553acd3b1SBarry Smith +  opt - option name
66653acd3b1SBarry Smith .  text - short string that describes the option
66753acd3b1SBarry Smith .  man - manual page with additional information on option
66853acd3b1SBarry Smith -  defaultv - the default (current) value
66953acd3b1SBarry Smith 
67053acd3b1SBarry Smith    Output Parameter:
67153acd3b1SBarry Smith +  value - the value to return
67253acd3b1SBarry Smith -  flg - PETSC_TRUE if found, else PETSC_FALSE
67353acd3b1SBarry Smith 
67453acd3b1SBarry Smith    Level: beginner
67553acd3b1SBarry Smith 
67653acd3b1SBarry Smith    Concepts: options database^has int
67753acd3b1SBarry Smith 
67853acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
67953acd3b1SBarry Smith 
68053acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
68153acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
68253acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
68353acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
68453acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
68553acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
68653acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
68753acd3b1SBarry Smith @*/
68853acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsScalar(const char opt[],const char text[],const char man[],PetscScalar defaultv,PetscScalar *value,PetscTruth *set)
68953acd3b1SBarry Smith {
69053acd3b1SBarry Smith   PetscErrorCode ierr;
69153acd3b1SBarry Smith 
69253acd3b1SBarry Smith   PetscFunctionBegin;
69353acd3b1SBarry Smith #if !defined(PETSC_USE_COMPLEX)
69453acd3b1SBarry Smith   ierr = PetscOptionsReal(opt,text,man,defaultv,value,set);CHKERRQ(ierr);
69553acd3b1SBarry Smith #else
69653acd3b1SBarry Smith   ierr = PetscOptionsGetScalar(PetscOptionsObject.prefix,opt,value,set);CHKERRQ(ierr);
69753acd3b1SBarry Smith #endif
69853acd3b1SBarry Smith   PetscFunctionReturn(0);
69953acd3b1SBarry Smith }
70053acd3b1SBarry Smith 
70153acd3b1SBarry Smith #undef __FUNCT__
70253acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsName"
70353acd3b1SBarry Smith /*@C
70490d69ab7SBarry Smith    PetscOptionsName - Determines if a particular option has been set in the database. This returns true whether the option is a number, string or boolean, even
70590d69ab7SBarry Smith                       its value is set to false.
70653acd3b1SBarry Smith 
70753acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
70853acd3b1SBarry Smith 
70953acd3b1SBarry Smith    Input Parameters:
71053acd3b1SBarry Smith +  opt - option name
71153acd3b1SBarry Smith .  text - short string that describes the option
71253acd3b1SBarry Smith -  man - manual page with additional information on option
71353acd3b1SBarry Smith 
71453acd3b1SBarry Smith    Output Parameter:
71553acd3b1SBarry Smith .  flg - PETSC_TRUE if found, else PETSC_FALSE
71653acd3b1SBarry Smith 
71753acd3b1SBarry Smith    Level: beginner
71853acd3b1SBarry Smith 
71953acd3b1SBarry Smith    Concepts: options database^has int
72053acd3b1SBarry Smith 
72153acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
72253acd3b1SBarry Smith 
72353acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
72453acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
72553acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
72653acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
72753acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
72853acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
72953acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
73053acd3b1SBarry Smith @*/
73153acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsName(const char opt[],const char text[],const char man[],PetscTruth *flg)
73253acd3b1SBarry Smith {
73353acd3b1SBarry Smith   PetscErrorCode ierr;
73453acd3b1SBarry Smith 
73553acd3b1SBarry Smith   PetscFunctionBegin;
73653acd3b1SBarry Smith   ierr = PetscOptionsHasName(PetscOptionsObject.prefix,opt,flg);CHKERRQ(ierr);
73761b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
73853acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,text,man);CHKERRQ(ierr);
73953acd3b1SBarry Smith   }
74053acd3b1SBarry Smith   PetscFunctionReturn(0);
74153acd3b1SBarry Smith }
74253acd3b1SBarry Smith 
74353acd3b1SBarry Smith #undef __FUNCT__
74453acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsList"
74553acd3b1SBarry Smith /*@C
74653acd3b1SBarry Smith      PetscOptionsList - Puts a list of option values that a single one may be selected from
74753acd3b1SBarry Smith 
74853acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
74953acd3b1SBarry Smith 
75053acd3b1SBarry Smith    Input Parameters:
75153acd3b1SBarry Smith +  opt - option name
75253acd3b1SBarry Smith .  text - short string that describes the option
75353acd3b1SBarry Smith .  man - manual page with additional information on option
75453acd3b1SBarry Smith .  list - the possible choices
7553cc1e11dSBarry Smith .  defaultv - the default (current) value
7563cc1e11dSBarry Smith -  len - the length of the character array value
75753acd3b1SBarry Smith 
75853acd3b1SBarry Smith    Output Parameter:
75953acd3b1SBarry Smith +  value - the value to return
76053acd3b1SBarry Smith -  set - PETSC_TRUE if found, else PETSC_FALSE
76153acd3b1SBarry Smith 
76253acd3b1SBarry Smith    Level: intermediate
76353acd3b1SBarry Smith 
76453acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
76553acd3b1SBarry Smith 
76653acd3b1SBarry Smith    See PetscOptionsEList() for when the choices are given in a string array
76753acd3b1SBarry Smith 
76853acd3b1SBarry Smith    To get a listing of all currently specified options,
76953acd3b1SBarry Smith     see PetscOptionsPrint() or PetscOptionsGetAll()
77053acd3b1SBarry Smith 
77153acd3b1SBarry Smith    Concepts: options database^list
77253acd3b1SBarry Smith 
77353acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
77453acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
77553acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
77653acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
77753acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
77853acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
77953acd3b1SBarry Smith @*/
7803cc1e11dSBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsList(const char opt[],const char ltext[],const char man[],PetscFList list,const char defaultv[],char value[],size_t len,PetscTruth *set)
78153acd3b1SBarry Smith {
78253acd3b1SBarry Smith   PetscErrorCode ierr;
7833cc1e11dSBarry Smith   PetscOptions   amsopt;
78453acd3b1SBarry Smith 
78553acd3b1SBarry Smith   PetscFunctionBegin;
786*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
7873cc1e11dSBarry Smith     ierr = PetscOptionsCreate_Private(opt,ltext,man,OPTION_LIST,&amsopt);CHKERRQ(ierr);
7883cc1e11dSBarry Smith     ierr = PetscMalloc(1024*sizeof(char),&amsopt->data);CHKERRQ(ierr);
789330cf3c9SBarry Smith     ierr = PetscStrcpy((char*)amsopt->data,defaultv);CHKERRQ(ierr);
7903cc1e11dSBarry Smith     amsopt->flist = list;
7913cc1e11dSBarry Smith   }
79253acd3b1SBarry Smith   ierr = PetscOptionsGetString(PetscOptionsObject.prefix,opt,value,len,set);CHKERRQ(ierr);
79361b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
7943cc1e11dSBarry Smith     ierr = PetscFListPrintTypes(PetscOptionsObject.comm,stdout,PetscOptionsObject.prefix,opt,ltext,man,list,defaultv);CHKERRQ(ierr);CHKERRQ(ierr);
79553acd3b1SBarry Smith   }
79653acd3b1SBarry Smith   PetscFunctionReturn(0);
79753acd3b1SBarry Smith }
79853acd3b1SBarry Smith 
79953acd3b1SBarry Smith #undef __FUNCT__
80053acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsEList"
80153acd3b1SBarry Smith /*@C
80253acd3b1SBarry Smith      PetscOptionsEList - Puts a list of option values that a single one may be selected from
80353acd3b1SBarry Smith 
80453acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
80553acd3b1SBarry Smith 
80653acd3b1SBarry Smith    Input Parameters:
80753acd3b1SBarry Smith +  opt - option name
80853acd3b1SBarry Smith .  ltext - short string that describes the option
80953acd3b1SBarry Smith .  man - manual page with additional information on option
81053acd3b1SBarry Smith .  list - the possible choices
81153acd3b1SBarry Smith .  ntext - number of choices
81253acd3b1SBarry Smith -  defaultv - the default (current) value
81353acd3b1SBarry Smith 
81453acd3b1SBarry Smith    Output Parameter:
81553acd3b1SBarry Smith +  value - the index of the value to return
81653acd3b1SBarry Smith -  set - PETSC_TRUE if found, else PETSC_FALSE
81753acd3b1SBarry Smith 
81853acd3b1SBarry Smith    Level: intermediate
81953acd3b1SBarry Smith 
82053acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
82153acd3b1SBarry Smith 
82253acd3b1SBarry Smith    See PetscOptionsList() for when the choices are given in a PetscFList()
82353acd3b1SBarry Smith 
82453acd3b1SBarry Smith    Concepts: options database^list
82553acd3b1SBarry Smith 
82653acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
82753acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
82853acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
82953acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
83053acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
83153acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
83253acd3b1SBarry Smith @*/
8332ae9f97cSJed Brown PetscErrorCode PETSC_DLLEXPORT PetscOptionsEList(const char opt[],const char ltext[],const char man[],const char *const*list,PetscInt ntext,const char defaultv[],PetscInt *value,PetscTruth *set)
83453acd3b1SBarry Smith {
83553acd3b1SBarry Smith   PetscErrorCode ierr;
83653acd3b1SBarry Smith   PetscInt       i;
83753acd3b1SBarry Smith 
83853acd3b1SBarry Smith   PetscFunctionBegin;
83953acd3b1SBarry Smith   ierr = PetscOptionsGetEList(PetscOptionsObject.prefix,opt,list,ntext,value,set);CHKERRQ(ierr);
84061b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
84153acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%s> (choose one of)",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,defaultv);CHKERRQ(ierr);
84253acd3b1SBarry Smith     for (i=0; i<ntext; i++){
84353acd3b1SBarry Smith       ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm," %s",list[i]);CHKERRQ(ierr);
84453acd3b1SBarry Smith     }
84553acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"\n");CHKERRQ(ierr);
84653acd3b1SBarry Smith   }
84753acd3b1SBarry Smith   PetscFunctionReturn(0);
84853acd3b1SBarry Smith }
84953acd3b1SBarry Smith 
85053acd3b1SBarry Smith #undef __FUNCT__
85153acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsTruthGroupBegin"
85253acd3b1SBarry Smith /*@C
85353acd3b1SBarry Smith      PetscOptionsTruthGroupBegin - First in a series of logical queries on the options database for
85453acd3b1SBarry Smith        which only a single value can be true.
85553acd3b1SBarry Smith 
85653acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
85753acd3b1SBarry Smith 
85853acd3b1SBarry Smith    Input Parameters:
85953acd3b1SBarry Smith +  opt - option name
86053acd3b1SBarry Smith .  text - short string that describes the option
86153acd3b1SBarry Smith -  man - manual page with additional information on option
86253acd3b1SBarry Smith 
86353acd3b1SBarry Smith    Output Parameter:
86453acd3b1SBarry Smith .  flg - whether that option was set or not
86553acd3b1SBarry Smith 
86653acd3b1SBarry Smith    Level: intermediate
86753acd3b1SBarry Smith 
86853acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
86953acd3b1SBarry Smith 
87053acd3b1SBarry Smith    Must be followed by 0 or more PetscOptionsTruthGroup()s and PetscOptionsTruthGroupEnd()
87153acd3b1SBarry Smith 
87253acd3b1SBarry Smith     Concepts: options database^logical group
87353acd3b1SBarry Smith 
87453acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
87553acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
87653acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
87753acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
87853acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
87953acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
88053acd3b1SBarry Smith @*/
88153acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthGroupBegin(const char opt[],const char text[],const char man[],PetscTruth *flg)
88253acd3b1SBarry Smith {
88353acd3b1SBarry Smith   PetscErrorCode ierr;
88453acd3b1SBarry Smith 
88553acd3b1SBarry Smith   PetscFunctionBegin;
88617326d04SJed Brown   *flg = PETSC_FALSE;
88717326d04SJed Brown   ierr = PetscOptionsGetTruth(PetscOptionsObject.prefix,opt,flg,PETSC_NULL);CHKERRQ(ierr);
88861b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
88953acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  Pick at most one of -------------\n");CHKERRQ(ierr);
89053acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"    -%s%s: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,text,man);CHKERRQ(ierr);
89153acd3b1SBarry Smith   }
89253acd3b1SBarry Smith   PetscFunctionReturn(0);
89353acd3b1SBarry Smith }
89453acd3b1SBarry Smith 
89553acd3b1SBarry Smith #undef __FUNCT__
89653acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsTruthGroup"
89753acd3b1SBarry Smith /*@C
89853acd3b1SBarry Smith      PetscOptionsTruthGroup - One in a series of logical queries on the options database for
89953acd3b1SBarry Smith        which only a single value can be true.
90053acd3b1SBarry Smith 
90153acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
90253acd3b1SBarry Smith 
90353acd3b1SBarry Smith    Input Parameters:
90453acd3b1SBarry Smith +  opt - option name
90553acd3b1SBarry Smith .  text - short string that describes the option
90653acd3b1SBarry Smith -  man - manual page with additional information on option
90753acd3b1SBarry Smith 
90853acd3b1SBarry Smith    Output Parameter:
90953acd3b1SBarry Smith .  flg - PETSC_TRUE if found, else PETSC_FALSE
91053acd3b1SBarry Smith 
91153acd3b1SBarry Smith    Level: intermediate
91253acd3b1SBarry Smith 
91353acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
91453acd3b1SBarry Smith 
91553acd3b1SBarry Smith    Must follow a PetscOptionsTruthGroupBegin() and preceded a PetscOptionsTruthGroupEnd()
91653acd3b1SBarry Smith 
91753acd3b1SBarry Smith     Concepts: options database^logical group
91853acd3b1SBarry Smith 
91953acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
92053acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
92153acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
92253acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
92353acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
92453acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
92553acd3b1SBarry Smith @*/
92653acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthGroup(const char opt[],const char text[],const char man[],PetscTruth *flg)
92753acd3b1SBarry Smith {
92853acd3b1SBarry Smith   PetscErrorCode ierr;
92953acd3b1SBarry Smith 
93053acd3b1SBarry Smith   PetscFunctionBegin;
93117326d04SJed Brown   *flg = PETSC_FALSE;
93217326d04SJed Brown   ierr = PetscOptionsGetTruth(PetscOptionsObject.prefix,opt,flg,PETSC_NULL);CHKERRQ(ierr);
93361b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
93453acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"    -%s%s: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,text,man);CHKERRQ(ierr);
93553acd3b1SBarry Smith   }
93653acd3b1SBarry Smith   PetscFunctionReturn(0);
93753acd3b1SBarry Smith }
93853acd3b1SBarry Smith 
93953acd3b1SBarry Smith #undef __FUNCT__
94053acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsTruthGroupEnd"
94153acd3b1SBarry Smith /*@C
94253acd3b1SBarry Smith      PetscOptionsTruthGroupEnd - Last in a series of logical queries on the options database for
94353acd3b1SBarry Smith        which only a single value can be true.
94453acd3b1SBarry Smith 
94553acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
94653acd3b1SBarry Smith 
94753acd3b1SBarry Smith    Input Parameters:
94853acd3b1SBarry Smith +  opt - option name
94953acd3b1SBarry Smith .  text - short string that describes the option
95053acd3b1SBarry Smith -  man - manual page with additional information on option
95153acd3b1SBarry Smith 
95253acd3b1SBarry Smith    Output Parameter:
95353acd3b1SBarry Smith .  flg - PETSC_TRUE if found, else PETSC_FALSE
95453acd3b1SBarry Smith 
95553acd3b1SBarry Smith    Level: intermediate
95653acd3b1SBarry Smith 
95753acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
95853acd3b1SBarry Smith 
95953acd3b1SBarry Smith    Must follow a PetscOptionsTruthGroupBegin()
96053acd3b1SBarry Smith 
96153acd3b1SBarry Smith     Concepts: options database^logical group
96253acd3b1SBarry Smith 
96353acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
96453acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
96553acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
96653acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
96753acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
96853acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
96953acd3b1SBarry Smith @*/
97053acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthGroupEnd(const char opt[],const char text[],const char man[],PetscTruth *flg)
97153acd3b1SBarry Smith {
97253acd3b1SBarry Smith   PetscErrorCode ierr;
97353acd3b1SBarry Smith 
97453acd3b1SBarry Smith   PetscFunctionBegin;
97517326d04SJed Brown   *flg = PETSC_FALSE;
97617326d04SJed Brown   ierr = PetscOptionsGetTruth(PetscOptionsObject.prefix,opt,flg,PETSC_NULL);CHKERRQ(ierr);
97761b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
97853acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"    -%s%s: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,text,man);CHKERRQ(ierr);
97953acd3b1SBarry Smith   }
98053acd3b1SBarry Smith   PetscFunctionReturn(0);
98153acd3b1SBarry Smith }
98253acd3b1SBarry Smith 
98353acd3b1SBarry Smith #undef __FUNCT__
98453acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsTruth"
98553acd3b1SBarry Smith /*@C
98653acd3b1SBarry Smith    PetscOptionsTruth - Determines if a particular option is in the database with a true or false
98753acd3b1SBarry Smith 
98853acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
98953acd3b1SBarry Smith 
99053acd3b1SBarry Smith    Input Parameters:
99153acd3b1SBarry Smith +  opt - option name
99253acd3b1SBarry Smith .  text - short string that describes the option
99353acd3b1SBarry Smith -  man - manual page with additional information on option
99453acd3b1SBarry Smith 
99553acd3b1SBarry Smith    Output Parameter:
99653acd3b1SBarry Smith .  flg - PETSC_TRUE or PETSC_FALSE
99753acd3b1SBarry Smith .  set - PETSC_TRUE if found, else PETSC_FALSE
99853acd3b1SBarry Smith 
99953acd3b1SBarry Smith    Level: beginner
100053acd3b1SBarry Smith 
100153acd3b1SBarry Smith    Concepts: options database^logical
100253acd3b1SBarry Smith 
100353acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
100453acd3b1SBarry Smith 
100553acd3b1SBarry Smith .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
100653acd3b1SBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
100753acd3b1SBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
100853acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
100953acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
101053acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
101153acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
101253acd3b1SBarry Smith @*/
101353acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruth(const char opt[],const char text[],const char man[],PetscTruth deflt,PetscTruth *flg,PetscTruth *set)
101453acd3b1SBarry Smith {
101553acd3b1SBarry Smith   PetscErrorCode ierr;
101653acd3b1SBarry Smith   PetscTruth     iset;
1017aee2cecaSBarry Smith   PetscOptions   amsopt;
101853acd3b1SBarry Smith 
101953acd3b1SBarry Smith   PetscFunctionBegin;
1020*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
1021aee2cecaSBarry Smith     ierr = PetscOptionsCreate_Private(opt,text,man,OPTION_LOGICAL,&amsopt);CHKERRQ(ierr);
1022aee2cecaSBarry Smith     ierr = PetscMalloc(16*sizeof(char),&amsopt->data);CHKERRQ(ierr);
1023aee2cecaSBarry Smith     ierr = PetscStrcpy((char*)amsopt->data,deflt ? "true" : "false");CHKERRQ(ierr);
1024af6d86caSBarry Smith   }
102553acd3b1SBarry Smith   ierr = PetscOptionsGetTruth(PetscOptionsObject.prefix,opt,flg,&iset);CHKERRQ(ierr);
102653acd3b1SBarry Smith   if (!iset) {
102753acd3b1SBarry Smith     if (flg) *flg = deflt;
102853acd3b1SBarry Smith   }
102953acd3b1SBarry Smith   if (set) *set = iset;
103061b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
103153acd3b1SBarry Smith     const char *v = PetscTruths[deflt];
103253acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s: <%s> %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,v,text,man);CHKERRQ(ierr);
103353acd3b1SBarry Smith   }
103453acd3b1SBarry Smith   PetscFunctionReturn(0);
103553acd3b1SBarry Smith }
103653acd3b1SBarry Smith 
103753acd3b1SBarry Smith #undef __FUNCT__
103853acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsRealArray"
103953acd3b1SBarry Smith /*@C
104053acd3b1SBarry Smith    PetscOptionsRealArray - Gets an array of double values for a particular
104153acd3b1SBarry Smith    option in the database. The values must be separated with commas with
104253acd3b1SBarry Smith    no intervening spaces.
104353acd3b1SBarry Smith 
104453acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
104553acd3b1SBarry Smith 
104653acd3b1SBarry Smith    Input Parameters:
104753acd3b1SBarry Smith +  opt - the option one is seeking
104853acd3b1SBarry Smith .  text - short string describing option
104953acd3b1SBarry Smith .  man - manual page for option
105053acd3b1SBarry Smith -  nmax - maximum number of values
105153acd3b1SBarry Smith 
105253acd3b1SBarry Smith    Output Parameter:
105353acd3b1SBarry Smith +  value - location to copy values
105453acd3b1SBarry Smith .  nmax - actual number of values found
105553acd3b1SBarry Smith -  set - PETSC_TRUE if found, else PETSC_FALSE
105653acd3b1SBarry Smith 
105753acd3b1SBarry Smith    Level: beginner
105853acd3b1SBarry Smith 
105953acd3b1SBarry Smith    Notes:
106053acd3b1SBarry Smith    The user should pass in an array of doubles
106153acd3b1SBarry Smith 
106253acd3b1SBarry Smith    Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
106353acd3b1SBarry Smith 
106453acd3b1SBarry Smith    Concepts: options database^array of strings
106553acd3b1SBarry Smith 
106653acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
106753acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
106853acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
106953acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
107053acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
107153acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
107253acd3b1SBarry Smith @*/
107353acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsRealArray(const char opt[],const char text[],const char man[],PetscReal value[],PetscInt *n,PetscTruth *set)
107453acd3b1SBarry Smith {
107553acd3b1SBarry Smith   PetscErrorCode ierr;
107653acd3b1SBarry Smith   PetscInt       i;
1077e26ddf31SBarry Smith   PetscOptions   amsopt;
107853acd3b1SBarry Smith 
107953acd3b1SBarry Smith   PetscFunctionBegin;
1080*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
1081e26ddf31SBarry Smith     PetscReal *vals;
1082e26ddf31SBarry Smith 
1083e26ddf31SBarry Smith     ierr = PetscOptionsCreate_Private(opt,text,man,OPTION_REAL_ARRAY,&amsopt);CHKERRQ(ierr);
1084e26ddf31SBarry Smith     ierr = PetscMalloc((*n)*sizeof(PetscReal),&amsopt->data);CHKERRQ(ierr);
1085e26ddf31SBarry Smith     vals = (PetscReal*)amsopt->data;
1086e26ddf31SBarry Smith     for (i=0; i<*n; i++) vals[i] = value[i];
1087e26ddf31SBarry Smith     amsopt->arraylength = *n;
1088e26ddf31SBarry Smith   }
108953acd3b1SBarry Smith   ierr = PetscOptionsGetRealArray(PetscOptionsObject.prefix,opt,value,n,set);CHKERRQ(ierr);
109061b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
1091a83599f4SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%G",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,value[0]);CHKERRQ(ierr);
109253acd3b1SBarry Smith     for (i=1; i<*n; i++) {
1093a83599f4SBarry Smith       ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,",%G",value[i]);CHKERRQ(ierr);
109453acd3b1SBarry Smith     }
109553acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,">: %s (%s)\n",text,man);CHKERRQ(ierr);
109653acd3b1SBarry Smith   }
109753acd3b1SBarry Smith   PetscFunctionReturn(0);
109853acd3b1SBarry Smith }
109953acd3b1SBarry Smith 
110053acd3b1SBarry Smith 
110153acd3b1SBarry Smith #undef __FUNCT__
110253acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsIntArray"
110353acd3b1SBarry Smith /*@C
110453acd3b1SBarry Smith    PetscOptionsIntArray - Gets an array of integers for a particular
110553acd3b1SBarry Smith    option in the database. The values must be separated with commas with
110653acd3b1SBarry Smith    no intervening spaces.
110753acd3b1SBarry Smith 
110853acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
110953acd3b1SBarry Smith 
111053acd3b1SBarry Smith    Input Parameters:
111153acd3b1SBarry Smith +  opt - the option one is seeking
111253acd3b1SBarry Smith .  text - short string describing option
111353acd3b1SBarry Smith .  man - manual page for option
1114f8a50e2bSBarry Smith -  n - maximum number of values
111553acd3b1SBarry Smith 
111653acd3b1SBarry Smith    Output Parameter:
111753acd3b1SBarry Smith +  value - location to copy values
1118f8a50e2bSBarry Smith .  n - actual number of values found
111953acd3b1SBarry Smith -  set - PETSC_TRUE if found, else PETSC_FALSE
112053acd3b1SBarry Smith 
112153acd3b1SBarry Smith    Level: beginner
112253acd3b1SBarry Smith 
112353acd3b1SBarry Smith    Notes:
112453acd3b1SBarry Smith    The user should pass in an array of integers
112553acd3b1SBarry Smith 
112653acd3b1SBarry Smith    Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
112753acd3b1SBarry Smith 
112853acd3b1SBarry Smith    Concepts: options database^array of strings
112953acd3b1SBarry Smith 
113053acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
113153acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
113253acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
113353acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
113453acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
113553acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList(), PetscOptionsRealArray()
113653acd3b1SBarry Smith @*/
113753acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsIntArray(const char opt[],const char text[],const char man[],PetscInt value[],PetscInt *n,PetscTruth *set)
113853acd3b1SBarry Smith {
113953acd3b1SBarry Smith   PetscErrorCode ierr;
114053acd3b1SBarry Smith   PetscInt       i;
1141e26ddf31SBarry Smith   PetscOptions   amsopt;
114253acd3b1SBarry Smith 
114353acd3b1SBarry Smith   PetscFunctionBegin;
1144*b3506946SBarry Smith   if (!PetscOptionsPublishCount) {
1145e26ddf31SBarry Smith     PetscInt *vals;
1146e26ddf31SBarry Smith 
1147e26ddf31SBarry Smith     ierr = PetscOptionsCreate_Private(opt,text,man,OPTION_INT_ARRAY,&amsopt);CHKERRQ(ierr);
1148e26ddf31SBarry Smith     ierr = PetscMalloc((*n)*sizeof(PetscInt),&amsopt->data);CHKERRQ(ierr);
1149e26ddf31SBarry Smith     vals = (PetscInt*)amsopt->data;
1150e26ddf31SBarry Smith     for (i=0; i<*n; i++) vals[i] = value[i];
1151e26ddf31SBarry Smith     amsopt->arraylength = *n;
1152e26ddf31SBarry Smith   }
115353acd3b1SBarry Smith   ierr = PetscOptionsGetIntArray(PetscOptionsObject.prefix,opt,value,n,set);CHKERRQ(ierr);
115461b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
115553acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%d",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,value[0]);CHKERRQ(ierr);
115653acd3b1SBarry Smith     for (i=1; i<*n; i++) {
115753acd3b1SBarry Smith       ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,",%d",value[i]);CHKERRQ(ierr);
115853acd3b1SBarry Smith     }
115953acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,">: %s (%s)\n",text,man);CHKERRQ(ierr);
116053acd3b1SBarry Smith   }
116153acd3b1SBarry Smith   PetscFunctionReturn(0);
116253acd3b1SBarry Smith }
116353acd3b1SBarry Smith 
116453acd3b1SBarry Smith #undef __FUNCT__
116553acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsStringArray"
116653acd3b1SBarry Smith /*@C
116753acd3b1SBarry Smith    PetscOptionsStringArray - Gets an array of string values for a particular
116853acd3b1SBarry Smith    option in the database. The values must be separated with commas with
116953acd3b1SBarry Smith    no intervening spaces.
117053acd3b1SBarry Smith 
117153acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
117253acd3b1SBarry Smith 
117353acd3b1SBarry Smith    Input Parameters:
117453acd3b1SBarry Smith +  opt - the option one is seeking
117553acd3b1SBarry Smith .  text - short string describing option
117653acd3b1SBarry Smith .  man - manual page for option
117753acd3b1SBarry Smith -  nmax - maximum number of strings
117853acd3b1SBarry Smith 
117953acd3b1SBarry Smith    Output Parameter:
118053acd3b1SBarry Smith +  value - location to copy strings
118153acd3b1SBarry Smith .  nmax - actual number of strings found
118253acd3b1SBarry Smith -  set - PETSC_TRUE if found, else PETSC_FALSE
118353acd3b1SBarry Smith 
118453acd3b1SBarry Smith    Level: beginner
118553acd3b1SBarry Smith 
118653acd3b1SBarry Smith    Notes:
118753acd3b1SBarry Smith    The user should pass in an array of pointers to char, to hold all the
118853acd3b1SBarry Smith    strings returned by this function.
118953acd3b1SBarry Smith 
119053acd3b1SBarry Smith    The user is responsible for deallocating the strings that are
119153acd3b1SBarry Smith    returned. The Fortran interface for this routine is not supported.
119253acd3b1SBarry Smith 
119353acd3b1SBarry Smith    Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
119453acd3b1SBarry Smith 
119553acd3b1SBarry Smith    Concepts: options database^array of strings
119653acd3b1SBarry Smith 
119753acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
119853acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
119953acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
120053acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
120153acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
120253acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
120353acd3b1SBarry Smith @*/
120453acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsStringArray(const char opt[],const char text[],const char man[],char *value[],PetscInt *nmax,PetscTruth *set)
120553acd3b1SBarry Smith {
120653acd3b1SBarry Smith   PetscErrorCode ierr;
120753acd3b1SBarry Smith 
120853acd3b1SBarry Smith   PetscFunctionBegin;
120953acd3b1SBarry Smith   ierr = PetscOptionsGetStringArray(PetscOptionsObject.prefix,opt,value,nmax,set);CHKERRQ(ierr);
121061b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
121153acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <string1,string2,...>: %s (%s)\n",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,text,man);CHKERRQ(ierr);
121253acd3b1SBarry Smith   }
121353acd3b1SBarry Smith   PetscFunctionReturn(0);
121453acd3b1SBarry Smith }
121553acd3b1SBarry Smith 
1216e2446a98SMatthew Knepley #undef __FUNCT__
1217e2446a98SMatthew Knepley #define __FUNCT__ "PetscOptionsTruthArray"
1218e2446a98SMatthew Knepley /*@C
1219e2446a98SMatthew Knepley    PetscOptionsTruthArray - Gets an array of logical values (true or false) for a particular
1220e2446a98SMatthew Knepley    option in the database. The values must be separated with commas with
1221e2446a98SMatthew Knepley    no intervening spaces.
1222e2446a98SMatthew Knepley 
1223e2446a98SMatthew Knepley    Collective on the communicator passed in PetscOptionsBegin()
1224e2446a98SMatthew Knepley 
1225e2446a98SMatthew Knepley    Input Parameters:
1226e2446a98SMatthew Knepley +  opt - the option one is seeking
1227e2446a98SMatthew Knepley .  text - short string describing option
1228e2446a98SMatthew Knepley .  man - manual page for option
1229e2446a98SMatthew Knepley -  nmax - maximum number of values
1230e2446a98SMatthew Knepley 
1231e2446a98SMatthew Knepley    Output Parameter:
1232e2446a98SMatthew Knepley +  value - location to copy values
1233e2446a98SMatthew Knepley .  nmax - actual number of values found
1234e2446a98SMatthew Knepley -  set - PETSC_TRUE if found, else PETSC_FALSE
1235e2446a98SMatthew Knepley 
1236e2446a98SMatthew Knepley    Level: beginner
1237e2446a98SMatthew Knepley 
1238e2446a98SMatthew Knepley    Notes:
1239e2446a98SMatthew Knepley    The user should pass in an array of doubles
1240e2446a98SMatthew Knepley 
1241e2446a98SMatthew Knepley    Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
1242e2446a98SMatthew Knepley 
1243e2446a98SMatthew Knepley    Concepts: options database^array of strings
1244e2446a98SMatthew Knepley 
1245e2446a98SMatthew Knepley .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
1246e2446a98SMatthew Knepley            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
1247e2446a98SMatthew Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
1248e2446a98SMatthew Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
1249e2446a98SMatthew Knepley           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
1250e2446a98SMatthew Knepley           PetscOptionsList(), PetscOptionsEList()
1251e2446a98SMatthew Knepley @*/
1252e2446a98SMatthew Knepley PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthArray(const char opt[],const char text[],const char man[],PetscTruth value[],PetscInt *n,PetscTruth *set)
1253e2446a98SMatthew Knepley {
1254e2446a98SMatthew Knepley   PetscErrorCode ierr;
1255e2446a98SMatthew Knepley   PetscInt       i;
1256e2446a98SMatthew Knepley 
1257e2446a98SMatthew Knepley   PetscFunctionBegin;
1258e2446a98SMatthew Knepley   ierr = PetscOptionsGetTruthArray(PetscOptionsObject.prefix,opt,value,n,set);CHKERRQ(ierr);
1259e2446a98SMatthew Knepley   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
1260e2446a98SMatthew Knepley     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  -%s%s <%d",PetscOptionsObject.prefix?PetscOptionsObject.prefix:"",opt+1,value[0]);CHKERRQ(ierr);
1261e2446a98SMatthew Knepley     for (i=1; i<*n; i++) {
1262e2446a98SMatthew Knepley       ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,",%d",value[i]);CHKERRQ(ierr);
1263e2446a98SMatthew Knepley     }
1264e2446a98SMatthew Knepley     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,">: %s (%s)\n",text,man);CHKERRQ(ierr);
1265e2446a98SMatthew Knepley   }
1266e2446a98SMatthew Knepley   PetscFunctionReturn(0);
1267e2446a98SMatthew Knepley }
1268e2446a98SMatthew Knepley 
126953acd3b1SBarry Smith 
127053acd3b1SBarry Smith #undef __FUNCT__
127153acd3b1SBarry Smith #define __FUNCT__ "PetscOptionsHead"
127253acd3b1SBarry Smith /*@C
1273b52f573bSBarry Smith      PetscOptionsHead - Puts a heading before listing any more published options. Used, for example,
127453acd3b1SBarry Smith             in KSPSetFromOptions_GMRES().
127553acd3b1SBarry Smith 
127653acd3b1SBarry Smith    Collective on the communicator passed in PetscOptionsBegin()
127753acd3b1SBarry Smith 
127853acd3b1SBarry Smith    Input Parameter:
127953acd3b1SBarry Smith .   head - the heading text
128053acd3b1SBarry Smith 
128153acd3b1SBarry Smith 
128253acd3b1SBarry Smith    Level: intermediate
128353acd3b1SBarry Smith 
128453acd3b1SBarry Smith    Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
128553acd3b1SBarry Smith 
1286b52f573bSBarry Smith           Can be followed by a call to PetscOptionsTail() in the same function.
128753acd3b1SBarry Smith 
128853acd3b1SBarry Smith    Concepts: options database^subheading
128953acd3b1SBarry Smith 
129053acd3b1SBarry Smith .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
129153acd3b1SBarry Smith            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
129253acd3b1SBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
129353acd3b1SBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
129453acd3b1SBarry Smith           PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
129553acd3b1SBarry Smith           PetscOptionsList(), PetscOptionsEList()
129653acd3b1SBarry Smith @*/
129753acd3b1SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscOptionsHead(const char head[])
129853acd3b1SBarry Smith {
129953acd3b1SBarry Smith   PetscErrorCode ierr;
130053acd3b1SBarry Smith 
130153acd3b1SBarry Smith   PetscFunctionBegin;
130261b37b28SSatish Balay   if (PetscOptionsObject.printhelp && PetscOptionsPublishCount == 1 && !PetscOptionsObject.alreadyprinted) {
130353acd3b1SBarry Smith     ierr = (*PetscHelpPrintf)(PetscOptionsObject.comm,"  %s\n",head);CHKERRQ(ierr);
130453acd3b1SBarry Smith   }
130553acd3b1SBarry Smith   PetscFunctionReturn(0);
130653acd3b1SBarry Smith }
130753acd3b1SBarry Smith 
130853acd3b1SBarry Smith 
130953acd3b1SBarry Smith 
131053acd3b1SBarry Smith 
131153acd3b1SBarry Smith 
131253acd3b1SBarry Smith 
1313