Public Member Functions | List of all members
zoneIdentifier Class Reference

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

Inheritance diagram for zoneIdentifier:
Inheritance graph
[legend]

Public Member Functions

 zoneIdentifier (const zoneIdentifier &)=default
 
zoneIdentifieroperator= (const zoneIdentifier &)=default
 
virtual ~zoneIdentifier ()=default
 
 zoneIdentifier ()
 
 zoneIdentifier (const word &name, const label index)
 
 zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 
 zoneIdentifier (const word &name, const dictionary &dict, const label index)
 
 zoneIdentifier (const zoneIdentifier &ident, const label index)
 
const wordname () const noexcept
 
wordname () noexcept
 
label index () const noexcept
 
label & index () noexcept
 
const wordphysicalType () const noexcept
 
wordphysicalType () noexcept
 
const wordListinGroups () const noexcept
 
wordListinGroups () noexcept
 
bool inGroup (const word &name) const
 
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 53 of file zoneIdentifier.H.

Constructor & Destructor Documentation

◆ zoneIdentifier() [1/6]

zoneIdentifier ( const zoneIdentifier )
default

◆ ~zoneIdentifier()

virtual ~zoneIdentifier ( )
virtualdefault

◆ zoneIdentifier() [2/6]

Definition at line 26 of file zoneIdentifier.C.

◆ zoneIdentifier() [3/6]

zoneIdentifier ( const word name,
const label  index 
)

Definition at line 34 of file zoneIdentifier.C.

◆ zoneIdentifier() [4/6]

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

Definition at line 45 of file zoneIdentifier.C.

◆ zoneIdentifier() [5/6]

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

Definition at line 60 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 
)

Definition at line 74 of file zoneIdentifier.C.

Member Function Documentation

◆ operator=()

zoneIdentifier& operator= ( const zoneIdentifier )
default

◆ name() [1/2]

const word& name ( ) const
inlinenoexcept

◆ name() [2/2]

word& name ( )
inlinenoexcept

Definition at line 125 of file zoneIdentifier.H.

◆ index() [1/2]

label index ( ) const
inlinenoexcept

Definition at line 131 of file zoneIdentifier.H.

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

Here is the caller graph for this function:

◆ index() [2/2]

label& index ( )
inlinenoexcept

Definition at line 137 of file zoneIdentifier.H.

◆ physicalType() [1/2]

const word& physicalType ( ) const
inlinenoexcept

Definition at line 143 of file zoneIdentifier.H.

◆ physicalType() [2/2]

word& physicalType ( )
inlinenoexcept

Definition at line 149 of file zoneIdentifier.H.

◆ inGroups() [1/2]

const wordList& inGroups ( ) const
inlinenoexcept

Definition at line 155 of file zoneIdentifier.H.

◆ inGroups() [2/2]

wordList& inGroups ( )
inlinenoexcept

Definition at line 161 of file zoneIdentifier.H.

◆ inGroup()

bool inGroup ( const word name) const
inline

Definition at line 167 of file zoneIdentifier.H.

References zoneIdentifier::name().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const

Definition at line 88 of file zoneIdentifier.C.

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

Referenced by Foam::operator<<(), cellZone::writeDict(), pointZone::writeDict(), and faceZone::writeDict().

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: