fvCellSet Class Reference
Collaboration diagram for fvCellSet:

Public Types

enum  selectionModeType { points, cellSet, cellZone, all }
 Enumeration for selection mode types. More...
 

Public Member Functions

 fvCellSet (const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 ~fvCellSet ()
 Destructor. More...
 
const selectionModeType & selectionMode () const
 Return const access to the cell selection mode. More...
 
const word & cellSetName () const
 Return const access to the name of cell set for "cellSet". More...
 
scalar V () const
 Return const access to the total cell volume. More...
 
const labelList & cells () const
 Return const access to the cell set. More...
 
void updateMesh (const mapPolyMesh &)
 Update for mesh changes. More...
 
bool read (const dictionary &dict)
 Read coefficients dictionary. More...
 

Static Public Attributes

static const NamedEnum< selectionModeType, 4 > selectionModeTypeNames_
 Word list of selection mode type names. More...
 

Detailed Description

Definition at line 77 of file fvCellSet.H.

Member Enumeration Documentation

◆ selectionModeType

enum selectionModeType
strong

Enumeration for selection mode types.

Enumerator
points 
cellSet 
cellZone 
all 

Definition at line 84 of file fvCellSet.H.

Constructor & Destructor Documentation

◆ fvCellSet()

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

Construct from components.

Definition at line 141 of file fvCellSet.C.

References Foam::read().

Referenced by NamedEnum< compressibleField, 8 >::names().

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

◆ ~fvCellSet()

~fvCellSet ( )

Destructor.

Definition at line 157 of file fvCellSet.C.

Member Function Documentation

◆ selectionMode()

const Foam::fvCellSet::selectionModeType & selectionMode ( ) const
inline

Return const access to the cell selection mode.

Definition at line 29 of file fvCellSetI.H.

◆ cellSetName()

const Foam::word & cellSetName ( ) const
inline

Return const access to the name of cell set for "cellSet".

selectionMode

Definition at line 35 of file fvCellSetI.H.

◆ V()

Foam::scalar V ( ) const
inline

Return const access to the total cell volume.

Definition at line 41 of file fvCellSetI.H.

◆ cells()

const Foam::labelList & cells ( ) const
inline

Return const access to the cell set.

Definition at line 47 of file fvCellSetI.H.

◆ updateMesh()

void updateMesh ( const mapPolyMesh &  )

Update for mesh changes.

Definition at line 163 of file fvCellSet.C.

◆ read()

bool read ( const dictionary &  dict)

Read coefficients dictionary.

Definition at line 169 of file fvCellSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::lookup(), and points.

Here is the call graph for this function:

Member Data Documentation

◆ selectionModeTypeNames_

const NamedEnum< fvCellSet::selectionModeType, 4 > selectionModeTypeNames_
static

Word list of selection mode type names.

Definition at line 94 of file fvCellSet.H.

Referenced by NamedEnum< compressibleField, 8 >::names().


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