www.mooseframework.org
Functions
AnnularMesh.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< AnnularMesh > ()
 

Function Documentation

Definition at line 22 of file AnnularMesh.C.

23 {
25  params.addRangeCheckedParam<unsigned int>(
26  "nr", 1, "nr>0", "Number of elements in the radial direction");
27  params.addRequiredRangeCheckedParam<unsigned int>(
28  "nt", "nt>0", "Number of elements in the angular direction");
29  params.addRequiredRangeCheckedParam<Real>(
30  "rmin",
31  "rmin>=0.0",
32  "Inner radius. If rmin=0 then a disc mesh (with no central hole) will be created.");
33  params.addRequiredParam<Real>("rmax", "Outer radius");
34  params.addParam<Real>("tmin", 0.0, "Minimum angle, measured anticlockwise from x axis");
35  params.addParam<Real>("tmax",
36  2 * M_PI,
37  "Maximum angle, measured anticlockwise from x axis. If "
38  "tmin=0 and tmax=2Pi an annular mesh is created. "
39  "Otherwise, only a sector of an annulus is created");
40  params.addRangeCheckedParam<Real>(
41  "growth_r", 1.0, "growth_r>0.0", "The ratio of radial sizes of successive rings of elements");
42  params.addParam<SubdomainID>(
43  "quad_subdomain_id", 0, "The subdomain ID given to the QUAD4 elements");
44  params.addParam<SubdomainID>("tri_subdomain_id",
45  1,
46  "The subdomain ID given to the TRI3 elements "
47  "(these exist only if rmin=0, and they exist "
48  "at the center of the disc");
49  params.addClassDescription("For rmin>0: creates an annular mesh of QUAD4 elements. For rmin=0: "
50  "creates a disc mesh of QUAD4 and TRI3 elements. Boundary sidesets "
51  "are created at rmax and rmin, and given these names. If tmin!=0 and "
52  "tmax!=2Pi, a sector of an annulus or disc is created. In this case "
53  "boundary sidesets are also created a tmin and tmax, and "
54  "given these names");
55  return params;
56 }
void addRequiredRangeCheckedParam(const std::string &name, const std::string &parsed_function, const std::string &doc_string)
These methods add an range checked parameters.
subdomain_id_type SubdomainID
Definition: MooseTypes.h:77
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)