Identifies a surface patch/zone by name and index, with geometric type. More...
Classes | |
struct | fromIdentifier |
Helper to convert identifier types as an operation. More... | |
Public Member Functions | |
geometricSurfacePatch (const geometricSurfacePatch &)=default | |
Copy construct. More... | |
geometricSurfacePatch & | operator= (const geometricSurfacePatch &)=default |
Copy assignment. More... | |
geometricSurfacePatch () | |
Default construct. Uses name="patch", index=0, type="". More... | |
geometricSurfacePatch (const label index) | |
Construct null with specified index. Uses name="patch", type="". More... | |
geometricSurfacePatch (const word &name, const label index) | |
Construct from mandatory components, type="". More... | |
geometricSurfacePatch (const word &name, const label index, const word &geometricType) | |
Construct from components. More... | |
geometricSurfacePatch (const word &name, const dictionary &dict, const label index) | |
Construct from dictionary. More... | |
geometricSurfacePatch (const surfZoneIdentifier &ident) | |
Implicit conversion from surfZoneIdentifier. More... | |
const word & | name () const noexcept |
The patch/zone name. More... | |
word & | name () noexcept |
Modifiable patch/zone name. More... | |
label | index () const noexcept |
The index of this patch/zone in the surface mesh. More... | |
label & | index () noexcept |
Modifiable index of this patch/zone in the surface mesh. More... | |
const word & | geometricType () const noexcept |
The geometric type of the patch/zone. More... | |
word & | geometricType () noexcept |
Modifiable geometric type of the patch/zone. More... | |
void | write (Ostream &os) const |
Write (geometricType) dictionary entry (without surrounding braces) More... | |
geometricSurfacePatch (Istream &is, const label index)=delete | |
Removed(2020-01) Construct from Istream. More... | |
geometricSurfacePatch (const word &geometricType, const word &name, const label index) | |
Deprecated(2020-01) Construct from components. More... | |
void | writeDict (Ostream &os) const |
Deprecated(2020-01) Write dictionary. More... | |
Static Public Member Functions | |
static word | defaultName (const label n=-1) |
Default patch name: "patch" or "patchN". 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 geometric type.
Definition at line 49 of file geometricSurfacePatch.H.
|
default |
Copy construct.
Default construct. Uses name="patch", index=0, type="".
Definition at line 27 of file geometricSurfacePatch.C.
Referenced by geometricSurfacePatch::fromIdentifier::operator()().
|
explicit |
Construct null with specified index. Uses name="patch", type="".
Definition at line 33 of file geometricSurfacePatch.C.
geometricSurfacePatch | ( | const word & | name, |
const label | index | ||
) |
Construct from mandatory components, type="".
Definition at line 42 of file geometricSurfacePatch.C.
geometricSurfacePatch | ( | const word & | name, |
const label | index, | ||
const word & | geometricType | ||
) |
Construct from components.
Definition at line 54 of file geometricSurfacePatch.C.
geometricSurfacePatch | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index | ||
) |
Construct from dictionary.
Definition at line 67 of file geometricSurfacePatch.C.
References dict, and dictionary::readIfPresent().
geometricSurfacePatch | ( | const surfZoneIdentifier & | ident | ) |
Implicit conversion from surfZoneIdentifier.
Definition at line 80 of file geometricSurfacePatch.C.
|
delete |
Removed(2020-01) Construct from Istream.
|
inline |
Deprecated(2020-01) Construct from components.
Definition at line 245 of file geometricSurfacePatch.H.
|
inlinestatic |
Default patch name: "patch" or "patchN".
Definition at line 83 of file geometricSurfacePatch.H.
References n.
Referenced by boundaryMesh::readTriSurface().
|
default |
Copy assignment.
|
inlinenoexcept |
The patch/zone name.
Definition at line 175 of file geometricSurfacePatch.H.
Referenced by Foam::operator<<(), Foam::operator==(), Foam::operator>>(), and boundaryMesh::readTriSurface().
|
inlinenoexcept |
Modifiable patch/zone name.
Definition at line 183 of file geometricSurfacePatch.H.
|
inlinenoexcept |
The index of this patch/zone in the surface mesh.
Definition at line 191 of file geometricSurfacePatch.H.
|
inlinenoexcept |
Modifiable index of this patch/zone in the surface mesh.
Definition at line 199 of file geometricSurfacePatch.H.
|
inlinenoexcept |
The geometric type of the patch/zone.
Definition at line 207 of file geometricSurfacePatch.H.
Referenced by Foam::operator<<(), Foam::operator==(), Foam::operator>>(), and boundaryMesh::readTriSurface().
|
inlinenoexcept |
Modifiable geometric type of the patch/zone.
Definition at line 215 of file geometricSurfacePatch.H.
void write | ( | Ostream & | os | ) | const |
Write (geometricType) dictionary entry (without surrounding braces)
Definition at line 90 of file geometricSurfacePatch.C.
References os(), and Ostream::writeEntry().
Referenced by surfacePatch::write(), and geometricSurfacePatch::writeDict().
|
inline |
Deprecated(2020-01) Write dictionary.
Definition at line 260 of file geometricSurfacePatch.H.
References os(), and geometricSurfacePatch::write().
|
static |
The name for an 'empty' type.
Definition at line 75 of file geometricSurfacePatch.H.
Referenced by boundaryMesh::readTriSurface().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.