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

A subset of mesh faces organised as a primitive patch. More...

#include <OpenFOAM/faceZone.H>


Detailed Description

A subset of mesh faces organised as a primitive patch.

For quick check whether a face belongs to the zone use the lookup mechanism in faceZoneMesh, where all the zoned faces are registered with their zone number.

Source files

Definition at line 68 of file faceZone.H.

Inheritance diagram for faceZone:
Collaboration diagram for faceZone:

List of all members.

Public Member Functions

 TypeName ("faceZone")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, faceZone, dictionary,(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm),(name, dict, index, zm))
 faceZone (const word &name, const labelList &addr, const boolList &fm, const label index, const faceZoneMesh &zm)
 Construct from components.
 faceZone (const word &name, const Xfer< labelList > &addr, const Xfer< boolList > &fm, const label index, const faceZoneMesh &)
 Construct from components, transferring contents.
 faceZone (const word &name, const dictionary &, const label index, const faceZoneMesh &)
 Construct from dictionary.
 faceZone (const faceZone &, const labelList &addr, const boolList &fm, const label index, const faceZoneMesh &)
 Construct given the original zone and resetting the.
 faceZone (const faceZone &, const Xfer< labelList > &addr, const Xfer< boolList > &fm, const label index, const faceZoneMesh &)
 Construct given the original zone, resetting the.
virtual autoPtr< faceZone >  clone (const faceZoneMesh &zm) const
 Construct and return a clone, resetting the zone mesh.
virtual autoPtr< faceZone >  clone (const labelList &addr, const boolList &fm, const label index, const faceZoneMesh &zm) const
 Construct and return a clone, resetting the face list.
virtual  ~faceZone ()
 Destructor.
const word &  name () const
 Return name.
const boolList &  flipMap () const
 Return face flip map.
label  whichFace (const label globalFaceID) const
 Map storing the local face index for every global face index.
const primitiveFacePatch &  operator() () const
 Return reference to primitive patch.
label  index () const
 Return the index of this zone in zone list.
const faceZoneMesh &  zoneMesh () const
 Return zoneMesh reference.
const labelList &  masterCells () const
 Return labels of master cells (cells next to the master face.
const labelList &  slaveCells () const
 Return labels of slave cells.
const labelList &  meshEdges () const
 Return global edge index for local edges.
void  clearAddressing ()
 Clear addressing.
void  resetAddressing (const labelList &, const boolList &)
 Reset addressing and flip map (clearing demand-driven data)
bool  checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error.
bool  checkParallelSync (const bool report=false) const
 Check whether all procs have faces synchronised. Return.
virtual void  movePoints (const pointField &)
 Correct patch after moving points.
void  updateMesh (const mapPolyMesh &mpm)
 Update for changes in topology.
virtual void  write (Ostream &) const
 Write.
virtual void  writeDict (Ostream &) const
 Write dictionary.

Static Public Member Functions

static autoPtr< faceZone >  New (const word &name, const dictionary &, const label index, const faceZoneMesh &)
 Return a pointer to a new face zone.

Friends

Ostream &  operator<< (Ostream &, const faceZone &)

Constructor & Destructor Documentation

faceZone ( const word &   name,
const labelList &   addr,
const boolList &   fm,
const label   index,
const faceZoneMesh &   zm  
)

Construct from components.

Definition at line 230 of file faceZone.C.

faceZone ( const word &   name,
const Xfer< labelList > &   addr,
const Xfer< boolList > &   fm,
const label   index,
const faceZoneMesh &   zm  
)

Construct from components, transferring contents.

Definition at line 254 of file faceZone.C.

faceZone ( const word &   name,
const dictionary &   dict,
const label   index,
const faceZoneMesh &   zm  
)

Construct from dictionary.

Definition at line 279 of file faceZone.C.

faceZone ( const faceZone &   fz,
const labelList &   addr,
const boolList &   fm,
const label   index,
const faceZoneMesh &   zm  
)

Construct given the original zone and resetting the.

face list and zone mesh information

Definition at line 304 of file faceZone.C.

faceZone ( const faceZone &   fz,
const Xfer< labelList > &   addr,
const Xfer< boolList > &   fm,
const label   index,
const faceZoneMesh &   zm  
)

Construct given the original zone, resetting the.

face list and zone mesh information

Definition at line 328 of file faceZone.C.

~faceZone (  ) [virtual]

Destructor.

Definition at line 353 of file faceZone.C.


Member Function Documentation

TypeName ( "faceZone"    )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr   ,
faceZone   ,
dictionary   ,
(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)   ,
(name, dict, index, zm)    
)
virtual autoPtr<faceZone> clone ( const faceZoneMesh &   zm  ) const [inline, virtual]

