Loading...
Searching...
No Matches
FieldMapper Class Referenceabstract

Abstract base class to hold the Field mapping addressing and weights. More...

#include <FieldMapper.H>

Inheritance diagram for FieldMapper:
Inheritance graph
[legend]

Public Member Functions

 FieldMapper ()=default
 Default construct.
virtual ~FieldMapper ()=default
 Destructor.
virtual label size () const =0
 The size of the mapper.
virtual bool direct () const =0
 Is it a direct (non-interpolating) mapper?
virtual bool distributed () const
 Does the mapper have remote contributions?
virtual bool hasUnmapped () const =0
 Any unmapped values?
virtual const labelUList & directAddressing () const
 Return the direct addressing values.
virtual const mapDistributeBase & distributeMap () const
 Return the distribution map.
virtual const labelListList & addressing () const
 Return the interpolation addressing.
virtual const scalarListList & weights () const
 Return the interpolation weights.
template<class Type>
tmp< Field< Type > > operator() (const Field< Type > &fld) const
 Perform mapping on the given field.

Detailed Description

Abstract base class to hold the Field mapping addressing and weights.

Definition at line 43 of file FieldMapper.H.

Constructor & Destructor Documentation

◆ FieldMapper()

FieldMapper ( )
default

Default construct.

◆ ~FieldMapper()

virtual ~FieldMapper ( )
virtualdefault

Destructor.

Member Function Documentation

◆ size()

virtual label size ( ) const
pure virtual

The size of the mapper.

Implemented in cellMapper, DirectFieldMapper< faPatchFieldMapper >, DirectFieldMapper< FieldMapper >, DirectFieldMapper< fvPatchFieldMapper >, DirectFieldMapper< pointPatchFieldMapper >, DistributedFieldMapper< directFaPatchFieldMapper >, DistributedFieldMapper< directFieldMapper >, DistributedFieldMapper< directFvPatchFieldMapper >, DistributedFieldMapper< directPointPatchFieldMapper >, distributedWeightedFvPatchFieldMapper, faAreaMapper, faceMapper, faEdgeMapper, faFieldDecomposer::patchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, faFieldDecomposer::processorEdgePatchFieldDecomposer, faFieldReconstructor::faPatchFieldReconstructor, faPatchMapper, fvFieldDecomposer::patchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvFieldReconstructor::fvPatchFieldReconstructor, fvPatchMapper, fvSurfaceMapper, meshToMesh0::patchFieldInterpolator, pointFieldDecomposer::patchFieldDecomposer, pointFieldReconstructor::pointPatchFieldReconstructor, pointMapper, pointPatchMapper, and singleCellFvMesh::agglomPatchFieldMapper.

Referenced by fvPatchField< Type >::autoMap(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), and Field< Type >::map().

Here is the caller graph for this function:

◆ direct()

virtual bool direct ( ) const
pure virtual

Is it a direct (non-interpolating) mapper?

Implemented in cellMapper, DirectFieldMapper< faPatchFieldMapper >, DirectFieldMapper< FieldMapper >, DirectFieldMapper< fvPatchFieldMapper >, DirectFieldMapper< pointPatchFieldMapper >, distributedWeightedFvPatchFieldMapper, faAreaMapper, faceMapper, faEdgeMapper, faFieldDecomposer::patchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, faFieldDecomposer::processorEdgePatchFieldDecomposer, faFieldReconstructor::faPatchFieldReconstructor, faPatchMapper, fvFieldDecomposer::patchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvFieldReconstructor::fvPatchFieldReconstructor, fvPatchMapper, fvSurfaceMapper, meshToMesh0::patchFieldInterpolator, pointFieldDecomposer::patchFieldDecomposer, pointFieldReconstructor::pointPatchFieldReconstructor, pointMapper, pointPatchMapper, and singleCellFvMesh::agglomPatchFieldMapper.

Referenced by fvPatchField< Type >::autoMap(), Field< Type >::map(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), uniformFixedValueFaPatchField< Type >::uniformFixedValueFaPatchField(), uniformFixedValueFvPatchField< Type >::uniformFixedValueFvPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), and uniformNormalFixedValueFvPatchVectorField::uniformNormalFixedValueFvPatchVectorField().

Here is the caller graph for this function:

◆ distributed()

virtual bool distributed ( ) const
inlinevirtual

Does the mapper have remote contributions?

Reimplemented in DistributedFieldMapper< directFaPatchFieldMapper >, DistributedFieldMapper< directFieldMapper >, DistributedFieldMapper< directFvPatchFieldMapper >, DistributedFieldMapper< directPointPatchFieldMapper >, and distributedWeightedFvPatchFieldMapper.

Definition at line 76 of file FieldMapper.H.

Referenced by Field< Type >::autoMap(), fvPatchField< Type >::autoMap(), and Field< Type >::map().

Here is the caller graph for this function:

◆ hasUnmapped()

virtual bool hasUnmapped ( ) const
pure virtual

Any unmapped values?

I.e. do all size() elements get value

Implemented in cellMapper, DirectFieldMapper< faPatchFieldMapper >, DirectFieldMapper< FieldMapper >, DirectFieldMapper< fvPatchFieldMapper >, DirectFieldMapper< pointPatchFieldMapper >, distributedWeightedFvPatchFieldMapper, faAreaMapper, faceMapper, faEdgeMapper, faFieldDecomposer::patchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, faFieldDecomposer::processorEdgePatchFieldDecomposer, faFieldReconstructor::faPatchFieldReconstructor, faPatchMapper, fvFieldDecomposer::patchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvFieldReconstructor::fvPatchFieldReconstructor, fvPatchMapper, fvSurfaceMapper, meshToMesh0::patchFieldInterpolator, pointFieldDecomposer::patchFieldDecomposer, pointFieldReconstructor::pointPatchFieldReconstructor, pointMapper, pointPatchMapper, and singleCellFvMesh::agglomPatchFieldMapper.

Referenced by fvPatchField< Type >::autoMap(), directionMixedFvPatchField< Type >::directionMixedFvPatchField(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedValueFvPatchField< Type >::fixedValueFvPatchField(), fvPatchField< Type >::fvPatchField(), mixedFvPatchField< Type >::mixedFvPatchField(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), uniformFixedValueFaPatchField< Type >::uniformFixedValueFaPatchField(), uniformFixedValueFvPatchField< Type >::uniformFixedValueFvPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), and uniformNormalFixedValueFvPatchVectorField::uniformNormalFixedValueFvPatchVectorField().

Here is the caller graph for this function:

◆ directAddressing()

virtual const labelUList & directAddressing ( ) const
inlinevirtual

Return the direct addressing values.

Reimplemented in cellMapper, DirectFieldMapper< faPatchFieldMapper >, DirectFieldMapper< FieldMapper >, DirectFieldMapper< fvPatchFieldMapper >, DirectFieldMapper< pointPatchFieldMapper >, faAreaMapper, faceMapper, faEdgeMapper, faFieldDecomposer::patchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, faFieldReconstructor::faPatchFieldReconstructor, faPatchMapper, fvFieldDecomposer::patchFieldDecomposer, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvFieldReconstructor::fvPatchFieldReconstructor, fvPatchMapper, fvSurfaceMapper, meshToMesh0::patchFieldInterpolator, pointFieldDecomposer::patchFieldDecomposer, pointFieldReconstructor::pointPatchFieldReconstructor, pointMapper, and pointPatchMapper.

Definition at line 91 of file FieldMapper.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and UList< label >::null().

Referenced by fvPatchField< Type >::autoMap(), and Field< Type >::map().

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

◆ distributeMap()

virtual const mapDistributeBase & distributeMap ( ) const
inlinevirtual

Return the distribution map.

Reimplemented in DistributedFieldMapper< directFaPatchFieldMapper >, DistributedFieldMapper< directFieldMapper >, DistributedFieldMapper< directFvPatchFieldMapper >, DistributedFieldMapper< directPointPatchFieldMapper >, and distributedWeightedFvPatchFieldMapper.

Definition at line 103 of file FieldMapper.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::NullObjectRef().

Referenced by Field< Type >::autoMap(), and Field< Type >::map().

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

◆ addressing()

virtual const labelListList & addressing ( ) const
inlinevirtual

Return the interpolation addressing.

Reimplemented in cellMapper, distributedWeightedFvPatchFieldMapper, faAreaMapper, faceMapper, faEdgeMapper, faFieldDecomposer::processorEdgePatchFieldDecomposer, faPatchMapper, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, fvPatchMapper, fvSurfaceMapper, pointMapper, pointPatchMapper, and singleCellFvMesh::agglomPatchFieldMapper.

Definition at line 115 of file FieldMapper.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and List< labelList >::null().

Referenced by fvPatchField< Type >::autoMap(), and Field< Type >::map().

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

◆ weights()

virtual const scalarListList & weights ( ) const
inlinevirtual

Return the interpolation weights.

Reimplemented in cellMapper, distributedWeightedFvPatchFieldMapper, faAreaMapper, faceMapper, faEdgeMapper, faFieldDecomposer::processorEdgePatchFieldDecomposer, faPatchMapper, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, fvPatchMapper, fvSurfaceMapper, pointMapper, pointPatchMapper, and singleCellFvMesh::agglomPatchFieldMapper.

Definition at line 127 of file FieldMapper.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and List< scalarList >::null().

Referenced by Field< Type >::map().

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

◆ operator()()

template<class Type>
tmp< Field< Type > > operator() ( const Field< Type > & fld) const
inline

Perform mapping on the given field.

Definition at line 143 of file FieldMapper.H.

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

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