Removes registered objects if present in the database. More...
Public Member Functions | |
TypeName ("removeRegisteredObject") | |
Runtime type information. More... | |
removeRegisteredObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
removeRegisteredObject (const removeRegisteredObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~removeRegisteredObject () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the removeRegisteredObject data. More... | |
virtual wordList | fields () const |
Return the list of fields required. More... | |
virtual bool | execute () |
Remove the registered objects. More... | |
virtual bool | write () |
Do nothing. More... | |
void | operator= (const removeRegisteredObject &)=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, const Time &runTime) | |
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 bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual scalar | timeToNextAction () |
Called by Time::adjustTimeStep(). Allows the functionObject to. More... | |
virtual scalar | maxDeltaT () const |
Return the maximum time-step for stable operation. More... | |
virtual void | movePoints (const polyMesh &mesh) |
Update topology using the given map. More... | |
virtual void | topoChange (const polyTopoChangeMap &map) |
Update topology using the given map. More... | |
virtual void | mapMesh (const polyMeshMap &) |
Update from another mesh using the given map. More... | |
virtual void | distribute (const polyDistributionMap &) |
Redistribute or update using the given distribution map. More... | |
void | operator= (const functionObject &)=delete |
Disallow default bitwise assignment. 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... | |
Protected Attributes inherited from functionObject | |
const Time & | time_ |
Reference to time. More... | |
Removes registered objects if present in the database.
Example of function object specification:
removeRegisteredObject1 { type removeRegisteredObject; libs ("libutilityFunctionObjects.so"); objects (obj1 obj2); }
Property | Description | Required | Default value |
---|---|---|---|
type | type name: removeRegisteredObject | yes | |
objects | objects to remove | yes |
Definition at line 92 of file removeRegisteredObject.H.
removeRegisteredObject | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 51 of file removeRegisteredObject.C.
References dict, and removeRegisteredObject::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 74 of file removeRegisteredObject.C.
TypeName | ( | "removeRegisteredObject" | ) |
Runtime type information.
|
virtual |
Read the removeRegisteredObject data.
Reimplemented from functionObject.
Definition at line 80 of file removeRegisteredObject.C.
References dict.
Referenced by removeRegisteredObject::removeRegisteredObject().
|
inlinevirtual |
Return the list of fields required.
Implements functionObject.
Definition at line 135 of file removeRegisteredObject.H.
References List< word >::null().
|
virtual |
Remove the registered objects.
Implements functionObject.
Definition at line 88 of file removeRegisteredObject.C.
References Foam::endl(), forAll, Foam::Info, IOobject::name(), Foam::name(), Foam::nl, regIOobject::ownedByRegistry(), regIOobject::release(), and Foam::type().
|
virtual |
|
delete |
Disallow default bitwise assignment.