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 ()
 Null constructor. More...
 
virtual ~FieldMapper ()
 Destructor. More...
 
virtual label size () const =0
 
virtual bool direct () const =0
 
virtual bool distributed () const
 
virtual const mapDistributeBase & distributeMap () const
 
virtual bool hasUnmapped () const =0
 Are there unmapped values? I.e. do all size() elements get. More...
 
virtual const labelUList & directAddressing () const
 
virtual const labelListList & addressing () const
 
virtual const scalarListList & weights () const
 
template<class Type >
tmp< Field< Type > > operator() (const Field< Type > &f) const
 

Detailed Description

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

Definition at line 45 of file FieldMapper.H.

Constructor & Destructor Documentation

◆ FieldMapper()

FieldMapper ( )
inline

Null constructor.

Definition at line 53 of file FieldMapper.H.

◆ ~FieldMapper()

virtual ~FieldMapper ( )
inlinevirtual

Destructor.

Definition at line 58 of file FieldMapper.H.

References FieldMapper::direct(), and FieldMapper::size().

Here is the call graph for this function:

Member Function Documentation

◆ size()

virtual label size ( ) const
pure virtual

Implemented in meshToMesh0::patchFieldInterpolator, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, pointPatchMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvPatchMapper, singleCellFvMesh::agglomPatchFieldMapper, faceMapper, cellMapper, pointMapper, fvSurfaceMapper, fvFieldReconstructor::fvPatchFieldReconstructor, distributedWeightedFvPatchFieldMapper, pointFieldReconstructor::pointPatchFieldReconstructor, weightedFvPatchFieldMapper, pointFieldDecomposer::patchFieldDecomposer, directFvPatchFieldMapper, directPointPatchFieldMapper, fvFieldDecomposer::patchFieldDecomposer, and directFieldMapper.

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

Here is the caller graph for this function:

◆ direct()

virtual bool direct ( ) const
pure virtual

Implemented in meshToMesh0::patchFieldInterpolator, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, pointPatchMapper, fvPatchMapper, faceMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvSurfaceMapper, singleCellFvMesh::agglomPatchFieldMapper, cellMapper, pointMapper, distributedWeightedFvPatchFieldMapper, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, weightedFvPatchFieldMapper, pointFieldDecomposer::patchFieldDecomposer, directFvPatchFieldMapper, directPointPatchFieldMapper, fvFieldDecomposer::patchFieldDecomposer, and directFieldMapper.

Referenced by Field< Foam::Vector2D >::autoMap(), fvPatchField< Type >::autoMap(), pointPatchMapper::direct(), Field< Foam::Vector2D >::map(), and FieldMapper::~FieldMapper().

Here is the caller graph for this function:

◆ distributed()

virtual bool distributed ( ) const
inlinevirtual

Reimplemented in distributedWeightedFvPatchFieldMapper.

Definition at line 68 of file FieldMapper.H.

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

Here is the caller graph for this function:

◆ distributeMap()

virtual const mapDistributeBase& distributeMap ( ) const
inlinevirtual

Reimplemented in distributedWeightedFvPatchFieldMapper.

Definition at line 73 of file FieldMapper.H.

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

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

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

◆ hasUnmapped()

virtual bool hasUnmapped ( ) const
pure virtual

Are there unmapped values? I.e. do all size() elements get.

get value

Implemented in meshToMesh0::patchFieldInterpolator, fvFieldDecomposer::processorSurfacePatchFieldDecomposer, distributedWeightedFvPatchFieldMapper, fvPatchMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, fvSurfaceMapper, faceMapper, pointPatchMapper, singleCellFvMesh::agglomPatchFieldMapper, pointMapper, cellMapper, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, weightedFvPatchFieldMapper, pointFieldDecomposer::patchFieldDecomposer, fvFieldDecomposer::patchFieldDecomposer, directFvPatchFieldMapper, directPointPatchFieldMapper, and directFieldMapper.

Referenced by fvPatchField< Type >::autoMap(), directionMixedFvPatchField< Type >::directionMixedFvPatchField(), FieldMapper::distributeMap(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedValueFvPatchField< scalar >::fixedValueFvPatchField(), fvPatchField< Type >::fvPatchField(), and mixedFvPatchField< scalar >::mixedFvPatchField().

Here is the caller graph for this function:

◆ directAddressing()

virtual const labelUList& directAddressing ( ) const
inlinevirtual

Reimplemented in meshToMesh0::patchFieldInterpolator, pointPatchMapper, fvPatchMapper, fvSurfaceMapper, faceMapper, fvFieldDecomposer::processorVolPatchFieldDecomposer, pointMapper, cellMapper, fvFieldReconstructor::fvPatchFieldReconstructor, pointFieldReconstructor::pointPatchFieldReconstructor, pointFieldDecomposer::patchFieldDecomposer, fvFieldDecomposer::patchFieldDecomposer, directFvPatchFieldMapper, directPointPatchFieldMapper, and directFieldMapper.

Definition at line 85 of file FieldMapper.H.

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

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

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

◆ addressing()

virtual const labelListList& addressing ( ) const
inlinevirtual

Reimplemented in fvFieldDecomposer::processorSurfacePatchFieldDecomposer, pointPatchMapper, fvPatchMapper, distributedWeightedFvPatchFieldMapper, fvSurfaceMapper, faceMapper, pointMapper, cellMapper, singleCellFvMesh::agglomPatchFieldMapper, and weightedFvPatchFieldMapper.

Definition at line 94 of file FieldMapper.H.

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

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

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

◆ weights()

virtual const scalarListList& weights ( ) const
inlinevirtual

Reimplemented in fvFieldDecomposer::processorSurfacePatchFieldDecomposer, pointPatchMapper, fvPatchMapper, distributedWeightedFvPatchFieldMapper, fvSurfaceMapper, faceMapper, pointMapper, cellMapper, singleCellFvMesh::agglomPatchFieldMapper, and weightedFvPatchFieldMapper.

Definition at line 103 of file FieldMapper.H.

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

Referenced by Field< Foam::Vector2D >::map(), and meshToMesh0::V().

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

◆ operator()()

tmp<Field<Type> > operator() ( const Field< Type > &  f) const
inline

Definition at line 116 of file FieldMapper.H.

References f().

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