https://mooseframework.inl.gov
AddPeriodicBCAction.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "Action.h"
13 #include "PeriodicBCHelper.h"
14 
15 class MooseMesh;
16 namespace libMesh
17 {
18 class PeriodicBoundaryBase;
19 }
20 
27 {
28 public:
30 
31  AddPeriodicBCAction(const InputParameters & params);
32 
33  virtual void act() override;
34 
35 protected:
36  using Action::paramError;
37 
43  virtual void onSetupPeriodicBoundary(libMesh::PeriodicBoundaryBase & p) override;
44 
49  std::vector<const MooseVariableFieldBase *> getVariables() const;
50 
52  std::vector<const MooseVariableFieldBase *> _vars;
53 
55 };
This Action adds a periodic boundary to the problem.
void paramError(const std::string &param, Args... args) const
Emits an error prefixed with the file and line number of the given param (from the input file) along ...
Definition: MooseBase.h:467
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::vector< const MooseVariableFieldBase * > getVariables() const
Helper for getting the variables to which periodic boundary conditions will be applied.
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
Helper class for setting up periodic boundary conditions via an Action.
Base class for actions.
Definition: Action.h:34
virtual void act() override
Method to add objects to the simulation or perform other setup tasks.
std::vector< const MooseVariableFieldBase * > _vars
The variables to apply periodic boundary conditions to.
AddPeriodicBCAction(const InputParameters &params)
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:93
static InputParameters validParams()
virtual void onSetupPeriodicBoundary(libMesh::PeriodicBoundaryBase &p) override
Overriden method from PeriodicBCHelper that is called on every periodic boundary, in which we will se...