functionObject to instantiate and execute an fvModel More...

Inheritance diagram for fvModel:

Collaboration diagram for fvModel:

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

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

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

virtual	~fvModel ()
	Destructor. More...

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

virtual bool	execute ()
	Execute the fvModel. More...

virtual bool	write ()
	Do nothing. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

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

	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, const Time &runTime)
	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 bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

virtual scalar	timeToNextAction ()
	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...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. 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 fvMeshFunctionObject
labelHashSet	patchSet (const dictionary &, const bool optional=false) const
	Return the patch set corresponding to the patch selection entries. 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...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames 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...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

functionObject to instantiate and execute an fvModel

With this functionObject it is possible to use the clouds fvModel to track particles without introducing sources into the continuous phase transport equations, i.e. one-way coupling. When executed from the functions solver module the particles are tracked without evolving the continuous phase and without drag or other transfer terms there is no coupling, i.e. a pure Lagrangian simulation.

Example of function object specification:

clouds
{
    type            fvModel;

    executeAtStart  false;

    fvModel
    {
        type    clouds;
        libs    ("liblagrangianParcel.so");
    }
}

See also: Foam::functionObject Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 78 of file fvModelFunctionObject.H.

Constructor & Destructor Documentation

◆ fvModel() [1/2]

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

Construct from Time and dictionary.

Definition at line 43 of file fvModelFunctionObject.C.

References dict, functionObject::executeAtStart_, and regionFunctionObject::read().

Here is the call graph for this function:

◆ fvModel() [2/2]

fvModel ( const fvModel & )

delete

Disallow default bitwise copy construction.

◆ ~fvModel()

~fvModel ( )

virtual

Destructor.

Definition at line 62 of file fvModelFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fvModel" )

Runtime type information.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 115 of file fvModelFunctionObject.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute the fvModel.

Implements functionObject.

Definition at line 68 of file fvModelFunctionObject.C.

◆ write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 75 of file fvModelFunctionObject.C.

◆ maxDeltaT()

Foam::scalar maxDeltaT ( ) const

virtual

Return the maximum time-step for stable operation.

Reimplemented from functionObject.

Definition at line 81 of file fvModelFunctionObject.C.

◆ operator=()

void operator= ( const fvModel & )

delete

Disallow default bitwise assignment.

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

src/finiteVolume/functionObjects/fvModelFunctionObject/fvModelFunctionObject.H
src/finiteVolume/functionObjects/fvModelFunctionObject/fvModelFunctionObject.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fvModel() [1/2]

◆ fvModel() [2/2]

◆ ~fvModel()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ execute()

◆ write()

◆ maxDeltaT()

◆ operator=()