Function object that solves for the evolution of a cloud. Only provides one-way coupling with a finite-volume carrier phase. The carrier phase affects the cloud, but the cloud does not affect the carrier phase. More...

Inheritance diagram for cloud:

[legend]

Collaboration diagram for cloud:

[legend]

Classes
class	Cloud
	Empty template class used to template the constructor on the type. More...

Public Member Functions
	TypeName ("cloud")
	Run-time type information. More...

virtual	~cloud ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return false so that this function does not execute at the start. More...

virtual bool	execute ()
	Solve the cloud. More...

virtual bool	write ()
	Dummy write. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	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...

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)
	Construct from the region objectRegistry. More...

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

virtual	~regionFunctionObject ()
	Destructor. More...

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

Public Member Functions inherited from objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

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

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

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

void	operator= (const objectRegistryFunctionObject &)=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...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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	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 scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

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

Protected Member Functions
template<class Type >
	cloud (const word &name, const Time &runTime, const dictionary &dict, const Cloud< Type > &)
	Construct from components. More...

Protected Member Functions inherited from objectRegistryFunctionObject
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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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...

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 execute at start time. More...

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

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

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

Detailed Description

Function object that solves for the evolution of a cloud. Only provides one-way coupling with a finite-volume carrier phase. The carrier phase affects the cloud, but the cloud does not affect the carrier phase.

Source files

Definition at line 54 of file cloud_functionObject.H.

Constructor & Destructor Documentation

◆ cloud()

cloud	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const Cloud< Type > &
	)

protected

Construct from components.

Definition at line 32 of file cloud_functionObjectTemplates.C.

References cloud::LagrangianModels().

Here is the call graph for this function:

◆ ~cloud()

~cloud ( )

virtual

Destructor.

Definition at line 41 of file cloud_functionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cloud" )

Run-time type information.

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 47 of file cloud_functionObject.C.

References List< word >::null().

Here is the call graph for this function:

◆ executeAtStart()

bool executeAtStart ( ) const

virtual

Return false so that this function does not execute at the start.

Reimplemented from functionObject.

Definition at line 53 of file cloud_functionObject.C.

◆ execute()

bool execute ( )

virtual

Solve the cloud.

Implements functionObject.

Definition at line 59 of file cloud_functionObject.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Dummy write.

Implements functionObject.

Definition at line 67 of file cloud_functionObject.C.

◆ movePoints()

void movePoints ( const polyMesh & )

virtual

Update for mesh motion.

Reimplemented from functionObject.

Definition at line 74 of file cloud_functionObject.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 78 of file cloud_functionObject.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 84 of file cloud_functionObject.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 90 of file cloud_functionObject.C.

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

src/Lagrangian/cloud/functionObject/cloud_functionObject.H
src/Lagrangian/cloud/functionObject/cloud_functionObject.C
src/Lagrangian/cloud/functionObject/cloud_functionObjectTemplates.C

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cloud()

◆ ~cloud()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ executeAtStart()

◆ execute()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()