PiecewiseBilinear

Interpolates values from a csv file

Description

The PiecewiseBilinear function reads a csv file and interpolates values based on the data in the file. The interpolation is based on x-y pairs. If axis is given, time is used as the y index. Either xaxis or yaxis or both may be given. Time is used as the other index if one of them is not given. If radius is given, xaxis and yaxis are used to orient a cylindrical coordinate system, and the x-y pair used in the query will be the radial coordinate and time.

The csv file data_file format expected is:

  • first line holds the x values.

  • each subsequent line holds the y value then the list of z values for this y and all values of x.

The csv file data_file may be substituted by specifying the x, y and z parameters.

Example Input Syntax

[Functions]

  [./u]
    type = PiecewiseBilinear
    #x = '0 1 3' # Testing this error
    y = '0 1 3'
    z = '0 0 0 0 1 3 0 5 7'
    axis = 0 # End Functions
  [../]
[]
(moose/test/tests/utils/2d_linear_interpolation/xyz_error.i)

Input Parameters

  • axis-1The axis used (0, 1, or 2 for x, y, or z).

    Default:-1

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:The axis used (0, 1, or 2 for x, y, or z).

  • data_fileFile holding csv data for use with PiecewiseBilinear

    C++ Type:FileName

    Unit:(no unit assumed)

    Controllable:No

    Description:File holding csv data for use with PiecewiseBilinear

  • radialFalseSet to true if you want to interpolate along a radius rather that along a specific axis, and note that you have to define xaxis and yaxis in the input file

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set to true if you want to interpolate along a radius rather that along a specific axis, and note that you have to define xaxis and yaxis in the input file

  • scale_factor1Scale factor to be applied to the axis, yaxis, or xaxis values

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Scale factor to be applied to the axis, yaxis, or xaxis values

  • xThe x abscissa values

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The x abscissa values

  • xaxis-1The coordinate used for x-axis data (0, 1, or 2 for x, y, or z).

    Default:-1

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:The coordinate used for x-axis data (0, 1, or 2 for x, y, or z).

  • yThe y abscissa values

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The y abscissa values

  • yaxis-1The coordinate used for y-axis data (0, 1, or 2 for x, y, or z).

    Default:-1

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:The coordinate used for y-axis data (0, 1, or 2 for x, y, or z).

  • zThe ordinate values

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The ordinate values

Optional Parameters

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

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters