Stops the run when the specified file is created in the case directory and optionally write results before stopping. More...

Inheritance diagram for stopAtFile:

[legend]

Collaboration diagram for stopAtFile:

[legend]

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

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

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

virtual	~stopAtFile ()
	Destructor. More...

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

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

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

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...

	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	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 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
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 execute at start time. 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 the specified file is created in the case directory and optionally write results before stopping.

The default name of the trigger file is $FOAM_CASE/<name> where <name> is the name of the functionObject entry.

Currently the following action types are supported:

noWriteNow
writeNow
nextWrite (default)

Examples of function object specification:

stop
{
    type            stopAtFile;

    libs            ("libutilityFunctionObjects.so");
}

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

stop
{
    type    stopAtFile;
    libs    ("libutilityFunctionObjects.so");
    file    "$FOAM_CASE/stop";
    action  writeNow;
}

will write the fields and stop the run when the file "stop" is created in the case directory.

Usage

Property	Description	Required	Default value
`type`	type name: stopAtFile	yes
`file`	Trigger file path name	no	$FOAM_CASE/<name>
`action`	Action executed	no	nextWrite

Source files

Definition at line 111 of file stopAtFile.H.

Constructor & Destructor Documentation

◆ stopAtFile() [1/2]

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

Construct from Time and dictionary.

Definition at line 73 of file stopAtFile.C.

References dict, string::expand(), and stopAtFile::read().

Here is the call graph for this function:

◆ stopAtFile() [2/2]

stopAtFile ( const stopAtFile & )

delete

Disallow default bitwise copy construction.

◆ ~stopAtFile()

~stopAtFile ( )

virtual

Destructor.

Definition at line 93 of file stopAtFile.C.

Member Function Documentation

◆ TypeName()

TypeName ( "stopAtFile" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the dictionary settings.

Reimplemented from stopAt.

Definition at line 99 of file stopAtFile.C.

References dict, and stopAt::read().

Referenced by stopAtFile::stopAtFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end()

bool end ( )

virtual

Execute at the final time-loop, used for cleanup.

Reimplemented from stopAt.

Definition at line 112 of file stopAtFile.C.

◆ operator=()

void operator= ( const stopAtFile & )

delete

Disallow default bitwise assignment.

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

src/functionObjects/utilities/stopAt/stopAtFile/stopAtFile.H
src/functionObjects/utilities/stopAt/stopAtFile/stopAtFile.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ stopAtFile() [1/2]

◆ stopAtFile() [2/2]

◆ ~stopAtFile()

Member Function Documentation

◆ TypeName()

◆ read()

◆ end()

◆ operator=()