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

ZoneMesh< ZoneType, MeshType > Class Template Reference

List of mesh zones. More...

Inheritance diagram for ZoneMesh< ZoneType, MeshType >:
Collaboration diagram for ZoneMesh< ZoneType, MeshType >:

List of all members.


Public Member Functions

 ZoneMesh (const IOobject &, const MeshType &)
 Read constructor given IOobject and a MeshType reference.
 ZoneMesh (const IOobject &, const MeshType &, const label size)
 Construct given size.
 ~ZoneMesh ()
const MeshType & mesh () const
 Return the mesh reference.
const Map< label > & zoneMap () const
 Map of zones containing zone index for all zoned elements.
label whichZone (const label objectIndex) const
 Given a global object index, return the zone it is in. If.
wordList types () const
 Return a list of zone types.
wordList names () const
 Return a list of zone names.
label findZoneID (const word &zoneName) const
 Find zone index given a name.
void clearAddressing ()
 Clear addressing.
void clear ()
 Clear the zones.
bool checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error.
void movePoints (const pointField &)
 Correct zone mesh after moving points.
bool writeData (Ostream &) const
 writeData member function required by regIOobject

Friends

Ostreamoperator (Ostream &, const ZoneMesh< ZoneType, MeshType > &)

Detailed Description

template<class ZoneType, class MeshType>
class Foam::ZoneMesh< ZoneType, MeshType >

List of mesh zones.

Source files

Definition at line 57 of file ZoneMesh.H.


Constructor & Destructor Documentation

ZoneMesh ( const IOobject io,
const MeshType &  mesh 
) [inline]

Read constructor given IOobject and a MeshType reference.

Definition at line 73 of file ZoneMesh.C.

ZoneMesh ( const IOobject io,
const MeshType &  mesh,
const label  size 
) [inline]

Construct given size.

Definition at line 132 of file ZoneMesh.C.

~ZoneMesh (  )  [inline]

Definition at line 148 of file ZoneMesh.C.


Member Function Documentation

const MeshType& mesh (  )  const [inline]

Return the mesh reference.

Definition at line 111 of file ZoneMesh.H.

const Map< label > & zoneMap (  )  const [inline]

Map of zones containing zone index for all zoned elements.

Return -1 if the object is not in the zone

Definition at line 158 of file ZoneMesh.C.

References ZoneMesh< ZoneType, MeshType >::clearAddressing().

Here is the call graph for this function:

label whichZone ( const label  objectIndex  )  const [inline]

Given a global object index, return the zone it is in. If.

object does not belong to any zones, return -1

Definition at line 172 of file ZoneMesh.C.

wordList types (  )  const [inline]

Return a list of zone types.

Definition at line 190 of file ZoneMesh.C.

wordList names (  )  const [inline]

Return a list of zone names.

Definition at line 207 of file ZoneMesh.C.

label findZoneID ( const word zoneName  )  const [inline]

Find zone index given a name.

Definition at line 223 of file ZoneMesh.C.

void clearAddressing (  )  [inline]

Clear addressing.

Definition at line 250 of file ZoneMesh.C.

Referenced by ZoneMesh< ZoneType, MeshType >::checkDefinition(), and ZoneMesh< ZoneType, MeshType >::zoneMap().

Here is the caller graph for this function:

void clear (  )  [inline]

Clear the zones.

Reimplemented from PtrList< ZoneType >.

Definition at line 264 of file ZoneMesh.C.

Referenced by ZoneMesh< ZoneType, MeshType >::checkDefinition().

Here is the caller graph for this function:

bool checkDefinition ( const bool  report = false  )  const [inline]

Check zone definition. Return true if in error.

Definition at line 273 of file ZoneMesh.C.

References ZoneMesh< ZoneType, MeshType >::clear(), and ZoneMesh< ZoneType, MeshType >::clearAddressing().

Here is the call graph for this function:

void movePoints ( const pointField p  )  [inline]

Correct zone mesh after moving points.

Definition at line 289 of file ZoneMesh.C.

bool writeData ( Ostream os  )  const [inline, virtual]

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 302 of file ZoneMesh.C.


Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const ZoneMesh< ZoneType, MeshType > &   
) [friend]


The documentation for this class was generated from the following files:
  • src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H
  • src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.C
Copyright © 2000-2009 OpenCFD Ltd