www.mooseframework.org
Functions
PiecewiseMultilinear.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< PiecewiseMultilinear > ()
 

Function Documentation

Definition at line 20 of file PiecewiseMultilinear.C.

21 {
23  params.addParam<FileName>(
24  "data_file",
25  "File holding data for use with PiecewiseMultilinear. Format: any empty line and any line "
26  "beginning with # are ignored, all other lines are assumed to contain relevant information. "
27  "The file must begin with specification of the grid. This is done through lines containing "
28  "the keywords: AXIS X; AXIS Y; AXIS Z; or AXIS T. Immediately following the keyword line "
29  "must be a space-separated line of real numbers which define the grid along the specified "
30  "axis. These data must be monotonically increasing. After all the axes and their grids "
31  "have been specified, there must be a line that is DATA. Following that line, function "
32  "values are given in the correct order (they may be on indivicual lines, or be "
33  "space-separated on a number of lines). When the function is evaluated, f[i,j,k,l] "
34  "corresponds to the i + j*Ni + k*Ni*Nj + l*Ni*Nj*Nk data value. Here i>=0 corresponding to "
35  "the index along the first AXIS, j>=0 corresponding to the index along the second AXIS, etc, "
36  "and Ni = number of grid points along the first AXIS, etc.");
37  params.addClassDescription("PiecewiseMultilinear performs interpolation on 1D, 2D, 3D or 4D "
38  "data. The data_file specifies the axes directions and the function "
39  "values. If a point lies outside the data range, the appropriate end "
40  "value is used.");
41  return params;
42 }
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