Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
calcType Class Reference

Base class for post-processing calculation functions. More...

Inheritance diagram for calcType:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("calcType")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, calcType, dictionary,(),())
 
 calcType ()
 Construct null. More...
 
virtual ~calcType ()
 Destructor. More...
 
void tryInit ()
 Initialise - typically setting static variables,. More...
 
void tryPreCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Pre-time loop calculations. More...
 
void tryCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Time loop calculations. More...
 
void tryPostCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Post-time loop calculations. More...
 

Static Public Member Functions

static autoPtr< calcTypeNew (const word &calcTypeName)
 

Protected Member Functions

virtual void init ()
 Initialise - typically setting static variables,. More...
 
virtual void preCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Pre-time loop calculations. More...
 
virtual void calc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Time loop calculations. More...
 
virtual void postCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Post-time loop calculations. More...
 

Detailed Description

Base class for post-processing calculation functions.

Source files

Definition at line 58 of file calcType.H.

Constructor & Destructor Documentation

calcType ( )

Construct null.

Definition at line 37 of file calcType.C.

~calcType ( )
virtual

Destructor.

Definition at line 43 of file calcType.C.

Member Function Documentation

void init ( )
protectedvirtual

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented in addSubtract, components, div, magGrad, randomise, interpolate, mag, and magSqr.

Definition at line 49 of file calcType.C.

References calcType::preCalc().

Referenced by calcType::tryInit().

Here is the call graph for this function:

Here is the caller graph for this function:

void preCalc ( const argList args,
const Time runTime,
const fvMesh mesh 
)
protectedvirtual

Pre-time loop calculations.

Reimplemented in addSubtract, components, div, magGrad, randomise, interpolate, mag, and magSqr.

Definition at line 56 of file calcType.C.

References calcType::calc().

Referenced by calcType::init(), and calcType::tryPreCalc().

Here is the call graph for this function:

Here is the caller graph for this function:

void calc ( const argList args,
const Time runTime,
const fvMesh mesh 
)
protectedvirtual

Time loop calculations.

Reimplemented in addSubtract, components, div, magGrad, randomise, interpolate, mag, and magSqr.

Definition at line 67 of file calcType.C.

References calcType::postCalc().

Referenced by calcType::preCalc(), and calcType::tryCalc().

Here is the call graph for this function:

Here is the caller graph for this function:

void postCalc ( const argList args,
const Time runTime,
const fvMesh mesh 
)
protectedvirtual

Post-time loop calculations.

Definition at line 78 of file calcType.C.

Referenced by calcType::calc(), and calcType::tryPostCalc().

Here is the caller graph for this function:

TypeName ( "calcType"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
calcType  ,
dictionary  ,
()  ,
()   
)
Foam::autoPtr< Foam::calcType > New ( const word calcTypeName)
static

Definition at line 31 of file calcTypeNew.C.

References Foam::abort(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and Foam::nl.

Here is the call graph for this function:

void tryInit ( )

Initialise - typically setting static variables,.

e.g. command line arguments

Definition at line 90 of file calcType.C.

References Foam::endl(), Foam::FatalIOError, calcType::init(), error::throwExceptions(), calcType::tryPreCalc(), and Foam::Warning.

Here is the call graph for this function:

void tryPreCalc ( const argList args,
const Time runTime,
const fvMesh mesh 
)

Pre-time loop calculations.

Definition at line 106 of file calcType.C.

References Foam::endl(), Foam::FatalIOError, calcType::preCalc(), error::throwExceptions(), calcType::tryCalc(), and Foam::Warning.

Referenced by calcType::tryInit().

Here is the call graph for this function:

Here is the caller graph for this function:

void tryCalc ( const argList args,
const Time runTime,
const fvMesh mesh 
)

Time loop calculations.

Definition at line 126 of file calcType.C.

References calcType::calc(), Foam::endl(), Foam::FatalIOError, error::throwExceptions(), calcType::tryPostCalc(), and Foam::Warning.

Referenced by calcType::tryPreCalc().

Here is the call graph for this function:

Here is the caller graph for this function:

void tryPostCalc ( const argList args,
const Time runTime,
const fvMesh mesh 
)

Post-time loop calculations.

Definition at line 146 of file calcType.C.

References Foam::endl(), Foam::FatalIOError, calcType::postCalc(), error::throwExceptions(), and Foam::Warning.

Referenced by calcType::tryCalc().

Here is the call graph for this function:

Here is the caller graph for this function:


The documentation for this class was generated from the following files: