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

// MOOSE includes
#include "CylinderComponent.h"
#include "RotationMatrix.h"

registerMooseAction("MooseApp", CylinderComponent, "add_mesh_generator");
// CylinderComponent is an example of ComponentPhysicsInterface
registerMooseAction("MooseApp", CylinderComponent, "init_component_physics");
// CylinderComponent is an example of ComponentMaterialPropertyInterface
registerMooseAction("MooseApp", CylinderComponent, "add_material");
// CylinderComponent is an example of ComponentInitialConditionInterface
registerMooseAction("MooseApp", CylinderComponent, "check_integrity");
registerActionComponent("MooseApp", CylinderComponent);

InputParameters
CylinderComponent::validParams()
{
  InputParameters params = ActionComponent::validParams();
  params += ComponentPhysicsInterface::validParams();
  params += ComponentMaterialPropertyInterface::validParams();
  params += ComponentInitialConditionInterface::validParams();
  params += ComponentBoundaryConditionInterface::validParams();
  params += ComponentMeshTransformHelper::validParams();
  params.addClassDescription("Cylindrical component.");
  MooseEnum dims("0 1 2 3");
  params.addRequiredParam<MooseEnum>("dimension",
                                     dims,
                                     "Dimension of the cylinder. 0 for a point (not implemented), "
                                     "1 for an (axial) 1D line, 2 for a 2D-RZ cylinder, and 3 for "
                                     "a 3D cylinder");
  params.addParam<SubdomainName>("block", "Block name for the cylinder");

  // Geometry
  params.addRequiredRangeCheckedParam<Real>("radius", "radius>0", "Radius of the cylinder");
  params.addRequiredRangeCheckedParam<Real>("length", "length>0", "Length/Height of the cylinder");
  params.addParam<bool>("position_is_bottom_center",
                        true,
                        "Whether the 'position' parameter gives the position of the bottom-center "
                        "of the cylinder. Only used in 3D");

  // Discretization
  params.addRangeCheckedParam<std::vector<unsigned int>>(
      "n_radial",
      {1},
      "n_radial > 0",
      "Number of radial elements (per ring if multiple values specified). All rings are lumped at "
      "this time.");
  // TODO: Specify the ring radii and subdomains as well
  params.addRequiredRangeCheckedParam<unsigned int>(
      "n_axial", "n_axial>0", "Number of axial elements of the cylinder");
  params.addRangeCheckedParam<unsigned int>(
      "n_sectors",
      "n_sectors>0",
      "Number of azimuthal sectors in each quadrant of cylinder face. Only used in 3D");
  params.addParamNamesToGroup("n_radial n_axial n_sectors", "Discretization");

  // Boundary layers
  params.addRangeCheckedParam<Real>("boundary_layer_width",
                                    "boundary_layer_width>=0",
                                    "The width of the radial boundary layer (if assigned).");
  params.addParam<unsigned int>(
      "n_boundary_layers",
      1,
      "The number of radial boundary layers. Only active if boundary_layer_width is specified");
  params.addParamNamesToGroup("boundary_layer_width n_boundary_layers", "Radial boundary layer");

  return params;
}

CylinderComponent::CylinderComponent(const InputParameters & params)
  : ActionComponent(params),
    ComponentPhysicsInterface(params),
    ComponentMaterialPropertyInterface(params),
    ComponentInitialConditionInterface(params),
    ComponentBoundaryConditionInterface(params),
    ComponentMeshTransformHelper(params),
    _radius(getParam<Real>("radius")),
    _height(getParam<Real>("length")),
    _offset_position_to_center(getParam<bool>("position_is_bottom_center"))
{
  _dimension = getParam<MooseEnum>("dimension");
  // The other component interfaces add their required task
  addRequiredTask("add_mesh_generator");
}

