FieldMapper Class Referenceabstract

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

Inheritance diagram for FieldMapper:
[legend]

Public Member Functions

 FieldMapper ()
 Null constructor. More...
 
virtual ~FieldMapper ()=default
 Destructor. More...
 
virtual label size () const =0
 
virtual bool direct () const =0
 
virtual bool distributed () const
 
virtual const mapDistributeBasedistributeMap () const
 
virtual bool hasUnmapped () const =0
 Are there unmapped values? I.e. do all size() elements get. More...
 
virtual const labelUListdirectAddressing () const
 
virtual const labelListListaddressing () const
 
virtual const scalarListListweights () 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 49 of file FieldMapper.H.

Constructor & Destructor Documentation

◆ FieldMapper()

FieldMapper ( )
inline

Null constructor.

Definition at line 57 of file FieldMapper.H.

◆ ~FieldMapper()

virtual ~FieldMapper ( )
virtualdefault

Destructor.

Member Function Documentation

◆ size()

◆ direct()

virtual bool direct ( ) const
pure virtual

◆ distributed()

virtual bool distributed ( ) const
inlinevirtual

Reimplemented in distributedWeightedFvPatchFieldMapper, distributedUnallocatedDirectFvPatchFieldMapper, and distributedUnallocatedDirectFieldMapper.

Definition at line 71 of file FieldMapper.H.

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

Here is the caller graph for this function:

◆ distributeMap()

virtual const mapDistributeBase& distributeMap ( ) const
inlinevirtual

Reimplemented in distributedWeightedFvPatchFieldMapper, distributedUnallocatedDirectFvPatchFieldMapper, and distributedUnallocatedDirectFieldMapper.

Definition at line 76 of file FieldMapper.H.

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

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

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

Here is the caller graph for this function:

◆ directAddressing()

◆ addressing()

virtual const labelListList& addressing ( ) const
inlinevirtual

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

Definition at line 98 of file FieldMapper.H.

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

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

Definition at line 107 of file FieldMapper.H.

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

Referenced by Field< Foam::Vector2D >::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 > &  f) const
inline

Definition at line 120 of file FieldMapper.H.

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

Here is the call graph for this function:

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