Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
stopAt Class Referenceabstract

Abstract base class for stop conditions. More...

Inheritance diagram for stopAt:
Inheritance graph
[legend]
Collaboration diagram for stopAt:
Collaboration graph
[legend]

Public Types

enum  actionType { noWriteNow, writeNow, nextWrite }
 Enumeration defining the type of action. More...
 

Public Member Functions

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

Protected Member Functions

virtual bool condition () const =0
 Return true when the stop condition is achieved. More...
 

Protected Attributes

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

static const NamedEnum< actionType, 3 > actionTypeNames_
 Action type names. 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 write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Abstract base class for stop conditions.

Currently the following actions are supported:

  • noWriteNow
  • writeNow
  • nextWrite
Source files

Definition at line 56 of file stopAt.H.

Member Enumeration Documentation

◆ actionType

enum actionType
strong

Enumeration defining the type of action.

Enumerator
noWriteNow 

stop immediately without writing data

writeNow 

write data and stop immediately

nextWrite 

stop the next time data are written

Definition at line 63 of file stopAt.H.

Constructor & Destructor Documentation

◆ stopAt() [1/2]

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

Construct from Time and dictionary.

Definition at line 62 of file stopAt.C.

Referenced by NamedEnum< compressibleField, 8 >::names().

Here is the caller graph for this function:

◆ stopAt() [2/2]

stopAt ( const stopAt &  )
delete

Disallow default bitwise copy construction.

◆ ~stopAt()

~stopAt ( )
virtual

Destructor.

Definition at line 77 of file stopAt.C.

Member Function Documentation

◆ condition()

virtual bool condition ( ) const
protectedpure virtual

Return true when the stop condition is achieved.

◆ TypeName()

TypeName ( "stopAt"  )

Runtime type information.

◆ read()

bool read ( const dictionary &  dict)
virtual

Read the dictionary settings.

Reimplemented from functionObject.

Reimplemented in stopAtFile, and stopAtClockTime.

Definition at line 83 of file stopAt.C.

References dictionary::found(), and dictionary::lookup().

Referenced by stopAtClockTime::read(), and stopAtFile::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, check existence of stopAt file and take action.

Implements functionObject.

Definition at line 98 of file stopAt.C.

References Foam::endl(), Foam::Info, Time::nextWrite, Time::noWriteNow, Foam::reduce(), Foam::type(), and Time::writeNow.

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Execute, check existence of stopAt file and take action.

Implements functionObject.

Definition at line 154 of file stopAt.C.

◆ end()

bool end ( )
virtual

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

Reimplemented from functionObject.

Reimplemented in stopAtFile.

Definition at line 160 of file stopAt.C.

◆ operator=()

void operator= ( const stopAt &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ time_

const Time& time_
protected

Reference to the Time.

Definition at line 76 of file stopAt.H.

◆ actionTypeNames_

const Foam::NamedEnum< Foam::functionObjects::stopAt::actionType, 3 > actionTypeNames_
staticprotected

Action type names.

Definition at line 79 of file stopAt.H.

Referenced by NamedEnum< compressibleField, 8 >::names().

◆ action_

actionType action_
protected

The type of action.

Definition at line 82 of file stopAt.H.

◆ stopped_

bool stopped_
protected

Set true when the stop action has executed.

Definition at line 85 of file stopAt.H.

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