AddPeriodicBCAction.C File Reference

Go to the source code of this file.


InputParameters validParams< AddPeriodicBCAction > ()

Function Documentation

Definition at line 31 of file AddPeriodicBCAction.C.

32 {
34  params.addParam<std::vector<std::string>>("auto_direction",
35  "If using a generated mesh, you can "
36  "specifiy just the dimension(s) you "
37  "want to mark as periodic");
39  params.addParam<BoundaryName>("primary", "Boundary ID associated with the primary boundary.");
40  params.addParam<BoundaryName>("secondary", "Boundary ID associated with the secondary boundary.");
41  params.addParam<RealVectorValue>("translation",
42  "Vector that translates coordinates on the "
43  "primary boundary to coordinates on the "
44  "secondary boundary.");
45  params.addParam<std::vector<std::string>>("transform_func",
46  "Functions that specify the transformation");
47  params.addParam<std::vector<std::string>>("inv_transform_func",
48  "Functions that specify the inverse transformation");
50  params.addParam<std::vector<VariableName>>("variable", "Variable for the periodic boundary");
51  return params;
52 }
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
InputParameters validParams< Action >()
Definition: Action.C:23