xref: /petsc/include/petscoptions.h (revision ffa8c5705e8ab2cf85ee1d14dbe507a6e2eb5283)
1 /*
2    Routines to determine options set in the options database.
3 */
4 #if !defined(PETSCOPTIONS_H)
5 #define PETSCOPTIONS_H
6 #include <petscsys.h>
7 #include <petscviewertypes.h>
8 
9 #define PETSC_MAX_OPTION_NAME 512
10 typedef struct _n_PetscOptions* PetscOptions;
11 PETSC_EXTERN PetscErrorCode PetscOptionsCreate(PetscOptions*);
12 PETSC_EXTERN PetscErrorCode PetscOptionsPush(PetscOptions);
13 PETSC_EXTERN PetscErrorCode PetscOptionsPop(void);
14 PETSC_EXTERN PetscErrorCode PetscOptionsDestroy(PetscOptions*);
15 PETSC_EXTERN PetscErrorCode PetscOptionsCreateDefault(void);
16 PETSC_EXTERN PetscErrorCode PetscOptionsDestroyDefault(void);
17 
18 PETSC_EXTERN PetscErrorCode PetscOptionsHasHelp(PetscOptions,PetscBool*);
19 PETSC_EXTERN PetscErrorCode PetscOptionsHasName(PetscOptions,const char[],const char[],PetscBool*);
20 PETSC_EXTERN PetscErrorCode PetscOptionsGetBool(PetscOptions,const char[],const char [],PetscBool*,PetscBool*);
21 PETSC_EXTERN PetscErrorCode PetscOptionsGetInt(PetscOptions,const char[],const char [],PetscInt*,PetscBool*);
22 PETSC_EXTERN PetscErrorCode PetscOptionsGetEnum(PetscOptions,const char[],const char[],const char*const*,PetscEnum*,PetscBool*);
23 PETSC_EXTERN PetscErrorCode PetscOptionsGetEList(PetscOptions,const char[],const char[],const char*const*,PetscInt,PetscInt*,PetscBool*);
24 PETSC_EXTERN PetscErrorCode PetscOptionsGetReal(PetscOptions,const char[],const char[],PetscReal*,PetscBool*);
25 PETSC_EXTERN PetscErrorCode PetscOptionsGetScalar(PetscOptions,const char[],const char[],PetscScalar*,PetscBool*);
26 PETSC_EXTERN PetscErrorCode PetscOptionsGetString(PetscOptions,const char[],const char[],char[],size_t,PetscBool*);
27 
28 PETSC_EXTERN PetscErrorCode PetscOptionsGetBoolArray(PetscOptions,const char[],const char[],PetscBool [],PetscInt*,PetscBool*);
29 PETSC_EXTERN PetscErrorCode PetscOptionsGetEnumArray(PetscOptions,const char[],const char[],const char*const*,PetscEnum*,PetscInt*,PetscBool*);
30 PETSC_EXTERN PetscErrorCode PetscOptionsGetIntArray(PetscOptions,const char[],const char[],PetscInt[],PetscInt*,PetscBool*);
31 PETSC_EXTERN PetscErrorCode PetscOptionsGetRealArray(PetscOptions,const char[],const char[],PetscReal[],PetscInt*,PetscBool*);
32 PETSC_EXTERN PetscErrorCode PetscOptionsGetScalarArray(PetscOptions,const char[],const char[],PetscScalar[],PetscInt*,PetscBool*);
33 PETSC_EXTERN PetscErrorCode PetscOptionsGetStringArray(PetscOptions,const char[],const char[],char*[],PetscInt*,PetscBool*);
34 
35 PETSC_EXTERN PetscErrorCode PetscOptionsValidKey(const char[],PetscBool*);
36 PETSC_EXTERN PetscErrorCode PetscOptionsSetAlias(PetscOptions,const char[],const char[]);
37 PETSC_EXTERN PetscErrorCode PetscOptionsSetValue(PetscOptions,const char[],const char[]);
38 PETSC_EXTERN PetscErrorCode PetscOptionsClearValue(PetscOptions,const char[]);
39 PETSC_EXTERN PetscErrorCode PetscOptionsFindPair(PetscOptions,const char[],const char[],const char*[],PetscBool*);
40 
41 PETSC_EXTERN PetscErrorCode PetscOptionsGetAll(PetscOptions,char*[]);
42 PETSC_EXTERN PetscErrorCode PetscOptionsAllUsed(PetscOptions,PetscInt*);
43 PETSC_EXTERN PetscErrorCode PetscOptionsUsed(PetscOptions,const char[],PetscBool*);
44 PETSC_EXTERN PetscErrorCode PetscOptionsLeft(PetscOptions);
45 PETSC_EXTERN PetscErrorCode PetscOptionsLeftGet(PetscOptions,PetscInt*,char***,char***);
46 PETSC_EXTERN PetscErrorCode PetscOptionsLeftRestore(PetscOptions,PetscInt*,char***,char***);
47 PETSC_EXTERN PetscErrorCode PetscOptionsView(PetscOptions,PetscViewer);
48 
49 PETSC_EXTERN PetscErrorCode PetscOptionsReject(PetscOptions,const char[],const char[],const char[]);
50 PETSC_EXTERN PetscErrorCode PetscOptionsInsert(PetscOptions,int*,char***,const char[]);
51 PETSC_EXTERN PetscErrorCode PetscOptionsInsertFile(MPI_Comm,PetscOptions,const char[],PetscBool);
52 PETSC_EXTERN PetscErrorCode PetscOptionsInsertFileYAML(MPI_Comm,PetscOptions,const char[],PetscBool);
53 PETSC_EXTERN PetscErrorCode PetscOptionsInsertString(PetscOptions,const char[]);
54 PETSC_EXTERN PetscErrorCode PetscOptionsInsertStringYAML(PetscOptions,const char[]);
55 PETSC_EXTERN PetscErrorCode PetscOptionsInsertArgs(PetscOptions,int,char**);
56 PETSC_EXTERN PetscErrorCode PetscOptionsClear(PetscOptions);
57 PETSC_EXTERN PetscErrorCode PetscOptionsPrefixPush(PetscOptions,const char[]);
58 PETSC_EXTERN PetscErrorCode PetscOptionsPrefixPop(PetscOptions);
59 
60 PETSC_EXTERN PetscErrorCode PetscOptionsGetenv(MPI_Comm,const char[],char[],size_t,PetscBool*);
61 PETSC_EXTERN PetscErrorCode PetscOptionsStringToBool(const char[],PetscBool*);
62 PETSC_EXTERN PetscErrorCode PetscOptionsStringToInt(const char[],PetscInt*);
63 PETSC_EXTERN PetscErrorCode PetscOptionsStringToReal(const char[],PetscReal*);
64 PETSC_EXTERN PetscErrorCode PetscOptionsStringToScalar(const char[],PetscScalar*);
65 
66 PETSC_EXTERN PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*)(const char[], const char[], void*), void*, PetscErrorCode (*)(void**));
67 PETSC_EXTERN PetscErrorCode PetscOptionsMonitorDefault(const char[], const char[], void*);
68 
69 PETSC_EXTERN PetscErrorCode PetscObjectSetOptions(PetscObject,PetscOptions);
70 PETSC_EXTERN PetscErrorCode PetscObjectGetOptions(PetscObject,PetscOptions*);
71 
72 PETSC_EXTERN PetscBool PetscOptionsPublish;
73 
74 /*
75     See manual page for PetscOptionsBegin()
76 
77     PetscOptionsItem and PetscOptionsItems are a single option (such as ksp_type) and a collection of such single
78   options being handled with a PetscOptionsBegin/End()
79 
80 */
81 typedef enum {OPTION_INT,OPTION_BOOL,OPTION_REAL,OPTION_FLIST,OPTION_STRING,OPTION_REAL_ARRAY,OPTION_SCALAR_ARRAY,OPTION_HEAD,OPTION_INT_ARRAY,OPTION_ELIST,OPTION_BOOL_ARRAY,OPTION_STRING_ARRAY} PetscOptionType;
82 typedef struct _n_PetscOptionItem* PetscOptionItem;
83 struct _n_PetscOptionItem{
84   char              *option;
85   char              *text;
86   void              *data;         /* used to hold the default value and then any value it is changed to by GUI */
87   PetscFunctionList flist;         /* used for available values for PetscOptionsList() */
88   const char *const *list;        /* used for available values for PetscOptionsEList() */
89   char              nlist;         /* number of entries in list */
90   char              *man;
91   size_t            arraylength;   /* number of entries in data in the case that it is an array (of PetscInt etc) */
92   PetscBool         set;           /* the user has changed this value in the GUI */
93   PetscOptionType   type;
94   PetscOptionItem   next;
95   char              *pman;
96   void              *edata;
97 };
98 
99 typedef struct _p_PetscOptionItems {
100   PetscInt         count;
101   PetscOptionItem  next;
102   char             *prefix,*pprefix;
103   char             *title;
104   MPI_Comm         comm;
105   PetscBool        printhelp,changedmethod,alreadyprinted;
106   PetscObject      object;
107   PetscOptions     options;
108 } PetscOptionItems;
109 
110 #if defined(PETSC_CLANG_STATIC_ANALYZER)
111 extern PetscOptionItems* PetscOptionsObject; /* declare this so that the PetscOptions stubs work */
112 PetscErrorCode PetscOptionsBegin(MPI_Comm,const char*,const char*,const char*);
113 PetscErrorCode PetscObjectOptionsBegin(PetscObject);
114 PetscErrorCode PetscOptionsEnd(void);
115 #else
116 /*MC
117     PetscOptionsBegin - Begins a set of queries on the options database that are related and should be
118      displayed on the same window of a GUI that allows the user to set the options interactively. Often one should
119      use PetscObjectOptionsBegin() rather than this call.
120 
121    Synopsis:
122     #include <petscoptions.h>
123     PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[])
124 
125     Collective
126 
127   Input Parameters:
128 +   comm - communicator that shares GUI
129 .   prefix - options prefix for all options displayed on window (optional)
130 .   title - short descriptive text, for example "Krylov Solver Options"
131 -   mansec - section of manual pages for options, for example KSP (optional)
132 
133   Level: intermediate
134 
135   Notes:
136     The set of queries needs to be ended by a call to PetscOptionsEnd().
137 
138     One can add subheadings with PetscOptionsHead().
139 
140   Developer Notes:
141       PetscOptionsPublish is set in PetscOptionsCheckInitial_Private() with -saws_options. When PetscOptionsPublish is set the
142       loop between PetscOptionsBegin() and PetscOptionsEnd() is run THREE times with PetscOptionsPublishCount of values -1,0,1.
143       Otherwise the loop is run ONCE with a PetscOptionsPublishCount of 1.
144 +      \-1 - PetscOptionsInt() etc. just call PetscOptionsGetInt() etc.
145 .      0  - The GUI objects are created in PetscOptionsInt() etc. and displayed in PetscOptionsEnd() and the options
146                database updated with user changes; PetscOptionsGetInt() etc. are also called.
147 -      1 - PetscOptionsInt() etc. again call PetscOptionsGetInt() etc. (possibly getting new values), in addition the help message and
148               default values are printed if -help was given.
149       When PetscOptionsObject.changedmethod is set this causes PetscOptionsPublishCount to be reset to -2 (so in the next loop iteration it is -1)
150       and the whole process is repeated. This is to handle when, for example, the KSPType is changed thus changing the list of
151       options available so they need to be redisplayed so the user can change the. Changing PetscOptionsObjects.changedmethod is never
152       currently set.
153 
154 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
155           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
156           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
157           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
158           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
159           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
160           PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()
161 
162 M*/
163 #define    PetscOptionsBegin(comm,prefix,mess,sec) 0; do {\
164              PetscOptionItems PetscOptionsObjectBase;\
165              PetscOptionItems *PetscOptionsObject = &PetscOptionsObjectBase; \
166              PetscMemzero(PetscOptionsObject,sizeof(*PetscOptionsObject)); \
167              for (PetscOptionsObject->count=(PetscOptionsPublish?-1:1); PetscOptionsObject->count<2; PetscOptionsObject->count++) {\
168              PetscCall(PetscOptionsBegin_Private(PetscOptionsObject,comm,prefix,mess,sec))
169 
170 /*MC
171     PetscObjectOptionsBegin - Begins a set of queries on the options database that are related and should be
172      displayed on the same window of a GUI that allows the user to set the options interactively.
173 
174    Synopsis:
175     #include <petscoptions.h>
176     PetscErrorCode PetscObjectOptionsBegin(PetscObject obj)
177 
178     Collective on obj
179 
180   Input Parameters:
181 .   obj - object to set options for
182 
183   Level: intermediate
184 
185   Notes:
186     Needs to be ended by a call the PetscOptionsEnd()
187          Can add subheadings with PetscOptionsHead()
188 
189 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
190           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
191           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
192           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
193           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
194           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
195           PetscOptionsFList(), PetscOptionsEList()
196 
197 M*/
198 #define PetscObjectOptionsBegin(obj) 0; do {                            \
199              PetscOptionItems PetscOptionsObjectBase;\
200              PetscOptionItems *PetscOptionsObject = &PetscOptionsObjectBase; \
201              PetscOptionsObject->options = ((PetscObject)obj)->options; \
202              for (PetscOptionsObject->count=(PetscOptionsPublish?-1:1); PetscOptionsObject->count<2; PetscOptionsObject->count++) {\
203              PetscCall(PetscObjectOptionsBegin_Private(PetscOptionsObject,obj))
204 
205 /*MC
206     PetscOptionsEnd - Ends a set of queries on the options database that are related and should be
207      displayed on the same window of a GUI that allows the user to set the options interactively.
208 
209     Collective on the comm used in PetscOptionsBegin() or obj used in PetscObjectOptionsBegin()
210 
211    Synopsis:
212      #include <petscoptions.h>
213      PetscErrorCode PetscOptionsEnd(void)
214 
215   Level: intermediate
216 
217   Notes:
218     Needs to be preceded by a call to PetscOptionsBegin() or PetscObjectOptionsBegin()
219 
220 .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
221           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
222           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
223           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
224           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
225           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
226           PetscOptionsFList(), PetscOptionsEList(), PetscObjectOptionsBegin()
227 
228 M*/
229 #define    PetscOptionsEnd() 0;PetscCall(PetscOptionsEnd_Private(PetscOptionsObject));}} while (0)
230 #endif /* PETSC_CLANG_STATIC_ANALYZER */
231 
232 PETSC_EXTERN PetscErrorCode PetscOptionsBegin_Private(PetscOptionItems *,MPI_Comm,const char[],const char[],const char[]);
233 PETSC_EXTERN PetscErrorCode PetscObjectOptionsBegin_Private(PetscOptionItems *,PetscObject);
234 PETSC_EXTERN PetscErrorCode PetscOptionsEnd_Private(PetscOptionItems *);
235 PETSC_EXTERN PetscErrorCode PetscOptionsHead(PetscOptionItems *,const char[]);
236 
237 #if defined(PETSC_CLANG_STATIC_ANALYZER)
238 PetscErrorCode PetscOptionsTail(void);
239 template <typename... T> PetscErrorCode PetscOptionsEnum(T...);
240 template <typename... T> PetscErrorCode PetscOptionsInt(T...);
241 template <typename... T> PetscErrorCode PetscOptionsBoundedInt(T...);
242 template <typename... T> PetscErrorCode PetscOptionsRangeInt(T...);
243 template <typename... T> PetscErrorCode PetscOptionsReal(T...);
244 template <typename... T> PetscErrorCode PetscOptionsScalar(T...);
245 template <typename... T> PetscErrorCode PetscOptionsName(T...);
246 template <typename... T> PetscErrorCode PetscOptionsString(T...);
247 template <typename... T> PetscErrorCode PetscOptionsBool(T...);
248 template <typename... T> PetscErrorCode PetscOptionsBoolGroupBegin(T...);
249 template <typename... T> PetscErrorCode PetscOptionsBoolGroup(T...);
250 template <typename... T> PetscErrorCode PetscOptionsBoolGroupEnd(T...);
251 template <typename... T> PetscErrorCode PetscOptionsFList(T...);
252 template <typename... T> PetscErrorCode PetscOptionsEList(T...);
253 template <typename... T> PetscErrorCode PetscOptionsRealArray(T...);
254 template <typename... T> PetscErrorCode PetscOptionsScalarArray(T...);
255 template <typename... T> PetscErrorCode PetscOptionsIntArray(T...);
256 template <typename... T> PetscErrorCode PetscOptionsStringArray(T...);
257 template <typename... T> PetscErrorCode PetscOptionsBoolArray(T...);
258 template <typename... T> PetscErrorCode PetscOptionsEnumArray(T...);
259 template <typename... T> PetscErrorCode PetscOptionsDeprecated(T...);
260 template <typename... T> PetscErrorCode PetscOptionsDeprecatedNoObject(T...);
261 #else
262 /*MC
263      PetscOptionsTail - Ends a section of options begun with PetscOptionsHead()
264             See, for example, KSPSetFromOptions_GMRES().
265 
266     Collective on the comm used in PetscOptionsBegin() or obj used in PetscObjectOptionsBegin()
267 
268    Synopsis:
269      #include <petscoptions.h>
270      PetscErrorCode PetscOptionsTail(void)
271 
272   Level: intermediate
273 
274    Notes:
275     Must be between a PetscOptionsBegin()/PetscObjectOptionsBegin() and a PetscOptionsEnd()
276 
277           Must be preceded by a call to PetscOptionsHead() in the same function.
278 
279           This needs to be used only if the code below PetscOptionsTail() can be run ONLY once.
280       See, for example, PCSetFromOptions_Composite(). This is a return(0) in it for early exit
281       from the function.
282 
283           This is only for use with the PETSc options GUI
284 
285 .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
286            PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
287           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
288           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
289           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
290           PetscOptionsFList(), PetscOptionsEList(), PetscOptionsEnum()
291 M*/
292 #define    PetscOptionsTail() 0; do {if (PetscOptionsObject->count != 1) PetscFunctionReturn(0);} while (0)
293 
294 #define PetscOptionsEnum(a,b,c,d,e,f,g) PetscOptionsEnum_Private(PetscOptionsObject,a,b,c,d,e,f,g)
295 #define PetscOptionsInt(a,b,c,d,e,f) PetscOptionsInt_Private(PetscOptionsObject,a,b,c,d,e,f,PETSC_MIN_INT,PETSC_MAX_INT)
296 #define PetscOptionsBoundedInt(a,b,c,d,e,f,g) PetscOptionsInt_Private(PetscOptionsObject,a,b,c,d,e,f,g,PETSC_MAX_INT)
297 #define PetscOptionsRangeInt(a,b,c,d,e,f,g,h) PetscOptionsInt_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
298 #define PetscOptionsReal(a,b,c,d,e,f) PetscOptionsReal_Private(PetscOptionsObject,a,b,c,d,e,f)
299 #define PetscOptionsScalar(a,b,c,d,e,f) PetscOptionsScalar_Private(PetscOptionsObject,a,b,c,d,e,f)
300 #define PetscOptionsName(a,b,c,d) PetscOptionsName_Private(PetscOptionsObject,a,b,c,d)
301 #define PetscOptionsString(a,b,c,d,e,f,g) PetscOptionsString_Private(PetscOptionsObject,a,b,c,d,e,f,g)
302 #define PetscOptionsBool(a,b,c,d,e,f) PetscOptionsBool_Private(PetscOptionsObject,a,b,c,d,e,f)
303 #define PetscOptionsBoolGroupBegin(a,b,c,d) PetscOptionsBoolGroupBegin_Private(PetscOptionsObject,a,b,c,d)
304 #define PetscOptionsBoolGroup(a,b,c,d) PetscOptionsBoolGroup_Private(PetscOptionsObject,a,b,c,d)
305 #define PetscOptionsBoolGroupEnd(a,b,c,d) PetscOptionsBoolGroupEnd_Private(PetscOptionsObject,a,b,c,d)
306 #define PetscOptionsFList(a,b,c,d,e,f,g,h) PetscOptionsFList_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
307 #define PetscOptionsEList(a,b,c,d,e,f,g,h) PetscOptionsEList_Private(PetscOptionsObject,a,b,c,d,e,f,g,h)
308 #define PetscOptionsRealArray(a,b,c,d,e,f) PetscOptionsRealArray_Private(PetscOptionsObject,a,b,c,d,e,f)
309 #define PetscOptionsScalarArray(a,b,c,d,e,f) PetscOptionsScalarArray_Private(PetscOptionsObject,a,b,c,d,e,f)
310 #define PetscOptionsIntArray(a,b,c,d,e,f) PetscOptionsIntArray_Private(PetscOptionsObject,a,b,c,d,e,f)
311 #define PetscOptionsStringArray(a,b,c,d,e,f) PetscOptionsStringArray_Private(PetscOptionsObject,a,b,c,d,e,f)
312 #define PetscOptionsBoolArray(a,b,c,d,e,f) PetscOptionsBoolArray_Private(PetscOptionsObject,a,b,c,d,e,f)
313 #define PetscOptionsEnumArray(a,b,c,d,e,f,g) PetscOptionsEnumArray_Private(PetscOptionsObject,a,b,c,d,e,f,g)
314 #define PetscOptionsDeprecated(a,b,c,d) PetscOptionsDeprecated_Private(PetscOptionsObject,a,b,c,d)
315 #define PetscOptionsDeprecatedNoObject(a,b,c,d) PetscOptionsDeprecated_Private(NULL,a,b,c,d)
316 #endif /* PETSC_CLANG_STATIC_ANALYZER */
317 
318 PETSC_EXTERN PetscErrorCode PetscOptionsEnum_Private(PetscOptionItems*,const char[],const char[],const char[],const char *const*,PetscEnum,PetscEnum*,PetscBool*);
319 PETSC_EXTERN PetscErrorCode PetscOptionsInt_Private(PetscOptionItems*,const char[],const char[],const char[],PetscInt,PetscInt*,PetscBool*,PetscInt,PetscInt);
320 PETSC_EXTERN PetscErrorCode PetscOptionsReal_Private(PetscOptionItems*,const char[],const char[],const char[],PetscReal,PetscReal*,PetscBool*);
321 PETSC_EXTERN PetscErrorCode PetscOptionsScalar_Private(PetscOptionItems*,const char[],const char[],const char[],PetscScalar,PetscScalar*,PetscBool*);
322 PETSC_EXTERN PetscErrorCode PetscOptionsName_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool*);
323 PETSC_EXTERN PetscErrorCode PetscOptionsString_Private(PetscOptionItems*,const char[],const char[],const char[],const char[],char*,size_t,PetscBool*);
324 PETSC_EXTERN PetscErrorCode PetscOptionsBool_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool ,PetscBool*,PetscBool*);
325 PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroupBegin_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool*);
326 PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroup_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool*);
327 PETSC_EXTERN PetscErrorCode PetscOptionsBoolGroupEnd_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool*);
328 PETSC_EXTERN PetscErrorCode PetscOptionsFList_Private(PetscOptionItems*,const char[],const char[],const char[],PetscFunctionList,const char[],char[],size_t,PetscBool*);
329 PETSC_EXTERN PetscErrorCode PetscOptionsEList_Private(PetscOptionItems*,const char[],const char[],const char[],const char*const*,PetscInt,const char[],PetscInt*,PetscBool*);
330 PETSC_EXTERN PetscErrorCode PetscOptionsRealArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscReal[],PetscInt*,PetscBool*);
331 PETSC_EXTERN PetscErrorCode PetscOptionsScalarArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscScalar[],PetscInt*,PetscBool*);
332 PETSC_EXTERN PetscErrorCode PetscOptionsIntArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscInt[],PetscInt*,PetscBool*);
333 PETSC_EXTERN PetscErrorCode PetscOptionsStringArray_Private(PetscOptionItems*,const char[],const char[],const char[],char*[],PetscInt*,PetscBool*);
334 PETSC_EXTERN PetscErrorCode PetscOptionsBoolArray_Private(PetscOptionItems*,const char[],const char[],const char[],PetscBool [],PetscInt*,PetscBool*);
335 PETSC_EXTERN PetscErrorCode PetscOptionsEnumArray_Private(PetscOptionItems*,const char[],const char[],const char[],const char *const*,PetscEnum[],PetscInt*,PetscBool*);
336 PETSC_EXTERN PetscErrorCode PetscOptionsDeprecated_Private(PetscOptionItems*,const char[],const char[],const char[],const char[]);
337 
338 PETSC_EXTERN PetscErrorCode PetscOptionsSAWsDestroy(void);
339 
340 PETSC_EXTERN PetscErrorCode PetscObjectAddOptionsHandler(PetscObject,PetscErrorCode (*)(PetscOptionItems*,PetscObject,void*),PetscErrorCode (*)(PetscObject,void*),void*);
341 PETSC_EXTERN PetscErrorCode PetscObjectProcessOptionsHandlers(PetscOptionItems*,PetscObject);
342 PETSC_EXTERN PetscErrorCode PetscObjectDestroyOptionsHandlers(PetscObject);
343 
344 #endif
345