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

Inheritance diagram for zoneIdentifier:

Public Member Functions
	zoneIdentifier (const zoneIdentifier &)=default
	Copy construct. More...

zoneIdentifier &	operator= (const zoneIdentifier &)=default
	Copy assignment. More...

virtual	~zoneIdentifier ()=default
	Destructor. More...

	zoneIdentifier ()
	Default construct. Uses name="", index=0. More...

	zoneIdentifier (const word &name, const label index)
	Construct from mandatory components. More...

	zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components. More...

	zoneIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...

	zoneIdentifier (const zoneIdentifier &ident, const label index)
	Copy construct, resetting the index. More...

const word &	name () const noexcept
	The zone name. More...

word &	name () noexcept
	Modifiable zone name. More...

label	index () const noexcept
	The index of this zone in the zone list. More...

label &	index () noexcept
	Modifiable index of this zone in the zone list. More...

const word &	physicalType () const noexcept
	The (optional) type of the zone. More...

word &	physicalType () noexcept
	Modifiable (optional) type of the zone. More...

const wordList &	inGroups () const noexcept
	The (optional) groups that the zone belongs to. More...

wordList &	inGroups () noexcept
	Modifiable (optional) groups that the zone belongs to. More...

bool	inGroup (const word &name) const
	True if given name is in a group. More...

void	write (Ostream &os) const

Detailed Description

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

See also: patchIdentifier

Source files

Definition at line 57 of file zoneIdentifier.H.

Constructor & Destructor Documentation

◆ zoneIdentifier() [1/6]

zoneIdentifier ( const zoneIdentifier & )

default

Copy construct.

◆ ~zoneIdentifier()

virtual ~zoneIdentifier ( )

virtualdefault

Destructor.

◆ zoneIdentifier() [2/6]

zoneIdentifier ( )

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

Definition at line 33 of file zoneIdentifier.C.

◆ zoneIdentifier() [3/6]

zoneIdentifier	(	const word &	name,
		const label	index
	)

Construct from mandatory components.

Definition at line 40 of file zoneIdentifier.C.

◆ zoneIdentifier() [4/6]

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

Construct from components.

Definition at line 51 of file zoneIdentifier.C.

◆ zoneIdentifier() [5/6]

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

Construct from dictionary.

Definition at line 66 of file zoneIdentifier.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ zoneIdentifier() [6/6]

zoneIdentifier	(	const zoneIdentifier &	ident,
		const label	index
	)

Copy construct, resetting the index.

Definition at line 80 of file zoneIdentifier.C.

Member Function Documentation

◆ operator=()

zoneIdentifier & operator= ( const zoneIdentifier & )

default

Copy assignment.

◆ name() [1/2]

const word & name ( ) const

inlinenoexcept

The zone name.

Definition at line 123 of file zoneIdentifier.H.

Referenced by multiBandZoneAbsorptionEmission::aCont(), meshRefinement::balance(), meshRefinement::checkCoupledFaceZones(), meshRefinement::createZoneBaffles(), snappyLayerDriver::doLayers(), multiBandZoneAbsorptionEmission::eCont(), meshRefinement::getZoneFaces(), meshRefinement::getZones(), zoneIdentifier::inGroup(), cellZone::New(), faceZone::New(), pointZone::New(), fvMeshDistribute::printMeshInfo(), FacePostProcessing< CloudType >::write(), ABAQUSsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), FLMAsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ name() [2/2]

word & name ( )

inlinenoexcept

Modifiable zone name.

Definition at line 129 of file zoneIdentifier.H.

◆ index() [1/2]

label index ( ) const

inlinenoexcept

The index of this zone in the zone list.

Definition at line 135 of file zoneIdentifier.H.

Referenced by cellZone::clone(), faceZone::clone(), pointZone::clone(), cellZone::New(), faceZone::New(), and pointZone::New().

Here is the caller graph for this function:

◆ index() [2/2]

label & index ( )

inlinenoexcept

Modifiable index of this zone in the zone list.

Definition at line 141 of file zoneIdentifier.H.

◆ physicalType() [1/2]

const word & physicalType ( ) const

inlinenoexcept

The (optional) type of the zone.

Definition at line 147 of file zoneIdentifier.H.

◆ physicalType() [2/2]

word & physicalType ( )

inlinenoexcept

Modifiable (optional) type of the zone.

Definition at line 153 of file zoneIdentifier.H.

◆ inGroups() [1/2]

const wordList & inGroups ( ) const

inlinenoexcept

The (optional) groups that the zone belongs to.

Definition at line 159 of file zoneIdentifier.H.

◆ inGroups() [2/2]

wordList & inGroups ( )

inlinenoexcept

Modifiable (optional) groups that the zone belongs to.

Definition at line 165 of file zoneIdentifier.H.

◆ inGroup()

bool inGroup ( const word & name ) const

inline

True if given name is in a group.

Definition at line 171 of file zoneIdentifier.H.

References UList< T >::found(), and zoneIdentifier::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 95 of file zoneIdentifier.C.

References token::END_STATEMENT, Foam::nl, os(), Ostream::writeEntry(), and Ostream::writeKeyword().

Referenced by Foam::operator<<().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ zoneIdentifier() [1/6]

◆ ~zoneIdentifier()

◆ zoneIdentifier() [2/6]

◆ zoneIdentifier() [3/6]

◆ zoneIdentifier() [4/6]

◆ zoneIdentifier() [5/6]

◆ zoneIdentifier() [6/6]

Member Function Documentation

◆ operator=()

◆ name() [1/2]

◆ name() [2/2]

◆ index() [1/2]

◆ index() [2/2]

◆ physicalType() [1/2]

◆ physicalType() [2/2]

◆ inGroups() [1/2]

◆ inGroups() [2/2]

◆ inGroup()

◆ write()