Construct and return a clone, resetting the zone mesh.

Definition at line 207 of file faceZone.H.

References faceZone::flipMap(), and faceZone::index().

virtual autoPtr<faceZone> clone ( const labelList &   addr,
const boolList &   fm,
const label   index,
const faceZoneMesh &   zm  
) const [inline, virtual]

Construct and return a clone, resetting the face list.

and zone mesh

Definition at line 218 of file faceZone.H.

Foam::autoPtr< Foam::faceZone > New ( const word &   name,
const dictionary &   dict,
const label   index,
const faceZoneMesh &   zm  
) [static]

Return a pointer to a new face zone.

created on freestore from dictionary

Definition at line 36 of file newFaceZone.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, dictionary::lookup(), and name().

const word& name (  ) const [inline]

Return name.

Definition at line 253 of file faceZone.H.

Referenced by meshRefinement::checkCoupledFaceZones(), and fvMeshDistribute::printMeshInfo().

Foam::label whichFace ( const label   globalFaceID  ) const
const Foam::primitiveFacePatch & operator() (  ) const

Return reference to primitive patch.

Definition at line 384 of file faceZone.C.

label index (  ) const [inline]

Return the index of this zone in zone list.

Definition at line 273 of file faceZone.H.

Referenced by faceZone::clone().

const Foam::faceZoneMesh & zoneMesh (  ) const

Return zoneMesh reference.

Definition at line 378 of file faceZone.C.

const Foam::labelList & masterCells (  ) const

Return labels of master cells (cells next to the master face.

zone in the prescribed direction)

Definition at line 395 of file faceZone.C.

Referenced by layerAdditionRemoval::changeTopology().

const Foam::labelList & slaveCells (  ) const

Return labels of slave cells.

Definition at line 406 of file faceZone.C.

const Foam::labelList & meshEdges (  ) const

Return global edge index for local edges.

Definition at line 417 of file faceZone.C.

References mesh.

void clearAddressing (  )

Clear addressing.

Definition at line 458 of file faceZone.C.

References Foam::deleteDemandDrivenData().

void resetAddressing ( const labelList &   addr,
const boolList &   flipMap  
)

Reset addressing and flip map (clearing demand-driven data)

Definition at line 471 of file faceZone.C.

References List< label >::operator=().

bool checkDefinition ( const bool   report = false  ) const

Check zone definition. Return true if in error.

Definition at line 512 of file faceZone.C.

References Foam::endl(), forAll, mesh, Foam::name(), Foam::nl, and SeriousErrorIn.

bool checkParallelSync ( const bool   report = false  ) const
void movePoints ( const pointField &   p  ) [virtual]

Correct patch after moving points.

Definition at line 621 of file faceZone.C.

void updateMesh ( const mapPolyMesh &   mpm  )

Update for changes in topology.

Definition at line 482 of file faceZone.C.

References forAll, mapPolyMesh::reverseFaceMap(), and List< T >::setSize().

void write ( Ostream &   os  ) const [virtual]

Write.

Definition at line 629 of file faceZone.C.

References Foam::name(), and Foam::nl.

Referenced by Foam::operator<<().

void writeDict ( Ostream &   os  ) const [virtual]

Friends And Related Function Documentation

Ostream& operator<< ( Ostream &   ,
const faceZone &    
) [friend]

The documentation for this class was generated from the following files:
  • src/OpenFOAM/meshes/polyMesh/zones/faceZone/faceZone.H
  • src/OpenFOAM/meshes/polyMesh/zones/faceZone/faceZone.C
  • src/OpenFOAM/meshes/polyMesh/zones/faceZone/newFaceZone.C