Abstract base class for all zoneGenerators, providing runtime selection. More...

Inheritance diagram for zoneGenerator:

[legend]

Collaboration diagram for zoneGenerator:

[legend]

Public Member Functions
	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	generate () const =0
	Generate and return the zoneSet. More...

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

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

Static Public Member Functions
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
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...

Friends
class	zoneGeneratorList

Detailed Description

Abstract base class for all zoneGenerators, providing runtime selection.

See also: Foam::zoneSet Foam::zoneGeneratorList

Source files

Definition at line 56 of file zoneGenerator.H.

Constructor & Destructor Documentation

◆ zoneGenerator() [1/2]

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

Construct from name, polyMesh and dictionary.

Definition at line 41 of file zoneGenerator.C.

◆ zoneGenerator() [2/2]

zoneGenerator ( const zoneGenerator & )

delete

Disallow default bitwise copy construction.

◆ ~zoneGenerator()

~zoneGenerator ( )

virtual

Destructor.

Definition at line 58 of file zoneGenerator.C.

Member Function Documentation

◆ TypeName()

TypeName ( "zoneGenerator" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New() [1/3]

Foam::autoPtr< Foam::zoneGenerator > New	(	const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

static

Select constructed from name, mesh and dictionary.

Definition at line 65 of file zoneGenerator.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, Foam::libs, dictionary::lookup(), mesh, Foam::name(), Foam::nl, dlLibraryTable::open(), and Foam::type().

Referenced by zoneGenerator::New(), zoneGeneratorList::read(), generatedZoneSet::read(), and zoneGeneratorList::zoneGeneratorList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/3]

Foam::autoPtr< Foam::zoneGenerator > New	(	const word &	name,
		const zoneTypes &	zoneType,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

static

Select constructed from name, zoneType, mesh and dictionary.

Definition at line 131 of file zoneGenerator.C.

References dict, dictionary::endLineNumber(), dictionary::entries(), mesh, Foam::name(), Foam::New(), and Foam::zoneTypesNames.

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::zoneGenerator > New	(	const polyMesh &	mesh,
		const dictionary &	dict
	)

static

Select constructed from mesh and first valid dictionary.

Definition at line 162 of file zoneGenerator.C.

References dict, Foam::endl(), dictionary::entries(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter, found, InfoInFunction, mesh, Foam::name(), and zoneGenerator::New().

Here is the call graph for this function:

◆ name()

const word& name ( ) const

inline

Definition at line 150 of file zoneGenerator.H.

References zoneGenerator::name_.

◆ zoneName()

const word& zoneName ( ) const

inline

Definition at line 155 of file zoneGenerator.H.

References zoneGenerator::zoneName_.

◆ indices()

Foam::labelList indices ( const boolList & selected )

static

Return the list of selected indices.

Definition at line 233 of file zoneGenerator.C.

References forAll.

Referenced by insideSurface::select(), and volume::select().

Here is the caller graph for this function:

◆ moveUpdate()

bool moveUpdate ( ) const

inline

Return true if the zoneGenerator updates any of the zones.

following mesh point motion

Definition at line 165 of file zoneGenerator.H.

◆ generate()

virtual zoneSet generate ( ) const

pure virtual

Generate and return the zoneSet.

Implemented in volume, lookup, write, truncatedCone, sphere, insideSurface, hemisphere, cylinder, box, annulus, Union, set, remove, point, periodic, invert, intersection, surface, plane, patch, orient, normal, flip, face, difference, clear, containsPoints, pistonBowlPoints, and cylinderHeadPoints.

◆ movePoints()

Foam::zoneSet movePoints ( ) const

virtual

Regenerate the zoneSet following mesh point motion.

Reimplemented in periodic.

Definition at line 259 of file zoneGenerator.C.

◆ operator=()

void operator= ( const zoneGenerator & )

delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ zoneGeneratorList

friend class zoneGeneratorList

friend

Definition at line 80 of file zoneGenerator.H.

Member Data Documentation

◆ name_

const word name_

protected

Name of zone generator.

Definition at line 63 of file zoneGenerator.H.

Referenced by zoneGenerator::name().

◆ dict_

const dictionary dict_

protected

Dictionary cached for error context.

Definition at line 66 of file zoneGenerator.H.

◆ zoneName_

const word zoneName_

protected

Name of the zone (defaults to the name of the generator)

Definition at line 69 of file zoneGenerator.H.

Referenced by zoneGenerator::zoneName().

◆ mesh_

const polyMesh& mesh_

protected

Reference to the polyMesh.

Definition at line 72 of file zoneGenerator.H.

◆ moveUpdate_

bool moveUpdate_

mutableprotected

Switch to update the zones if the mesh points are moved.

Definition at line 75 of file zoneGenerator.H.

Referenced by intersection::intersection(), periodic::periodic(), and write::write().

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

src/OpenFOAM/meshes/zoneGeneration/zoneGenerator/zoneGenerator.H
src/OpenFOAM/meshes/zoneGeneration/zoneGenerator/zoneGenerator.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ zoneGenerator() [1/2]

◆ zoneGenerator() [2/2]

◆ ~zoneGenerator()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ name()

◆ zoneName()

◆ indices()

◆ moveUpdate()

◆ generate()

◆ movePoints()

◆ operator=()

Friends And Related Function Documentation

◆ zoneGeneratorList

Member Data Documentation

◆ name_

◆ dict_

◆ zoneName_

◆ mesh_

◆ moveUpdate_