FreeFOAM The Cross-Platform CFD Toolkit
patchIdentifier Class Reference

Identifies patch by name, patch index and physical type. More...

#include <OpenFOAM/patchIdentifier.H>


Detailed Description

Identifies patch by name, patch index and physical type.

Source files

Definition at line 58 of file patchIdentifier.H.

+ Inheritance diagram for patchIdentifier:

List of all members.

Public Member Functions

 patchIdentifier (const word &name, const label index, const word &physicalType=word::null)
 Construct from components.
 patchIdentifier (const word &name, const dictionary &, const label index)
 Construct from dictionary.
 patchIdentifier (const patchIdentifier &, const label index)
 Construct from geometric patch, resetting the index.
virtual ~patchIdentifier ()
const wordname () const
 Return name.
wordname ()
 Return name for modification.
const wordphysicalType () const
 Return the optional physical type of the patch.
wordphysicalType ()
 Return the optional physical type of the patch for modification.
label index () const
 Return the index of this patch in the boundaryMesh.
label & index ()
 Return the index of this patch in the boundaryMesh for modification.
void write (Ostream &) const
 Write patchIdentifier as a dictionary.

Friends

Ostreamoperator<< (Ostream &, const patchIdentifier &)

Constructor & Destructor Documentation

patchIdentifier ( const word name,
const label  index,
const word physicalType = word::null 
)

Construct from components.

Definition at line 32 of file patchIdentifier.C.

patchIdentifier ( const word name,
const dictionary dict,
const label  index 
)

Construct from dictionary.

Definition at line 45 of file patchIdentifier.C.

References dictionary::readIfPresent().

patchIdentifier ( const patchIdentifier p,
const label  index 
)

Construct from geometric patch, resetting the index.

Definition at line 59 of file patchIdentifier.C.

~patchIdentifier ( )
virtual

Definition at line 72 of file patchIdentifier.C.


Member Function Documentation

word& name ( )
inline

Return name for modification.

Definition at line 114 of file patchIdentifier.H.

const word& physicalType ( ) const
inline
word& physicalType ( )
inline

Return the optional physical type of the patch for modification.

Definition at line 126 of file patchIdentifier.H.

label& index ( )
inline

Return the index of this patch in the boundaryMesh for modification.

Definition at line 138 of file patchIdentifier.H.


Friends And Related Function Documentation

Ostream& operator<< ( Ostream ,
const patchIdentifier  
)
friend

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