Stops the run when the specified clock time in second has been reached and optionally write results before stopping. More...

Inheritance diagram for stopAtClockTime:

[legend]

Collaboration diagram for stopAtClockTime:

[legend]

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

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

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

virtual	~stopAtClockTime ()
	Destructor. More...

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

void	operator= (const stopAtClockTime &)=delete
	Disallow default bitwise assignment. 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	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)
	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	setTimeStep ()
	Called by Time::setDeltaT(). Allows the functionObject to override. More...

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

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

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

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

Additional Inherited Members
Public Types inherited from stopAt
enum	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
const Time &	time_
	Reference to the Time. More...

actionType	action_
	The type of action. More...

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

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

Detailed Description

Stops the run when the specified clock time in second has been reached and optionally write results before stopping.

The following actions are supported:

noWriteNow
writeNow
nextWrite (default)

Examples of function object specification:

stop
{
    type        stopAtClockTime;
    libs        ("libutilityFunctionObjects.so");
    stopTime    10;
    action      writeNow;
}

will stop the run at the next write after the file "stop" is created in the case directory.

Usage

Property	Description	Required	Default value
`type`	type name: stopAtClockTime	yes
`stopTime`	Maximum elapsed time [s]	yes
`action`	Action executed	no	nextWrite

Source files

Definition at line 97 of file stopAtClockTime.H.

Constructor & Destructor Documentation

◆ stopAtClockTime() [1/2]

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

Construct from Time and dictionary.

Definition at line 59 of file stopAtClockTime.C.

References Foam::read().

Here is the call graph for this function:

◆ stopAtClockTime() [2/2]

stopAtClockTime ( const stopAtClockTime & )

delete

Disallow default bitwise copy construction.

◆ ~stopAtClockTime()

~stopAtClockTime ( )

virtual

Destructor.

Definition at line 74 of file stopAtClockTime.C.

Member Function Documentation

◆ TypeName()

TypeName ( "stopAtClockTime" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the dictionary settings.

Reimplemented from stopAt.

Definition at line 80 of file stopAtClockTime.C.

References dictionary::lookup(), and stopAt::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const stopAtClockTime & )