Simple proxy for holding a mesh, or mesh-subset. The subMeshes are currently limited to cellSet or cellZone definitions. More...

#include <fvMeshSubsetProxy.H>

Public Types
enum	subsetType { NONE , SET , ZONE , ZONES }
	Internal bookkeeping for subset type. More...

Public Member Functions
	fvMeshSubsetProxy (fvMesh &baseMesh)
	Construct a pass-through proxy. No correct() invoked or required.
	fvMeshSubsetProxy (fvMesh &baseMesh, const subsetType type, const word &selectionName, label exposedPatchId=-1)
	Construct from components.
	fvMeshSubsetProxy (fvMesh &baseMesh, const wordRes &zoneNames, label exposedPatchId=-1)
	Construct from components. The subsetType is ZONES.
	fvMeshSubsetProxy (fvMesh &baseMesh, wordRes &&zoneNames, label exposedPatchId=-1)
	Construct from components. The subsetType is ZONES.
const fvMesh &	baseMesh () const noexcept
	The entire base mesh.
const fvMeshSubset &	subsetter () const noexcept
	The mesh subsetter.
fvMeshSubset &	subsetter () noexcept
	The mesh subsetter.
bool	useSubMesh () const noexcept
	True if sub-mesh should be used.
const fvMesh &	mesh () const
	Access either base-mesh or sub-mesh.
const word &	name () const noexcept
	The associated (set or zone) name if any.
const bitSet &	selectedCells () const noexcept
	The current cell selection, when subsetting is active.
void	resetZones (const wordRes &zoneNames)
	Define the zones selection, subset the mesh accordingly.
bool	correct (bool verbose=false)
	Update of mesh subset.
polyMesh::readUpdateState	readUpdate ()
	Read mesh. Correct on topo-change.
template<class Type>
tmp< GeometricField< Type, fvPatchField, volMesh > >	interpolateInternal (const DimensionedField< Type, volMesh > &df) const
	Convert an internal field to a volume field (with zeroGradient).
template<class Type>
tmp< GeometricField< Type, fvPatchField, volMesh > >	interpolateInternal (const tmp< DimensionedField< Type, volMesh > > &tdf) const
	Convert an internal field to a volume field (with zeroGradient).
template<class GeoField>
tmp< GeoField >	interpolate (const GeoField &fld) const
	Wrapper for field or the subsetted field.
template<class GeoField>
tmp< GeoField >	interpolate (const tmp< GeoField > &fld) const
	Wrapper for field or the subsetted field.
template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	zeroGradientField (const DimensionedField< Type, volMesh > &df)
template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	interpolateInternal (const fvMeshSubset &subsetter, const DimensionedField< Type, volMesh > &df)
template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	interpolateInternal (const fvMeshSubset &subsetter, const tmp< DimensionedField< Type, volMesh > > &tdf)
template<class GeoField>
Foam::tmp< GeoField >	interpolate (const fvMeshSubset &subsetter, const GeoField &fld)
template<class GeoField>
Foam::tmp< GeoField >	interpolate (const fvMeshSubset &subsetter, const tmp< GeoField > &tfield)
template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	interpolateInternal (const DimensionedField< Type, volMesh > &df) const
template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	interpolateInternal (const tmp< DimensionedField< Type, volMesh > > &tdf) const
template<class GeoField>
Foam::tmp< GeoField >	interpolate (const GeoField &fld) const
template<class GeoField>
Foam::tmp< GeoField >	interpolate (const tmp< GeoField > &tfield) const

Static Public Member Functions
template<class Type>
static tmp< GeometricField< Type, fvPatchField, volMesh > >	zeroGradientField (const DimensionedField< Type, volMesh > &df)
	Construct volField (with zeroGradient) from an internal field.
template<class Type>
static tmp< GeometricField< Type, fvPatchField, volMesh > >	interpolateInternal (const fvMeshSubset &subsetter, const DimensionedField< Type, volMesh > &df)
	Convert an internal field to a volume field (with zeroGradient).
template<class Type>
static tmp< GeometricField< Type, fvPatchField, volMesh > >	interpolateInternal (const fvMeshSubset &subsetter, const tmp< DimensionedField< Type, volMesh > > &tdf)
	Convert an internal field to a volume field (with zeroGradient).
template<class GeoField>
static tmp< GeoField >	interpolate (const fvMeshSubset &subsetter, const GeoField &fld)
	Wrapper for field or the subsetted field.
template<class GeoField>
static tmp< GeoField >	interpolate (const fvMeshSubset &subsetter, const tmp< GeoField > &fld)
	Wrapper for field or the subsetted field.

Detailed Description

Simple proxy for holding a mesh, or mesh-subset. The subMeshes are currently limited to cellSet or cellZone definitions.

Source files

Definition at line 51 of file fvMeshSubsetProxy.H.

Member Enumeration Documentation

◆ subsetType

enum subsetType

Internal bookkeeping for subset type.

Enumerator
NONE	No subset.
SET	Subset with a cellSet.
ZONE	Subset with a cellZone.
ZONES	Subset with multiple cellZones.

Definition at line 60 of file fvMeshSubsetProxy.H.

Constructor & Destructor Documentation

◆ fvMeshSubsetProxy() [1/4]

fvMeshSubsetProxy ( fvMesh & baseMesh )

explicit

Construct a pass-through proxy. No correct() invoked or required.

Definition at line 40 of file fvMeshSubsetProxy.C.

References baseMesh(), and NONE.

Here is the call graph for this function:

◆ fvMeshSubsetProxy() [2/4]

fvMeshSubsetProxy	(	fvMesh &	baseMesh,
		const subsetType	type,
		const word &	selectionName,
		label	exposedPatchId = -1 )

Construct from components.

Definition at line 52 of file fvMeshSubsetProxy.C.

References baseMesh(), correct(), NONE, SET, ZONE, and ZONES.

Here is the call graph for this function:

◆ fvMeshSubsetProxy() [3/4]

fvMeshSubsetProxy	(	fvMesh &	baseMesh,
		const wordRes &	zoneNames,
		label	exposedPatchId = -1 )

Construct from components. The subsetType is ZONES.

Definition at line 83 of file fvMeshSubsetProxy.C.

References baseMesh(), correct(), and ZONES.

Here is the call graph for this function:

◆ fvMeshSubsetProxy() [4/4]

fvMeshSubsetProxy	(	fvMesh &	baseMesh,
		wordRes &&	zoneNames,
		label	exposedPatchId = -1 )

Construct from components. The subsetType is ZONES.

Definition at line 102 of file fvMeshSubsetProxy.C.

References baseMesh(), correct(), and ZONES.

Here is the call graph for this function:

Member Function Documentation

◆ baseMesh()

const fvMesh & baseMesh ( ) const

inlinenoexcept

The entire base mesh.

Definition at line 175 of file fvMeshSubsetProxy.H.

References Foam::noexcept.

Referenced by fvMeshSubsetProxy(), fvMeshSubsetProxy(), fvMeshSubsetProxy(), fvMeshSubsetProxy(), and Foam::writeAllPointFields().

Here is the caller graph for this function:

◆ subsetter() [1/2]

const fvMeshSubset & subsetter ( ) const

inlinenoexcept

The mesh subsetter.

Definition at line 183 of file fvMeshSubsetProxy.H.

References Foam::noexcept.

Referenced by interpolate(), interpolate(), interpolate(), interpolateInternal(), and interpolateInternal().

Here is the caller graph for this function:

◆ subsetter() [2/2]

fvMeshSubset & subsetter ( )

inlinenoexcept

The mesh subsetter.

Definition at line 191 of file fvMeshSubsetProxy.H.

References Foam::noexcept.

◆ useSubMesh()

bool useSubMesh ( ) const

inlinenoexcept

True if sub-mesh should be used.

Definition at line 199 of file fvMeshSubsetProxy.H.

References Foam::noexcept, and NONE.

Referenced by mesh(), and Foam::writePointField().

Here is the caller graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const

inline

Access either base-mesh or sub-mesh.

Definition at line 207 of file fvMeshSubsetProxy.H.

References useSubMesh().

Here is the call graph for this function:

◆ name()

const word & name ( ) const

inlinenoexcept

The associated (set or zone) name if any.

Definition at line 220 of file fvMeshSubsetProxy.H.

References Foam::noexcept.

◆ selectedCells()

const bitSet & selectedCells ( ) const

inlinenoexcept

The current cell selection, when subsetting is active.

Definition at line 228 of file fvMeshSubsetProxy.H.

References Foam::noexcept.

Referenced by correct().

Here is the caller graph for this function:

◆ resetZones()

void resetZones ( const wordRes & zoneNames )

Define the zones selection, subset the mesh accordingly.

Definition at line 123 of file fvMeshSubsetProxy.C.

References correct(), UList< T >::empty(), and ZONES.

Here is the call graph for this function:

◆ correct()

bool correct ( bool verbose = false )

Update of mesh subset.

Return true if the subset changed from previous call.

Definition at line 136 of file fvMeshSubsetProxy.C.

References Foam::endl(), Foam::flatOutput(), Foam::Info, IOobjectOption::NO_REGISTER, NONE, Foam::returnReduceOr(), selectedCells(), SET, ZONE, and ZONES.

Here is the call graph for this function:

◆ readUpdate()

Foam::polyMesh::readUpdateState readUpdate ( )

Read mesh. Correct on topo-change.

Definition at line 200 of file fvMeshSubsetProxy.C.

References correct(), polyMesh::POINTS_MOVED, polyMesh::TOPO_CHANGE, and polyMesh::TOPO_PATCH_CHANGE.

Here is the call graph for this function:

◆ zeroGradientField() [1/2]

template<class Type>

tmp< GeometricField< Type, fvPatchField, volMesh > > zeroGradientField ( const DimensionedField< Type, volMesh > & df )

static

Construct volField (with zeroGradient) from an internal field.

Referenced by interpolateInternal(), and interpolateInternal().

Here is the caller graph for this function:

◆ interpolateInternal() [1/8]

template<class Type>

tmp< GeometricField< Type, fvPatchField, volMesh > > interpolateInternal	(	const fvMeshSubset &	subsetter,
		const DimensionedField< Type, volMesh > &	df )

static

Convert an internal field to a volume field (with zeroGradient).

References subsetter().

Referenced by interpolateInternal(), and interpolateInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolateInternal() [2/8]

template<class Type>

tmp< GeometricField< Type, fvPatchField, volMesh > > interpolateInternal	(	const fvMeshSubset &	subsetter,
		const tmp< DimensionedField< Type, volMesh > > &	tdf )

static

Convert an internal field to a volume field (with zeroGradient).

Currently no proper memory reuse

References subsetter().

Here is the call graph for this function:

◆ interpolate() [1/8]

template<class GeoField>

tmp< GeoField > interpolate	(	const fvMeshSubset &	subsetter,
		const GeoField &	fld )

static

Wrapper for field or the subsetted field.

Pass through or forward to fvMeshSubset::interpolate()

References fld(), and subsetter().

Referenced by Foam::writePointField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [2/8]

template<class GeoField>

tmp< GeoField > interpolate	(	const fvMeshSubset &	subsetter,
		const tmp< GeoField > &	fld )

static

Wrapper for field or the subsetted field.

Pass through or forward to fvMeshSubset::interpolate()

References fld(), and subsetter().

Here is the call graph for this function:

◆ interpolateInternal() [3/8]

template<class Type>

tmp< GeometricField< Type, fvPatchField, volMesh > > interpolateInternal ( const DimensionedField< Type, volMesh > & df ) const

Convert an internal field to a volume field (with zeroGradient).

◆ interpolateInternal() [4/8]

template<class Type>

tmp< GeometricField< Type, fvPatchField, volMesh > > interpolateInternal ( const tmp< DimensionedField< Type, volMesh > > & tdf ) const

Convert an internal field to a volume field (with zeroGradient).

Currently no proper memory reuse

◆ interpolate() [3/8]

template<class GeoField>

tmp< GeoField > interpolate ( const GeoField & fld ) const

Wrapper for field or the subsetted field.

Pass through or forward to fvMeshSubset::interpolate()

References fld().

Here is the call graph for this function:

◆ interpolate() [4/8]

template<class GeoField>

tmp< GeoField > interpolate ( const tmp< GeoField > & fld ) const

Wrapper for field or the subsetted field.

Pass through or forward to fvMeshSubset::interpolate()

References fld().

Here is the call graph for this function:

◆ zeroGradientField() [2/2]

template<class Type>

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > zeroGradientField ( const DimensionedField< Type, volMesh > & df )

Definition at line 32 of file fvMeshSubsetProxyTemplates.C.

