FreeFOAM The Cross-Platform CFD Toolkit
calcType Class Reference

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

#include <foamCalcFunctions/calcType.H>


Detailed Description

Base class for post-processing calculation functions.

Source files

Definition at line 58 of file calcType.H.

+ Inheritance diagram for calcType:

List of all members.

Public Member Functions

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

Static Public Member Functions

static autoPtr< calcTypeNew (const word &calcTypeName)

Protected Member Functions

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

Constructor & Destructor Documentation

calcType ( )

Construct null.

Definition at line 37 of file calcType.C.

~calcType ( )
virtual

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.

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.

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.

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

Post-time loop calculations.

Definition at line 78 of file calcType.C.

TypeName ( "calcType"  )

Runtime type information.

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

Definition at line 31 of file newCalcType.C.

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

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, error::throwExceptions(), and Foam::Warning.

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, error::throwExceptions(), and Foam::Warning.

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

Time loop calculations.

Definition at line 126 of file calcType.C.

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

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, error::throwExceptions(), and Foam::Warning.


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