Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
geometricSurfacePatch Class Reference

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

Inheritance diagram for geometricSurfacePatch:
[legend]

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 ()
 
 geometricSurfacePatch (const label index)
 
 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
 
 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...
 

Detailed Description

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

Source files

Definition at line 53 of file geometricSurfacePatch.H.

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/9]

geometricSurfacePatch ( const geometricSurfacePatch &  )
default

Copy construct.

◆ geometricSurfacePatch() [2/9]

geometricSurfacePatch ( )

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

Definition at line 34 of file geometricSurfacePatch.C.

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

Here is the caller graph for this function:

◆ geometricSurfacePatch() [3/9]

geometricSurfacePatch ( const label  index)
explicit

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

Definition at line 40 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [4/9]

geometricSurfacePatch ( const word &  name,
const label  index 
)

Construct from mandatory components, type="".

Definition at line 49 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [5/9]

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

Construct from components.

Definition at line 61 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [6/9]

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

Construct from dictionary.

Definition at line 74 of file geometricSurfacePatch.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ geometricSurfacePatch() [7/9]

geometricSurfacePatch ( const surfZoneIdentifier &  ident)

Implicit conversion from surfZoneIdentifier.

Definition at line 87 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [8/9]

geometricSurfacePatch ( Istream &  is,
const label  index 
)
delete

Removed(2020-01) Construct from Istream.

Deprecated:
(2020-01) - unused, inconsistent

◆ geometricSurfacePatch() [9/9]

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 200 of file geometricSurfacePatch.H.

Member Function Documentation

◆ defaultName()

static word defaultName ( const label  n = -1)
inlinestatic

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

Definition at line 77 of file geometricSurfacePatch.H.

References n.

Referenced by boundaryMesh::readTriSurface().

Here is the caller graph for this function:

◆ operator=()

geometricSurfacePatch& operator= ( const geometricSurfacePatch &  )
default

Copy assignment.

◆ name() [1/2]

const word& name ( ) const
inlinenoexcept

The patch/zone name.

Definition at line 149 of file geometricSurfacePatch.H.

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

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )
inlinenoexcept

Modifiable patch/zone name.

Definition at line 155 of file geometricSurfacePatch.H.

◆ index() [1/2]

label index ( ) const
inlinenoexcept

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

Definition at line 161 of file geometricSurfacePatch.H.

◆ index() [2/2]

label& index ( )
inlinenoexcept

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

Definition at line 167 of file geometricSurfacePatch.H.

◆ geometricType() [1/2]

const word& geometricType ( ) const
inlinenoexcept

The geometric type of the patch/zone.

Definition at line 173 of file geometricSurfacePatch.H.

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

Here is the caller graph for this function:

◆ geometricType() [2/2]

word& geometricType ( )
inlinenoexcept

Modifiable geometric type of the patch/zone.

Definition at line 179 of file geometricSurfacePatch.H.

◆ 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 97 of file geometricSurfacePatch.C.

References os(), and Ostream::writeEntry().

Referenced by surfacePatch::write(), and geometricSurfacePatch::writeDict().

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 212 of file geometricSurfacePatch.H.

References os(), and geometricSurfacePatch::write().

Here is the call graph for this function:

Member Data Documentation

◆ emptyType

constexpr const char* const emptyType = "empty"
staticconstexpr

The name for an 'empty' type.

Definition at line 71 of file geometricSurfacePatch.H.

Referenced by boundaryMesh::readTriSurface().

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