ElemIndexHelper.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "MooseError.h"

// libMesh includes
#include "libmesh/elem.h"
#include "libmesh/elem_range.h"
#include "libmesh/mesh_base.h"

class ElemIndexHelper
{
public:
  ElemIndexHelper(libMesh::MeshBase & mesh, const std::string & extra_elem_integer_name);

  void initialize(const libMesh::SimpleRange<libMesh::MeshBase::element_iterator> elems);

  bool hasIndex(const libMesh::Elem * elem) const
  {
    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;
  }

  libMesh::dof_id_type getIndex(const libMesh::Elem * elem) const
  {
    mooseAssert(hasIndex(elem), "Elem not in indexed range");
    return elem->get_extra_integer(_extra_integer);
  }

  libMesh::dof_id_type maxIndex() const { return _max_index; }

private:
  // The mesh
  libMesh::MeshBase & _mesh;
  unsigned int _extra_integer;
  bool _initialized;
  libMesh::dof_id_type _max_index;
};