removeRegisteredObject Class Reference

Removes registered objects if present in the database. More...

Inheritance diagram for removeRegisteredObject:

Collaboration diagram for removeRegisteredObject:

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 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)
	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	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. 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...
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...

Detailed Description

Removes registered objects if present in the database.

Example of function object specification:

removeRegisteredObject1
{
    type        removeRegisteredObject;
    libs        ("libutilityFunctionObjects.so");
    ...
    objects     (obj1 obj2);
}

Usage

Property	Description	Required	Default value
type	type name: removeRegisteredObject	yes
objects	objects to remove	yes

See also

Foam::functionObject

Source files

• removeRegisteredObject.H
• removeRegisteredObject.C

Definition at line 91 of file removeRegisteredObject.H.

Constructor & Destructor Documentation

removeRegisteredObject() [1/2]

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().

Here is the call graph for this function:

removeRegisteredObject() [2/2]

removeRegisteredObject ( const removeRegisteredObject &  )

delete

Disallow default bitwise copy construction.

~removeRegisteredObject()

~removeRegisteredObject ( )

virtual

Destructor.

Definition at line 74 of file removeRegisteredObject.C.

Member Function Documentation

TypeName()

TypeName

(

"removeRegisteredObject"

)

Runtime type information.

read()

bool read ( const dictionary &  dict )

virtual

Read the removeRegisteredObject data.

Reimplemented from functionObject.

Definition at line 80 of file removeRegisteredObject.C.

References dictionary::lookup().

Here is the call graph for this function:

execute()

bool execute ( )

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().

Here is the call graph for this function:

write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 113 of file removeRegisteredObject.C.

operator=()

void operator= ( const removeRegisteredObject &  )

delete

Disallow default bitwise assignment.

---

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

• src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
• src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.C