Public Member Functions | List of all members
randomise Class Reference

This function object adds a random component to a field, with a specified perturbation magnitude. More...

Inheritance diagram for randomise:
Inheritance graph
[legend]
Collaboration diagram for randomise:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("randomise")
 Runtime type information. More...
 
 randomise (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~randomise ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the randomise data. More...
 
- Public Member Functions inherited from fieldExpression
 TypeName ("fieldExpression")
 Runtime type information. More...
 
 fieldExpression (const word &name, const Time &runTime, const dictionary &dict, const word &fieldName=word::null, const word &resultName=word::null)
 Construct from Time and dictionary. More...
 
virtual ~fieldExpression ()
 Destructor. More...
 
virtual bool execute ()
 Calculate the result field. More...
 
virtual bool write ()
 Write the result field. More...
 
virtual bool clear ()
 Clear the result field from the objectRegistry. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Member Functions inherited from fieldExpression
void setResultName (const word &typeName, const word &defaultArg)
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup field from the objectRegistry. More...
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Attributes inherited from fieldExpression
word fieldName_
 Name of field to process. More...
 
word resultName_
 Name of result field. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

This function object adds a random component to a field, with a specified perturbation magnitude.

The operation can be applied to any volume field.

See also
Foam::functionObjects::fvMeshFunctionObject
Source files

Definition at line 59 of file randomise.H.

Constructor & Destructor Documentation

randomise ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 60 of file randomise.C.

References Foam::read().

Here is the call graph for this function:

~randomise ( )
virtual

Destructor.

Definition at line 74 of file randomise.C.

Member Function Documentation

TypeName ( "randomise"  )

Runtime type information.

bool read ( const dictionary dict)
virtual

Read the randomise data.

Reimplemented from fieldExpression.

Definition at line 80 of file randomise.C.

References dictionary::lookup(), and fieldExpression::read().

Here is the call graph for this function:


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