LayeredBase.C File Reference

Go to the source code of this file.


InputParameters validParams< LayeredBase > ()

Function Documentation

Definition at line 28 of file LayeredBase.C.

Referenced by validParams< LayeredIntegral >(), and validParams< LayeredSideIntegral >().

29 {
31  MooseEnum directions("x y z");
33  params.addRequiredParam<MooseEnum>("direction", directions, "The direction of the layers.");
34  params.addParam<unsigned int>("num_layers", "The number of layers.");
35  params.addParam<std::vector<Real>>("bounds",
36  "The 'bounding' positions of the layers i.e.: '0, "
37  "1.2, 3.7, 4.2' will mean 3 layers between those "
38  "positions.");
40  MooseEnum sample_options("direct interpolate average", "direct");
41  params.addParam<MooseEnum>("sample_type",
42  sample_options,
43  "How to sample the layers. 'direct' means get the value of the layer "
44  "the point falls in directly (or average if that layer has no value). "
45  " 'interpolate' does a linear interpolation between the two closest "
46  "layers. 'average' averages the two closest layers.");
48  params.addParam<unsigned int>("average_radius",
49  1,
50  "When using 'average' sampling this is how "
51  "the number of values both above and below "
52  "the layer that will be averaged.");
54  params.addParam<bool>(
55  "cumulative",
56  false,
57  "When true the value in each layer is the sum of the values up to and including that layer");
59  return params;
60 }
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 emptyInputParameters()
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
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...