Moose::PeriodicBCHelper Class Reference

Helper class for setting up periodic boundary conditions via an Action. More...

#include <PeriodicBCHelper.h>

Inheritance diagram for Moose::PeriodicBCHelper:

Public Member Functions
	PeriodicBCHelper (const Action &action)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	checkPeriodicParams () const
	Checks the validity of the periodic boundary condition parameters. More...
void	setupPeriodicBoundaries (FEProblemBase &problem)
	Sets up the periodic boundaries. More...
virtual void	onSetupPeriodicBoundary (libMesh::PeriodicBoundaryBase &)
	Entry-point for derived actions to extend the addition of a periodic boundary. More...
const libMesh::PeriodicBoundaries &	getPeriodicBoundaries () const
	Get the PeriodicBoundaries map produced in setupPeriodicBoundaries(). More...

Private Member Functions
void	addPeriodicBoundary (std::unique_ptr< libMesh::PeriodicBoundaryBase >)
	Internal helper for adding a periodic boundary. More...
void	setupAutoPeriodicBoundaries (MooseMesh &mesh)
	Internal method for setting up periodic boundaries via the "auto_direction" param. More...
void	setupManualPeriodicBoundaries (FEProblemBase &problem)
	Internal method for setting up manual periodic boundaries via the "translation" and "transform_func" params. More...
const InputParameters &	getParams () const
	Internal method for getting the parameters by the owned action. More...

Private Attributes
const Action &	_action
	The owning Action. More...
const InputParameters &	_params
	The parameters used to create the periodic boundary. More...
libMesh::PeriodicBoundaries	_periodic_boundaries
	The PeriodicBoundaries map, filled in setupPeriodicBoundaries() More...

Detailed Description

Helper class for setting up periodic boundary conditions via an Action.

Determines the PeriodicBoundaries given the parameters and sets up geometric ghosting. Does not handle algebraic ghosting.

Definition at line 29 of file PeriodicBCHelper.h.

Constructor & Destructor Documentation

PeriodicBCHelper()

Moose::PeriodicBCHelper::PeriodicBCHelper

(

const Action &

action

)

Definition at line 46 of file PeriodicBCHelper.C.

: _action(action), _params(getParams()) {}

Member Function Documentation

addPeriodicBoundary()

void Moose::PeriodicBCHelper::addPeriodicBoundary ( std::unique_ptr< libMesh::PeriodicBoundaryBase >  p )

private

Internal helper for adding a periodic boundary.

Definition at line 93 of file PeriodicBCHelper.C.

Referenced by setupAutoPeriodicBoundaries(), and setupManualPeriodicBoundaries().

{
  onSetupPeriodicBoundary(*p);

  _periodic_boundaries.emplace(p->myboundary, p->clone());
  _periodic_boundaries.emplace(p->pairedboundary, p->clone(libMesh::PeriodicBoundaryBase::INVERSE));
}

checkPeriodicParams()

void Moose::PeriodicBCHelper::checkPeriodicParams ( ) const

protected

Checks the validity of the periodic boundary condition parameters.

Definition at line 49 of file PeriodicBCHelper.C.

Referenced by AddPeriodicBCAction::AddPeriodicBCAction().

{
  if (_params.isParamValid("auto_direction"))
  {
    for (const auto & param :
         {"primary", "secondary", "translation", "transform_func", "inv_transform_func"})
      if (_params.isParamValid(param))
        _params.paramError(param, "Should not be specified along with 'auto_direction'");
  }
  else if (!_params.isParamValid("primary") || !_params.isParamValid("secondary"))
    _action.mooseError(
        "Either 'auto_direction' or both 'primary' and 'secondary' must be specified");
}

getParams()

const InputParameters & Moose::PeriodicBCHelper::getParams ( ) const

private

Internal method for getting the parameters by the owned action.

Enables the use of the MOOSE object parameters if the owner is a MooseObjectAction.

Definition at line 182 of file PeriodicBCHelper.C.

{
  if (const auto moa = dynamic_cast<const MooseObjectAction *>(&_action))
    return moa->getObjectParams();
  return _action.parameters();
}

getPeriodicBoundaries()

const libMesh::PeriodicBoundaries& Moose::PeriodicBCHelper::getPeriodicBoundaries ( ) const

inlineprotected

Get the PeriodicBoundaries map produced in setupPeriodicBoundaries().

Definition at line 61 of file PeriodicBCHelper.h.

Referenced by AddPeriodicBCAction::act(), and setupPeriodicBoundaries().

{ return _periodic_boundaries; }

onSetupPeriodicBoundary()

virtual void Moose::PeriodicBCHelper::onSetupPeriodicBoundary ( libMesh::PeriodicBoundaryBase &  )

inlineprotectedvirtual

Entry-point for derived actions to extend the addition of a periodic boundary.

Reimplemented in AddPeriodicBCAction.

Definition at line 56 of file PeriodicBCHelper.h.

Referenced by addPeriodicBoundary().

{};

setupAutoPeriodicBoundaries()

void Moose::PeriodicBCHelper::setupAutoPeriodicBoundaries ( MooseMesh &  mesh )

private

Internal method for setting up periodic boundaries via the "auto_direction" param.

Definition at line 102 of file PeriodicBCHelper.C.

Referenced by setupPeriodicBoundaries().

{
  // If we are working with a parallel mesh then we're going to ghost all the boundaries
  // everywhere because we don't know what we need...
  if (mesh.isDistributedMesh() && !mesh.detectOrthogonalDimRanges())
    _action.mooseError("Could not detect orthogonal dimension ranges for DistributedMesh.");

  for (const auto & dir : _params.get<MultiMooseEnum>("auto_direction"))
  {
    const int component = dir.id();
    if (component > (cast_int<int>(mesh.dimension()) - 1))
      _params.paramError("auto_direction",
                         MooseUtils::toLower(dir.name()),
                         "-dimension component not valid for ",
                         mesh.dimension(),
                         "D mesh");

    const auto boundary_ids = mesh.getPairedBoundaryMapping(component);
    if (!boundary_ids)
      _params.paramError("auto_direction",
                         "Couldn't auto-detect a paired boundary in the ",
                         MooseUtils::toLower(dir.name()),
                         "-direction");

    RealVectorValue v;
    v(component) = mesh.dimensionWidth(component);

    auto p = std::make_unique<libMesh::PeriodicBoundary>(v);
    p->myboundary = boundary_ids->first;
    p->pairedboundary = boundary_ids->second;

    addPeriodicBoundary(std::move(p));
  }
}

setupManualPeriodicBoundaries()

void Moose::PeriodicBCHelper::setupManualPeriodicBoundaries ( FEProblemBase &  problem )

private

Internal method for setting up manual periodic boundaries via the "translation" and "transform_func" params.

Definition at line 138 of file PeriodicBCHelper.C.

Referenced by setupPeriodicBoundaries().

{
  auto & mesh = problem.mesh();
  std::unique_ptr<libMesh::PeriodicBoundaryBase> p;

  if (const auto translation_ptr = _params.queryParam<RealVectorValue>("translation"))
    p = std::make_unique<libMesh::PeriodicBoundary>(*translation_ptr);
  else if (const auto fn_names_ptr = _params.queryParam<std::vector<std::string>>("transform_func"))
  {
    const auto inv_fn_names_ptr =
        _params.queryParam<std::vector<std::string>>("inv_transform_func");
    if (!inv_fn_names_ptr)
      _params.paramError("transform_func", "Must also specify 'inv_transform_func'");
    if (fn_names_ptr->size() != mesh.dimension())
      _params.paramError(
          "transform_func", "Must be the size of the mesh dimension ", mesh.dimension());
    if (inv_fn_names_ptr->size() != mesh.dimension())
      _params.paramError(
          "inv_transform_func", "Must be the size of the mesh dimension ", mesh.dimension());

    p = std::make_unique<FunctionPeriodicBoundary>(problem, *fn_names_ptr, *inv_fn_names_ptr);
  }
  else
    _action.mooseError(
        "You need to specify either 'auto_direction', 'translation', or 'transform_func'");

  const auto get_boundary = [this, &mesh](const auto & param) -> BoundaryID
  {
    if (const auto name_ptr = _params.queryParam<BoundaryName>(param))
    {
      if (const auto id = MooseMeshUtils::getBoundaryID(*name_ptr, mesh);
          id != Moose::INVALID_BOUNDARY_ID)
        return id;
      _params.paramError(param, "Boundary '", *name_ptr, "' does not exist in the mesh");
    }
    _action.mooseError("Parameter '", param, "' is required when 'auto_direction' is not set");
  };
  p->myboundary = get_boundary("primary");
  p->pairedboundary = get_boundary("secondary");

  addPeriodicBoundary(std::move(p));
}

setupPeriodicBoundaries()

void Moose::PeriodicBCHelper::setupPeriodicBoundaries ( FEProblemBase &  problem )

protected

Sets up the periodic boundaries.

Should be called by the owning Action. Once called, the PeriodicBoundaries object will be available via getPeriodicBoundaries().

onSetupPeriodicBoundary() will be called on each periodic boundary added to enable the derived class to extend.

Definition at line 64 of file PeriodicBCHelper.C.

Referenced by AddPeriodicBCAction::act().

{
  mooseAssert(_periodic_boundaries.empty(), "Already set");

  // Setup paired sidesets to be able to call MooseMesh::getPairedBoundaryMapping()
  if (!problem.mesh().hasDetectedPairedSidesets())
    problem.mesh().detectPairedSidesets();

  if (_params.isParamValid("auto_direction"))
    setupAutoPeriodicBoundaries(problem.mesh());
  else
    setupManualPeriodicBoundaries(problem);

  mooseAssert(getPeriodicBoundaries().size(), "Shouldn't run without boundaries");

  const auto add_ghosting = [this](auto & problem)
  {
    auto & mesh = problem.mesh().getMesh();
    auto functor = std::make_shared<libMesh::GhostPointNeighbors>(mesh);
    functor->set_periodic_boundaries(&getPeriodicBoundaries());
    mesh.add_ghosting_functor(functor);
  };

  add_ghosting(problem);
  if (const auto displaced_problem = problem.getDisplacedProblem())
    add_ghosting(*displaced_problem);
}

validParams()

InputParameters Moose::PeriodicBCHelper::validParams ( )

static

Definition at line 24 of file PeriodicBCHelper.C.

Referenced by AddPeriodicBCAction::validParams().

{
  auto params = emptyInputParameters();

  const MultiMooseEnum auto_direction("x=0 y=1 z=2");
  params.addParam<MultiMooseEnum>(
      "auto_direction",
      auto_direction,
      "If using a generated mesh, the dimension(s) you want to mark as periodic.");

  params.addParam<BoundaryName>("primary", "Boundary associated with the primary boundary.");
  params.addParam<BoundaryName>("secondary", "Boundary associated with the secondary boundary.");
  params.addParam<RealVectorValue>("translation",
                                   "Vector that translates coordinates on the primary boundary to "
                                   "coordinates on the secondary boundary.");
  params.addParam<std::vector<std::string>>("transform_func",
                                            "Functions that specify the transformation");
  params.addParam<std::vector<std::string>>("inv_transform_func",
                                            "Functions that specify the inverse transformation");
  return params;
}

Member Data Documentation

_action

const Action& Moose::PeriodicBCHelper::_action

private

The owning Action.

Definition at line 88 of file PeriodicBCHelper.h.

Referenced by checkPeriodicParams(), getParams(), setupAutoPeriodicBoundaries(), and setupManualPeriodicBoundaries().

_params

const InputParameters& Moose::PeriodicBCHelper::_params

private

The parameters used to create the periodic boundary.

Definition at line 90 of file PeriodicBCHelper.h.

Referenced by checkPeriodicParams(), setupAutoPeriodicBoundaries(), setupManualPeriodicBoundaries(), and setupPeriodicBoundaries().

_periodic_boundaries

libMesh::PeriodicBoundaries Moose::PeriodicBCHelper::_periodic_boundaries

private

The PeriodicBoundaries map, filled in setupPeriodicBoundaries()

Definition at line 92 of file PeriodicBCHelper.h.

Referenced by addPeriodicBoundary(), getPeriodicBoundaries(), and setupPeriodicBoundaries().

---

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

• include/utils/PeriodicBCHelper.h
• src/utils/PeriodicBCHelper.C