Actual source code: petscoptions.h
1: /*
2: Routines to determine options set in the options database.
3: */
6: #include petsc.h
9: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsHasName(const char[],const char[],PetscTruth*);
10: PetscPolymorphicSubroutine(PetscOptionsHasName,(const char b[],PetscTruth *f),(PETSC_NULL,b,f))
11: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetInt(const char[],const char [],PetscInt *,PetscTruth*);
12: PetscPolymorphicSubroutine(PetscOptionsGetInt,(const char b[],PetscInt *i,PetscTruth *f),(PETSC_NULL,b,i,f))
13: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetTruth(const char[],const char [],PetscTruth *,PetscTruth*);
14: PetscPolymorphicSubroutine(PetscOptionsGetTruth,(const char b[],PetscTruth *i,PetscTruth *f),(PETSC_NULL,b,i,f))
15: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetReal(const char[],const char[],PetscReal *,PetscTruth*);
16: PetscPolymorphicSubroutine(PetscOptionsGetReal,(const char b[],PetscReal *i,PetscTruth *f),(PETSC_NULL,b,i,f))
17: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetScalar(const char[],const char[],PetscScalar *,PetscTruth*);
18: PetscPolymorphicSubroutine(PetscOptionsGetScalar,(const char b[],PetscScalar i[],PetscTruth *f),(PETSC_NULL,b,i,f))
19: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetIntArray(const char[],const char[],PetscInt[],PetscInt *,PetscTruth*);
20: PetscPolymorphicSubroutine(PetscOptionsGetIntArray,(const char b[],PetscInt i[],PetscInt *ii,PetscTruth *f),(PETSC_NULL,b,i,ii,f))
21: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetRealArray(const char[],const char[],PetscReal[],PetscInt *,PetscTruth*);
22: PetscPolymorphicSubroutine(PetscOptionsGetRealArray,(const char b[],PetscReal i[],PetscInt *ii,PetscTruth *f),(PETSC_NULL,b,i,ii,f))
23: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetString(const char[],const char[],char[],size_t,PetscTruth*);
24: PetscPolymorphicSubroutine(PetscOptionsGetString,(const char b[],char i[],size_t s,PetscTruth *f),(PETSC_NULL,b,i,s,f))
25: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetStringArray(const char[],const char[],char*[],PetscInt*,PetscTruth*);
26: PetscPolymorphicSubroutine(PetscOptionsGetStringArray,(const char b[],char *i[],PetscInt *ii,PetscTruth *f),(PETSC_NULL,b,i,ii,f))
27: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetEList(const char[],const char[],const char**,PetscInt,PetscInt*,PetscTruth*);
28: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetEnum(const char[],const char[],const char**,PetscEnum*,PetscTruth*);
30: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsSetAlias(const char[],const char[]);
31: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsSetValue(const char[],const char[]);
32: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsClearValue(const char[]);
34: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsAllUsed(int*);
35: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsLeft(void);
36: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsPrint(FILE *);
38: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsCreate(void);
39: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsInsert(int*,char ***,const char[]);
40: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsInsertFile(const char[]);
41: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsInsertString(const char[]);
42: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsDestroy(void);
44: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsReject(const char[],const char[]);
45: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetAll(char*[]);
47: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsGetenv(MPI_Comm,const char[],char[],size_t,PetscTruth *);
48: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsAtoi(const char[],PetscInt*);
49: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsAtod(const char[],PetscReal*);
54: /*MC
55: PetscOptionsBegin - Begins a set of queries on the options database that are related and should be
56: displayed on the same window of a GUI that allows the user to set the options interactively.
58: Synopsis: PetscErrorCode PetscOptionsBegin(MPI_Comm comm,const char prefix[],const char title[],const char mansec[])
60: Collective on MPI_Comm
62: Input Parameters:
63: + comm - communicator that shares GUI
64: . prefix - options prefix for all options displayed on window
65: . title - short descriptive text, for example "Krylov Solver Options"
66: - mansec - section of manual pages for options, for example KSP
68: Level: intermediate
70: Notes: Needs to be ended by a call the PetscOptionsEnd()
72: Can add subheadings with PetscOptionsHead()
74: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
75: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
76: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
77: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
78: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
79: PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
80: PetscOptionsList(), PetscOptionsEList()
82: M*/
83: #define PetscOptionsBegin(comm,prefix,mess,sec) 0; {\
84: for (PetscOptionsPublishCount=(PetscOptionsPublish?-1:1); PetscOptionsPublishCount<2; PetscOptionsPublishCount++) {\
85: PetscErrorCode _5_PetscOptionsBegin_Private(comm,prefix,mess,sec);CHKERRQ(_5_ierr);
87: /*MC
88: PetscOptionsEnd - Ends a set of queries on the options database that are related and should be
89: displayed on the same window of a GUI that allows the user to set the options interactively.
91: Collective on the MPI_Comm used in PetscOptionsBegin()
93: Synopsis: PetscErrorCode PetscOptionsEnd(void)
95: Level: intermediate
97: Notes: Needs to be preceded by a call to PetscOptionsBegin()
99: .seealso: PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
100: PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth()
101: PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsTruth(),
102: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
103: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
104: PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
105: PetscOptionsList(), PetscOptionsEList()
107: M*/
108: #define PetscOptionsEnd() _5_PetscOptionsEnd_Private();CHKERRQ(_5_ierr);}}
110: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsBegin_Private(MPI_Comm,const char[],const char[],const char[]);
111: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsEnd_Private(void);
112: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsHead(const char[]);
114: /*MC
115: PetscOptionsTail - Ends a section of options begun with PetscOptionsHead()
116: See, for example, KSPSetFromOptions_GMRES().
118: Collective on the communicator passed in PetscOptionsBegin()
120: Synopsis: PetscErrorCode PetscOptionsTail(void)
122: Level: intermediate
124: Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
126: Must be preceded by a call to PetscOptionsHead() in the same function.
128: Concepts: options database^subheading
130: .seealso: PetscOptionsGetInt(), PetscOptionsGetReal(),
131: PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsTruth(),
132: PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
133: PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
134: PetscOptionsTruthGroupBegin(), PetscOptionsTruthGroup(), PetscOptionsTruthGroupEnd(),
135: PetscOptionsList(), PetscOptionsEList(), PetscOptionsEnum()
136: M*/
137: #define PetscOptionsTail() 0; {if (PetscOptionsPublishCount != 1) return(0);}
139: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsEnum(const char[],const char[],const char[],const char **,PetscEnum,PetscEnum*,PetscTruth*);
140: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsInt(const char[],const char[],const char[],PetscInt,PetscInt*,PetscTruth*);
141: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsReal(const char[],const char[],const char[],PetscReal,PetscReal*,PetscTruth*);
142: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsScalar(const char[],const char[],const char[],PetscScalar,PetscScalar*,PetscTruth*);
143: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsName(const char[],const char[],const char[],PetscTruth*);
144: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsString(const char[],const char[],const char[],const char[],char*,size_t,PetscTruth*);
145: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruth(const char[],const char[],const char[],PetscTruth,PetscTruth*,PetscTruth*);
146: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthGroupBegin(const char[],const char[],const char[],PetscTruth*);
147: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthGroup(const char[],const char[],const char[],PetscTruth*);
148: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsTruthGroupEnd(const char[],const char[],const char[],PetscTruth*);
149: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsList(const char[],const char[],const char[],PetscFList,const char[],char[],PetscInt,PetscTruth*);
150: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsEList(const char[],const char[],const char[],const char**,PetscInt,const char[],PetscInt*,PetscTruth*);
151: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsRealArray(const char[],const char[],const char[],PetscReal[],PetscInt*,PetscTruth*);
152: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsIntArray(const char[],const char[],const char[],PetscInt[],PetscInt*,PetscTruth*);
153: EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOptionsStringArray(const char[],const char[],const char[],char*[],PetscInt*,PetscTruth*);
156: #endif