Public Member Functions | List of all members
FieldMapper Class Referenceabstract

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

Inheritance diagram for FieldMapper:
Inheritance graph
[legend]

Public Member Functions

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

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 meshToMesh0::patchFieldInterpolator, faFieldDecomposer::processorEdgePatchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faAreaMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, pointPatchMapper, pointMapper, faceMapper, singleCellFvMesh::agglomPatchFieldMapper, cellMapper, fvPatchMapper, faEdgeMapper, faPatchMapper, fvSurfaceMapper, faFieldReconstructor::faPatchFieldReconstructor, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, distributedWeightedFvPatchFieldMapper, faFieldDecomposer::patchFieldDecomposer, pointFieldDecomposer::patchFieldDecomposer, and fvFieldDecomposer::patchFieldDecomposer.

Referenced by Field< Foam::vector >::autoMap(), fvPatchField< vector >::autoMap(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), and Field< Foam::vector >::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 meshToMesh0::patchFieldInterpolator, faFieldDecomposer::processorEdgePatchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faAreaMapper, pointPatchMapper, faFieldDecomposer::processorAreaPatchFieldDecomposer, faceMapper, fvPatchMapper, pointMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, cellMapper, faPatchMapper, fvSurfaceMapper, faEdgeMapper, singleCellFvMesh::agglomPatchFieldMapper, faFieldReconstructor::faPatchFieldReconstructor, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, distributedWeightedFvPatchFieldMapper, faFieldDecomposer::patchFieldDecomposer, pointFieldDecomposer::patchFieldDecomposer, and fvFieldDecomposer::patchFieldDecomposer.

Referenced by Field< Foam::vector >::autoMap(), fvPatchField< vector >::autoMap(), pointPatchMapper::direct(), Field< Foam::vector >::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 distributedWeightedFvPatchFieldMapper.

Definition at line 76 of file FieldMapper.H.

Referenced by Field< Foam::vector >::autoMap(), fvPatchField< vector >::autoMap(), and Field< Foam::vector >::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 meshToMesh0::patchFieldInterpolator, faFieldDecomposer::processorEdgePatchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faAreaMapper, faFieldDecomposer::processorAreaPatchFieldDecomposer, faceMapper, pointMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvPatchMapper, cellMapper, fvSurfaceMapper, faPatchMapper, faEdgeMapper, singleCellFvMesh::agglomPatchFieldMapper, pointPatchMapper, faFieldReconstructor::faPatchFieldReconstructor, distributedWeightedFvPatchFieldMapper, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, faFieldDecomposer::patchFieldDecomposer, pointFieldDecomposer::patchFieldDecomposer, and fvFieldDecomposer::patchFieldDecomposer.

Referenced by fvPatchField< vector >::autoMap(), directionMixedFvPatchField< Type >::directionMixedFvPatchField(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedValueFvPatchField< scalar >::fixedValueFvPatchField(), fvPatchField< vector >::fvPatchField(), mixedFvPatchField< vector >::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 meshToMesh0::patchFieldInterpolator, faAreaMapper, pointPatchMapper, faceMapper, pointMapper, faFieldDecomposer::processorAreaPatchFieldDecomposer, fvPatchMapper, cellMapper, fvSurfaceMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, faPatchMapper, faEdgeMapper, faFieldReconstructor::faPatchFieldReconstructor, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, faFieldDecomposer::patchFieldDecomposer, pointFieldDecomposer::patchFieldDecomposer, and fvFieldDecomposer::patchFieldDecomposer.

Definition at line 91 of file FieldMapper.H.

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

Referenced by Field< Foam::vector >::autoMap(), fvPatchField< vector >::autoMap(), and Field< Foam::vector >::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 distributedWeightedFvPatchFieldMapper.

Definition at line 103 of file FieldMapper.H.

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

Referenced by Field< Foam::vector >::autoMap(), and Field< Foam::vector >::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 faFieldDecomposer::processorEdgePatchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faAreaMapper, pointPatchMapper, faceMapper, pointMapper, fvPatchMapper, cellMapper, fvSurfaceMapper, faPatchMapper, faEdgeMapper, singleCellFvMesh::agglomPatchFieldMapper, and distributedWeightedFvPatchFieldMapper.

Definition at line 115 of file FieldMapper.H.

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

Referenced by Field< Foam::vector >::autoMap(), fvPatchField< vector >::autoMap(), and Field< Foam::vector >::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 faFieldDecomposer::processorEdgePatchFieldDecomposer, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faAreaMapper, pointPatchMapper, faceMapper, pointMapper, fvPatchMapper, cellMapper, fvSurfaceMapper, faPatchMapper, faEdgeMapper, singleCellFvMesh::agglomPatchFieldMapper, and distributedWeightedFvPatchFieldMapper.

Definition at line 127 of file FieldMapper.H.

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

Referenced by Field< Foam::vector >::map().

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

◆ operator()()

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: