geosx::ToElementRelation< BASETYPE > Class Template Reference

A relationship to an element. More...

#include <ToElementRelation.hpp>

Public Types
using	base_type = BASETYPE
	The type of the underlying relationship storage object.

Public Member Functions
	ToElementRelation ()
	The default constructor.
	~ToElementRelation ()
	The default destructor.
template<typename ... DIMS>
void	resize (DIMS... newdims)
	Resize the underlying relationship storage. More...
localIndex	size () const
	Get the current size of the relationship storage. More...
localIndex	size (int const dim) const
	Get the size of a specific dimension of the relationship storage. More...
void	setElementRegionManager (ElementRegionManager const *const input)
	Set the ElementRegionManager. More...
ElementRegionManager const *	getElementRegionManager () const
	Get the ElementRegionManager. More...

Public Attributes
BASETYPE	m_toElementRegion
	The relationship between object indices and element regions.
BASETYPE	m_toElementSubRegion
	The relationship between object indices and element subregions.
BASETYPE	m_toElementIndex
	The relationship between object indices and element indices.
ElementRegionManager const *	m_elemRegionManager
	The current ElementRegionManager.

Detailed Description

template<typename BASETYPE>
class geosx::ToElementRelation< BASETYPE >

A relationship to an element.

Template Parameters

BASETYPE

The underlying relation type to use to store the relationsip information.

Definition at line 35 of file ToElementRelation.hpp.

Member Function Documentation

getElementRegionManager()

template<typename BASETYPE>

ElementRegionManager const* geosx::ToElementRelation< BASETYPE >::getElementRegionManager ( ) const

inline

Get the ElementRegionManager.

Returns

The current ElementRegionManager.

Definition at line 88 of file ToElementRelation.hpp.

resize()

template<typename BASETYPE>

template<typename ... DIMS>

void geosx::ToElementRelation< BASETYPE >::resize

(

DIMS...

newdims

)

Resize the underlying relationship storage.

Template Parameters

DIMS	The types of each dimensions resize parameter.

Parameters

newdims

A parameter pack of appropriate size to resize each dimension of the relationship storage.

setElementRegionManager()

template<typename BASETYPE>

void geosx::ToElementRelation< BASETYPE >::setElementRegionManager ( ElementRegionManager const *const  input )

inline

Set the ElementRegionManager.

Parameters

input

The ElementRegionManager to set.

Definition at line 79 of file ToElementRelation.hpp.

size() [1/2]

template<typename BASETYPE>

localIndex geosx::ToElementRelation< BASETYPE >::size ( ) const

inline

Get the current size of the relationship storage.

Returns

The current size of the relationship storage.

Definition at line 60 of file ToElementRelation.hpp.

size() [2/2]

template<typename BASETYPE>

localIndex geosx::ToElementRelation< BASETYPE >::size ( int const  dim ) const

inline

Get the size of a specific dimension of the relationship storage.

Parameters

dim	The dimension to get the storage size of.

Returns

The dimension size

Definition at line 70 of file ToElementRelation.hpp.

---

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

• coreComponents/mesh/ToElementRelation.hpp