DirectFieldMapper< FieldMapperType > Class Template Reference

A templated direct mapper for the given FieldMapper type. More...

#include <directFieldMapper.H>

Inheritance diagram for DirectFieldMapper< FieldMapperType >:

Collaboration diagram for DirectFieldMapper< FieldMapperType >:

Public Types
typedef FieldMapperType	mapper_type
	The base mapper type.

Public Member Functions
	DirectFieldMapper (const labelUList &directAddr, const bool checkUnmapped=true)
	Construct given addressing, check for unmapped (negative) values.
virtual	~DirectFieldMapper ()=default
	Destructor.
virtual bool	hasDirectAddressing () const
	True if directAddressing is not the null object (unallocated).
virtual label	size () const
	The mapper size is given by the size of the direct addressing.
virtual bool	direct () const
	It is a direct mapper.
virtual bool	hasUnmapped () const
	Any unmapped values?
virtual bool &	hasUnmapped ()
	Allow modification.
virtual const labelUList &	directAddressing () const
	Return the direct addressing values.

Detailed Description

template<class FieldMapperType>
class Foam::DirectFieldMapper< FieldMapperType >

A templated direct mapper for the given FieldMapper type.

Definition at line 54 of file directFieldMapper.H.

Member Typedef Documentation

mapper_type

template<class FieldMapperType>

typedef FieldMapperType mapper_type

The base mapper type.

Definition at line 92 of file directFieldMapper.H.

Constructor & Destructor Documentation

DirectFieldMapper()

template<class FieldMapperType>

DirectFieldMapper ( const labelUList & directAddr, const bool checkUnmapped = true )

inlineexplicit

Construct given addressing, check for unmapped (negative) values.

Definition at line 100 of file directFieldMapper.H.

~DirectFieldMapper()

template<class FieldMapperType>

virtual ~DirectFieldMapper ( )

virtualdefault

Destructor.

Member Function Documentation

hasDirectAddressing()

template<class FieldMapperType>

virtual bool hasDirectAddressing ( ) const

inlinevirtual

True if directAddressing is not the null object (unallocated).

Definition at line 123 of file directFieldMapper.H.

size()

template<class FieldMapperType>

virtual label size ( ) const

inlinevirtual

The mapper size is given by the size of the direct addressing.

Reimplemented in DistributedFieldMapper< directFaPatchFieldMapper >, DistributedFieldMapper< directFieldMapper >, DistributedFieldMapper< directFvPatchFieldMapper >, and DistributedFieldMapper< directPointPatchFieldMapper >.

Definition at line 131 of file directFieldMapper.H.

direct()

template<class FieldMapperType>

virtual bool direct ( ) const

inlinevirtual

It is a direct mapper.

Definition at line 139 of file directFieldMapper.H.

hasUnmapped() [1/2]

template<class FieldMapperType>

virtual bool hasUnmapped ( ) const

inlinevirtual

Any unmapped values?

Definition at line 147 of file directFieldMapper.H.

Referenced by cellDecomposer::interpolate(), fvMeshSubset::interpolate(), fvMeshAdder::MapSurfaceField(), and fvMeshAdder::MapVolField().

Here is the caller graph for this function:

hasUnmapped() [2/2]

template<class FieldMapperType>

virtual bool & hasUnmapped ( )

inlinevirtual

Allow modification.

Definition at line 155 of file directFieldMapper.H.

directAddressing()

template<class FieldMapperType>

virtual const labelUList & directAddressing ( ) const

inlinevirtual

Return the direct addressing values.

Definition at line 163 of file directFieldMapper.H.

---

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

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