CoarsenedPiecewiseLinear.h File Reference

Go to the source code of this file.

Classes
class	CoarsenedPiecewiseLinear
	Function class that reads in a list of (x,y) value pairs representing a pointwise defined function sililar to PiecewiseLinear. More...

Functions
template<>
InputParameters	validParams< CoarsenedPiecewiseLinear > ()

Function Documentation

validParams< CoarsenedPiecewiseLinear >()

template<>

InputParameters validParams< CoarsenedPiecewiseLinear >

(

)

Definition at line 18 of file CoarsenedPiecewiseLinear.C.

{
  InputParameters params = validParams<PiecewiseLinearBase>();
  params.addClassDescription("Perform a point reduction of the tabulated data upon initialization, "
                             "then evaluate using a linear interpolation.");
  params.addRequiredParam<Real>(
      "epsilon",
      "Significant distance in the function below which points are considered removable noise");
  params.addParam<Real>("y_scale",
                        1.0,
                        "Scaling factor to apply to the function nodes for the purpose of "
                        "computing distances in the Douglas-Peucker point reduction algorithm. "
                        "This permits shifting the weight between x and y-direction distances.");
  params.addParam<Real>("x_scale",
                        1.0,
                        "Scaling factor to apply to the function nodes for the purpose of "
                        "computing distances in the Douglas-Peucker point reduction algorithm. "
                        "This permits shifting the weight between x and y-direction distances.");
  return params;
}