ElemIndexHelper Class Reference

Helper for setting up a contiguous index for a given range of elements that are known by this processor. More...

#include <ElemIndexHelper.h>

Public Member Functions
	ElemIndexHelper (libMesh::MeshBase &mesh, const std::string &extra_elem_integer_name)
	Constructor. More...
void	initialize (const libMesh::SimpleRange< libMesh::MeshBase::element_iterator > elems)
	Initializes the indices in a contiguous manner for the given element range. More...
bool	hasIndex (const libMesh::Elem *elem) const
	Whether or not the element elem has an index set for it using this object. More...
libMesh::dof_id_type	getIndex (const libMesh::Elem *elem) const
	Get the index associated with the element elem. More...
libMesh::dof_id_type	maxIndex () const
	Gets the maximum index generated using this object. More...

Private Attributes
libMesh::MeshBase &	_mesh
unsigned int	_extra_integer
	The extra elem integer that stores the index. More...
bool	_initialized
	Whether or not this object is initialized. More...
libMesh::dof_id_type	_max_index
	The max index generated. More...

Detailed Description

Helper for setting up a contiguous index for a given range of elements that are known by this processor.

The contiguous index is useful for indexing into alternate data structures for each element without the need for a map.

The index is stored on each elem for quick access.

Definition at line 29 of file ElemIndexHelper.h.

Constructor & Destructor Documentation

ElemIndexHelper()

ElemIndexHelper::ElemIndexHelper	(	libMesh::MeshBase &	mesh,
		const std::string &	extra_elem_integer_name
	)

Constructor.

Parameters

mesh	The mesh that contains the elements that are to be index into.
extra_elem_integer_name	A name for the extra element integer that will store the index.

Make sure to call initialize() after construction!

Definition at line 14 of file ElemIndexHelper.C.

  : _mesh(mesh), _extra_integer(invalid_uint), _initialized(false)
{
  _extra_integer = mesh.add_elem_integer(extra_elem_integer_name);
}

Member Function Documentation

getIndex()

libMesh::dof_id_type ElemIndexHelper::getIndex ( const libMesh::Elem *  elem ) const

inline

Get the index associated with the element elem.

Definition at line 61 of file ElemIndexHelper.h.

Referenced by RayTracingStudy::internalSidesetSetup(), RayTracingStudy::nonPlanarSideSetup(), and RayTracingStudy::sideIsNonPlanar().

  {
    mooseAssert(hasIndex(elem), "Elem not in indexed range");
    return elem->get_extra_integer(_extra_integer);
  }

hasIndex()

bool ElemIndexHelper::hasIndex ( const libMesh::Elem *  elem ) const

inline

Whether or not the element elem has an index set for it using this object.

Definition at line 50 of file ElemIndexHelper.h.

Referenced by getIndex().

  {
    mooseAssert(elem, "Null elem");
    mooseAssert(_initialized, "Not initialized");
    mooseAssert(_mesh.query_elem_ptr(elem->id()), "Not an elem of the mesh");
    return elem->get_extra_integer(_extra_integer) != libMesh::DofObject::invalid_id;
  }

initialize()

void ElemIndexHelper::initialize

(

const libMesh::SimpleRange< libMesh::MeshBase::element_iterator >

elems

)

Initializes the indices in a contiguous manner for the given element range.

Definition at line 21 of file ElemIndexHelper.C.

Referenced by RayTracingStudy::localElemIndexSetup().

{
  // First, invalidate the integers for all elements that we know about
  // so that we can tell when getting an index for an elem if said elem
  // was not in the range
  for (Elem * elem : _mesh.element_ptr_range())
    elem->set_extra_integer(_extra_integer, DofObject::invalid_id);

  // Set the index in a contiguous manner for all elements in the range
  dof_id_type next_index = 0;
  for (Elem * elem : elems)
    elem->set_extra_integer(_extra_integer, next_index++);

  // Store the max index so that users can use it to initialize data
  // structures that will use these indices
  _max_index = next_index - 1;

  _initialized = true;
}

maxIndex()

libMesh::dof_id_type ElemIndexHelper::maxIndex ( ) const

inline

Gets the maximum index generated using this object.

Useful for initializing data structures that will be indexed using the indices provided by this object.

Definition at line 73 of file ElemIndexHelper.h.

Referenced by RayTracingStudy::internalSidesetSetup(), and RayTracingStudy::nonPlanarSideSetup().

{ return _max_index; }

Member Data Documentation

_extra_integer

unsigned int ElemIndexHelper::_extra_integer

private

The extra elem integer that stores the index.

Definition at line 79 of file ElemIndexHelper.h.

Referenced by ElemIndexHelper(), getIndex(), hasIndex(), and initialize().

_initialized

bool ElemIndexHelper::_initialized

private

Whether or not this object is initialized.

Definition at line 81 of file ElemIndexHelper.h.

Referenced by hasIndex(), and initialize().

_max_index

libMesh::dof_id_type ElemIndexHelper::_max_index

private

The max index generated.

Definition at line 83 of file ElemIndexHelper.h.

Referenced by initialize(), and maxIndex().

_mesh

libMesh::MeshBase& ElemIndexHelper::_mesh

private

Definition at line 77 of file ElemIndexHelper.h.

Referenced by hasIndex(), and initialize().

---

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

• ray_tracing/include/utils/ElemIndexHelper.h
• ray_tracing/src/utils/ElemIndexHelper.C