PeriodicBCHelper.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 "InputParameters.h"

#include "libmesh/periodic_boundaries.h"

class Action;
class FEProblemBase;
class InputParameters;
class MooseMesh;

namespace Moose
{
class PeriodicBCHelper
{
public:
  static InputParameters validParams();

  PeriodicBCHelper(const Action & action);

protected:
  void checkPeriodicParams() const;

  void setupPeriodicBoundaries(FEProblemBase & problem);

  virtual void onSetupPeriodicBoundary(libMesh::PeriodicBoundaryBase & /* p */) {};

  const libMesh::PeriodicBoundaries & getPeriodicBoundaries() const { return _periodic_boundaries; }

private:
  void addPeriodicBoundary(std::unique_ptr<libMesh::PeriodicBoundaryBase> /* p */);

  void setupAutoPeriodicBoundaries(MooseMesh & mesh);
  void setupManualPeriodicBoundaries(FEProblemBase & problem);

  const InputParameters & getParams() const;

  const Action & _action;
  const InputParameters & _params;
  libMesh::PeriodicBoundaries _periodic_boundaries;
};
}