Loading...
Searching...
No Matches
geometricSurfacePatch Class Reference

Identifies a surface patch/zone by name and index, with geometric type. More...

#include <geometricSurfacePatch.H>

Inheritance diagram for geometricSurfacePatch:
Inheritance graph
[legend]

Classes

struct  fromIdentifier
 Helper to convert identifier types as an operation. More...

Public Member Functions

 geometricSurfacePatch (const geometricSurfacePatch &)=default
 Copy construct.
 geometricSurfacePatch (geometricSurfacePatch &&)=default
 Move construct.
geometricSurfacePatch & operator= (const geometricSurfacePatch &)=default
 Copy assignment.
geometricSurfacePatch & operator= (geometricSurfacePatch &&)=default
 Move assignment.
 geometricSurfacePatch ()
 Default construct. Uses name="patch", index=0, type="".
 geometricSurfacePatch (const label index)
 Construct null with specified index. Uses name="patch", type="".
 geometricSurfacePatch (const word &name, const label index)
 Construct from mandatory components, type="".
 geometricSurfacePatch (const word &name, const label index, const word &geometricType)
 Construct from components.
 geometricSurfacePatch (const word &name, const dictionary &dict, const label index)
 Construct from dictionary.
 geometricSurfacePatch (const surfZoneIdentifier &ident)
 Implicit conversion from surfZoneIdentifier.
const word & name () const noexcept
 The patch/zone name.
word & name () noexcept
 Modifiable patch/zone name.
label index () const noexcept
 The index of this patch/zone in the surface mesh.
label & index () noexcept
 Modifiable index of this patch/zone in the surface mesh.
const word & geometricType () const noexcept
 The geometric type of the patch/zone.
word & geometricType () noexcept
 Modifiable geometric type of the patch/zone.
void write (Ostream &os) const
 Write (geometricType) dictionary entry (without surrounding braces).
 geometricSurfacePatch (Istream &is, const label index)=delete
 Removed(2020-01) Construct from Istream.
 geometricSurfacePatch (const word &geometricType, const word &name, const label index)
 Deprecated(2020-01) Construct from components.
void writeDict (Ostream &os) const
 Deprecated(2020-01) Write dictionary.

Static Public Member Functions

static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN".

Static Public Attributes

static constexpr const char *const emptyType = "empty"
 The name for an 'empty' type.

Detailed Description

Identifies a surface patch/zone by name and index, with geometric type.

Source files

Definition at line 49 of file geometricSurfacePatch.H.

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/10]

geometricSurfacePatch ( const geometricSurfacePatch & )
default

Copy construct.

References geometricSurfacePatch().

Referenced by geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch::fromIdentifier::operator()(), operator=(), operator=(), surfacePatch::surfacePatch(), surfacePatch::surfacePatch(), and surfacePatch::surfacePatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ geometricSurfacePatch() [2/10]

geometricSurfacePatch ( geometricSurfacePatch && )
default

Move construct.

References geometricSurfacePatch().

Here is the call graph for this function:

◆ geometricSurfacePatch() [3/10]

geometricSurfacePatch ( )

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

Definition at line 27 of file geometricSurfacePatch.C.

Referenced by geometricSurfacePatch::fromIdentifier::operator()().

Here is the caller graph for this function:

◆ geometricSurfacePatch() [4/10]

geometricSurfacePatch ( const label index)
explicit

Construct null with specified index. Uses name="patch", type="".

Definition at line 34 of file geometricSurfacePatch.C.

References index().

Here is the call graph for this function:

◆ geometricSurfacePatch() [5/10]

geometricSurfacePatch ( const word & name,
const label index )

Construct from mandatory components, type="".

Definition at line 41 of file geometricSurfacePatch.C.

References index(), and name().

Here is the call graph for this function:

◆ geometricSurfacePatch() [6/10]

geometricSurfacePatch ( const word & name,
const label index,
const word & geometricType )

Construct from components.

Definition at line 52 of file geometricSurfacePatch.C.

References geometricType(), index(), and name().

Here is the call graph for this function:

◆ geometricSurfacePatch() [7/10]

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

Construct from dictionary.

Definition at line 65 of file geometricSurfacePatch.C.

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

Here is the call graph for this function:

◆ geometricSurfacePatch() [8/10]

geometricSurfacePatch ( const surfZoneIdentifier & ident)

Implicit conversion from surfZoneIdentifier.

Definition at line 78 of file geometricSurfacePatch.C.

References geometricSurfacePatch(), geometricType(), index(), and name().

Here is the call graph for this function:

◆ geometricSurfacePatch() [9/10]

geometricSurfacePatch ( Istream & is,
const label index )
delete

Removed(2020-01) Construct from Istream.

Deprecated
(2020-01) - unused, inconsistent

References index().

Here is the call graph for this function:

◆ geometricSurfacePatch() [10/10]

geometricSurfacePatch ( const word & geometricType,
const word & name,
const label index )
inline

Deprecated(2020-01) Construct from components.

Deprecated
(2020-01) - order inconsistent with other identifiers

Definition at line 237 of file geometricSurfacePatch.H.

References geometricSurfacePatch(), geometricType(), index(), and name().

Here is the call graph for this function:

Member Function Documentation

◆ defaultName()

word defaultName ( const label n = -1)
inlinestatic

Default patch name: "patch" or "patchN".

Definition at line 83 of file geometricSurfacePatch.H.

References n.

Referenced by boundaryMesh::readTriSurface().

Here is the caller graph for this function:

◆ operator=() [1/2]

geometricSurfacePatch & operator= ( const geometricSurfacePatch & )
default

Copy assignment.

References geometricSurfacePatch().

Here is the call graph for this function:

◆ operator=() [2/2]

geometricSurfacePatch & operator= ( geometricSurfacePatch && )
default

Move assignment.

References dict, geometricSurfacePatch(), geometricType(), index(), and name().

Here is the call graph for this function:

◆ name() [1/2]

const word & name ( ) const
inlinenoexcept

The patch/zone name.

Definition at line 186 of file geometricSurfacePatch.H.

References Foam::noexcept.

Referenced by geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), Foam::operator<<(), operator=(), surfacePatch::operator=(), Foam::operator==(), Foam::operator>>(), boundaryMesh::readTriSurface(), surfacePatch::surfacePatch(), surfacePatch::surfacePatch(), and surfacePatch::surfacePatch().

Here is the caller graph for this function:

◆ name() [2/2]

word & name ( )
inlinenoexcept

Modifiable patch/zone name.

Definition at line 191 of file geometricSurfacePatch.H.

References Foam::noexcept.

◆ index() [1/2]

label index ( ) const
inlinenoexcept

The index of this patch/zone in the surface mesh.

Definition at line 196 of file geometricSurfacePatch.H.

References Foam::noexcept.

Referenced by geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), operator=(), surfacePatch::operator=(), surfacePatch::surfacePatch(), surfacePatch::surfacePatch(), surfacePatch::surfacePatch(), surfacePatch::surfacePatch(), and surfacePatch::surfacePatch().

Here is the caller graph for this function:

◆ index() [2/2]

label & index ( )
inlinenoexcept

Modifiable index of this patch/zone in the surface mesh.

Definition at line 201 of file geometricSurfacePatch.H.

References Foam::noexcept.

◆ geometricType() [1/2]

const word & geometricType ( ) const
inlinenoexcept

The geometric type of the patch/zone.

Definition at line 206 of file geometricSurfacePatch.H.

References Foam::noexcept.

Referenced by geometricSurfacePatch(), geometricSurfacePatch(), geometricSurfacePatch(), Foam::operator<<(), operator=(), surfacePatch::operator=(), Foam::operator==(), Foam::operator==(), Foam::operator>>(), boundaryMesh::readTriSurface(), surfacePatch::surfacePatch(), and surfacePatch::surfacePatch().

Here is the caller graph for this function:

◆ geometricType() [2/2]

word & geometricType ( )
inlinenoexcept

Modifiable geometric type of the patch/zone.

Definition at line 211 of file geometricSurfacePatch.H.

References Foam::noexcept.

◆ write()

void write ( Ostream & os) const

Write (geometricType) dictionary entry (without surrounding braces).

Warning
Prior to 2020-01 was identical to operator<< output

Definition at line 89 of file geometricSurfacePatch.C.

References os().

Referenced by surfacePatch::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeDict()

void writeDict ( Ostream & os) const
inline

Deprecated(2020-01) Write dictionary.

Deprecated
(2020-01) - Write dictionary

Definition at line 253 of file geometricSurfacePatch.H.

References os(), write(), and writeDict().

Referenced by writeDict().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ emptyType

const char* const emptyType = "empty"
staticconstexpr

The name for an 'empty' type.

Definition at line 75 of file geometricSurfacePatch.H.

Referenced by boundaryMesh::readTriSurface().

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