Classes | Functions
PiecewiseBilinear.h File Reference

Go to the source code of this file.


class  PiecewiseBilinear
 PiecewiseBilinear reads from a file the information necessary to build the vectors x and y and the ColumnMajorMatrix z, and then sends those (along with a sample point) to BilinearInterpolation. More...


InputParameters validParams< PiecewiseBilinear > ()

Function Documentation

Definition at line 23 of file PiecewiseBilinear.C.

24 {
26  params.addParam<FileName>(
27  "data_file", "", "File holding csv data for use with PiecewiseBilinear");
28  params.addParam<std::vector<Real>>("x", "The x abscissa values");
29  params.addParam<std::vector<Real>>("y", "The y abscissa values");
30  params.addParam<std::vector<Real>>("z", "The ordinate values");
31  params.addParam<int>("axis", -1, "The axis used (0, 1, or 2 for x, y, or z).");
32  params.addParam<int>(
33  "xaxis", -1, "The coordinate used for x-axis data (0, 1, or 2 for x, y, or z).");
34  params.addParam<int>(
35  "yaxis", -1, "The coordinate used for y-axis data (0, 1, or 2 for x, y, or z).");
36  params.addParam<Real>(
37  "scale_factor", 1.0, "Scale factor to be applied to the axis, yaxis, or xaxis values");
38  params.addParam<bool>("radial",
39  false,
40  "Set to true if you want to interpolate along a radius "
41  "rather that along a specific axis, and note that you "
42  "have to define xaxis and yaxis in the input file");
43  params.addClassDescription("Interpolates values from a csv file");
44  return params;
45 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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