Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
removeRegisteredObject Class Reference

This function object removes registered objects if present in the database. More...

Collaboration diagram for removeRegisteredObject:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("removeRegisteredObject")
 Runtime type information. More...
 
 removeRegisteredObject (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~removeRegisteredObject ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the removeRegisteredObject. More...
 
virtual void read (const dictionary &)
 Read the removeRegisteredObject data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Write the removeRegisteredObject. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 

Protected Member Functions

 removeRegisteredObject (const removeRegisteredObject &)
 Disallow default bitwise copy construct. More...
 
void operator= (const removeRegisteredObject &)
 Disallow default bitwise assignment. More...
 

Protected Attributes

word name_
 Name of this set of removeRegisteredObject. More...
 
const objectRegistryobr_
 
wordList objectNames_
 Names of objects to control. More...
 

Detailed Description

This function object removes registered objects if present in the database.

Example of function object specification:

removeRegisteredObject1
{
    type        removeRegisteredObject;
    functionObjectLibs ("libIOFunctionObjects.so");
    ...
    objectNames (obj1 obj2);
}


Function object usage

Property Description Required Default value
type type name: removeRegisteredObject yes
objectNames objects to remove yes
See also
Foam::functionObject Foam::OutputFilterFunctionObject
Source files

Definition at line 96 of file removeRegisteredObject.H.

Constructor & Destructor Documentation

Disallow default bitwise copy construct.

removeRegisteredObject ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 41 of file removeRegisteredObject.C.

References Foam::read().

Here is the call graph for this function:

~removeRegisteredObject ( )
virtual

Destructor.

Definition at line 58 of file removeRegisteredObject.C.

Member Function Documentation

void operator= ( const removeRegisteredObject )
protected

Disallow default bitwise assignment.

TypeName ( "removeRegisteredObject"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual
void read ( const dictionary dict)
virtual

Read the removeRegisteredObject data.

Definition at line 64 of file removeRegisteredObject.C.

References dictionary::lookup().

Referenced by removeRegisteredObject::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 70 of file removeRegisteredObject.C.

References Foam::endl(), forAll, Foam::Info, IOobject::name(), Foam::nl, regIOobject::ownedByRegistry(), and Foam::type().

Referenced by removeRegisteredObject::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Definition at line 93 of file removeRegisteredObject.C.

Referenced by removeRegisteredObject::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 99 of file removeRegisteredObject.C.

Referenced by removeRegisteredObject::name().

Here is the caller graph for this function:

void write ( )
virtual

Write the removeRegisteredObject.

Definition at line 105 of file removeRegisteredObject.C.

Referenced by removeRegisteredObject::name().

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 170 of file removeRegisteredObject.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 174 of file removeRegisteredObject.H.

Member Data Documentation

word name_
protected

Name of this set of removeRegisteredObject.

Definition at line 103 of file removeRegisteredObject.H.

Referenced by removeRegisteredObject::name().

const objectRegistry& obr_
protected

Definition at line 105 of file removeRegisteredObject.H.

wordList objectNames_
protected

Names of objects to control.

Definition at line 110 of file removeRegisteredObject.H.


The documentation for this class was generated from the following files: