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 cells. More...

#include <OpenFOAM/cellZone.H>


Detailed Description

A subset of mesh cells.

Currently set up as an indirect list but will be extended to use a primitive mesh. For quick check whether a cell belongs to the zone use the lookup mechanism in cellZoneMesh, where all the zoned cells are registered with their zone number.

Source files

Definition at line 66 of file cellZone.H.

Inheritance diagram for cellZone:
Collaboration diagram for cellZone:

List of all members.

Public Member Functions

 TypeName ("cellZone")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, cellZone, dictionary,(const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm),(name, dict, index, zm))
 cellZone (const word &name, const labelList &addr, const label index, const cellZoneMesh &)
 Construct from components.
 cellZone (const word &name, const Xfer< labelList > &addr, const label index, const cellZoneMesh &)
 Construct from components, transferring contents.
 cellZone (const word &name, const dictionary &, const label index, const cellZoneMesh &)
 Construct from dictionary.
 cellZone (const cellZone &, const labelList &addr, const label index, const cellZoneMesh &)
 Construct given the original zone and resetting the.
 cellZone (const cellZone &, const Xfer< labelList > &addr, const label index, const cellZoneMesh &)
 Construct given the original zone, resetting the.
virtual autoPtr< cellZone >  clone (const cellZoneMesh &zm) const
 Construct and return a clone, resetting the zone mesh.
virtual autoPtr< cellZone >  clone (const labelList &addr, const label index, const cellZoneMesh &zm) const
 Construct and return a clone, resetting the cell list.
virtual  ~cellZone ()
 Destructor.
const word &  name () const
 Return name.
label  whichCell (const label globalCellID) const
 Map storing the local cell index for every global cell.
label  index () const
 Return the index of this zone in zone list.
const cellZoneMesh &  zoneMesh () const
 Return zoneMesh reference.
void  clearAddressing ()
 Clear addressing.
bool  checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error.
virtual void  movePoints (const pointField &)
 Correct patch after moving points.
virtual void  write (Ostream &) const
 Write.
virtual void  writeDict (Ostream &) const
 Write dictionary.
void  operator= (const cellZone &)
 Assign to zone clearing demand-driven data.
void  operator= (const labelList &)
 Assign addressing clearing demand-driven data.

Static Public Member Functions

static autoPtr< cellZone >  New (const word &name, const dictionary &, const label index, const cellZoneMesh &)
 Return a pointer to a new cell zone.

Friends

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

Constructor & Destructor Documentation

cellZone ( const word &   name,
const labelList &   addr,
const label   index,
const cellZoneMesh &   zm  
)

Construct from components.

Definition at line 101 of file cellZone.C.

cellZone ( const word &   name,
const Xfer< labelList > &   addr,
const label   index,
const cellZoneMesh &   zm  
)

Construct from components, transferring contents.

Definition at line 117 of file cellZone.C.

cellZone ( const word &   name,
const dictionary &   dict,
const label   index,
const cellZoneMesh &   zm  
)

Construct from dictionary.

Definition at line 134 of file cellZone.C.

cellZone ( const cellZone &   cz,
const labelList &   addr,
const label   index,
const cellZoneMesh &   zm  
)

Construct given the original zone and resetting the.

cell list and zone mesh information

Definition at line 152 of file cellZone.C.

cellZone ( const cellZone &   cz,
const Xfer< labelList > &   addr,
const label   index,
const cellZoneMesh &   zm  
)

Construct given the original zone, resetting the.

cell list and zone mesh information

Definition at line 167 of file cellZone.C.

~cellZone (  ) [virtual]

Destructor.

Definition at line 184 of file cellZone.C.


Member Function Documentation

TypeName ( "cellZone"    )

Runtime type information.

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

Construct and return a clone, resetting the zone mesh.

Definition at line 172 of file cellZone.H.

References cellZone::index().

virtual autoPtr<cellZone> clone ( const labelList &   addr,
const label   index,
const cellZoneMesh &   zm  
) const [inline, virtual]

Construct and return a clone, resetting the cell list.

and zone mesh

Definition at line 183 of file cellZone.H.

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

Return a pointer to a new cell zone.

created on freestore from dictionary

Definition at line 36 of file newCellZone.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 217 of file cellZone.H.

Referenced by fvMeshDistribute::printMeshInfo().

Foam::label whichCell ( const label   globalCellID  ) const

Map storing the local cell index for every global cell.

index. Used to find out the index of cell in the zone from the known global cell index. If the cell is not in the zone, returns -1

Definition at line 192 of file cellZone.C.

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

label index (  ) const [inline]

Return the index of this zone in zone list.

Definition at line 229 of file cellZone.H.

Referenced by cellZone::clone().

const Foam::cellZoneMesh & zoneMesh (  ) const

Return zoneMesh reference.

Definition at line 209 of file cellZone.C.

void clearAddressing (  )

Clear addressing.

Definition at line 215 of file cellZone.C.

References Foam::deleteDemandDrivenData().

bool checkDefinition ( const bool   report = false  ) const

Check zone definition. Return true if in error.

Definition at line 221 of file cellZone.C.

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

virtual void movePoints ( const pointField &    ) [inline, virtual]

Correct patch after moving points.

Definition at line 244 of file cellZone.H.

void write ( Ostream &   os  ) const [virtual]

Write.

Definition at line 250 of file cellZone.C.

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

Referenced by Foam::operator<<().

void writeDict ( Ostream &   os  ) const [virtual]

Write dictionary.

Definition at line 257 of file cellZone.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, and Foam::type().

void operator= ( const cellZone &   cz  )

Assign to zone clearing demand-driven data.

Definition at line 270 of file cellZone.C.

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

void operator= ( const labelList &   addr  )

Assign addressing clearing demand-driven data.

Definition at line 277 of file cellZone.C.

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


Friends And Related Function Documentation

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

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