fvCellZone Class Reference

cellZone selection or generation class with caching of zone volume More...

Inheritance diagram for fvCellZone:
Collaboration diagram for fvCellZone:

Public Member Functions

 fvCellZone (const fvMesh &mesh)
 Construct from mesh selecting all cells. More...
 
 fvCellZone (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 ~fvCellZone ()
 Destructor. More...
 
label nGlobalCells () const
 Return const access to the global number of cells. More...
 
scalar V () const
 Return const access to the total cell volume. More...
 
void writeFileHeader (const functionObjects::writeFile &wf, Ostream &file)
 Output file header information. 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)
 Read coefficients dictionary. More...
 
- Public Member Functions inherited from generatedCellZone
 generatedCellZone (const polyMesh &mesh)
 Construct from mesh selecting all cells. More...
 
 generatedCellZone (const polyMesh &mesh, const dictionary &dict)
 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 wordname () const
 Return const access to the name of cellZone. More...
 
const cellZonezone () 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...
 
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)
 Read coefficients dictionary. More...
 
void operator= (const generatedCellZone &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

cellZone selection or generation class with caching of zone volume

for fvModels, fvConstraints, functionObjects etc.

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

Usage
Examples:
    // Select all cells
    cellZone all;

    // Select the cells within the given cellZone
    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
    // and update the cells with respect to the fixed points
    // if the mesh moves
    cellZone
    {
        type            containsPoints;
        moveUpdate      true;
        points          ((0.075 0.2 0.05));
    }
See also
Foam::generatedCellZone Foam::generatedZoneSet Foam::zoneGenerator Foam::fvModel Foam::fvConstraint
Source files

Definition at line 91 of file fvCellZone.H.

Constructor & Destructor Documentation

◆ fvCellZone() [1/2]

fvCellZone ( const fvMesh mesh)

Construct from mesh selecting all cells.

Definition at line 49 of file fvCellZone.C.

◆ fvCellZone() [2/2]

fvCellZone ( const fvMesh mesh,
const dictionary dict 
)

Construct from mesh and dictionary.

Definition at line 58 of file fvCellZone.C.

◆ ~fvCellZone()

~fvCellZone ( )

Destructor.

Definition at line 71 of file fvCellZone.C.

Member Function Documentation

◆ nGlobalCells()

Foam::label nGlobalCells ( ) const
inline

Return const access to the global number of cells.

Definition at line 28 of file fvCellZoneI.H.

◆ V()

Foam::scalar V ( ) const
inline

Return const access to the total cell volume.

Definition at line 34 of file fvCellZoneI.H.

Referenced by propellerDisk::readCoeffs().

Here is the caller graph for this function:

◆ writeFileHeader()

void writeFileHeader ( const functionObjects::writeFile wf,
Ostream file 
)

Output file header information.

Definition at line 77 of file fvCellZone.C.

References Foam::endl(), Foam::file, Foam::name(), Foam::setw(), writeFile::writeCommented(), and writeFile::writeHeaderValue().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( )

Update for mesh motion.

Definition at line 90 of file fvCellZone.C.

References generatedCellZone::movePoints().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)

Update topology using the given map.

Definition at line 97 of file fvCellZone.C.

References generatedCellZone::topoChange().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap map)

Update from another mesh using the given map.

Definition at line 104 of file fvCellZone.C.

References generatedCellZone::mapMesh().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap map)

Redistribute or update using the given distribution map.

Definition at line 111 of file fvCellZone.C.

References generatedCellZone::distribute().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)

Read coefficients dictionary.

Definition at line 118 of file fvCellZone.C.

References dict, and generatedCellZone::read().

Here is the call graph for this function:

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