calcType Class Reference

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

Inheritance diagram for calcType:

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< calcType >	New (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...

Private Member Functions
	calcType (const calcType &)
	Disallow default bitwise copy construct. More...
void	operator= (const calcType &)
	Disallow default bitwise assignment. More...

Detailed Description

Base class for post-processing calculation functions.

Source files

• calcType.H
• calcType.C

Definition at line 58 of file calcType.H.

Constructor & Destructor Documentation

calcType() [1/2]

calcType ( const calcType &  )

private

Disallow default bitwise copy construct.

calcType() [2/2]

calcType

(

)

Construct null.

Definition at line 37 of file calcType.C.

~calcType()

~calcType ( )

virtual

Destructor.

Definition at line 43 of file calcType.C.

Member Function Documentation

operator=()

void operator= ( const calcType &  )

private

Disallow default bitwise assignment.

init()

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.

preCalc()

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.

calc()

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.

postCalc()

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()

TypeName

(

"calcType"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		calcType	,
		dictionary	,
		()	,
		()
	)

New()

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, FatalErrorInFunction, Foam::Info, and Foam::nl.

Here is the call graph for this function:

tryInit()

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.

Here is the call graph for this function:

tryPreCalc()

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

Pre-time loop calculations.

Definition at line 106 of file calcType.C.

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

Here is the call graph for this function:

tryCalc()

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

Time loop calculations.

Definition at line 126 of file calcType.C.

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

Here is the call graph for this function:

tryPostCalc()

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

Post-time loop calculations.

Definition at line 146 of file calcType.C.

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

Here is the call graph for this function:

---

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

• src/postProcessing/foamCalcFunctions/calcType/calcType.H
• src/postProcessing/foamCalcFunctions/calcType/calcType.C
• src/postProcessing/foamCalcFunctions/calcType/calcTypeNew.C