Public Member Functions | List of all members
boundaryPatch Class Reference

Like polyPatch but without reference to mesh. Used in boundaryMesh to hold data on patches. The patchIdentifier::index is set, but not used. More...

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

Public Member Functions

 boundaryPatch (const word &name, const label index, const label size, const label start, const word &physicalType=word::null)
 Construct from components. More...
 
 boundaryPatch (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 boundaryPatch (const boundaryPatch &p, const label index)
 Copy construct, resetting the index. More...
 
autoPtr< boundaryPatch > clone () const
 Clone. More...
 
label size () const
 
label & size ()
 
label start () const
 
label & start ()
 
virtual void write (Ostream &os) const
 Write dictionary entries (without surrounding braces) More...
 
- Public Member Functions inherited from patchIdentifier
 patchIdentifier (const patchIdentifier &)=default
 Copy construct. More...
 
patchIdentifier & operator= (const patchIdentifier &)=default
 Copy assignment. More...
 
virtual ~patchIdentifier ()=default
 Destructor. More...
 
 patchIdentifier ()
 Default construct. Uses name="", index=0. More...
 
 patchIdentifier (const word &name, const label index)
 Construct from mandatory components. More...
 
 patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 Construct from components. More...
 
 patchIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary. More...
 
 patchIdentifier (const patchIdentifier &ident, const label index)
 Copy construct, resetting the index. More...
 
const word & name () const noexcept
 The patch name. More...
 
word & name () noexcept
 Modifiable patch name. More...
 
label index () const noexcept
 The index of this patch in the boundaryMesh. More...
 
label & index () noexcept
 Modifiable index of this patch in the boundaryMesh. More...
 
const word & physicalType () const noexcept
 The (optional) physical type of the patch. More...
 
word & physicalType () noexcept
 Modifiable (optional) physical type of the patch. More...
 
const wordList & inGroups () const noexcept
 The (optional) groups that the patch belongs to. More...
 
wordList & inGroups () noexcept
 Modifiable (optional) groups that the patch belongs to. More...
 
bool inGroup (const word &name) const
 True if given name is in a group. More...
 
void write (Ostream &os) const
 

Additional Inherited Members

- Static Public Member Functions inherited from patchIdentifier
static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN". More...
 

Detailed Description

Like polyPatch but without reference to mesh. Used in boundaryMesh to hold data on patches. The patchIdentifier::index is set, but not used.

Source files

Definition at line 54 of file boundaryPatch.H.

Constructor & Destructor Documentation

◆ boundaryPatch() [1/3]

boundaryPatch ( const word &  name,
const label  index,
const label  size,
const label  start,
const word &  physicalType = word::null 
)

Construct from components.

Definition at line 35 of file boundaryPatch.C.

References Foam::name().

Here is the call graph for this function:

◆ boundaryPatch() [2/3]

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

Construct from dictionary.

Definition at line 50 of file boundaryPatch.C.

◆ boundaryPatch() [3/3]

boundaryPatch ( const boundaryPatch &  p,
const label  index 
)

Copy construct, resetting the index.

Definition at line 63 of file boundaryPatch.C.

References patchIdentifier::index().

Here is the call graph for this function:

Member Function Documentation

◆ clone()

autoPtr< boundaryPatch > clone ( ) const
inline

Clone.

Definition at line 94 of file boundaryPatch.H.

References Time::New().

Here is the call graph for this function:

◆ size() [1/2]

label size ( ) const
inline

Definition at line 102 of file boundaryPatch.H.

Referenced by boundaryMesh::addPatch(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), boundaryMesh::deletePatch(), boundaryMesh::read(), boundaryMesh::readTriSurface(), and boundaryMesh::whichPatch().

Here is the caller graph for this function:

◆ size() [2/2]

label & size ( )
inline

Definition at line 107 of file boundaryPatch.H.

◆ start() [1/2]

label start ( ) const
inline

Definition at line 112 of file boundaryPatch.H.

Referenced by boundaryMesh::addPatch(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), boundaryMesh::deletePatch(), boundaryMesh::read(), boundaryMesh::readTriSurface(), boundaryMesh::whichPatch(), and boundaryMesh::writeTriSurface().

Here is the caller graph for this function:

◆ start() [2/2]

label & start ( )
inline

Definition at line 117 of file boundaryPatch.H.

◆ write()

void write ( Ostream &  os) const
virtual

Write dictionary entries (without surrounding braces)

Definition at line 73 of file boundaryPatch.C.

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

Here is the call graph for this function:
The documentation for this class was generated from the following files: