DistributedFieldMapper< DirectFieldMapperType > Class Template Reference

A templated field mapper with direct mapping from local or remote quantities. More...

Inheritance diagram for DistributedFieldMapper< DirectFieldMapperType >:
[legend]
Collaboration diagram for DistributedFieldMapper< DirectFieldMapperType >:
[legend]

Public Types

typedef DirectFieldMapperType mapper_type
 The base direct mapper type. More...
 

Public Member Functions

 DistributedFieldMapper (const labelUList &directAddr, const mapDistributeBase &distMap)
 Construct with addressing and distribute map. More...
 
virtual ~DistributedFieldMapper ()=default
 Destructor. More...
 
virtual label size () const
 
virtual bool distributed () const
 It is a distributed mapper. More...
 
virtual const mapDistributeBasedistributeMap () const
 Return the distribution map. More...
 

Detailed Description

template<class DirectFieldMapperType>
class Foam::DistributedFieldMapper< DirectFieldMapperType >

A templated field mapper with direct mapping from local or remote quantities.

Definition at line 58 of file distributedFieldMapper.H.

Member Typedef Documentation

◆ mapper_type

typedef DirectFieldMapperType mapper_type

The base direct mapper type.

Definition at line 73 of file distributedFieldMapper.H.

Constructor & Destructor Documentation

◆ DistributedFieldMapper()

DistributedFieldMapper ( const labelUList directAddr,
const mapDistributeBase distMap 
)
inline

Construct with addressing and distribute map.

Definition at line 79 of file distributedFieldMapper.H.

◆ ~DistributedFieldMapper()

virtual ~DistributedFieldMapper ( )
virtualdefault

Destructor.

Member Function Documentation

◆ size()

virtual label size ( ) const
inlinevirtual

The mapper size is given by the direct addressing size (if valid) or from the distributeMap construct size.

Definition at line 98 of file distributedFieldMapper.H.

References mapDistributeBase::constructSize().

Here is the call graph for this function:

◆ distributed()

virtual bool distributed ( ) const
inlinevirtual

It is a distributed mapper.

Definition at line 109 of file distributedFieldMapper.H.

◆ distributeMap()

virtual const mapDistributeBase & distributeMap ( ) const
inlinevirtual

Return the distribution map.

Definition at line 115 of file distributedFieldMapper.H.


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