OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

polyPatchID Class Reference

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

Collaboration diagram for polyPatchID:

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 wordname () const
 Return name.
label index () const
 Return index.
bool active () const
 Has the patch been found.
void update (const polyBoundaryMesh &bm)
 Update.

Friends

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

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 47 of file polyPatchID.H.


Constructor & Destructor Documentation

polyPatchID ( const word name,
const polyBoundaryMesh bm 
) [inline]

Construct from name.

Definition at line 63 of file polyPatchID.H.

polyPatchID ( Istream is,
const polyBoundaryMesh bm 
) [inline]

Construct from Istream.

Definition at line 70 of file polyPatchID.H.


Member Function Documentation

const word& name (  )  const [inline]

Return name.

Definition at line 82 of file polyPatchID.H.

label index (  )  const [inline]

Return index.

Definition at line 88 of file polyPatchID.H.

bool active (  )  const [inline]

Has the patch been found.

Definition at line 94 of file polyPatchID.H.

void update ( const polyBoundaryMesh bm  )  [inline]

Update.

Definition at line 103 of file polyPatchID.H.


Friends And Related Function Documentation

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

Definition at line 111 of file polyPatchID.H.


The documentation for this class was generated from the following file:
Copyright © 2000-2009 OpenCFD Ltd