Global Variables

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...
int	Verbosity
	Verbosity parameter. More...
int	theStep
	Time step counter. More...
int	theIteration
	Iteration counter. More...
int	NbTimeSteps
	Number of time steps. More...
int	MaxNbIterations
	Maximal number of iterations. More...
real_t	theTimeStep
	Time step label. More...
real_t	theTime
	Time value. More...
real_t	theFinalTime
	Final time value. More...
real_t	theTolerance
	Tolerance value for convergence. More...
real_t	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

All global variables in the library.

Variable Documentation

Converged

bool Converged

extern

Boolean variable to say if an iterative procedure has converged.

Its default value is false

InitPetsc

bool InitPetsc

extern

Boolean to say if PETSc use was initialized. Useful only if PETSc is used

MaxNbIterations

int MaxNbIterations

extern

Maximal number of iterations.

Remarks

May be used in conjunction with the macro IterationLoop. Its default value is 1000

NbTimeSteps

int NbTimeSteps

extern

Number of time steps.

Remarks

May be used in conjunction with the macro TimeLoop.

theEdge

Edge* theEdge

extern

A pointer to Edge.

Useful for loops on edges

theElement

Element* theElement

extern

A pointer to Element.

Useful for loops on elements

theFinalTime

real_t theFinalTime

extern

Final time value.

Remarks

May be used in conjunction with the macro TimeLoop. In this case, it has to be initialized before

theIteration

int theIteration

extern

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

theNode

Node* theNode

extern

A pointer to Node.

Useful for loops on nodes

theSide

Side* theSide

extern

A pointer to Side.

Useful for loops on sides

theStep

int theStep

extern

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

theTime

real_t theTime

extern

Time value.

Remarks

May be used in conjunction with the macro TimeLoop. Its default value is 0.0

theTimeStep

real_t theTimeStep

extern

Time step label.

Remarks

May be used in conjunction with the macro TimeLoop. In this case, it has to be initialized before

theTolerance

real_t theTolerance

extern

Tolerance value for convergence.

Remarks

May be used within an iterative procedure. Its default value is 1.e-8

Verbosity

int Verbosity

extern

Verbosity parameter.

Parameter for verbosity of message outputting.

The value of Verbosity can be modified anywhere in the calling programs. It allows outputting messages in function of the used class or function. To see how this parameter is used in any class, the OFELI user has to read corresponding documentation.

Its default value is 1