Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh. More...

Inheritance diagram for fvMeshFunctionObject:

[legend]

Collaboration diagram for fvMeshFunctionObject:

Public Member Functions
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. 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...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read optional controls. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () 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< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual wordList	fields () const =0
	Return the list of fields required. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Protected Attributes
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (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...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const 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...

Detailed Description

Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh.

If the selected region is not an Foam::fvMesh a Foam::FatalError will be generated.

See also: Foam::regionFunctionObject Foam::functionObject

Source files

Definition at line 62 of file fvMeshFunctionObject.H.

Constructor & Destructor Documentation

◆ fvMeshFunctionObject() [1/3]

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

Construct from Time and dictionary.

Definition at line 44 of file fvMeshFunctionObject.C.

◆ fvMeshFunctionObject() [2/3]

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

Construct from the region objectRegistry and dictionary.

Definition at line 56 of file fvMeshFunctionObject.C.

◆ fvMeshFunctionObject() [3/3]

fvMeshFunctionObject ( const fvMeshFunctionObject & )

delete

Disallow default bitwise copy construction.

◆ ~fvMeshFunctionObject()

~fvMeshFunctionObject ( )

virtual

Destructor.

Definition at line 69 of file fvMeshFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fvMeshFunctionObject" )

Runtime type information.

◆ operator=()

void operator= ( const fvMeshFunctionObject & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the fvMesh.

Definition at line 72 of file fvMeshFunctionObject.H.

Referenced by specieReactionRates::write(), volFieldValue::write(), residuals::writeFileHeader(), and residuals::writeResidual().

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

src/finiteVolume/functionObjects/fvMeshFunctionObject/fvMeshFunctionObject.H
src/finiteVolume/functionObjects/fvMeshFunctionObject/fvMeshFunctionObject.C

Public Member Functions

Protected Attributes

Additional Inherited Members