void
CylinderComponent::addMeshGenerators()
{
  // Create the base mesh for the component using a mesh generator
  if (_dimension == 0)
    paramError("dimension", "0D cylinder not implemented");
  else if (_dimension == 1 || _dimension == 2)
  {
    InputParameters params = _factory.getValidParams("GeneratedMeshGenerator");
    params.set<MooseEnum>("dim") = _dimension;
    params.set<Real>("xmax") = {getParam<Real>("length")};
    params.set<unsigned int>("nx") = {getParam<unsigned int>("n_axial")};
    params.set<std::string>("boundary_name_prefix") = name();
    if (_dimension == 2)
    {
      params.set<Real>("ymax") = {getParam<Real>("radius")};
      params.set<Real>("ymin") = 0;
      if (!isParamValid("n_radial"))
        paramError("n_radial", "Should be provided for a 2D cylinder");
      params.set<unsigned int>("ny") = getParam<std::vector<unsigned int>>("n_radial")[0];
    }
    else if (isParamSetByUser("n_radial"))
      paramError("n_radial", "Should not be provided for a 1D cylinder");
    if (isParamValid("block"))
    {
      const auto block_name = getParam<SubdomainName>("block");
      params.set<SubdomainName>("subdomain_name") = block_name;
      _blocks.push_back(block_name);
    }
    _app.getMeshGeneratorSystem().addMeshGenerator(
        "GeneratedMeshGenerator", name() + "_base", params);
    _mg_names.push_back(name() + "_base");
  }
  else if (_dimension == 3)
  {
    if (!isParamValid("n_axial"))
      paramError("n_axial", "Should be provided for a 3D cylinder");
    if (!isParamValid("n_sectors"))
      paramError("n_sectors", "Should be provided in 3D");

    // create circular face
    InputParameters circle_params = _factory.getValidParams("ConcentricCircleMeshGenerator");
    circle_params.set<bool>("preserve_volumes") = true;
    circle_params.set<bool>("has_outer_square") = false;
    auto ring_disc_vec = getParam<std::vector<unsigned int>>("n_radial");
    // TODO: multi-ring support
    ring_disc_vec = {std::accumulate(ring_disc_vec.begin(), ring_disc_vec.end(), (unsigned int)0)};
    if (isParamValid("boundary_layer_width"))
    {
      Real inner_radius = getParam<Real>("radius") - getParam<Real>("boundary_layer_width");
      circle_params.set<std::vector<Real>>("radii") = {inner_radius, getParam<Real>("radius")};
      ring_disc_vec.push_back(getParam<unsigned int>("n_boundary_layers"));
    }
    else
      circle_params.set<std::vector<Real>>("radii") = {getParam<Real>("radius")};
    circle_params.set<std::vector<unsigned int>>("rings") = ring_disc_vec;

    circle_params.set<unsigned int>("num_sectors") = getParam<unsigned int>("n_sectors");
    if (isParamValid("block"))
    {
      const auto block_name = getParam<SubdomainName>("block");
      circle_params.set<SubdomainName>("subdomain_name") = block_name;
      _blocks.push_back(block_name);
    }
    _app.getMeshGeneratorSystem().addMeshGenerator(
        "ConcentricCircleMeshGenerator", name() + "_circle_base", circle_params);
    _mg_names.push_back(name() + "_circle_base");

    // rotate to have extrusion axis be along x-axis
    // NOTE: this is re-rotated by the ComponentMeshTransformHelper
    InputParameters rotate_params = _factory.getValidParams("TransformGenerator");
    rotate_params.set<MeshGeneratorName>("input") = _mg_names.back();
    rotate_params.set<MooseEnum>("transform") = "ROTATE_EXT";
    RealVectorValue angles(-90, -90, 90);
    rotate_params.set<RealVectorValue>("vector_value") = angles;
    _app.getMeshGeneratorSystem().addMeshGenerator(
        "TransformGenerator", name() + "_3D_init_rotate", rotate_params);
    _mg_names.push_back(name() + "_3D_init_rotate");

    // extrude the surface
    InputParameters ext_params = _factory.getValidParams("AdvancedExtruderGenerator");
    ext_params.set<std::vector<unsigned int>>("num_layers") = {getParam<unsigned int>("n_axial")};
    ext_params.set<MeshGeneratorName>("input") = _mg_names.back();
    ext_params.set<std::vector<Real>>("heights") = {_height};
    ext_params.set<BoundaryName>("bottom_boundary") = name() + "_bottom_boundary";
    ext_params.set<BoundaryName>("top_boundary") = name() + "_top_boundary";

    const Point default_direction(1, 0, 0);
    ext_params.set<Point>("direction") = default_direction;
    _app.getMeshGeneratorSystem().addMeshGenerator(
        "AdvancedExtruderGenerator", name() + "_base", ext_params);
    _mg_names.push_back(name() + "_base");
  }
  _top_mg_name = _mg_names.back();

  ComponentMeshTransformHelper::addMeshGenerators();
}

void
CylinderComponent::setupComponent()
{
  if (_dimension == 2)
  {
    _awh.getMesh()->setCoordSystem(_blocks, MultiMooseEnum("COORD_RZ"));
    if (_direction)
      _awh.getMesh()->setGeneralAxisymmetricCoordAxes(
          {getParam<SubdomainName>("block")},
          {std::make_pair(translation(), _direction ? *_direction : RealVectorValue(0, 1, 0))});
    if (_rotation)
      paramError("rotation", "Rotation + 2D RZ cylinder not implemented");
  }
}

void
CylinderComponent::checkIntegrity()
{
  ComponentInitialConditionInterface::checkIntegrity();
  ComponentBoundaryConditionInterface::checkIntegrity();
}

Point
CylinderComponent::translation() const
{
  // The 1D or 2D RZ cylinders are naturally centered
  if (!_offset_position_to_center || _dimension <= 2)
    return ComponentMeshTransformHelper::translation();

  auto input_translation = ComponentMeshTransformHelper::translation();
  // The translation will be applied after the rotation, we need to translate by the rotated radius
  // There are two options for specifying rotations / translations
  if (_rotation)
    paramError("position_is_bottom_center",
               "Rotation + offset cylinder to center not implemented. Use 'direction' instead");

  const auto rotation_matrix =
      _direction
          ? RotationMatrix::rodriguesRotationMatrix<false>(RealVectorValue(1, 0, 0), *_direction)
          : RealTensorValue(1, 0, 0, 0, 1, 0, 0, 0, 1);
  input_translation -= rotation_matrix * Point(_radius, 0, 0);

  return input_translation;
}