www.mooseframework.org
Functions
PatternedMesh.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< PatternedMesh > ()
 

Function Documentation

Definition at line 25 of file PatternedMesh.C.

26 {
28  params.addRequiredParam<std::vector<MeshFileName>>("files",
29  "The name of the mesh files to read. "
30  " They are automatically assigned "
31  "ids starting with zero.");
32 
33  params.addRangeCheckedParam<Real>(
34  "x_width", 0, "x_width>=0", "The tile width in the x direction");
35  params.addRangeCheckedParam<Real>(
36  "y_width", 0, "y_width>=0", "The tile width in the y direction");
37  params.addRangeCheckedParam<Real>(
38  "z_width", 0, "z_width>=0", "The tile width in the z direction");
39 
40  // x boundary names
41  params.addParam<BoundaryName>("left_boundary", "left_boundary", "name of the left (x) boundary");
42  params.addParam<BoundaryName>(
43  "right_boundary", "right_boundary", "name of the right (x) boundary");
44 
45  // y boundary names
46  params.addParam<BoundaryName>("top_boundary", "top_boundary", "name of the top (y) boundary");
47  params.addParam<BoundaryName>(
48  "bottom_boundary", "bottom_boundary", "name of the bottom (y) boundary");
49 
50  params.addRequiredParam<std::vector<std::vector<unsigned int>>>(
51  "pattern", "A double-indexed array starting with the upper-left corner");
52 
53  params.addClassDescription("Creates a 2D mesh from a specified set of unique 'tiles' meshes and "
54  "a two-dimensional pattern.");
55 
56  return params;
57 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< MooseMesh >()
Definition: MooseMesh.C:65
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
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...
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)