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

Inheritance diagram for removeObjects:

Collaboration diagram for removeObjects:

Public Member Functions
	TypeName ("removeObjects")
	Runtime type information. More...

	removeObjects (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	removeObjects (const removeObjects &)=delete
	Disallow default bitwise copy construction. More...

virtual	~removeObjects ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the removeObjects 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 removeObjects &)=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...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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 execute at start time. 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...

Detailed Description

Removes registered objects if present in the database.

Example of function object specification:

removeObjects1
{
    type        removeObjects;

    libs        ("libutilityFunctionObjects.so");

    objects     (obj1 obj2);
}

Usage

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

See also: Foam::functionObject

Source files

Definition at line 92 of file removeObjects.H.

Constructor & Destructor Documentation

◆ removeObjects() [1/2]

removeObjects	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 46 of file removeObjects.C.

References dict, and removeObjects::read().

Here is the call graph for this function:

◆ removeObjects() [2/2]

removeObjects ( const removeObjects & )

delete

Disallow default bitwise copy construction.

◆ ~removeObjects()

~removeObjects ( )

virtual

Destructor.

Definition at line 69 of file removeObjects.C.

Member Function Documentation

◆ TypeName()

TypeName ( "removeObjects" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the removeObjects data.

Reimplemented from functionObject.

Definition at line 75 of file removeObjects.C.

References dict.

Referenced by removeObjects::removeObjects().

Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 135 of file removeObjects.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Remove the registered objects.

Implements functionObject.

Definition at line 83 of file removeObjects.C.

References Foam::endl(), forAll, Foam::Info, IOobject::name(), Foam::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 108 of file removeObjects.C.

◆ operator=()

void operator= ( const removeObjects & )

delete

Disallow default bitwise assignment.

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

src/functionObjects/utilities/removeObjects/removeObjects.H
src/functionObjects/utilities/removeObjects/removeObjects.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ removeObjects() [1/2]

◆ removeObjects() [2/2]

◆ ~removeObjects()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()