References DimensionedField< Type, GeoMesh >::dimensions(), io, DimensionedField< Type, GeoMesh >::mesh(), Foam::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, DimensionedField< Type, GeoMesh >::oriented(), Foam::Zero, and fvPatchFieldBase::zeroGradientType().

Here is the call graph for this function:

◆ interpolateInternal() [5/8]

template<class Type>

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > interpolateInternal	(	const fvMeshSubset &	subsetter,
		const DimensionedField< Type, volMesh > &	df )

Definition at line 59 of file fvMeshSubsetProxyTemplates.C.

References Foam::interpolate(), subsetter(), and zeroGradientField().

Here is the call graph for this function:

◆ interpolateInternal() [6/8]

template<class Type>

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > interpolateInternal	(	const fvMeshSubset &	subsetter,
		const tmp< DimensionedField< Type, volMesh > > &	tdf )

Definition at line 78 of file fvMeshSubsetProxyTemplates.C.

References Foam::interpolate(), subsetter(), and zeroGradientField().

Here is the call graph for this function:

◆ interpolate() [5/8]

template<class GeoField>

Foam::tmp< GeoField > interpolate	(	const fvMeshSubset &	subsetter,
		const GeoField &	fld )

Definition at line 113 of file fvMeshSubsetProxyTemplates.C.

References fld(), and subsetter().

Here is the call graph for this function:

◆ interpolate() [6/8]

template<class GeoField>

Foam::tmp< GeoField > interpolate	(	const fvMeshSubset &	subsetter,
		const tmp< GeoField > &	tfield )

Definition at line 134 of file fvMeshSubsetProxyTemplates.C.

References tmp< T >::clear(), tmp< T >::good(), Foam::interpolate(), and subsetter().

Here is the call graph for this function:

◆ interpolateInternal() [7/8]

template<class Type>

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > interpolateInternal ( const DimensionedField< Type, volMesh > & df ) const

Definition at line 157 of file fvMeshSubsetProxyTemplates.C.

References interpolateInternal().

Here is the call graph for this function:

◆ interpolateInternal() [8/8]

template<class Type>

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > interpolateInternal ( const tmp< DimensionedField< Type, volMesh > > & tdf ) const

Definition at line 168 of file fvMeshSubsetProxyTemplates.C.

References interpolateInternal().

Here is the call graph for this function:

◆ interpolate() [7/8]

template<class GeoField>

Foam::tmp< GeoField > interpolate ( const GeoField & fld ) const

Definition at line 179 of file fvMeshSubsetProxyTemplates.C.

References fld(), and Foam::interpolate().

Here is the call graph for this function:

◆ interpolate() [8/8]

template<class GeoField>

Foam::tmp< GeoField > interpolate ( const tmp< GeoField > & tfield ) const

Definition at line 187 of file fvMeshSubsetProxyTemplates.C.

References Foam::interpolate().

Here is the call graph for this function:

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

src/finiteVolume/fvMesh/fvMeshSubset/fvMeshSubsetProxy.H
src/finiteVolume/fvMesh/fvMeshSubset/fvMeshSubsetProxy.C
src/finiteVolume/fvMesh/fvMeshSubset/fvMeshSubsetProxyTemplates.C

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ subsetType

Constructor & Destructor Documentation

◆ fvMeshSubsetProxy() [1/4]

◆ fvMeshSubsetProxy() [2/4]

◆ fvMeshSubsetProxy() [3/4]

◆ fvMeshSubsetProxy() [4/4]

Member Function Documentation

◆ baseMesh()

◆ subsetter() [1/2]

◆ subsetter() [2/2]

◆ useSubMesh()

◆ mesh()

◆ name()

◆ selectedCells()

◆ resetZones()

◆ correct()

◆ readUpdate()

◆ zeroGradientField() [1/2]

◆ interpolateInternal() [1/8]

◆ interpolateInternal() [2/8]

◆ interpolate() [1/8]

◆ interpolate() [2/8]

◆ interpolateInternal() [3/8]

◆ interpolateInternal() [4/8]

◆ interpolate() [3/8]

◆ interpolate() [4/8]

◆ zeroGradientField() [2/2]

◆ interpolateInternal() [5/8]

◆ interpolateInternal() [6/8]

◆ interpolate() [5/8]

◆ interpolate() [6/8]

◆ interpolateInternal() [7/8]

◆ interpolateInternal() [8/8]

◆ interpolate() [7/8]

◆ interpolate() [8/8]