FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions | Friends
ZoneID< ZoneType > Class Template Reference

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

#include <OpenFOAM/ZoneID.H>

Detailed Description

template<class ZoneType>
class Foam::ZoneID< ZoneType >

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

The zone is identified by name. Its index in the zoneMesh is updated if the mesh has changed.

Definition at line 61 of file ZoneID.H.

+ Inheritance diagram for ZoneID< ZoneType >:

List of all members.

Public Member Functions

 ZoneID (const word &name, const ZoneMesh< ZoneType, polyMesh > &zm)
 Construct from name.
 ZoneID (Istream &is, const ZoneMesh< ZoneType, polyMesh > &zm)
 Construct from Istream.
const word & name () const
 Return name.
label index () const
 Return index.
bool active () const
 Has the zone been found.
void update (const ZoneMesh< ZoneType, polyMesh > &zm)
 Update.

Friends

Ostream & operator (Ostream &os, const ZoneID< ZoneType > &p)

Constructor & Destructor Documentation

ZoneID ( const word &  name,
const ZoneMesh< ZoneType, polyMesh > &  zm 
)
inline

Construct from name.

Definition at line 77 of file ZoneID.H.

ZoneID ( Istream &  is,
const ZoneMesh< ZoneType, polyMesh > &  zm 
)
inline

Construct from Istream.

Definition at line 84 of file ZoneID.H.

Member Function Documentation

const word& name ( ) const
inline

Return name.

Definition at line 99 of file ZoneID.H.

label index ( ) const
inline

Return index.

Definition at line 105 of file ZoneID.H.

bool active ( ) const
inline

Has the zone been found.

Definition at line 111 of file ZoneID.H.

void update ( const ZoneMesh< ZoneType, polyMesh > &  zm)
inline

Update.

Definition at line 119 of file ZoneID.H.

Friends And Related Function Documentation

Ostream& operator ( Ostream &  os,
const ZoneID< ZoneType > &  p 
)
friend
The documentation for this class was generated from the following file: