Stops the run when all parcel clouds are empty. More...

Inheritance diagram for stopAtEmptyClouds:

Collaboration diagram for stopAtEmptyClouds:

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

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

virtual	~stopAtEmptyClouds ()
	Destructor. More...

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

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

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

virtual	~stopAt ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the dictionary settings. More...

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

virtual bool	execute ()
	Execute, check existence of stopAt file and take action. More...

virtual bool	write ()
	Execute, check existence of stopAt file and take action. More...

virtual bool	end ()
	Execute at the final time-loop, used for cleanup. More...

void	operator= (const stopAt &)=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 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
Public Types inherited from stopAt
enum class	actionType { noWriteNow , writeNow , nextWrite }
	Enumeration defining the type of action. More...

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 Attributes inherited from stopAt
actionType	action_
	The type of action. More...

bool	stopped_
	Set true when the stop action has executed. More...

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

Static Protected Attributes inherited from stopAt
static const NamedEnum< actionType, 3 >	actionTypeNames_
	Action type names. More...

Detailed Description

Stops the run when all parcel clouds are empty.

The following actions are supported:

noWriteNow
writeNow
nextWrite (default)

Example of function object specification:

stop
{
    type            stopAtEmptyClouds;
    libs            ("liblagrangianFunctionObjects.so");

    executeControl  timeStep; // <-- Likely only to be needed if injection
    startTime       0.500001; // starts after time zero. In which case the
                              // startTime should be slightly after the
                              // injection start time.

    action          nextWrite;
}

Usage

Property	Description	Required	Default value
`type`	type name: stopAtEmptyClouds	yes
`action`	Action executed	no	nextWrite

Source files

Definition at line 93 of file stopAtEmptyClouds.H.

Constructor & Destructor Documentation

◆ stopAtEmptyClouds()

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

Construct from Time and dictionary.

Definition at line 85 of file stopAtEmptyClouds.C.

References dict, and stopAt::read().

Here is the call graph for this function:

◆ ~stopAtEmptyClouds()

~stopAtEmptyClouds ( )

virtual

Destructor.

Definition at line 100 of file stopAtEmptyClouds.C.

Member Function Documentation

◆ TypeName()

TypeName ( "stopAtEmptyClouds" )

Runtime type information.

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

src/lagrangian/functionObjects/stopAtEmptyClouds/stopAtEmptyClouds.H
src/lagrangian/functionObjects/stopAtEmptyClouds/stopAtEmptyClouds.C