geos::InterObjectRelation< BASETYPE > Class Template Reference

#include <InterObjectRelation.hpp>

Inheritance diagram for geos::InterObjectRelation< BASETYPE >:

Public Types
using	base_type = BASETYPE
	The type of the base class.

Public Member Functions
template<typename ... ARGS>
	InterObjectRelation (ARGS &&... args)
	A forwarding constructor. More...
InterObjectRelation< BASETYPE > &	operator= (InterObjectRelation< BASETYPE > const &rhs)
	copy assignement operator More...
const base_type &	base () const
	Get a reference to this object cast to BASETYPE const. More...
base_type &	base ()
	Get a reference to this object cast to BASETYPE. More...
void	setRelatedObject (ObjectManagerBase const &relatedObject)
	Set the related object. More...
const ObjectManagerBase *	relatedObject () const
	Get the related object. More...
arrayView1d< globalIndex const >	relatedObjectLocalToGlobal () const
	Get the LocalToGlobal mapping from the related object. More...
unordered_map< globalIndex, localIndex > const &	relatedObjectGlobalToLocal () const
	Get the GlobalToLocal mapping from the related object. More...

Detailed Description

template<typename BASETYPE>
class geos::InterObjectRelation< BASETYPE >

Template Parameters

BASETYPE

The base class to provide the implementation of the relationship mapping.

Definition at line 35 of file InterObjectRelation.hpp.

Constructor & Destructor Documentation

InterObjectRelation()

template<typename BASETYPE >

template<typename ... ARGS>

geos::InterObjectRelation< BASETYPE >::InterObjectRelation ( ARGS &&...  args )

inline

A forwarding constructor.

Template Parameters

ARGS	The types of the arguments to forward to the BASETYPE constructor.

Parameters

args	A parameter pack of arguments to forward to the BASETYPE constructor.

Definition at line 48 of file InterObjectRelation.hpp.

Member Function Documentation

base() [1/2]

template<typename BASETYPE >

base_type& geos::InterObjectRelation< BASETYPE >::base ( )

inline

Get a reference to this object cast to BASETYPE.

Returns

A reference to this object cast to BASETYPE.

Definition at line 75 of file InterObjectRelation.hpp.

base() [2/2]

template<typename BASETYPE >

const base_type& geos::InterObjectRelation< BASETYPE >::base ( ) const

inline

Get a reference to this object cast to BASETYPE const.

Returns

A reference to this object cast to BASETYPE const.

Definition at line 69 of file InterObjectRelation.hpp.

operator=()

template<typename BASETYPE >

InterObjectRelation< BASETYPE >& geos::InterObjectRelation< BASETYPE >::operator= ( InterObjectRelation< BASETYPE > const &  rhs )

inline

copy assignement operator

Parameters

rhs	the relation to copy

Returns

InterObjectRelation< BASETYPE >&

Definition at line 58 of file InterObjectRelation.hpp.

relatedObject()

template<typename BASETYPE >

const ObjectManagerBase* geos::InterObjectRelation< BASETYPE >::relatedObject ( ) const

inline

Get the related object.

Returns

The related object.

Definition at line 88 of file InterObjectRelation.hpp.

relatedObjectGlobalToLocal()

template<typename BASETYPE >

unordered_map< globalIndex, localIndex > const& geos::InterObjectRelation< BASETYPE >::relatedObjectGlobalToLocal ( ) const

inline

Get the GlobalToLocal mapping from the related object.

Returns

The GlobalToLocal mapping from the related object.

Definition at line 102 of file InterObjectRelation.hpp.

relatedObjectLocalToGlobal()

template<typename BASETYPE >

arrayView1d< globalIndex const > geos::InterObjectRelation< BASETYPE >::relatedObjectLocalToGlobal ( ) const

inline

Get the LocalToGlobal mapping from the related object.

Returns

The LocalToGlobal mapping from the related object.

Definition at line 95 of file InterObjectRelation.hpp.

setRelatedObject()

template<typename BASETYPE >

void geos::InterObjectRelation< BASETYPE >::setRelatedObject ( ObjectManagerBase const &  relatedObject )

inline

Set the related object.

Parameters

relatedObject

The related object to use for mapping.

Definition at line 81 of file InterObjectRelation.hpp.

---

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

• coreComponents/dataRepository/BufferOps.hpp
• coreComponents/mesh/InterObjectRelation.hpp