www.mooseframework.org
Classes | Functions
PiecewiseLinearInterpolationMaterial.h File Reference

Go to the source code of this file.

Classes

class  PiecewiseLinearInterpolationMaterial
 This material uses a LinearInterpolation object to define the dependence of the material's value on a variable. More...
 

Functions

template<>
InputParameters validParams< PiecewiseLinearInterpolationMaterial > ()
 

Function Documentation

Definition at line 22 of file PiecewiseLinearInterpolationMaterial.C.

23 {
25  params.addClassDescription("Compute a property using a piecewise linear interpolation to define "
26  "its dependence on a variable");
27  params.addRequiredParam<std::string>("property",
28  "The name of the property this material will compute");
29  params.addRequiredCoupledVar(
30  "variable",
31  "The name of the variable whose value is used as the abscissa in the interpolation");
32  params.addParam<std::vector<Real>>("x", "The abscissa values");
33  params.addParam<std::vector<Real>>("y", "The ordinate values");
34  params.addParam<std::vector<Real>>("xy_data",
35  "All function data, supplied in abscissa, ordinate pairs");
36  params.addParam<Real>("scale_factor", 1.0, "Scale factor to be applied to the ordinate values");
37  return params;
38 }
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 addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
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< Material >()
Definition: Material.C:27