Gathers all global variables in the library. More...
Variables | |
Node * | theNode |
A pointer to Node. More... | |
Element * | theElement |
A pointer to Element. More... | |
Side * | theSide |
A pointer to Side. More... | |
Edge * | theEdge |
A pointer to Edge. More... | |
unsigned int | theStep |
Time step counter. More... | |
unsigned int | theIteration |
Iteration counter. More... | |
unsigned int | NbTimeSteps |
Number of time steps. More... | |
unsigned int | MaxNbIterations |
Maximal number of iterations. More... | |
unsigned int | Verbosity |
Parameter for verbosity of message outputting. More... | |
double | theTimeStep |
Time step label. More... | |
double | theTime |
Time value. More... | |
double | theFinalTime |
Final time value. More... | |
double | theTolerance |
Tolerance value for convergence. More... | |
double | theDiscrepancy |
Value of discrepancy for an iterative procedure Its default value is 1.0 . | |
bool | Converged |
Boolean variable to say if an iterative procedure has converged. More... | |
bool | InitPetsc |
Detailed Description
Gathers all global variables in the library.
Variable Documentation
Node* theNode |
A pointer to Node.
Useful for loops on nodes
Element* theElement |
A pointer to Element.
Useful for loops on elements
Side* theSide |
A pointer to Side.
Useful for loops on sides
Edge* theEdge |
A pointer to Edge.
Useful for loops on edges
unsigned int theStep |
Time step counter.
This counter must be initialized by the user if the macro timeLoop is not used
- Remarks
- May be used in conjunction with the macro TimeLoop. In this case, it has to be initialized before. Its default value is 1
unsigned int theIteration |
Iteration counter.
This counter must be initialized by the user
- Remarks
- May be used in conjunction with the macro IterationLoop. Its default value is 1
unsigned int NbTimeSteps |
Number of time steps.
- Remarks
- May be used in conjunction with the macro TimeLoop.
unsigned int MaxNbIterations |
Maximal number of iterations.
- Remarks
- May be used in conjunction with the macro IterationLoop. Its default value is 1000
unsigned int Verbosity |
Parameter for verbosity of message outputting.
Its default value is 1
double theTimeStep |
Time step label.
- Remarks
- May be used in conjunction with the macro TimeLoop. In this case, it has to be initialized before
double theTime |
Time value.
- Remarks
- May be used in conjunction with the macro TimeLoop. Its default value is
0.0
double theFinalTime |
Final time value.
- Remarks
- May be used in conjunction with the macro TimeLoop. In this case, it has to be initialized before
double theTolerance |
Tolerance value for convergence.
- Remarks
- May be used within an iterative procedure. Its default value is
1.e-8
bool Converged |
Boolean variable to say if an iterative procedure has converged.
Its default value is false
bool InitPetsc |
Boolean to say if PETSc use was initialized. Useful only if PETSc is used