Public Member Functions | Protected Member Functions | List of all members
fvCellSet Class Reference

General run-time selected cell set selection class for fvMesh. More...

Inheritance diagram for fvCellSet:
Inheritance graph
[legend]
Collaboration diagram for fvCellSet:
Collaboration graph
[legend]

Public Member Functions

 fvCellSet (const fvMesh &mesh)
 Construct from mesh. Will select all. More...
 
 fvCellSet (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 ~fvCellSet ()
 Destructor. More...
 
scalar V () const
 Return const access to the total cell volume. 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 polyCellSet
 polyCellSet (const polyMesh &mesh)
 Construct from mesh. Will select all. More...
 
 polyCellSet (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 ~polyCellSet ()
 Destructor. More...
 
const selectionTypes & selectionType () const
 Return const access to the cell selection type. More...
 
const word & cellSetName () const
 Return const access to the name of cellSet. More...
 
labelUList cells () const
 Return const access to the cell set. More...
 
label nCells () const
 Return the number of cells in the set. More...
 
bool all () const
 Return true if the set comprises all the cells. 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...
 

Protected Member Functions

void writeFileHeader (const functionObjects::writeFile &wf, Ostream &file)
 Output file header information. More...
 

Additional Inherited Members

- Public Types inherited from polyCellSet
enum class  selectionTypes { points , cellSet , cellZone , all }
 Enumeration for selection mode types. More...
 
- Static Public Attributes inherited from polyCellSet
static const NamedEnum< selectionTypes, 4 > selectionTypeNames
 Word list of selection type names. More...
 

Detailed Description

General run-time selected cell set selection class for fvMesh.

Currently supports cell selection from:

Usage
Examples: 
    // Select all cells
    select   all;

    // Select the cells within the given cellSet
    select   cellSet;   // Optional
    cellSet  rotor;

    // Select the cells within the given cellZone
    select   cellZone;  // Optional
    cellZone rotor;

    // Select the cells containing a list of points
    select   points;    // Optional
    points
    (
        (2.25 0.5 0)
        (2.75 0.5 0)
    );
See also
Foam::polyCellSet
Source files

Definition at line 85 of file fvCellSet.H.

Constructor & Destructor Documentation

◆ fvCellSet() [1/2]

fvCellSet ( const fvMesh &  mesh)

Construct from mesh. Will select all.

Definition at line 69 of file fvCellSet.C.

◆ fvCellSet() [2/2]

fvCellSet ( const fvMesh &  mesh,
const dictionary &  dict 
)

Construct from mesh and dictionary.

Definition at line 77 of file fvCellSet.C.

◆ ~fvCellSet()

~fvCellSet ( )

Destructor.

Definition at line 89 of file fvCellSet.C.

Member Function Documentation

◆ writeFileHeader()

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

Output file header information.

Definition at line 54 of file fvCellSet.C.

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

Referenced by volFieldValue::writeFileHeader().

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

◆ V()

Foam::scalar V ( ) const
inline

Return const access to the total cell volume.

Definition at line 28 of file fvCellSetI.H.

◆ movePoints()

void movePoints ( )

Update for mesh motion.

Definition at line 95 of file fvCellSet.C.

References polyCellSet::movePoints().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)

Update topology using the given map.

Definition at line 102 of file fvCellSet.C.

References polyCellSet::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 109 of file fvCellSet.C.

References polyCellSet::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 116 of file fvCellSet.C.

References polyCellSet::distribute().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)

Read coefficients dictionary.

Definition at line 123 of file fvCellSet.C.

References dict, and polyCellSet::read().

Here is the call graph for this function:
The documentation for this class was generated from the following files: