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... | |
| virtual | ~removeRegisteredObject () |
| Destructor. More... | |
| virtual bool | read (const dictionary &) |
| Read the removeRegisteredObject data. More... | |
| virtual bool | execute () |
| Remove the registered objects. More... | |
| virtual bool | write () |
| Do nothing. More... | |
Public Member Functions inherited from 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) | |
| Construct from components. More... | |
| autoPtr< functionObject > | clone () const |
| Return clone. More... | |
| virtual | ~functionObject () |
| Destructor. More... | |
| const word & | name () const |
| Return the name of this functionObject. 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 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< 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... | |
Static Public Attributes inherited from functionObject | |
| static int | debug |
| static bool | postProcess |
| Global post-processing mode switch. 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 94 of file removeRegisteredObject.H.
| removeRegisteredObject | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 52 of file removeRegisteredObject.C.
References Foam::read().

|
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 dictionary::lookup().

|
virtual |
Remove the registered objects.
Implements functionObject.
Definition at line 88 of file removeRegisteredObject.C.
References Foam::endl(), forAll, Foam::Info, Foam::name(), IOobject::name(), Foam::nl, regIOobject::ownedByRegistry(), regIOobject::release(), and Foam::type().

|
virtual |
1.8.13