zoneIdentifier Class Reference

Identifies a mesh zone by name and index, with optional physical type and group information. More...

#include <zoneIdentifier.H>

Inheritance diagram for zoneIdentifier:

Public Member Functions
	zoneIdentifier (const zoneIdentifier &)=default
	Copy construct.
	zoneIdentifier (zoneIdentifier &&)=default
	Move construct.
zoneIdentifier &	operator= (const zoneIdentifier &)=default
	Copy assignment.
zoneIdentifier &	operator= (zoneIdentifier &&)=default
	Move assignment.
virtual	~zoneIdentifier ()=default
	Destructor.
	zoneIdentifier ()
	Default construct: name="", index=0.
	zoneIdentifier (const word &name, const label index)
	Construct from mandatory components.
	zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components.
	zoneIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	zoneIdentifier (const zoneIdentifier &ident, const label newIndex)
	Copy construct, resetting the index (if non-negative).
	zoneIdentifier (zoneIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative).
const word &	name () const noexcept
	The zone name.
word &	name () noexcept
	Modifiable zone name.
label	index () const noexcept
	The index of this zone in the zone list.
label &	index () noexcept
	Modifiable index of this zone in the zone list.
const word &	physicalType () const noexcept
	The (optional) type of the zone.
word &	physicalType () noexcept
	Modifiable (optional) type of the zone.
const wordList &	inGroups () const noexcept
	The (optional) groups that the zone belongs to.
wordList &	inGroups () noexcept
	Modifiable (optional) groups that the zone belongs to.
bool	inGroup (const word &name) const
	True if given name is in a group.
void	addGroup (const word &name)
	Add (unique) group for the zone.
void	removeGroup (const word &name)
	Remove group for the zone.
void	write (Ostream &os) const
	Write (physicalType, inGroups) dictionary entries (without surrounding braces).

Detailed Description

Identifies a mesh zone by name and index, with optional physical type and group information.

See also

patchIdentifier

Source files

• zoneIdentifier.H
• zoneIdentifier.C

Definition at line 53 of file zoneIdentifier.H.

Constructor & Destructor Documentation

zoneIdentifier() [1/8]

zoneIdentifier ( const zoneIdentifier & )

default

Copy construct.

References zoneIdentifier().

Referenced by operator=(), operator=(), zone::zone(), zone::zone(), zone::zone(), zone::zone(), zone::zone(), zone::zone(), zoneIdentifier(), zoneIdentifier(), zoneIdentifier(), zoneIdentifier(), zoneIdentifier(), and ~zoneIdentifier().

Here is the call graph for this function:

Here is the caller graph for this function:

zoneIdentifier() [2/8]

zoneIdentifier ( zoneIdentifier && )

default

Move construct.

References zoneIdentifier().

Here is the call graph for this function:

~zoneIdentifier()

virtual ~zoneIdentifier ( )

virtualdefault

Destructor.

References dict, index(), inGroups(), name(), physicalType(), and zoneIdentifier().

Here is the call graph for this function:

zoneIdentifier() [3/8]

zoneIdentifier

(

)

Default construct: name="", index=0.

Definition at line 26 of file zoneIdentifier.C.

zoneIdentifier() [4/8]

zoneIdentifier	(	const word &	name,
		const label	index )

Construct from mandatory components.

Definition at line 32 of file zoneIdentifier.C.

References index(), and name().

Here is the call graph for this function:

zoneIdentifier() [5/8]

zoneIdentifier	(	const word &	name,
		const label	index,
		const word &	physicalType,
		const wordList &	inGroups = wordList() )

Construct from components.

Definition at line 43 of file zoneIdentifier.C.

References index(), inGroups(), name(), and physicalType().

Here is the call graph for this function:

zoneIdentifier() [6/8]

zoneIdentifier	(	const word &	name,
		const dictionary &	dict,
		const label	index )

Construct from dictionary.

Definition at line 58 of file zoneIdentifier.C.

References dict, index(), name(), and zoneIdentifier().

Here is the call graph for this function:

zoneIdentifier() [7/8]

zoneIdentifier	(	const zoneIdentifier &	ident,
		const label	newIndex )

Copy construct, resetting the index (if non-negative).

Definition at line 72 of file zoneIdentifier.C.

References zoneIdentifier().

Here is the call graph for this function:

zoneIdentifier() [8/8]

zoneIdentifier	(	zoneIdentifier &&	ident,
		const label	newIndex )

Move construct, resetting the index (if non-negative).

Definition at line 87 of file zoneIdentifier.C.

References zoneIdentifier().

Here is the call graph for this function:

Member Function Documentation

operator=() [1/2]

zoneIdentifier & operator= ( const zoneIdentifier & )

default

Copy assignment.

References zoneIdentifier().

Here is the call graph for this function:

operator=() [2/2]

zoneIdentifier & operator= ( zoneIdentifier && )

default

Move assignment.

References zoneIdentifier().

Here is the call graph for this function:

name() [1/2]

const word & name ( ) const

inlinenoexcept

The zone name.

Definition at line 164 of file zoneIdentifier.H.

References Foam::noexcept.

Referenced by multiBandZoneAbsorptionEmission::aCont(), addGroup(), meshRefinement::balance(), meshRefinement::checkCoupledFaceZones(), meshRefinement::createZoneBaffles(), snappyLayerDriver::doLayers(), multiBandZoneAbsorptionEmission::eCont(), meshRefinement::getZoneFaces(), meshRefinement::getZones(), inGroup(), Foam::operator<<(), removeGroup(), zone::TypeNameNoDebug(), FacePostProcessing< CloudType >::write(), ABAQUSsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), FLMAsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), cellZone::writeDict(), faceZone::writeDict(), pointZone::writeDict(), zone::zone(), zone::zone(), zone::zone(), zone::zone(), zoneIdentifier(), zoneIdentifier(), zoneIdentifier(), meshRefinement::zonify(), and ~zoneIdentifier().

Here is the caller graph for this function:

name() [2/2]

word & name ( )

inlinenoexcept

Modifiable zone name.

Definition at line 169 of file zoneIdentifier.H.

References Foam::noexcept.

index() [1/2]

label index ( ) const

inlinenoexcept

The index of this zone in the zone list.

Definition at line 174 of file zoneIdentifier.H.

References Foam::noexcept.

Referenced by cellZone::cellZone(), cellZone::cellZone(), cellZone::cellZone(), cellZone::cellZone(), cellZone::cellZone(), cellZone::cellZone(), cellZone::cellZone(), cellZone::cellZone(), faceZone::checkParallelSync(), pointZone::checkParallelSync(), cellZone::clone(), faceZone::clone(), faFaceZone::clone(), pointZone::clone(), cellZone::declareRunTimeSelectionTable(), faceZone::declareRunTimeSelectionTable(), pointZone::declareRunTimeSelectionTable(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faceZone::faceZone(), faFaceZone::faFaceZone(), faFaceZone::faFaceZone(), faFaceZone::faFaceZone(), faFaceZone::faFaceZone(), faFaceZone::faFaceZone(), faFaceZone::faFaceZone(), faFaceZone::faFaceZone(), cellZone::New(), faceZone::New(), pointZone::New(), pointZone::pointZone(), pointZone::pointZone(), pointZone::pointZone(), pointZone::pointZone(), pointZone::pointZone(), pointZone::pointZone(), pointZone::pointZone(), zone::TypeNameNoDebug(), zone::zone(), zone::zone(), zone::zone(), zone::zone(), zoneIdentifier(), zoneIdentifier(), zoneIdentifier(), and ~zoneIdentifier().

index() [2/2]

label & index ( )

inlinenoexcept

Modifiable index of this zone in the zone list.

Definition at line 179 of file zoneIdentifier.H.

References Foam::noexcept.

physicalType() [1/2]

const word & physicalType ( ) const

inlinenoexcept

The (optional) type of the zone.

Definition at line 184 of file zoneIdentifier.H.

References Foam::noexcept.

Referenced by zoneIdentifier(), and ~zoneIdentifier().

Here is the caller graph for this function:

physicalType() [2/2]

word & physicalType ( )

inlinenoexcept

Modifiable (optional) type of the zone.

Definition at line 189 of file zoneIdentifier.H.

References Foam::noexcept.

inGroups() [1/2]

const wordList & inGroups ( ) const

inlinenoexcept

The (optional) groups that the zone belongs to.

Definition at line 194 of file zoneIdentifier.H.

References Foam::noexcept.

Referenced by zoneIdentifier(), and ~zoneIdentifier().

Here is the caller graph for this function:

inGroups() [2/2]

wordList & inGroups ( )

inlinenoexcept

Modifiable (optional) groups that the zone belongs to.

Definition at line 199 of file zoneIdentifier.H.

References Foam::noexcept.

inGroup()

bool inGroup ( const word & name ) const

inline

True if given name is in a group.

Definition at line 204 of file zoneIdentifier.H.

References name().

Here is the call graph for this function:

addGroup()

void addGroup ( const word & name )

inline

Add (unique) group for the zone.

Definition at line 212 of file zoneIdentifier.H.

References name().

Here is the call graph for this function:

removeGroup()

void removeGroup

(

const word &

name

)

Remove group for the zone.

Definition at line 104 of file zoneIdentifier.C.

References name().

Here is the call graph for this function:

write()

void write

(

Ostream &

os

)

const

Write (physicalType, inGroups) dictionary entries (without surrounding braces).

Definition at line 123 of file zoneIdentifier.C.

References os().

Referenced by Foam::operator<<(), and zone::write().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/OpenFOAM/meshes/Identifiers/zone/zoneIdentifier.H
• src/OpenFOAM/meshes/Identifiers/zone/zoneIdentifier.C