geos::ToParticleRelation< BASETYPE > Class Template Reference

A relationship to a particle. More...

#include <ToParticleRelation.hpp>

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

Public Member Functions
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	setParticleManager (ParticleManager const &input)
	Set the ParticleRegionManager. More...
ParticleManager const *	getParticleManager () const
	Get the ParticleRegionManager. More...

Public Attributes
array1d< localIndex >	m_numParticles
	The number of particles associated with the object.
BASETYPE	m_toParticleRegion
	The relationship between object indices and particle regions.
BASETYPE	m_toParticleSubRegion
	The relationship between object indices and particle subregions.
BASETYPE	m_toParticleIndex
	The relationship between object indices and particle indices.
ParticleManager const *	m_particleManager {}
	The current ParticleRegionManager.

Detailed Description

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

A relationship to a particle.

Template Parameters

BASETYPE

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

Definition at line 36 of file ToParticleRelation.hpp.

Member Function Documentation

getParticleManager()

template<typename BASETYPE >

ParticleManager const* geos::ToParticleRelation< BASETYPE >::getParticleManager ( ) const

inline

Get the ParticleRegionManager.

Returns

The current ParticleRegionManager.

Definition at line 90 of file ToParticleRelation.hpp.

resize()

template<typename BASETYPE >

template<typename ... DIMS>

void geos::ToParticleRelation< BASETYPE >::resize ( DIMS...  newdims )

inline

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.

Definition at line 50 of file ToParticleRelation.hpp.

setParticleManager()

template<typename BASETYPE >

void geos::ToParticleRelation< BASETYPE >::setParticleManager ( ParticleManager const &  input )

inline

Set the ParticleRegionManager.

Parameters

input

The ParticleRegionManager to set.

Definition at line 81 of file ToParticleRelation.hpp.

size() [1/2]

template<typename BASETYPE >

localIndex geos::ToParticleRelation< BASETYPE >::size ( ) const

inline

Get the current size of the relationship storage.

Returns

The current size of the relationship storage.

Definition at line 62 of file ToParticleRelation.hpp.

size() [2/2]

template<typename BASETYPE >

localIndex geos::ToParticleRelation< 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 72 of file ToParticleRelation.hpp.

---

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

• coreComponents/mesh/ToParticleRelation.hpp