randomise Class Reference

Adds a random component to a field, with a given perturbation magnitude. More...

Inheritance diagram for randomise:

Collaboration diagram for randomise:

Public Member Functions
	TypeName ("randomise")
	Runtime type information. More...
	randomise ()
	Construct null. More...
virtual	~randomise ()
	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	writeRandomField (const IOobject &header, const scalar pertMag, Random &rand, 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
	randomise (const randomise &)
	Disallow default bitwise copy construct. More...
void	operator= (const randomise &)
	Disallow default bitwise assignment. More...

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

Detailed Description

Adds a random component to a field, with a given perturbation magnitude.

Source files

• randomise.H
• randomise.C

Definition at line 52 of file randomise.H.

Constructor & Destructor Documentation

randomise() [1/2]

randomise ( const randomise &  )

private

Disallow default bitwise copy construct.

randomise() [2/2]

randomise

(

)

Construct null.

Definition at line 43 of file randomise.C.

~randomise()

~randomise ( )

virtual

Destructor.

Definition at line 51 of file randomise.C.

Member Function Documentation

operator=()

void operator= ( const randomise &  )

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 randomise.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 66 of file randomise.C.

calc()

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

protectedvirtual

Time loop calculations.

Reimplemented from calcType.

Definition at line 75 of file randomise.C.

References argList::argRead(), 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:

writeRandomField()

void writeRandomField ( const IOobject &  header, const scalar  pertMag, Random &  rand, const fvMesh &  mesh, bool &  processed  )

protected

Write component fields.

Definition at line 28 of file writeRandomField.C.

References Foam::endl(), forAll, IOobject::headerClassName(), Foam::Info, Foam::mag(), mesh, IOobject::name(), Random::randomise(), and Ostream::write().

Here is the call graph for this function:

TypeName()

TypeName

(

"randomise"

)

Runtime type information.

---

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

• src/postProcessing/foamCalcFunctions/field/randomise/randomise.H
• src/postProcessing/foamCalcFunctions/field/randomise/randomise.C
• src/postProcessing/foamCalcFunctions/field/randomise/writeRandomField.C