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

Referenced by fvPatchField< Type >::autoMap(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), and Field< T >::operator/=().

Here is the caller graph for this function:

◆ direct()

virtual bool direct ( ) const
pure virtual

Is it a direct (non-interpolating) mapper?

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

Referenced by fvPatchField< Type >::autoMap(), pointPatchMapper::direct(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), 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 72 of file FieldMapper.H.

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

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

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

Definition at line 82 of file FieldMapper.H.

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

Referenced by fvPatchField< Type >::autoMap(), Field< T >::component(), and Field< T >::writeEntry().

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 92 of file FieldMapper.H.

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

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

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 faAreaMapper, faEdgeMapper, faPatchMapper, fvPatchMapper, fvSurfaceMapper, singleCellFvMesh::agglomPatchFieldMapper, pointMapper, pointPatchMapper, cellMapper, faceMapper, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, faFieldDecomposer::processorEdgePatchFieldDecomposer, and distributedWeightedFvPatchFieldMapper.

Definition at line 102 of file FieldMapper.H.

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

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

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 faAreaMapper, faEdgeMapper, faPatchMapper, fvPatchMapper, fvSurfaceMapper, singleCellFvMesh::agglomPatchFieldMapper, pointMapper, pointPatchMapper, cellMapper, faceMapper, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, faFieldDecomposer::processorAreaPatchFieldDecomposer, faFieldDecomposer::processorEdgePatchFieldDecomposer, and distributedWeightedFvPatchFieldMapper.

Definition at line 112 of file FieldMapper.H.

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

Referenced by Field< T >::replace().

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 126 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: