PlaneIDMeshGenerator.C

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

#include "PlaneIDMeshGenerator.h"
#include "CastUniquePointer.h"

#include "libmesh/elem.h"

registerMooseObject("MooseApp", PlaneIDMeshGenerator);

InputParameters
PlaneIDMeshGenerator::validParams()
{
  InputParameters params = MeshGenerator::validParams();

  params.addRequiredParam<MeshGeneratorName>("input", "The mesh we want to modify");
  params.addRequiredParam<std::vector<Real>>(
      "plane_coordinates",
      "Coordinates of planes along the axis. The origin are at x/y/z=0 depending on the axis");
  params.addParam<std::vector<unsigned int>>("num_ids_per_plane", "Number of unique ids per plane");
  MooseEnum plane_axis("x y z", "z");
  params.addParam<MooseEnum>("plane_axis", plane_axis, "Axis of plane");
  params.addRequiredParam<std::string>("id_name", "Name of extra integer ID set");
  params.addParam<Real>("tolerance", 1.0E-4, "Tolerance for plane coordinate check");
  params.addClassDescription("Adds an extra element integer that identifies planes in a mesh.");
  return params;
}

PlaneIDMeshGenerator::PlaneIDMeshGenerator(const InputParameters & parameters)
  : MeshGenerator(parameters),
    _input(getMesh("input")),
    _axis_index(getParam<MooseEnum>("plane_axis")),
    _element_id_name(getParam<std::string>("id_name"))
{
  if (!isParamValid("num_ids_per_plane"))
    _planes = getParam<std::vector<Real>>("plane_coordinates");
  else
  {
    _planes.clear();
    std::vector<Real> base_planes = getParam<std::vector<Real>>("plane_coordinates");
    std::vector<unsigned int> sublayers = getParam<std::vector<unsigned int>>("num_ids_per_plane");
    if (base_planes.size() != sublayers.size() + 1)
      paramError("plane_coordinates",
                 "Sizes of 'plane_coordinates' and 'num_ids_per_plane' disagree");
    _planes.push_back(base_planes[0]);
    for (unsigned int i = 0; i < sublayers.size(); ++i)
    {
      Real layer_size = (base_planes[i + 1] - base_planes[i]) / (Real)sublayers[i];
      if (MooseUtils::absoluteFuzzyGreaterEqual(base_planes[i], base_planes[i + 1]))
        paramError("plane_coordinates", "Plane coordinates must be in increasing order");

      for (unsigned int j = 0; j < sublayers[i]; ++j)
        _planes.push_back(_planes.back() + layer_size);
    }
  }
  if (_planes.size() < 2)
    paramError("plane_coordinates", "Size of 'plane_coordinates' should be at least two");
}

std::unique_ptr<MeshBase>
PlaneIDMeshGenerator::generate()
{
  std::unique_ptr<MeshBase> mesh = std::move(_input);
  if (mesh->mesh_dimension() < _axis_index + 1)
    paramError("plane_axis", "Plane axis must be contained in the mesh. Check mesh dimension");
  unsigned int extra_id_index = 0;
  if (!mesh->has_elem_integer(_element_id_name))
    extra_id_index = mesh->add_elem_integer(_element_id_name);
  else
  {
    extra_id_index = mesh->get_elem_integer_index(_element_id_name);
    paramWarning(
        "id_name", "An element integer with the name '", _element_id_name, "' already exists");
  }

  // Check that the planes do not cut the elements beyond the acceptable tolerance
  const Real tol = getParam<Real>("tolerance");
  for (auto & elem : mesh->active_element_ptr_range())
  {
    const int layer_id = getPlaneID(elem->vertex_average());
    for (unsigned int i = 0; i < elem->n_nodes(); ++i)
    {
      const Point & p = elem->point(i) - (elem->point(i) - elem->vertex_average()) * tol;
      if (getPlaneID(p) != layer_id)
        mooseError("Element at ", elem->vertex_average(), " is cut by the planes");
    }
    elem->set_extra_integer(extra_id_index, layer_id);
  }
  return dynamic_pointer_cast<MeshBase>(mesh);
}

int
PlaneIDMeshGenerator::getPlaneID(const Point & p) const
{
  // check the input point is located within the plane range
  if (p(_axis_index) < _planes[0] || p(_axis_index) > _planes.back())
    mooseError("The planes do not cover element at ", p);
  int id = 0;
  // looping over each plane to find a plane ID corresponding to the input point
  for (unsigned int layer_id = 0; layer_id < _planes.size() - 1; ++layer_id)
  {
    // check the input point is located between _planes[layer_id] and _planes[layer_id + 1]
    if (_planes[layer_id] < p(_axis_index) && _planes[layer_id + 1] >= p(_axis_index))
    {
      id = layer_id;
      break;
    }
  }
  return id;
}