Base class for function objects relating to a Lagrangian mesh. More...

Inheritance diagram for LagrangianMeshFunctionObject:

[legend]

Collaboration diagram for LagrangianMeshFunctionObject:

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

	LagrangianMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict, const word &LagrangianKeyword="Lagrangian")
	Construct from Time and dictionary. More...

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

virtual	~LagrangianMeshFunctionObject ()
	Destructor. More...

const LagrangianMesh &	mesh () const
	Access the mesh. More...

void	operator= (const LagrangianMeshFunctionObject &)=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 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	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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 execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. 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...

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

Base class for function objects relating to a Lagrangian mesh.

Source files

Definition at line 54 of file LagrangianMeshFunctionObject.H.

Constructor & Destructor Documentation

◆ LagrangianMeshFunctionObject() [1/2]

LagrangianMeshFunctionObject	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const word &	LagrangianKeyword = `"Lagrangian"`
	)

Construct from Time and dictionary.

Definition at line 43 of file LagrangianMeshFunctionObject.C.

◆ LagrangianMeshFunctionObject() [2/2]

LagrangianMeshFunctionObject ( const LagrangianMeshFunctionObject & )

delete

Disallow default bitwise copy construction.

◆ ~LagrangianMeshFunctionObject()

~LagrangianMeshFunctionObject ( )

virtual

Destructor.

Definition at line 72 of file LagrangianMeshFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LagrangianMeshFunctionObject" )

Runtime type information.

◆ mesh()

const Foam::LagrangianMesh & mesh ( ) const

inline

Access the mesh.

Definition at line 31 of file LagrangianMeshFunctionObjectI.H.

◆ operator=()

void operator= ( const LagrangianMeshFunctionObject & )