Public Member Functions | List of all members
zoneSubSet Class Reference

Public Member Functions

 TypeName ("zoneSubSet")
 Runtime type information. More...
 
 zoneSubSet (const fvMesh &mesh, const wordRes &zoneSelector, const label nZoneLayers=0)
 Construct from components. More...
 
 zoneSubSet (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
virtual ~zoneSubSet ()=default
 Destructor. More...
 
const fvMesh & baseMesh () const noexcept
 The entire base mesh. More...
 
const fvMeshSubset & subsetter () const
 The mesh subsetter. More...
 
fvMeshSubset & subsetter ()
 The mesh subsetter. More...
 
bool useSubMesh () const noexcept
 True if sub-mesh is expected to be used. More...
 
const wordRes & zones () const noexcept
 Return the current zones selector. More...
 
label nLayers () const noexcept
 Return number of layers around cell zones. More...
 
template<class Type >
tmp< GeometricField< Type, fvPatchField, volMesh > > mapToZone (const GeometricField< Type, fvPatchField, volMesh > &subVolField) const
 Map from the sub-mesh to original cell zones. More...
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > mapToZone (const GeometricField< Type, fvPatchField, volMesh > &subVolField) const
 

Detailed Description

Definition at line 98 of file zoneSubSet.H.

Constructor & Destructor Documentation

◆ zoneSubSet() [1/2]

zoneSubSet ( const fvMesh &  mesh,
const wordRes &  zoneSelector,
const label  nZoneLayers = 0 
)

Construct from components.

Definition at line 106 of file zoneSubSet.C.

◆ zoneSubSet() [2/2]

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

Construct from mesh and dictionary.

Definition at line 122 of file zoneSubSet.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ ~zoneSubSet()

virtual ~zoneSubSet ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "zoneSubSet"  )

Runtime type information.

◆ baseMesh()

const fvMesh & baseMesh ( ) const
inlinenoexcept

The entire base mesh.

Definition at line 160 of file zoneSubSet.H.

References fvMeshSubset::baseMesh().

Here is the call graph for this function:

◆ subsetter() [1/2]

const fvMeshSubset & subsetter ( ) const
inline

The mesh subsetter.

Definition at line 166 of file zoneSubSet.H.

◆ subsetter() [2/2]

fvMeshSubset & subsetter ( )
inline

The mesh subsetter.

Definition at line 172 of file zoneSubSet.H.

◆ useSubMesh()

bool useSubMesh ( ) const
inlinenoexcept

True if sub-mesh is expected to be used.

Definition at line 178 of file zoneSubSet.H.

References UList< T >::empty().

Here is the call graph for this function:

◆ zones()

const wordRes & zones ( ) const
inlinenoexcept

Return the current zones selector.

Definition at line 184 of file zoneSubSet.H.

◆ nLayers()

label nLayers ( ) const
inlinenoexcept

Return number of layers around cell zones.

Definition at line 190 of file zoneSubSet.H.

◆ mapToZone() [1/2]

tmp< GeometricField< Type, fvPatchField, volMesh > > mapToZone ( const GeometricField< Type, fvPatchField, volMesh > &  subVolField) const

Map from the sub-mesh to original cell zones.

◆ mapToZone() [2/2]

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > mapToZone ( const GeometricField< Type, fvPatchField, volMesh > &  subVolField) const

Definition at line 34 of file zoneSubSetTemplates.C.

References fvMeshSubset::baseMesh(), fvMeshSubset::cellMap(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, IOobject::name(), and bitSet::test().

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