www.mooseframework.org
Functions
TiledMesh.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< TiledMesh > ()
 

Function Documentation

Definition at line 25 of file TiledMesh.C.

26 {
28  params.addRequiredParam<MeshFileName>("file", "The name of the mesh file to read");
29 
30  params.addParam<Real>("x_width", 0, "The tile width in the x direction");
31  params.addParam<Real>("y_width", 0, "The tile width in the y direction");
32  params.addParam<Real>("z_width", 0, "The tile width in the z direction");
33 
34  // x boundary names
35  params.addParam<BoundaryName>("left_boundary", "left_boundary", "name of the left (x) boundary");
36  params.addParam<BoundaryName>(
37  "right_boundary", "right_boundary", "name of the right (x) boundary");
38 
39  // y boundary names
40  params.addParam<BoundaryName>("top_boundary", "top_boundary", "name of the top (y) boundary");
41  params.addParam<BoundaryName>(
42  "bottom_boundary", "bottom_boundary", "name of the bottom (y) boundary");
43 
44  // z boundary names
45  params.addParam<BoundaryName>(
46  "front_boundary", "front_boundary", "name of the front (z) boundary");
47  params.addParam<BoundaryName>("back_boundary", "back_boundary", "name of the back (z) boundary");
48 
49  // The number of tiles is 1 in each direction unless otherwise specified.
50  // An x_tiles value of 1 means do not stitch any extra meshes together in
51  // the x-direction.
52  params.addParam<unsigned int>(
53  "x_tiles", 1, "Number of tiles to stitch together (left to right) in the x-direction");
54  params.addParam<unsigned int>(
55  "y_tiles", 1, "Number of tiles to stitch together (top to bottom) in the y-direction");
56  params.addParam<unsigned int>(
57  "z_tiles", 1, "Number of tiles to stitch together (front to back) in the z-direction");
58 
59  params.addClassDescription("Use the supplied mesh and create a tiled grid by repeating this mesh "
60  "in the x,y, and z directions.");
61 
62  return params;
63 }
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...