Go to the documentation of this file.
196 #ifndef functionObject_H
197 #define functionObject_H
236 class unavailableFunctionObject;
239 virtual const word&
type()
const = 0;
272 autoPtr<functionObject>
clone()
const
282 static autoPtr<functionObject>
New
286 const dictionary&
dict
297 const word&
name()
const;
300 virtual bool read(
const dictionary&
dict);
311 virtual bool execute(
const label subIndex);
316 virtual bool write() = 0;
354 void carp(std::string message =
"")
const;
365 virtual bool write();
virtual bool execute()
No nothing.
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.
Mesh consisting of general polyhedral cells.
Abstract base-class for Time/database function objects.
unavailableFunctionObject(const word &name)
Construct with name.
declareRunTimeSelectionTable(autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
virtual bool write()
No nothing.
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
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.
void carp(std::string message="") const
virtual bool end()
Called when Time::run() determines that the time-loop exits.
word scopedName(const word &name) const
Return a scoped name, e.g. used to construct local field names.
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.
static int debug
Flag to execute debug content.
const word & name() const
Return the name of this functionObject.
Macros to ease declaration of run-time selection tables.
virtual const word & type() const =0
Runtime type information.
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.
functionObject(const word &name)
Construct from components.