SplineFunction

under construction:Undocumented Class

The SplineFunction has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Functions/SplineFunction

Input Parameters

  • yThe ordinate values

    C++ Type:std::vector

    Description:The ordinate values

  • xThe abscissa values

    C++ Type:std::vector

    Description:The abscissa values

Required Parameters

  • ypn1e+30The value of the first derivative of the interpolating function at point n

    Default:1e+30

    C++ Type:double

    Description:The value of the first derivative of the interpolating function at point n

  • yp11e+30The value of the first derivative of the interpolating function at point 1

    Default:1e+30

    C++ Type:double

    Description:The value of the first derivative of the interpolating function at point 1

  • componentxThe component of the geometry point to interpolate with

    Default:x

    C++ Type:MooseEnum

    Description:The component of the geometry point to interpolate with

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References