Public Types | Public Member Functions | List of all members
DirectFieldMapper< FieldMapperType > Class Template Reference

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

Inheritance diagram for DirectFieldMapper< FieldMapperType >:
Inheritance graph
[legend]
Collaboration diagram for DirectFieldMapper< FieldMapperType >:
Collaboration graph
[legend]

Public Types

typedef FieldMapperType mapper_type
 The base mapper type. More...
 

Public Member Functions

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

Detailed Description

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

A templated direct mapper for the given FieldMapper type.

Definition at line 39 of file directFieldMapper.H.

Member Typedef Documentation

◆ mapper_type

typedef FieldMapperType mapper_type

The base mapper type.

Definition at line 92 of file directFieldMapper.H.

Constructor & Destructor Documentation

◆ DirectFieldMapper()

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

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

Definition at line 101 of file directFieldMapper.H.

◆ ~DirectFieldMapper()

virtual ~DirectFieldMapper ( )
virtualdefault

Destructor.

Member Function Documentation

◆ hasDirectAddressing()

virtual bool hasDirectAddressing ( ) const
inlinevirtual

True if directAddressing is not the null object (unallocated)

Definition at line 123 of file directFieldMapper.H.

References Foam::notNull().

Here is the call graph for this function:

◆ size()

virtual label size ( ) const
inlinevirtual

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

Definition at line 131 of file directFieldMapper.H.

References UList< T >::size().

Here is the call graph for this function:

◆ direct()

virtual bool direct ( ) const
inlinevirtual

It is a direct mapper.

Definition at line 139 of file directFieldMapper.H.

◆ hasUnmapped() [1/2]

virtual bool hasUnmapped ( ) const
inlinevirtual

Any unmapped values?

Definition at line 147 of file directFieldMapper.H.

Referenced by fvMeshAdder::MapSurfaceField(), and fvMeshAdder::MapVolField().

Here is the caller graph for this function:

◆ hasUnmapped() [2/2]

virtual bool& hasUnmapped ( )
inlinevirtual

Allow modification.

Definition at line 155 of file directFieldMapper.H.

◆ directAddressing()

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: