Identifies a surface patch/zone by name and index, with optional geometric type. More...
Public Member Functions | |
surfZoneIdentifier (const surfZoneIdentifier &)=default | |
Copy construct. More... | |
surfZoneIdentifier & | operator= (const surfZoneIdentifier &)=default |
Copy assignment. More... | |
surfZoneIdentifier () | |
Default construct. Uses name="", index=0. More... | |
surfZoneIdentifier (const label index) | |
Construct null with specified index. More... | |
surfZoneIdentifier (const word &name, const label index) | |
Construct from mandatory components. More... | |
surfZoneIdentifier (const word &name, const label index, const word &geometricType) | |
Construct from components. More... | |
surfZoneIdentifier (const word &name, const dictionary &dict, const label index) | |
Construct from dictionary. More... | |
surfZoneIdentifier (const surfZoneIdentifier &ident, const label index) | |
Copy construct, resetting the index. More... | |
const word & | name () const |
The patch/zone name. More... | |
word & | name () |
Modifiable patch/zone name. More... | |
const word & | geometricType () const |
The geometric type of the patch/zone. More... | |
word & | geometricType () |
Modifiable geometric type of the patch/zone. More... | |
label | index () const |
The index of this patch/zone in the surface mesh. More... | |
label & | index () |
Modifiable index of this patch/zone in the surface mesh. More... | |
void | write (Ostream &os) const |
Write (geometricType) dictionary entry (without surrounding braces) More... | |
Static Public Member Functions | |
static word | defaultName (const label n=-1) |
Default zone name: "zone" or "zoneN". More... | |
Static Public Attributes | |
static constexpr const char *const | emptyType = "empty" |
The name for an 'empty' type. More... | |
Identifies a surface patch/zone by name and index, with optional geometric type.
Definition at line 55 of file surfZoneIdentifier.H.
|
default |
Copy construct.
Default construct. Uses name="", index=0.
Definition at line 27 of file surfZoneIdentifier.C.
|
explicit |
Construct null with specified index.
Definition at line 33 of file surfZoneIdentifier.C.
surfZoneIdentifier | ( | const word & | name, |
const label | index | ||
) |
Construct from mandatory components.
Definition at line 42 of file surfZoneIdentifier.C.
surfZoneIdentifier | ( | const word & | name, |
const label | index, | ||
const word & | geometricType | ||
) |
Construct from components.
Definition at line 54 of file surfZoneIdentifier.C.
surfZoneIdentifier | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index | ||
) |
Construct from dictionary.
Definition at line 67 of file surfZoneIdentifier.C.
References dict, and dictionary::readIfPresent().
surfZoneIdentifier | ( | const surfZoneIdentifier & | ident, |
const label | index | ||
) |
Copy construct, resetting the index.
Definition at line 82 of file surfZoneIdentifier.C.
|
inlinestatic |
Default zone name: "zone" or "zoneN".
Definition at line 89 of file surfZoneIdentifier.H.
References n.
Referenced by UnsortedMeshedSurface< Face >::setZones(), and UnsortedMeshedSurface< Face >::sortedZones().
|
default |
Copy assignment.
|
inline |
The patch/zone name.
Definition at line 165 of file surfZoneIdentifier.H.
Referenced by surfZone::New(), Foam::operator<<(), Foam::operator==(), and Foam::operator>>().
|
inline |
Modifiable patch/zone name.
Definition at line 173 of file surfZoneIdentifier.H.
|
inline |
The geometric type of the patch/zone.
Definition at line 181 of file surfZoneIdentifier.H.
Referenced by Foam::operator<<(), Foam::operator==(), and Foam::operator>>().
|
inline |
Modifiable geometric type of the patch/zone.
Definition at line 189 of file surfZoneIdentifier.H.
|
inline |
The index of this patch/zone in the surface mesh.
Definition at line 197 of file surfZoneIdentifier.H.
Referenced by Foam::operator==(), and surfZone::surfZone().
|
inline |
Modifiable index of this patch/zone in the surface mesh.
Definition at line 205 of file surfZoneIdentifier.H.
void write | ( | Ostream & | os | ) | const |
Write (geometricType) dictionary entry (without surrounding braces)
Definition at line 95 of file surfZoneIdentifier.C.
References os(), and Ostream::writeEntry().
Referenced by surfZone::write().
|
static |
The name for an 'empty' type.
Definition at line 81 of file surfZoneIdentifier.H.