KokkosPiecewiseConstant

This is the Kokkos version of PiecewiseConstant. See the original document for details.

Example Syntax

[KokkosFunctions<<<{"href": "../../../syntax/KokkosFunctions/index.html"}>>>]
  [func_x_y]
    type = KokkosPiecewiseConstant<<<{"description": "Defines piece-wise constant data using a set of x-y data pairs", "href": "KokkosPiecewiseConstant.html"}>>>
    x<<<{"description": "The abscissa values"}>>> = '0.0 0.5'
    y<<<{"description": "The ordinate values"}>>> = '2.0 3.0'
  []
  [func_xy_data]
    type = KokkosPiecewiseConstant<<<{"description": "Defines piece-wise constant data using a set of x-y data pairs", "href": "KokkosPiecewiseConstant.html"}>>>
    xy_data<<<{"description": "All function data, supplied in abscissa, ordinate pairs"}>>> = '0.0 2.0
               0.5 3.0'
  []
  [func_csv]
    type = KokkosPiecewiseConstant<<<{"description": "Defines piece-wise constant data using a set of x-y data pairs", "href": "KokkosPiecewiseConstant.html"}>>>
    data_file<<<{"description": "File holding CSV data"}>>> = xy.csv
  []
  [func_json]
    type = KokkosPiecewiseConstant<<<{"description": "Defines piece-wise constant data using a set of x-y data pairs", "href": "KokkosPiecewiseConstant.html"}>>>
    json_uo<<<{"description": "JSONFileReader holding the data"}>>> = json
    x_keys<<<{"description": "Ordered vector of keys in the JSON tree to obtain the abscissa"}>>> = 'data x value'
    y_keys<<<{"description": "Ordered vector of keys in the JSON tree to obtain the ordinate"}>>> = 'data y value'
  []
[]
(test/tests/kokkos/functions/piecewise_constant/kokkos_piecewise_constant.i)

Input Parameters

  • axisThe axis used (x, y, or z) if this is to be a function of position

    C++ Type:MooseEnum

    Options:x, y, z

    Controllable:No

    Description:The axis used (x, y, or z) if this is to be a function of position

  • directionLEFTDirection to look to find value: LEFT RIGHT LEFT_INCLUSIVE RIGHT_INCLUSIVE

    Default:LEFT

    C++ Type:MooseEnum

    Options:LEFT, RIGHT, LEFT_INCLUSIVE, RIGHT_INCLUSIVE

    Controllable:No

    Description:Direction to look to find value: LEFT RIGHT LEFT_INCLUSIVE RIGHT_INCLUSIVE

  • scale_factor1Scale factor to be applied to the output values

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Scale factor to be applied to the output values

Optional Parameters

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

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

    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

    Controllable:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

  • data_fileFile holding CSV data

    C++ Type:FileName

    Controllable:No

    Description:File holding CSV data

  • formatrowsFormat of csv data file that is in either in columns or rows

    Default:rows

    C++ Type:MooseEnum

    Options:columns, rows

    Controllable:No

    Description:Format of csv data file that is in either in columns or rows

  • x_index_in_file0The abscissa index in the data file

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The abscissa index in the data file

  • x_titleThe title of the column/row containing the x data in the data file

    C++ Type:std::string

    Controllable:No

    Description:The title of the column/row containing the x data in the data file

  • xy_in_file_onlyTrueIf the data file only contains abscissa and ordinate data

    Default:True

    C++ Type:bool

    Controllable:No

    Description:If the data file only contains abscissa and ordinate data

  • y_index_in_file1The ordinate index in the data file

    Default:1

    C++ Type:unsigned int

    Controllable:No

    Description:The ordinate index in the data file

  • y_titleThe title of the column/row containing the y data in the data file

    C++ Type:std::string

    Controllable:No

    Description:The title of the column/row containing the y data in the data file

Data From Csv File Parameters

  • json_uoJSONFileReader holding the data

    C++ Type:UserObjectName

    Controllable:No

    Description:JSONFileReader holding the data

  • x_keysOrdered vector of keys in the JSON tree to obtain the abscissa

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

    Controllable:No

    Description:Ordered vector of keys in the JSON tree to obtain the abscissa

  • y_keysOrdered vector of keys in the JSON tree to obtain the ordinate

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

    Controllable:No

    Description:Ordered vector of keys in the JSON tree to obtain the ordinate

Data From Json Parameters

  • xThe abscissa values

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The abscissa values

  • xy_dataAll function data, supplied in abscissa, ordinate pairs

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

    Unit:(no unit assumed)

    Controllable:No

    Description:All function data, supplied in abscissa, ordinate pairs

  • yThe ordinate values

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The ordinate values

Data From Input File Parameters