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

Go to the source code of this file.

Classes

class  SplineFunction
 Function that uses spline interpolation. More...
 

Functions

template<>
InputParameters validParams< SplineFunction > ()
 

Function Documentation

Definition at line 19 of file SplineFunction.C.

20 {
22  MooseEnum component("x=0 y=1 z=2", "x");
23  params.addParam<MooseEnum>(
24  "component", component, "The component of the geometry point to interpolate with");
25  params.addRequiredParam<std::vector<Real>>("x", "The abscissa values");
26  params.addRequiredParam<std::vector<Real>>("y", "The ordinate values");
27  params.addParam<Real>(
28  "yp1", 1e30, "The value of the first derivative of the interpolating function at point 1");
29  params.addParam<Real>(
30  "ypn", 1e30, "The value of the first derivative of the interpolating function at point n");
31 
32  return params;
33 }
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...
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...
InputParameters validParams< Function >()
Definition: Function.C:19