ElementIDInterface.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

#include <string>
#include <memory>

#include "MooseObject.h"
#include "MooseMesh.h"

#include "libmesh/elem.h"

class InputParameters;
class MooseObject;

class ElementIDInterface
{
public:
  static InputParameters validParams();

  ElementIDInterface(const MooseObject * moose_object);

#ifdef MOOSE_KOKKOS_ENABLED

  ElementIDInterface(const ElementIDInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif

  virtual ~ElementIDInterface() {}

  virtual unsigned int getElementIDIndex(const std::string & id_parameter_name,
                                         unsigned int comp = 0) const;

  virtual unsigned int getElementIDIndexByName(const std::string & id_name) const;

  virtual const dof_id_type & getElementID(const std::string & id_parameter_name,
                                           unsigned int comp = 0) const;

  virtual const dof_id_type & getElementIDNeighbor(const std::string & id_parameter_name,
                                                   unsigned int comp = 0) const;

  virtual const dof_id_type & getElementIDByName(const std::string & id_name) const;

  virtual const dof_id_type & getElementIDNeighborByName(const std::string & id_name) const;

  bool hasElementID(const std::string & id_name) const { return _id_mesh->hasElementID(id_name); }

  dof_id_type maxElementID(unsigned int elem_id_index) const
  {
    return _id_mesh->maxElementID(elem_id_index);
  }

  dof_id_type minElementID(unsigned int elem_id_index) const
  {
    return _id_mesh->minElementID(elem_id_index);
  }

  bool areElemIDsIdentical(const std::string & id_name1, const std::string & id_name2) const
  {
    return _id_mesh->areElemIDsIdentical(id_name1, id_name2);
  }

  std::unordered_map<dof_id_type, std::set<dof_id_type>>
  getElemIDMapping(const std::string & id_name1, const std::string & id_name2) const
  {
    return _id_mesh->getElemIDMapping(id_name1, id_name2);
  }

  std::set<dof_id_type> getAllElemIDs(unsigned int elem_id_index) const
  {
    return _id_mesh->getAllElemIDs(elem_id_index);
  }

  std::set<dof_id_type> getElemIDsOnBlocks(unsigned int elem_id_index,
                                           const std::set<SubdomainID> & blks) const
  {
    return _id_mesh->getElemIDsOnBlocks(elem_id_index, blks);
  }

  dof_id_type getElementID(const Elem * elem, unsigned int elem_id_index) const
  {
    if (elem_id_index == elem->n_extra_integers())
      return elem->subdomain_id();

    return elem->get_extra_integer(elem_id_index);
  }

private:
  const InputParameters & _obj_parameters;

  std::shared_ptr<MooseMesh> & _id_mesh;

  const std::string & _ei_name;
};