Go to the documentation of this file.
201 #ifndef functionObject_H
202 #define functionObject_H
245 class unavailableFunctionObject;
291 autoPtr<functionObject>
clone()
const
301 static autoPtr<functionObject>
New
305 const dictionary&
dict
316 virtual const word&
type()
const = 0;
319 const word&
name() const noexcept;
329 virtual
bool read(const dictionary&
dict);
340 virtual
bool execute(const label subIndex);
345 virtual
bool write() = 0;
383 void carp(std::string message =
"")
const;
394 virtual bool write();
virtual bool execute()=0
Called at each ++ or += of the time-loop.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
virtual bool write()=0
Called at each ++ or += of the time-loop.
A class for handling words, derived from Foam::string.
static autoPtr< functionObject > New(const word &name, const Time &runTime, const dictionary &dict)
Select from dictionary, based on its "type" entry.
functionObject(const word &name, const bool withNamePrefix=defaultUseNamePrefix)
Construct from components.
Mesh consisting of general polyhedral cells.
Abstract base-class for Time/database function objects.
declareRunTimeSelectionTable(autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
static bool defaultUseNamePrefix
Global default for useNamePrefix.
virtual ~functionObject()=default
Destructor.
static bool postProcess
Global post-processing mode switch.
virtual bool read(const dictionary &dict)
Read and set the function object if its data have changed.
static word outputPrefix
Directory prefix.
autoPtr< functionObject > clone() const
Return clone.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
virtual bool adjustTimeStep()
Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual void movePoints(const polyMesh &mesh)
Update for changes of mesh.
virtual bool end()
Called when Time::run() determines that the time-loop exits.
word scopedName(const word &name) const
Return a scoped (prefixed) name.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
virtual void updateMesh(const mapPolyMesh &mpm)
Update for changes of mesh.
Abstract functionObject to report when a real version is unavailable.
const word & name() const noexcept
Return the name of this functionObject.
static int debug
Flag to execute debug content.
Macros to ease declaration of run-time selection tables.
virtual const word & type() const =0
Runtime type information.
bool useNamePrefix() const noexcept
Return the flag for adding a scoping name prefix.
virtual bool filesModified() const
Did any file get changed during execution?
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
bool log
Flag to write log into Info.