magSqr Class Reference

Calculates and writes the magnitude-sqaured of a field for each time. More...

Inheritance diagram for magSqr:

Collaboration diagram for magSqr:

Public Member Functions
	TypeName ("magSqr")
	Runtime type information. More...
	magSqr ()
	Construct null. More...
virtual	~magSqr ()
	Destructor. More...
Public Member Functions inherited from calcType
	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...

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...
template<class Type >
void	writeMagSqrField (const IOobject &header, const fvMesh &mesh, bool &processed)
	Write component fields. More...
Protected Member Functions inherited from calcType
virtual void	postCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
	Post-time loop calculations. More...

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

Additional Inherited Members
Static Public Member Functions inherited from calcType
static autoPtr< calcType >	New (const word &calcTypeName)

Detailed Description

Calculates and writes the magnitude-sqaured of a field for each time.

Source files

• magSqr.H
• magSqr.C

Definition at line 51 of file magSqr.H.

Constructor & Destructor Documentation

magSqr() [1/2]

magSqr ( const magSqr &  )

private

Disallow default bitwise copy construct.

magSqr() [2/2]

magSqr

(

)

Construct null.

Definition at line 43 of file magSqr.C.

~magSqr()

~magSqr ( )

virtual

Destructor.

Definition at line 51 of file magSqr.C.

Member Function Documentation

operator=()

void operator= ( const magSqr &  )

private

Disallow default bitwise assignment.

init()

void init ( )

protectedvirtual

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented from calcType.

Definition at line 57 of file magSqr.C.

References argList::validArgs.

preCalc()

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

protectedvirtual

Pre-time loop calculations.

Reimplemented from calcType.

Definition at line 65 of file magSqr.C.

calc()

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

protectedvirtual

Time loop calculations.

Reimplemented from calcType.

Definition at line 74 of file magSqr.C.

References args, Foam::endl(), Foam::exit(), Foam::FatalError, IOobject::headerClassName(), IOobject::headerOk(), Foam::Info, mesh, IOobject::MUST_READ, Foam::nl, and Time::timeName().

Here is the call graph for this function:

writeMagSqrField()

void writeMagSqrField ( const IOobject &  header, const fvMesh &  mesh, bool &  processed  )

protected

Write component fields.

Definition at line 28 of file writeMagSqrField.C.

References Foam::endl(), IOobject::headerClassName(), Foam::Info, Foam::magSqr(), mesh, and IOobject::name().

Here is the call graph for this function:

TypeName()

TypeName

(

"magSqr"

)

Runtime type information.

---

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

• src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H
• src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.C
• src/postProcessing/foamCalcFunctions/field/magSqr/writeMagSqrField.C