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 fvMeshbaseMesh () const noexcept
 The entire base mesh. More...
 
const fvMeshSubsetsubsetter () const
 The mesh subsetter. More...
 
fvMeshSubsetsubsetter ()
 The mesh subsetter. More...
 
bool useSubMesh () const noexcept
 True if sub-mesh is expected to be used. More...
 
const wordReszones () 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 94 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 100 of file zoneSubSet.C.

References correct.

◆ zoneSubSet() [2/2]

zoneSubSet ( const fvMesh mesh,
const dictionary dict 
)

Construct from mesh and dictionary.

Definition at line 116 of file zoneSubSet.C.

References correct, and dict.

◆ ~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 180 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 188 of file zoneSubSet.H.

◆ subsetter() [2/2]

fvMeshSubset& subsetter ( )
inline

The mesh subsetter.

Definition at line 196 of file zoneSubSet.H.

◆ useSubMesh()

bool useSubMesh ( ) const
inlinenoexcept

True if sub-mesh is expected to be used.

Definition at line 204 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 212 of file zoneSubSet.H.

◆ nLayers()

label nLayers ( ) const
inlinenoexcept

Return number of layers around cell zones.

Definition at line 220 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 28 of file zoneSubSetTemplates.C.

References DimensionedField< Type, GeoMesh >::dimensions(), forAll, IOobject::name(), and Foam::New().

Here is the call graph for this function:

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