GEOSX
Public Types | Public Member Functions | List of all members
geosx::InterObjectRelation< BASETYPE > Class Template Reference

#include <InterObjectRelation.hpp>

Inheritance diagram for geosx::InterObjectRelation< BASETYPE >:
Inheritance graph
[legend]

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...
 
const base_typeBase () const
 Get a reference to this object cast to BASETYPE const. More...
 
base_typeBase ()
 Get a reference to this object cast to BASETYPE. More...
 
void SetRelatedObject (ObjectManagerBase const *const relatedObject)
 Set the related object. More...
 
const ObjectManagerBaseRelatedObject () 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 geosx::InterObjectRelation< BASETYPE >

Template Parameters
BASETYPEThe base class to provide the implementation of the relationship mapping.

Definition at line 32 of file BufferOps.hpp.

Constructor & Destructor Documentation

◆ InterObjectRelation()

template<typename BASETYPE>
template<typename ... ARGS>
geosx::InterObjectRelation< BASETYPE >::InterObjectRelation ( ARGS &&...  args)
inline

A forwarding constructor.

Template Parameters
ARGSThe types of the arguments to forward to the BASETYPE constructor.
Parameters
argsA parameter pack of arguments to forward to the BASETYPE constructor.

Definition at line 47 of file InterObjectRelation.hpp.

Member Function Documentation

◆ Base() [1/2]

template<typename BASETYPE>
const base_type& geosx::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 55 of file InterObjectRelation.hpp.

◆ Base() [2/2]

template<typename BASETYPE>
base_type& geosx::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 61 of file InterObjectRelation.hpp.

◆ RelatedObject()

template<typename BASETYPE>
const ObjectManagerBase* geosx::InterObjectRelation< BASETYPE >::RelatedObject ( ) const
inline

Get the related object.

Returns
The related object.

Definition at line 74 of file InterObjectRelation.hpp.

◆ RelatedObjectGlobalToLocal()

template<typename BASETYPE>
unordered_map< globalIndex, localIndex > const& geosx::InterObjectRelation< BASETYPE >::RelatedObjectGlobalToLocal ( ) const
inline

Get the GlobalToLocal mapping from the related object.

Returns
The GlobalToLocal mapping from the related object.

Definition at line 88 of file InterObjectRelation.hpp.

◆ RelatedObjectLocalToGlobal()

template<typename BASETYPE>
arrayView1d< globalIndex const > geosx::InterObjectRelation< BASETYPE >::RelatedObjectLocalToGlobal ( ) const
inline

Get the LocalToGlobal mapping from the related object.

Returns
The LocalToGlobal mapping from the related object.

Definition at line 81 of file InterObjectRelation.hpp.

◆ SetRelatedObject()

template<typename BASETYPE>
void geosx::InterObjectRelation< BASETYPE >::SetRelatedObject ( ObjectManagerBase const *const  relatedObject)
inline

Set the related object.

Parameters
relatedObjectThe related object to use for mapping.

Definition at line 67 of file InterObjectRelation.hpp.


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