BicubicSplineFunction

under construction:Undocumented Class

The BicubicSplineFunction 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/BicubicSplineFunction

Input Parameters

  • x2The second independent coordinate.

    C++ Type:std::vector

    Options:

    Description:The second independent coordinate.

  • yThe dependent values

    C++ Type:std::vector

    Options:

    Description:The dependent values

  • x1The first independent coordinate.

    C++ Type:std::vector

    Options:

    Description:The first independent coordinate.

Required Parameters

  • normal_componentzThe component of the geometry that is normal to the spline x1/x2 values

    Default:z

    C++ Type:MooseEnum

    Options:x y z

    Description:The component of the geometry that is normal to the spline x1/x2 values

  • yx2nThe values of the derivative wrt x2 on the upper interpolation grid points.

    C++ Type:std::vector

    Options:

    Description:The values of the derivative wrt x2 on the upper interpolation grid points.

  • yx21e30The functional form of the derivative with respect to x2.

    Default:1e30

    C++ Type:FunctionName

    Options:

    Description:The functional form of the derivative with respect to x2.

  • yx11e30The functional form of the derivative with respect to x1.

    Default:1e30

    C++ Type:FunctionName

    Options:

    Description:The functional form of the derivative with respect to x1.

  • yx11The values of the derivative wrt x1 on the lower interpolation grid points.

    C++ Type:std::vector

    Options:

    Description:The values of the derivative wrt x1 on the lower interpolation grid points.

  • yx1nThe values of the derivative wrt x1 on the upper interpolation grid points.

    C++ Type:std::vector

    Options:

    Description:The values of the derivative wrt x1 on the upper interpolation grid points.

  • yx21The values of the derivative wrt x2 on the lower interpolation grid points.

    C++ Type:std::vector

    Options:

    Description:The values of the derivative wrt x2 on the lower interpolation grid points.

Optional Parameters

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

    C++ Type:std::vector

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

References