KokkosParsedFunction

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

note

The Kokkos version does not support using scalar variables for "symbol_values" yet.

Example Syntax

[Functions<<<{"href": "../../../syntax/Functions/index.html"}>>>]
  [parsed]
    type = KokkosParsedFunction<<<{"description": "Function created by parsing a string", "href": "KokkosParsedFunction.html"}>>>
    expression<<<{"description": "The user defined function."}>>> = 'if (x > y, 0.1*x, 0.1*y) + const + t + t_pp'
    symbol_names<<<{"description": "Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the symbol_values vector."}>>> = 'const t_pp'
    symbol_values<<<{"description": "Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names."}>>> = '1 time'
    print_rpn<<<{"description": "Print parsed Reverse Polish Notation (RPN) for debugging."}>>> = true
  []
[]

Input Parameters

expressionThe user defined function.
C++ Type:FunctionExpression
Unit:(no unit assumed)
Controllable:No
Description:The user defined function.
print_rpnFalsePrint parsed Reverse Polish Notation (RPN) for debugging.
Default:False
C++ Type:bool
Controllable:No
Description:Print parsed Reverse Polish Notation (RPN) for debugging.
symbol_namesSymbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the symbol_values vector.
C++ Type:std::vector<std::string>
Controllable:No
Description:Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the symbol_values vector.
symbol_valuesConstant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.
C++ Type:std::vector<std::string>
Controllable:No
Description:Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.

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

Input Files

(test/tests/kokkos/functions/parsed_function/kokkos_parsed_function.i)
(test/tests/kokkos/materials/parsed/kokkos_parsed_material.i)

(test/tests/kokkos/functions/parsed_function/kokkos_parsed_function.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
[]

[Functions]
  [parsed]
    type = KokkosParsedFunction
    expression = 'if (x > y, 0.1*x, 0.1*y) + const + t + t_pp'
    symbol_names = 'const t_pp'
    symbol_values = '1 time'
    print_rpn = true
  []
[]

[Kernels]
  [diff]
    type = KokkosParsedFuncCoefDiffusion
    variable = u
    coef = parsed
  []
  [time]
    type = KokkosTimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = KokkosDirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = KokkosNeumannBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Postprocessors]
  [time]
    type = ParsedPostprocessor
    expression = 't'
    use_t = true
  []
[]

[Executioner]
  type = Transient
  num_steps = 10
  dt = 0.1
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/functions/parsed_function/kokkos_parsed_function.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
[]

[Functions]
  [parsed]
    type = KokkosParsedFunction
    expression = 'if (x > y, 0.1*x, 0.1*y) + const + t + t_pp'
    symbol_names = 'const t_pp'
    symbol_values = '1 time'
    print_rpn = true
  []
[]

[Kernels]
  [diff]
    type = KokkosParsedFuncCoefDiffusion
    variable = u
    coef = parsed
  []
  [time]
    type = KokkosTimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = KokkosDirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = KokkosNeumannBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Postprocessors]
  [time]
    type = ParsedPostprocessor
    expression = 't'
    use_t = true
  []
[]

[Executioner]
  type = Transient
  num_steps = 10
  dt = 0.1
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/materials/parsed/kokkos_parsed_material.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmax = 10
  ymax = 10
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
[]

[AuxVariables]
  [phi]
  []
  [hm]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[ICs]
  [phi_IC]
    type = FunctionIC
    variable = phi
    function = ic_func_phi
  []
[]

[Functions]
  [ic_func_phi]
    type = ParsedFunction
    expression = '0.5 * (1 - tanh((x - 5) / 0.8))'
  []
  [tf]
    type = KokkosParsedFunction
    expression = '1 + sin(y)'
  []
[]

[BCs]
  [top]
    type = KokkosMatNeumannBC
    variable = u
    boundary = top
    value = 2
    boundary_material = hm
  []
[]

[Kernels]
  [dudt]
    type = KokkosTimeDerivative
    variable = u
  []
  [diff]
    type = KokkosDiffusion
    variable = u
  []
[]

[AuxKernels]
  [hm]
    type = KokkosMaterialRealAux
    variable = hm
    property = hm
    execute_on = 'INITIAL'
  []
[]

[Materials]
  [mat]
    type = KokkosParsedMaterial
    property_name = hm
    coupled_variables = 'phi'
    function_names = 'tf'
    expression = '3*phi^2 - 2*phi^3 + tf'
  []
[]

[Executioner]
  type = Transient
  solve_type = 'PJFNK'
  end_time = 10
[]

[Outputs]
  exodus = true
[]

Example Syntax
Input Parameters
Input Files