FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions | Friends
polyPatchID Class Reference

A class holds the data needed to identify a patch in a dynamic mesh. More...

#include <OpenFOAM/polyPatchID.H>

Detailed Description

A class holds the data needed to identify a patch in a dynamic mesh.

The patch is identified by name and its index in the boundary mesh is updated if the mesh has changed.

Definition at line 55 of file polyPatchID.H.

List of all members.

Public Member Functions

 polyPatchID (const word &name, const polyBoundaryMesh &bm)
 Construct from name.
 polyPatchID (Istream &is, const polyBoundaryMesh &bm)
 Construct from Istream.
const word & name () const
 Return name.
label index () const
 Return index.
bool active () const
 Has the patch been found.
void update (const polyBoundaryMesh &bm)
 Update.

Friends

Ostream & operator<< (Ostream &os, const polyPatchID &p)

Constructor & Destructor Documentation

polyPatchID ( const word &  name,
const polyBoundaryMesh &  bm 
)
inline

Construct from name.

Definition at line 71 of file polyPatchID.H.

polyPatchID ( Istream &  is,
const polyBoundaryMesh &  bm 
)
inline

Construct from Istream.

Definition at line 78 of file polyPatchID.H.

Member Function Documentation

const word& name ( ) const
inline

Return name.

Definition at line 90 of file polyPatchID.H.

Referenced by enginePiston::writeDict().

label index ( ) const
inline

Return index.

Definition at line 96 of file polyPatchID.H.

bool active ( ) const
inline

Has the patch been found.

Definition at line 102 of file polyPatchID.H.

void update ( const polyBoundaryMesh &  bm)
inline

Update.

Definition at line 111 of file polyPatchID.H.

References polyBoundaryMesh::findPatchID().

Friends And Related Function Documentation

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

Definition at line 119 of file polyPatchID.H.

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