Stops the run if the time-step drops below the specified value in seconds and optionally write results before stopping. More...

Inheritance diagram for stopAtTimeStep:

[legend]

Collaboration diagram for stopAtTimeStep:

[legend]

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

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

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

virtual	~stopAtTimeStep ()
	Destructor. More...

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

void	operator= (const stopAtTimeStep &)=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 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 if the time-step drops below the specified value in seconds and optionally write results before stopping.

The following actions are supported:

noWriteNow
writeNow (default)
nextWrite

Examples of function object specification:

stop
{
    type            stopAtTimeStep;

    libs            ("libutilityFunctionObjects.so");

    minDeltaT       1e-8;
    action          writeNow;
}

will write the fields and stop if the time-step drops below 1e-8s.

Usage

Property	Description	Required	Default value
`type`	type name: stopAtTimeStep	yes
`minDeltaT`	Minimum time-step [s]	yes
`action`	Action executed	no	writeNow

Source files

Definition at line 98 of file stopAtTimeStep.H.

Constructor & Destructor Documentation

◆ stopAtTimeStep() [1/2]

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

Construct from Time and dictionary.

Definition at line 58 of file stopAtTimeStep.C.

References stopAt::action_, dict, stopAtTimeStep::read(), and stopAt::writeNow.

Here is the call graph for this function:

◆ stopAtTimeStep() [2/2]

stopAtTimeStep ( const stopAtTimeStep & )

delete

Disallow default bitwise copy construction.

◆ ~stopAtTimeStep()

~stopAtTimeStep ( )

virtual

Destructor.

Definition at line 75 of file stopAtTimeStep.C.

Member Function Documentation

◆ TypeName()

TypeName ( "stopAtTimeStep" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the dictionary settings.

Reimplemented from stopAt.

Definition at line 81 of file stopAtTimeStep.C.

References dict, and stopAt::read().

Referenced by stopAtTimeStep::stopAtTimeStep().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const stopAtTimeStep & )