FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

ZoneMesh< ZoneType, MeshType > Class Template Reference

List of mesh zones. More...

#include <OpenFOAM/ZoneMesh.H>


Detailed Description

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

List of mesh zones.

Source files

Definition at line 62 of file ZoneMesh.H.

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

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

Constructor & Destructor Documentation

ZoneMesh ( const IOobject &   io,
const MeshType &   mesh  
)

Read constructor given IOobject and a MeshType reference.

Definition at line 81 of file ZoneMesh.C.

References IOstream::check(), forAll, IOobject::MUST_READ, IOobject::READ_IF_PRESENT, PtrList< T >::set(), PtrList< T >::setSize(), and PtrList< T >::size().

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

Construct given size.

Definition at line 140 of file ZoneMesh.C.

~ZoneMesh (  )

Definition at line 156 of file ZoneMesh.C.


Member Function Documentation

const MeshType& mesh (  ) const [inline]

Return the mesh reference.

Definition at line 116 of file ZoneMesh.H.

const Map< label > & zoneMap (  ) const

Map of zones containing zone index for all zoned elements.

Return -1 if the object is not in the zone

Definition at line 166 of file ZoneMesh.C.

label whichZone ( const label   objectIndex  ) const

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

object does not belong to any zones, return -1

Definition at line 180 of file ZoneMesh.C.

References HashTable< T, Key, Hash >::end(), and HashTable< T, Key, Hash >::find().

Referenced by meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), removeCells::setRefinement(), edgeCollapser::setRefinement(), and perfectInterface::setRefinement().

wordList types (  ) const

Return a list of zone types.

Definition at line 198 of file ZoneMesh.C.

References forAll, and PtrList< T >::size().

void clearAddressing (  )
void clear (  )

Clear the zones.

Reimplemented from PtrList< ZoneType >.

Definition at line 272 of file ZoneMesh.C.

References PtrList< T >::clear().

Referenced by polyMeshAdder::add(), and cellTable::addCellZones().

bool checkDefinition ( const bool   report = false  ) const

Check zone definition. Return true if in error.

Definition at line 281 of file ZoneMesh.C.

References forAll.

void movePoints ( const pointField &   p  )

Correct zone mesh after moving points.

Definition at line 297 of file ZoneMesh.C.

References forAll.

bool writeData ( Ostream &   os  ) const [virtual]

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 310 of file ZoneMesh.C.

References IOstream::good().


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