Zone container returned by zoneGenerator::generate. More...

Inheritance diagram for zoneSet:

Public Types
enum class	zoneTypess { point , cell , face }
	Enumeration defining the zone types. More...

Public Member Functions
	zoneSet ()
	Construct null. More...

	zoneSet (const zoneSet &)
	Construct copy transferring content of temporaries. More...

	zoneSet (zoneSet &&)=default
	Construct copy moving content. More...

	zoneSet (pointZone *pointZonePtr)
	Construct from pointZone pointer. More...

	zoneSet (cellZone *cellZonePtr)
	Construct from cellZone pointer. More...

	zoneSet (faceZone *faceZonePtr)
	Construct from faceZone pointer. More...

	zoneSet (pointZone pointZonePtr, cellZone cellZonePtr, faceZone *faceZonePtr)
	Construct from pointZone, cellZone and faceZone pointers. More...

	zoneSet (const pointZone &pointZoneRef)
	Construct from pointZone. More...

	zoneSet (const cellZone &cellZoneRef)
	Construct from cellZone. More...

	zoneSet (const faceZone &faceZoneRef)
	Construct from faceZone. More...

	zoneSet (const zoneSet &, bool allowTransfer)
	Construct copy transferring content of temporaries if required. More...

zoneSet	clone (const word &name) const
	Construct and return a clone with a new name. More...

bool	pValid () const
	Return true if the pointZone is allocated. More...

bool	cValid () const
	Return true if the cellZone is allocated. More...

bool	fValid () const
	Return true if the faceZone is allocated. More...

bool	valid () const
	Return true if any of the zone types are allocated. More...

template<class ZoneType >
bool	valid () const
	Return true if the zone type specified by template specialisation. More...

const pointZone &	pZone () const
	Return a reference to the pointZone if allocated. More...

const cellZone &	cZone () const
	Return a reference to the cellZone if allocated. More...

const faceZone &	fZone () const
	Return a reference to the faceZone if allocated. More...

template<class ZoneType >
const ZoneType &	zone () const
	Return a reference to the zone type. More...

zoneSet	store () const
	Store the temporary zones and return the stored zoneSet. More...

void	operator= (const zoneSet &)
	Assignment transferring the temporary zones. More...

zoneSet &	operator= (zoneSet &&)=default
	Assignment moving content. More...

void	operator= (const pointZone &)
	Assignment to pointZone, updating pZone_. More...

void	operator= (const cellZone &)
	Assignment to cellZone, updating cZone_. More...

void	operator= (const faceZone &)
	Assignment to faceZone, updating fZone_. More...

template<>
bool	valid () const

template<>
bool	valid () const

template<>
bool	valid () const

template<>
const pointZone &	zone () const

template<>
const cellZone &	zone () const

template<>
const faceZone &	zone () const

Detailed Description

Zone container returned by zoneGenerator::generate.

Optionally contains any combination of point, cell or face zones generated by the zoneGenerator::generate function which may simply be the zones returned by a lookup from the lists of zones stored on the mesh or generated by the particular zoneGenerator from a geometric search for example.

Having zoneSet optionally hold zones of more than one type is particularly useful for the generation of complex coupled or related zone systems, for example rotating regions requiring both the cellZone of the rotating cells and the faces of the outer moving/sliding boundary.

Source files

See also: Foam::zoneGenerator

Definition at line 93 of file zoneSet.H.

Member Enumeration Documentation

◆ zoneTypess

enum zoneTypess

strong

Enumeration defining the zone types.

Enumerator
point
cell
face

Definition at line 117 of file zoneSet.H.

Constructor & Destructor Documentation

◆ zoneSet() [1/11]

zoneSet ( )

inline

Construct null.

Definition at line 61 of file zoneSetI.H.

◆ zoneSet() [2/11]

zoneSet ( const zoneSet & zs )

inline

Construct copy transferring content of temporaries.

Definition at line 69 of file zoneSetI.H.

◆ zoneSet() [3/11]

zoneSet ( zoneSet && )

inlinedefault

Construct copy moving content.

◆ zoneSet() [4/11]

zoneSet ( pointZone * pointZonePtr )

inline

Construct from pointZone pointer.

Definition at line 77 of file zoneSetI.H.

◆ zoneSet() [5/11]

zoneSet ( cellZone * cellZonePtr )

inline

Construct from cellZone pointer.

Definition at line 85 of file zoneSetI.H.

◆ zoneSet() [6/11]

zoneSet ( faceZone * faceZonePtr )

inline

Construct from faceZone pointer.

Definition at line 93 of file zoneSetI.H.

◆ zoneSet() [7/11]

zoneSet	(	pointZone *	pointZonePtr,
		cellZone *	cellZonePtr,
		faceZone *	faceZonePtr
	)

inline

Construct from pointZone, cellZone and faceZone pointers.

Definition at line 101 of file zoneSetI.H.

◆ zoneSet() [8/11]

zoneSet ( const pointZone & pointZoneRef )

inline

Construct from pointZone.

Definition at line 114 of file zoneSetI.H.

◆ zoneSet() [9/11]

zoneSet ( const cellZone & cellZoneRef )

inline

Construct from cellZone.

Definition at line 122 of file zoneSetI.H.

◆ zoneSet() [10/11]

zoneSet ( const faceZone & faceZoneRef )

inline

Construct from faceZone.

Definition at line 130 of file zoneSetI.H.

◆ zoneSet() [11/11]

zoneSet	(	const zoneSet &	zs,
		bool	allowTransfer
	)

inline

Construct copy transferring content of temporaries if required.

Definition at line 138 of file zoneSetI.H.

Member Function Documentation

◆ clone()

Foam::zoneSet clone ( const word & name ) const

inline

Construct and return a clone with a new name.

Definition at line 146 of file zoneSetI.H.

References Foam::clone(), and Foam::name().

Referenced by periodic::generate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pValid()

bool pValid ( ) const

inline

Return true if the pointZone is allocated.

Definition at line 167 of file zoneSetI.H.

Referenced by face::generate(), intersection::generate(), periodic::generate(), point::generate(), and Union::generate().

Here is the caller graph for this function:

◆ cValid()

bool cValid ( ) const

inline

Return true if the cellZone is allocated.

Definition at line 174 of file zoneSetI.H.

Referenced by face::generate(), intersection::generate(), periodic::generate(), point::generate(), and Union::generate().

Here is the caller graph for this function:

◆ fValid()

bool fValid ( ) const

inline

Return true if the faceZone is allocated.

Definition at line 181 of file zoneSetI.H.

Referenced by face::generate(), intersection::generate(), periodic::generate(), point::generate(), and Union::generate().

Here is the caller graph for this function:

◆ valid() [1/5]

bool valid ( ) const

inline

Return true if any of the zone types are allocated.

Definition at line 188 of file zoneSetI.H.

◆ valid() [2/5]

bool valid ( ) const

inline

Return true if the zone type specified by template specialisation.

is allocated

◆ pZone()

const Foam::pointZone & pZone ( ) const

inline

Return a reference to the pointZone if allocated.

otherwise stop with an error

Definition at line 216 of file zoneSetI.H.

Referenced by intersection::generate(), point::generate(), lookup::generate(), and Union::generate().

Here is the caller graph for this function:

◆ cZone()

const Foam::cellZone & cZone ( ) const

inline

Return a reference to the cellZone if allocated.

otherwise stop with an error

Definition at line 223 of file zoneSetI.H.

Referenced by face::generate(), intersection::generate(), point::generate(), lookup::generate(), and Union::generate().

Here is the caller graph for this function:

◆ fZone()

const Foam::faceZone & fZone ( ) const

inline

Return a reference to the faceZone if allocated.

otherwise stop with an error

Definition at line 230 of file zoneSetI.H.

Referenced by face::generate(), flip::generate(), orient::generate(), intersection::generate(), point::generate(), lookup::generate(), Union::generate(), generatedFaceZone::name(), insideSurface::select(), and volume::select().

Here is the caller graph for this function:

◆ zone() [1/4]

const ZoneType& zone ( ) const

inline

Return a reference to the zone type.

specified by template specialisation if allocated otherwise stop with an error

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

Here is the caller graph for this function:

◆ store()

Foam::zoneSet store ( ) const

Store the temporary zones and return the stored zoneSet.

Definition at line 53 of file zoneSet.C.

References ZoneList< ZoneType, ZonesType, MeshType >::append(), and Zone< ZoneType, ZonesType >::zones().

Here is the call graph for this function:

◆ operator=() [1/5]

void operator= ( const zoneSet & zs )

Assignment transferring the temporary zones.

Definition at line 93 of file zoneSet.C.

Referenced by generatedZoneSet::distribute(), generatedZoneSet::mapMesh(), generatedZoneSet::movePoints(), generatedZoneSet::read(), generatedZoneSet::set(), and generatedZoneSet::topoChange().

Here is the caller graph for this function:

◆ operator=() [2/5]

zoneSet& operator= ( zoneSet && )

inlinedefault

Assignment moving content.

◆ operator=() [3/5]

void operator= ( const pointZone & pZone )

inline

Assignment to pointZone, updating pZone_.

Definition at line 260 of file zoneSetI.H.

◆ operator=() [4/5]

void operator= ( const cellZone & cZone )

inline

Assignment to cellZone, updating cZone_.

Definition at line 266 of file zoneSetI.H.

◆ operator=() [5/5]

void operator= ( const faceZone & fZone )

inline

Assignment to faceZone, updating fZone_.

Definition at line 272 of file zoneSetI.H.

◆ valid() [3/5]

bool valid ( ) const

inline

◆ valid() [4/5]

bool valid ( ) const

inline

◆ valid() [5/5]

bool valid ( ) const

inline

◆ zone() [2/4]

const pointZone& zone ( ) const

inline

◆ zone() [3/4]

const cellZone& zone ( ) const

inline

◆ zone() [4/4]

const faceZone& zone ( ) const

inline

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

src/OpenFOAM/meshes/zoneGeneration/zoneSet/zoneSet.H
src/OpenFOAM/meshes/zoneGeneration/zoneSet/zoneSet.C
src/OpenFOAM/meshes/zoneGeneration/zoneSet/zoneSetI.H

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ zoneTypess

Constructor & Destructor Documentation

◆ zoneSet() [1/11]

◆ zoneSet() [2/11]

◆ zoneSet() [3/11]

◆ zoneSet() [4/11]

◆ zoneSet() [5/11]

◆ zoneSet() [6/11]

◆ zoneSet() [7/11]

◆ zoneSet() [8/11]

◆ zoneSet() [9/11]

◆ zoneSet() [10/11]

◆ zoneSet() [11/11]

Member Function Documentation

◆ clone()

◆ pValid()

◆ cValid()

◆ fValid()

◆ valid() [1/5]

◆ valid() [2/5]

◆ pZone()

◆ cZone()

◆ fZone()

◆ zone() [1/4]

◆ store()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ valid() [3/5]

◆ valid() [4/5]

◆ valid() [5/5]

◆ zone() [2/4]

◆ zone() [3/4]

◆ zone() [4/4]