DistributedFieldMapper< DirectFieldMapperType > Class Template Reference

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

#include <distributedFieldMapper.H>

Inheritance diagram for DistributedFieldMapper< DirectFieldMapperType >:

Collaboration diagram for DistributedFieldMapper< DirectFieldMapperType >:

Public Types
typedef DirectFieldMapperType	mapper_type
	The base direct mapper type.

Public Member Functions
	DistributedFieldMapper (const labelUList &directAddr, const mapDistributeBase &distMap)
	Construct with addressing and distribute map.
virtual	~DistributedFieldMapper ()=default
	Destructor.
virtual label	size () const
	The mapper size is given by the direct addressing size (if valid) or from the distributeMap construct size.
virtual bool	distributed () const
	It is a distributed mapper.
virtual const mapDistributeBase &	distributeMap () const
	Return the distribution map.

Detailed Description

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

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

Definition at line 54 of file distributedFieldMapper.H.

Member Typedef Documentation

mapper_type

template<class DirectFieldMapperType>

typedef DirectFieldMapperType mapper_type

The base direct mapper type.

Definition at line 73 of file distributedFieldMapper.H.

Constructor & Destructor Documentation

DistributedFieldMapper()

template<class DirectFieldMapperType>

DistributedFieldMapper ( const labelUList & directAddr, const mapDistributeBase & distMap )

inline

Construct with addressing and distribute map.

Definition at line 81 of file distributedFieldMapper.H.

~DistributedFieldMapper()

template<class DirectFieldMapperType>

virtual ~DistributedFieldMapper ( )

virtualdefault

Destructor.

Member Function Documentation

size()

template<class DirectFieldMapperType>

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 104 of file distributedFieldMapper.H.

distributed()

template<class DirectFieldMapperType>

virtual bool distributed ( ) const

inlinevirtual

It is a distributed mapper.

Definition at line 117 of file distributedFieldMapper.H.

distributeMap()

template<class DirectFieldMapperType>

virtual const mapDistributeBase & distributeMap ( ) const

inlinevirtual

Return the distribution map.

Definition at line 125 of file distributedFieldMapper.H.

---

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

• src/OpenFOAM/fields/Fields/Field/distributedFieldMapper.H