Axisymmetric2D3DSolutionFunction.C File Reference

Go to the source code of this file.


InputParameters validParams< Axisymmetric2D3DSolutionFunction > ()

Function Documentation

Definition at line 21 of file Axisymmetric2D3DSolutionFunction.C.

22 {
23  // Get the Function input parameters
26  // Add parameters specific to this object
27  params.addRequiredParam<UserObjectName>("solution",
28  "The SolutionUserObject to extract data from.");
29  params.addParam<std::vector<std::string>>(
30  "from_variables",
31  "The names of the variables in the file that are to be extracted, in x, y "
32  "order if they are vector components");
34  params.addParam<Real>(
35  "scale_factor",
36  1.0,
37  "Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'");
38  params.addParam<Real>(
39  "add_factor",
40  0.0,
41  "Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'");
42  params.addParam<Real>("axial_dimension_ratio",
43  1.0,
44  "Ratio of the axial dimension in the 3d model to that in the 2d model. "
45  "Optinally permits the 3d model to be larger than the 2d model in that "
46  "dimension, and scales vector solutions in that direction by this factor.");
48  params.addParam<RealVectorValue>("2d_axis_point1",
49  RealVectorValue(0, 0, 0),
50  "Start point for axis of symmetry for the 2d model");
51  params.addParam<RealVectorValue>("2d_axis_point2",
52  RealVectorValue(0, 1, 0),
53  "End point for axis of symmetry for the 2d model");
54  params.addParam<RealVectorValue>("3d_axis_point1",
55  RealVectorValue(0, 0, 0),
56  "Start point for axis of symmetry for the 3d model");
57  params.addParam<RealVectorValue>("3d_axis_point2",
58  RealVectorValue(0, 1, 0),
59  "End point for axis of symmetry for the 3d model");
61  params.addParam<unsigned int>("component",
62  "Component of the variable to be computed if it is a vector");
64  params.addClassDescription("Function for reading a 2D axisymmetric solution from file and "
65  "mapping it to a 3D Cartesian model");
67  return params;
68 }
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
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...
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...
InputParameters validParams< Function >()
Definition: Function.C:19