pointHistory Class Reference
Inheritance diagram for pointHistory:
[legend]
Collaboration diagram for pointHistory:
[legend]

Public Member Functions

 TypeName ("pointHistory")
 Runtime type information. More...
 
 pointHistory (const word &name, const Time &runTime, const dictionary &)
 Construct from components. More...
 
virtual bool execute ()
 execute is called at each ++ or += of the time-loop More...
 
virtual bool read (const dictionary &dict)
 Read and set the function object if its data has changed. More...
 
virtual bool write ()
 No-op. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()=default
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool execute (const label subIndex)
 Execute using the specified subIndex. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual bool filesModified () const
 Did any file get changed during execution? 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &runTime, const dictionary &dict)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
bool log
 Flag to write log into Info. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content. More...
 
static bool postProcess
 Global post-processing mode switch. More...
 
static word outputPrefix
 Directory prefix. More...
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped name, e.g. used to construct local field names. More...
 

Detailed Description

Source files

Definition at line 52 of file pointHistory.H.

Constructor & Destructor Documentation

◆ pointHistory()

pointHistory ( const word name,
const Time runTime,
const dictionary dict 
)

Member Function Documentation

◆ TypeName()

TypeName ( "pointHistory"  )

Runtime type information.

◆ execute()

bool execute ( )
virtual

execute is called at each ++ or += of the time-loop

Implements functionObject.

Definition at line 199 of file pointHistory.C.

References Foam::writeData().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read and set the function object if its data has changed.

Reimplemented from functionObject.

Definition at line 205 of file pointHistory.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ write()

virtual bool write ( )
inlinevirtual

No-op.

Implements functionObject.

Definition at line 119 of file pointHistory.H.


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