Adds a random component to an input field, with a specified perturbation magnitude. More...

Inheritance diagram for randomise:

Collaboration diagram for randomise:

Public Member Functions
	TypeName ("randomise")

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

virtual	~randomise ()=default

virtual bool	read (const dictionary &dict)

Public Member Functions inherited from fieldExpression
	TypeName ("fieldExpression")

	fieldExpression (const word &name, const Time &runTime, const dictionary &dict, const word &fieldName=word::null, const word &resultName=word::null)

	fieldExpression (const fieldExpression &)=delete

void	operator= (const fieldExpression &)=delete

virtual	~fieldExpression ()=default

virtual bool	execute ()

virtual bool	write ()

virtual bool	clear ()

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~fvMeshFunctionObject ()=default

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~regionFunctionObject ()=default

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)

virtual	~stateFunctionObject ()=default

dictionary &	propertyDict ()

bool	foundProperty (const word &entryName) const

void	clearTrigger ()

label	getTrigger () const

bool	setTrigger (const label triggeri, bool increaseOnly=true)

bool	getDict (const word &entryName, dictionary &dict) const

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getProperty (const word &entryName, Type &value) const

template<class Type >
void	setProperty (const word &entryName, const Type &value)

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)

template<class Type >
void	setResult (const word &entryName, const Type &value)

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const

word	resultType (const word &entryName) const

word	objectResultType (const word &objectName, const word &entryName) const

wordList	objectResultEntries () const

wordList	objectResultEntries (const word &objectName) const

void	writeResultEntries (Ostream &os) const

void	writeResultEntries (const word &objectName, Ostream &os) const

void	writeAllResultEntries (Ostream &os) const

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)

virtual	~timeFunctionObject ()=default

const Time &	time () const

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

virtual void	updateMesh (const mapPolyMesh &mpm)

virtual void	movePoints (const polyMesh &mesh)

Public Member Functions inherited from volRegion
	TypeName ("volRegion")

	volRegion (const fvMesh &mesh, const dictionary &dict)

virtual	~volRegion ()=default

regionTypes	regionType () const noexcept

const labelList &	cellIDs () const

label	nCells () const

scalar	V () const

bool	update ()

virtual void	updateMesh (const mapPolyMesh &)

virtual void	movePoints (const polyMesh &)

Protected Member Functions
virtual bool	calc ()

	randomise (const randomise &)=delete

void	operator= (const randomise &)=delete

Protected Member Functions inherited from fieldExpression
void	setResultName (const word &typeName, const word &defaultArg)

template<class Type >
bool	foundObject (const word &name, const bool verbose=true) const

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete

void	operator= (const fvMeshFunctionObject &)=delete

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const

template<class ObjectType >
bool	foundObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)

bool	writeObject (const word &fieldName)

bool	clearObject (const word &fieldName)

void	clearObjects (const wordList &objNames)

	regionFunctionObject (const regionFunctionObject &)=delete

void	operator= (const regionFunctionObject &)=delete

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const

functionObjects::properties &	stateDict ()

	stateFunctionObject (const stateFunctionObject &)=delete

void	operator= (const stateFunctionObject &)=delete

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Member Functions inherited from volRegion
bool	useAllCells () const noexcept

void	writeFileHeader (const writeFile &wf, Ostream &file) const

Additional Inherited Members
Public Types inherited from volRegion
enum	regionTypes { vrtAll = 0, vrtCellSet, vrtCellZone }

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Public Attributes inherited from functionObject
bool	log

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Static Public Attributes inherited from volRegion
static const Enum< regionTypes >	regionTypeNames_

Protected Attributes inherited from fieldExpression
word	fieldName_

word	resultName_

autoPtr< Detail::zoneSubSet >	zoneSubSetPtr_

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_

const objectRegistry &	obr_

const objectRegistry *	obrPtr_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

Protected Attributes inherited from volRegion
regionTypes	regionType_

word	regionName_

label	regionID_

Detailed Description

Adds a random component to an input field, with a specified perturbation magnitude.

Operands:

Operand	Type	Location
`input`	vol<Type>Field	$FOAM_CASE/<time>/<inpField>
`output` file	-	-
`output` field	vol<Type>Field	$FOAM_CASE/<time>/<outField>

where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

Usage

Minimal example by using system/controlDict.functions:

randomise1
{
    // Mandatory entries (unmodifiable)
    type            randomise;
    libs            (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    magPerturbation 0.1;

    // Mandatory (inherited) entries (runtime modifiable)
    field           <field>;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: randomise	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`regionType`	Selection type: all/cellSet/cellZone	word	no	all
`magPerturbation`	The magnitude of the perturbation	scalar	yes	-
`field`	Name of the operand field	word	yes	-
`name`	Name of cellSet/cellZone if required	word	conditional	-

The inherited entries are elaborated in:

Minimal example by using the postProcess utility:

        postProcess -func "randomise(<field>)"

See also

Foam::functionObject
Foam::functionObjects::fieldExpression
Foam::functionObjects::fvMeshFunctionObject
ExtendedCodeGuide::functionObjects::field::randomise

Source files

Definition at line 168 of file randomise.H.

Constructor & Destructor Documentation

◆ randomise() [1/2]

randomise ( const randomise & )

protecteddelete

◆ randomise() [2/2]

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

Definition at line 113 of file randomise.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~randomise()

virtual ~randomise ( )

virtualdefault

Member Function Documentation

◆ calc()

bool calc ( )

protectedvirtual

Implements fieldExpression.

Definition at line 93 of file randomise.C.

References volRegion::update().

Here is the call graph for this function:

◆ operator=()

void operator= ( const randomise & )

protecteddelete

◆ TypeName()

TypeName ( "randomise" )

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from volRegion.

Definition at line 128 of file randomise.C.

References dict, fieldExpression::read(), and volRegion::read().

Here is the call graph for this function:

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

src/functionObjects/field/randomise/randomise.H
src/functionObjects/field/randomise/randomise.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ randomise() [1/2]

◆ randomise() [2/2]

◆ ~randomise()

Member Function Documentation

◆ calc()

◆ operator=()

◆ TypeName()

◆ read()