Public Member Functions | List of all members
generatedCellZone Class Reference

cellZone selection or generation class More...

Inheritance diagram for generatedCellZone:
Inheritance graph
[legend]

Public Member Functions

 generatedCellZone (const polyMesh &mesh)
 Construct from mesh selecting all cells. More...
 
 generatedCellZone (const polyMesh &mesh, const dictionary &dict, const bool defaultIsAll=false, const bool onDemand=false)
 Construct from mesh and dictionary. More...
 
 generatedCellZone (const generatedCellZone &)=delete
 Disallow default bitwise copy construction. More...
 
 ~generatedCellZone ()
 Destructor. More...
 
bool all () const
 Return true if the set comprises all the cells. More...
 
const word & name () const
 Return const access to the name of cellZone. More...
 
const cellZone & zone () const
 Return const access to the cell set. More...
 
label nCells () const
 Return the number of cells in the set. More...
 
label celli (const label i) const
 Return the cell index corresponding to the cell set index. More...
 
bool regenerate ()
 Regenerate the cellZone if the regenerate switch is set true. More...
 
void movePoints ()
 Update for mesh motion. More...
 
void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
bool read (const dictionary &dict, const bool defaultIsAll=false, const bool onDemand=false)
 Read coefficients dictionary. More...
 
void operator= (const generatedCellZone &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

cellZone selection or generation class

The cellZone is either looked-up from the mesh or generated by a zoneGenerator and stored locally.

Usage
Examples: 
    // Select all the cells
    cellZone all;

    // Select the cells within the cellZone rotor
    cellZone rotor;

    // Select the cells within the given box
    cellZone
    {
        type        box;
        box         (3.48 -0.1 -0.1) (3.5 0.1 0.1);
    }

    // Select the cell containing the given point
    cellZone
    {
        type            containsPoints;
        points          ((0.075 0.2 0.05));
    }
See also
Foam::generatedZoneSet Foam::zoneGenerator
Source files

Definition at line 84 of file generatedCellZone.H.

Constructor & Destructor Documentation

◆ generatedCellZone() [1/3]

generatedCellZone ( const polyMesh &  mesh)

Construct from mesh selecting all cells.

Definition at line 32 of file generatedCellZone.C.

◆ generatedCellZone() [2/3]

generatedCellZone ( const polyMesh &  mesh,
const dictionary &  dict,
const bool  defaultIsAll = false,
const bool  onDemand = false 
)

Construct from mesh and dictionary.

Definition at line 39 of file generatedCellZone.C.

References dict, and generatedCellZone::read().

Here is the call graph for this function:

◆ generatedCellZone() [3/3]

generatedCellZone ( const generatedCellZone &  )
delete

Disallow default bitwise copy construction.

◆ ~generatedCellZone()

~generatedCellZone ( )

Destructor.

Definition at line 56 of file generatedCellZone.C.

Member Function Documentation

◆ all()

bool all ( ) const
inline

Return true if the set comprises all the cells.

Definition at line 30 of file generatedCellZoneI.H.

Referenced by sampledIsoSurfaceSurface::calcIsoSurf(), and solidBody::solidBody().

Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const
inline

Return const access to the name of cellZone.

Definition at line 36 of file generatedCellZoneI.H.

◆ zone()

const Foam::cellZone & zone ( ) const
inline

Return const access to the cell set.

Definition at line 56 of file generatedCellZoneI.H.

Referenced by sampledIsoSurfaceSurface::calcIsoSurf(), propellerDiskAdjustment::correctn(), and propellerDisk::readCoeffs().

Here is the caller graph for this function:

◆ nCells()

Foam::label nCells ( ) const
inline

Return the number of cells in the set.

Definition at line 74 of file generatedCellZoneI.H.

Referenced by Foam::cellCutPlot::calcCutXs(), Foam::cellCutPlot::calcInterpolatingWeights(), Foam::cellCutPlot::calcNonInterpolatingWeights(), and Foam::cellCutPlot::calcWeights().

Here is the caller graph for this function:

◆ celli()

Foam::label celli ( const label  i) const
inline

Return the cell index corresponding to the cell set index.

Definition at line 92 of file generatedCellZoneI.H.

Referenced by Foam::cellCutPlot::calcCutXs(), Foam::cellCutPlot::calcInterpolatingWeights(), Foam::cellCutPlot::calcNonInterpolatingWeights(), and Foam::cellCutPlot::calcWeights().

Here is the caller graph for this function:

◆ regenerate()

bool regenerate ( )

Regenerate the cellZone if the regenerate switch is set true.

and true if regenerated Useful if the zone is not purely geometric e.g. field dependent

Definition at line 62 of file generatedCellZone.C.

References Foam::all.

Referenced by fvCellZone::regenerate().

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( )

Update for mesh motion.

Definition at line 73 of file generatedCellZone.C.

References Foam::all.

Referenced by fvCellZone::movePoints().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)

Update topology using the given map.

Definition at line 82 of file generatedCellZone.C.

References Foam::all.

Referenced by fvCellZone::topoChange().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)

Update from another mesh using the given map.

Definition at line 91 of file generatedCellZone.C.

References Foam::all.

Referenced by fvCellZone::mapMesh().

Here is the caller graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap &  map)

Redistribute or update using the given distribution map.

Definition at line 100 of file generatedCellZone.C.

References Foam::all.

Referenced by fvCellZone::distribute().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  dict,
const bool  defaultIsAll = false,
const bool  onDemand = false 
)

Read coefficients dictionary.

Definition at line 109 of file generatedCellZone.C.

References Foam::cell, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), IOWarningInFunction, dictionary::isDict(), dictionary::lookup(), and Foam::nl.

Referenced by generatedCellZone::generatedCellZone(), and fvCellZone::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const generatedCellZone &  )
delete

Disallow default bitwise assignment.

The documentation for this class was generated from the following files: