Loading...
Searching...
No Matches
pointHistory Class Reference

#include <pointHistory.H>

Inheritance diagram for pointHistory:
Collaboration diagram for pointHistory:

Public Member Functions

 TypeName ("pointHistory")
 Runtime type information.
 pointHistory (const word &name, const Time &runTime, const dictionary &)
 Construct from components.
virtual bool execute ()
 execute is called at each ++ or += of the time-loop
virtual bool read (const dictionary &dict)
 Read and set the function object if its data has changed.
virtual bool write ()
 No-op.
Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 Construct from components.
autoPtr< functionObjectclone () const
 Return clone.
virtual ~functionObject ()=default
 Destructor.
virtual const wordtype () const =0
 Runtime type information.
const wordname () const noexcept
 Return the name of this functionObject.
bool useNamePrefix () const noexcept
 Return the flag for adding a scoping name prefix.
bool useNamePrefix (bool on) noexcept
 Modify the flag for adding a scoping name prefix.
virtual bool execute (const label subIndex)
 Execute using the specified subIndex.
virtual bool end ()
 Called when Time::run() determines that the time-loop exits.
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool filesModified () const
 Did any file get changed during execution?
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh.
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh.

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.
Public Attributes inherited from functionObject
bool log
 Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content.
static bool postProcess
 Global post-processing mode switch.
static bool defaultUseNamePrefix
 Global default for useNamePrefix.
static word outputPrefix
 Directory prefix.
Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped (prefixed) name.

Detailed Description

Source files

Definition at line 48 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.

References dict, functionObject::name(), and runTime.

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

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

Implements functionObject.

Definition at line 179 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 185 of file pointHistory.C.

References dict.

◆ write()

virtual bool write ( )
inlinevirtual

No-op.

Implements functionObject.

Definition at line 147 of file pointHistory.H.


The documentation for this class was generated from the following files:
  • src/dynamicFaMesh/interfaceTrackingFvMesh/functionObjects/pointHistory/pointHistory.H
  • src/dynamicFaMesh/interfaceTrackingFvMesh/functionObjects/pointHistory/pointHistory.C