distributedWeightedFvPatchFieldMapper Class Reference

FieldMapper with weighted mapping from (optionally remote) quantities. More...

Inheritance diagram for distributedWeightedFvPatchFieldMapper:
[legend]
Collaboration diagram for distributedWeightedFvPatchFieldMapper:
[legend]

Public Member Functions

 distributedWeightedFvPatchFieldMapper (const label singlePatchProc, const mapDistributeBase *distMapPtr, const labelListList &addressing, const scalarListList &weights)
 Construct given addressing. More...
 
virtual ~distributedWeightedFvPatchFieldMapper ()=default
 Destructor. More...
 
virtual label size () const
 The size of the mapper. More...
 
virtual bool direct () const
 Is it a direct (non-interpolating) mapper? More...
 
virtual bool distributed () const
 Does the mapper have remote contributions? More...
 
virtual const mapDistributeBasedistributeMap () const
 Return the distribution map. More...
 
virtual bool hasUnmapped () const
 Any unmapped values? More...
 
virtual const labelListListaddressing () const
 Return the interpolation addressing. More...
 
virtual const scalarListListweights () const
 Return the interpolation weights. More...
 
- Public Member Functions inherited from fvPatchFieldMapper
 fvPatchFieldMapper ()=default
 Default construct. More...
 
- Public Member Functions inherited from FieldMapper
 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 labelUListdirectAddressing () const
 Return the direct addressing values. More...
 
virtual const mapDistributeBasedistributeMap () const
 Return the distribution map. More...
 
virtual const labelListListaddressing () const
 Return the interpolation addressing. More...
 
virtual const scalarListListweights () 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

FieldMapper with weighted mapping from (optionally remote) quantities.

Definition at line 49 of file distributedWeightedFvPatchFieldMapper.H.

Constructor & Destructor Documentation

◆ distributedWeightedFvPatchFieldMapper()

distributedWeightedFvPatchFieldMapper ( const label  singlePatchProc,
const mapDistributeBase distMapPtr,
const labelListList addressing,
const scalarListList weights 
)
inline

Construct given addressing.

Definition at line 68 of file distributedWeightedFvPatchFieldMapper.H.

References distributedWeightedFvPatchFieldMapper::addressing(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ ~distributedWeightedFvPatchFieldMapper()

virtual ~distributedWeightedFvPatchFieldMapper ( )
virtualdefault

Destructor.

Member Function Documentation

◆ size()

virtual label size ( ) const
inlinevirtual

The size of the mapper.

Implements FieldMapper.

Definition at line 108 of file distributedWeightedFvPatchFieldMapper.H.

References distributedWeightedFvPatchFieldMapper::addressing(), mapDistributeBase::constructSize(), distributedWeightedFvPatchFieldMapper::distributed(), distributedWeightedFvPatchFieldMapper::distributeMap(), and UList< T >::size().

Here is the call graph for this function:

◆ direct()

virtual bool direct ( ) const
inlinevirtual

Is it a direct (non-interpolating) mapper?

Implements FieldMapper.

Definition at line 120 of file distributedWeightedFvPatchFieldMapper.H.

◆ distributed()

virtual bool distributed ( ) const
inlinevirtual

Does the mapper have remote contributions?

Reimplemented from FieldMapper.

Definition at line 125 of file distributedWeightedFvPatchFieldMapper.H.

Referenced by distributedWeightedFvPatchFieldMapper::size().

Here is the caller graph for this function:

◆ distributeMap()

virtual const mapDistributeBase & distributeMap ( ) const
inlinevirtual

Return the distribution map.

Reimplemented from FieldMapper.

Definition at line 130 of file distributedWeightedFvPatchFieldMapper.H.

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

Referenced by distributedWeightedFvPatchFieldMapper::size().

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

◆ hasUnmapped()

virtual bool hasUnmapped ( ) const
inlinevirtual

Any unmapped values?

I.e. do all size() elements get value

Implements FieldMapper.

Definition at line 141 of file distributedWeightedFvPatchFieldMapper.H.

◆ addressing()

virtual const labelListList & addressing ( ) const
inlinevirtual

Return the interpolation addressing.

Reimplemented from FieldMapper.

Definition at line 146 of file distributedWeightedFvPatchFieldMapper.H.

Referenced by distributedWeightedFvPatchFieldMapper::distributedWeightedFvPatchFieldMapper(), and distributedWeightedFvPatchFieldMapper::size().

Here is the caller graph for this function:

◆ weights()

virtual const scalarListList & weights ( ) const
inlinevirtual

Return the interpolation weights.

Reimplemented from FieldMapper.

Definition at line 151 of file distributedWeightedFvPatchFieldMapper.H.


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