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

The geometricSurfacePatch is like patchIdentifier but for surfaces. Holds type, name and index. More...

Inheritance diagram for geometricSurfacePatch:
[legend]
Collaboration diagram for geometricSurfacePatch:
[legend]

Classes

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

Public Member Functions

 ClassName ("geometricSurfacePatch")
 Runtime type information. More...
 
 geometricSurfacePatch ()
 Construct null. More...
 
 geometricSurfacePatch (const label index)
 Construct null with specified index. More...
 
 geometricSurfacePatch (const word &name, const label index, const word &geometricType=word::null)
 Construct from components. More...
 
 geometricSurfacePatch (const word &geometricType, const word &name, const label index)
 Construct from components. More...
 
 geometricSurfacePatch (const surfZoneIdentifier &ident)
 
 geometricSurfacePatch (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 geometricSurfacePatch (Istream &is, const label index)
 Construct from Istream. More...
 
const word & name () const
 Return name. More...
 
word & name ()
 Return name. More...
 
const word & geometricType () const
 Return the geometric type of the patch. More...
 
word & geometricType ()
 Return the geometric type of the patch for modification. More...
 
label index () const
 Return the index of this patch in the surface mesh. More...
 
label & index ()
 Return the index of this patch in the surface mesh for modification. More...
 
void write (Ostream &os) const
 Write. More...
 
void writeDict (Ostream &os) const
 Write dictionary. More...
 

Static Public Attributes

static const word emptyType = "empty"
 The name for an 'empty' type. More...
 

Friends

Istream & operator>> (Istream &is, geometricSurfacePatch &p)
 
Ostream & operator<< (Ostream &os, const geometricSurfacePatch &p)
 

Detailed Description

The geometricSurfacePatch is like patchIdentifier but for surfaces. Holds type, name and index.

Source files

Definition at line 60 of file geometricSurfacePatch.H.

Constructor & Destructor Documentation

◆ geometricSurfacePatch() [1/7]

geometricSurfacePatch ( )

Construct null.

Definition at line 44 of file geometricSurfacePatch.C.

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

Here is the caller graph for this function:

◆ geometricSurfacePatch() [2/7]

geometricSurfacePatch ( const label  index)
explicit

Construct null with specified index.

Definition at line 52 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [3/7]

geometricSurfacePatch ( const word &  name,
const label  index,
const word &  geometricType = word::null 
)

Construct from components.

Definition at line 61 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [4/7]

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

Construct from components.

Definition at line 79 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [5/7]

geometricSurfacePatch ( const surfZoneIdentifier &  ident)

Implicit conversion from surfZoneIdentifier, which has similar information but in a different order

Definition at line 97 of file geometricSurfacePatch.C.

◆ geometricSurfacePatch() [6/7]

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

Construct from dictionary.

Definition at line 130 of file geometricSurfacePatch.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ geometricSurfacePatch() [7/7]

geometricSurfacePatch ( Istream &  is,
const label  index 
)

Construct from Istream.

Definition at line 113 of file geometricSurfacePatch.C.

Member Function Documentation

◆ ClassName()

ClassName ( "geometricSurfacePatch"  )

Runtime type information.

◆ name() [1/2]

const word& name ( ) const
inline

Return name.

Definition at line 138 of file geometricSurfacePatch.H.

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

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )
inline

Return name.

Definition at line 144 of file geometricSurfacePatch.H.

◆ geometricType() [1/2]

const word& geometricType ( ) const
inline

Return the geometric type of the patch.

Definition at line 150 of file geometricSurfacePatch.H.

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

Here is the caller graph for this function:

◆ geometricType() [2/2]

word& geometricType ( )
inline

Return the geometric type of the patch for modification.

Definition at line 156 of file geometricSurfacePatch.H.

◆ index() [1/2]

label index ( ) const
inline

Return the index of this patch in the surface mesh.

Definition at line 162 of file geometricSurfacePatch.H.

◆ index() [2/2]

label& index ( )
inline

Return the index of this patch in the surface mesh for modification.

Definition at line 168 of file geometricSurfacePatch.H.

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 146 of file geometricSurfacePatch.C.

References Foam::nl.

◆ writeDict()

void writeDict ( Ostream &  os) const

Write dictionary.

Definition at line 153 of file geometricSurfacePatch.C.

References Ostream::writeEntry().

Referenced by surfacePatch::writeDict().

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

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  is,
geometricSurfacePatch &  p 
)
friend

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const geometricSurfacePatch &  p 
)
friend

Member Data Documentation

◆ emptyType

const Foam::word emptyType = "empty"
static

The name for an 'empty' type.

Definition at line 78 of file geometricSurfacePatch.H.

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