Public Member Functions | List of all members
generalFieldMapper Class Referenceabstract

General field mapper supporting both direct and weighted mapping. More...

Inheritance diagram for generalFieldMapper:
Inheritance graph
[legend]
Collaboration diagram for generalFieldMapper:
Collaboration graph
[legend]

Public Member Functions

 generalFieldMapper ()
 Null constructor. More...
 
virtual ~generalFieldMapper ()
 Destructor. More...
 
virtual bool direct () const =0
 
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
 
 FOR_ALL_FIELD_TYPES (DEFINE_FIELD_MAPPER_OPERATOR,)
 Map a field. More...
 
 DEFINE_FIELD_MAPPER_OPERATOR (label,)
 Map a label field. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > map (const Field< Type > &mapF) const
 
- Public Member Functions inherited from fieldMapper
 fieldMapper ()
 Null constructor. More...
 
virtual ~fieldMapper ()
 Destructor. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FIELD_MAPPER_OPERATOR,=0)
 Map a field. More...
 
virtual void operator() (Field< label > &f, const Field< label > &mapF) const =0
 Map a label field. More...
 
virtual tmp< Field< label > > operator() (const Field< label > &mapF) const =0
 
template<class Type >
void operator() (Field< Type > &f, const tmp< Field< Type >> &tmapF) const
 Map a temporary field. More...
 
template<class Type >
tmp< Field< Type > > operator() (const tmp< Field< Type >> &tmapF) const
 Map a temporary field. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > operator() (const tmp< Field< Type >> &tmapF) const
 

Detailed Description

General field mapper supporting both direct and weighted mapping.

Definition at line 45 of file generalFieldMapper.H.

Constructor & Destructor Documentation

◆ generalFieldMapper()

generalFieldMapper ( )
inline

Null constructor.

Definition at line 63 of file generalFieldMapper.H.

◆ ~generalFieldMapper()

virtual ~generalFieldMapper ( )
inlinevirtual

Destructor.

Definition at line 68 of file generalFieldMapper.H.

References generalFieldMapper::addressing(), generalFieldMapper::DEFINE_FIELD_MAPPER_OPERATOR(), generalFieldMapper::direct(), generalFieldMapper::directAddressing(), generalFieldMapper::FOR_ALL_FIELD_TYPES(), generalFieldMapper::hasUnmapped(), and generalFieldMapper::weights().

Here is the call graph for this function:

Member Function Documentation

◆ direct()

virtual bool direct ( ) const
pure virtual

Implemented in meshToMesh0::patchFieldInterpolator, pointPatchMapper, fvPatchMapper, faceMapper, singleCellFvMesh::agglomPatchFieldMapper, fvSurfaceMapper, cellMapper, pointMapper, pointFieldDecomposer::patchFieldDecomposer, and directPointPatchFieldMapper.

Referenced by pointPatchMapper::direct(), generalFieldMapper::map(), and generalFieldMapper::~generalFieldMapper().

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

Implements fieldMapper.

Implemented in meshToMesh0::patchFieldInterpolator, fvPatchMapper, faceMapper, singleCellFvMesh::agglomPatchFieldMapper, fvSurfaceMapper, pointMapper, cellMapper, pointPatchMapper, pointFieldDecomposer::patchFieldDecomposer, directPointPatchFieldMapper, and directPointPatchFieldMapper.

Referenced by generalFieldMapper::~generalFieldMapper().

Here is the caller graph for this function:

◆ directAddressing()

const Foam::labelUList & directAddressing ( ) const
virtual

Reimplemented in meshToMesh0::patchFieldInterpolator, pointPatchMapper, fvPatchMapper, faceMapper, fvSurfaceMapper, pointMapper, cellMapper, pointFieldDecomposer::patchFieldDecomposer, and directPointPatchFieldMapper.

Definition at line 30 of file generalFieldMapper.C.

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

Referenced by generalFieldMapper::map(), and generalFieldMapper::~generalFieldMapper().

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

◆ addressing()

const Foam::labelListList & addressing ( ) const
virtual

Reimplemented in pointPatchMapper, fvPatchMapper, faceMapper, fvSurfaceMapper, pointMapper, cellMapper, singleCellFvMesh::agglomPatchFieldMapper, and directPointPatchFieldMapper.

Definition at line 40 of file generalFieldMapper.C.

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

Referenced by generalFieldMapper::map(), and generalFieldMapper::~generalFieldMapper().

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

◆ weights()

const Foam::scalarListList & weights ( ) const
virtual

Reimplemented in pointPatchMapper, fvPatchMapper, faceMapper, fvSurfaceMapper, pointMapper, singleCellFvMesh::agglomPatchFieldMapper, and cellMapper.

Definition at line 50 of file generalFieldMapper.C.

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

Referenced by meshToMesh0::V(), and generalFieldMapper::~generalFieldMapper().

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

◆ FOR_ALL_FIELD_TYPES()

FOR_ALL_FIELD_TYPES ( DEFINE_FIELD_MAPPER_OPERATOR  )

Map a field.

Referenced by generalFieldMapper::weights(), and generalFieldMapper::~generalFieldMapper().

Here is the caller graph for this function:

◆ DEFINE_FIELD_MAPPER_OPERATOR()

DEFINE_FIELD_MAPPER_OPERATOR ( label  )

Map a label field.

Referenced by generalFieldMapper::~generalFieldMapper().

Here is the caller graph for this function:

◆ map()

Foam::tmp<Foam::Field<Type> > map ( const Field< Type > &  mapF) const

Definition at line 64 of file generalFieldMapperTemplates.C.

References generalFieldMapper::addressing(), generalFieldMapper::direct(), generalFieldMapper::directAddressing(), tmp< T >::ref(), and tf.

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