A zoneGenerator which clears all existing zones from the mesh. More...

Inheritance diagram for clear:

Collaboration diagram for clear:

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

	clear (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~clear ()
	Destructor. More...

virtual zoneSet	generate () const
	Generate and return the zoneSet. More...

Public Member Functions inherited from zoneGenerator
	TypeName ("zoneGenerator")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, zoneGenerator, dictionary,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))

	zoneGenerator (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from name, polyMesh and dictionary. More...

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

virtual	~zoneGenerator ()
	Destructor. More...

const word &	name () const

const word &	zoneName () const

bool	moveUpdate () const
	Return true if the zoneGenerator updates any of the zones. More...

virtual zoneSet	movePoints () const
	Regenerate the zoneSet following mesh point motion. More...

void	operator= (const zoneGenerator &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from zoneGenerator
static autoPtr< zoneGenerator >	New (const word &name, const polyMesh &mesh, const dictionary &dict)
	Select constructed from name, mesh and dictionary. More...

static autoPtr< zoneGenerator >	New (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict)
	Select constructed from name, zoneType, mesh and dictionary. More...

static autoPtr< zoneGenerator >	New (const polyMesh &mesh, const dictionary &dict)
	Select constructed from mesh and first valid dictionary. More...

static labelList	indices (const boolList &selected)
	Return the list of selected indices. More...

Protected Attributes inherited from zoneGenerator
const word	name_
	Name of zone generator. More...

const dictionary	dict_
	Dictionary cached for error context. More...

const word	zoneName_
	Name of the zone (defaults to the name of the generator) More...

const polyMesh &	mesh_
	Reference to the polyMesh. More...

bool	moveUpdate_
	Switch to update the zones if the mesh points are moved. More...

Detailed Description

A zoneGenerator which clears all existing zones from the mesh.

Usage

Property	Description	Required	Default value
`type`	Type: clear	yes

Example:

        clearAllZones
        {
            type        clear;
        }

When called from the top-level of the createZonesDict or zonesGenerator files which is the most likely use the simpler syntax to clear all the zones can be used:

        clear;

See also: zoneGenerators::remove

Source files

Definition at line 83 of file clear.H.

Constructor & Destructor Documentation

◆ clear()

clear	(	const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 44 of file clear.C.

◆ ~clear()

~clear ( )

virtual

Destructor.

Definition at line 57 of file clear.C.

Member Function Documentation

◆ TypeName()

TypeName ( "clear" )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const

virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 63 of file clear.C.

References clear().

Here is the call graph for this function:

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

src/meshTools/zoneGenerators/clear/clear.H
src/meshTools/zoneGenerators/clear/clear.C

Public Member Functions