KokkosParsedAux

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

note

The Kokkos version does not support functors yet. Instead, postprocessors, variables, material properties, and functions can be specified for the use in the parsed expression through separate parameters.

Example Input Syntax

  [set_parsed]
    type = KokkosParsedAux
    variable = parsed
    coupled_variables = 'u v'
    expression = '(u-0.5)^3*v'
  []

Input Parameters

variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
constant_expressionsVector of values for the constants in constant_names.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of values for the constants in constant_names.
constant_namesVector of constants used in the parsed function.
C++ Type:std::vector<std::string>
Controllable:No
Description:Vector of constants used in the parsed function.
coupled_variablesVector of variables used in the parsed function.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of variables used in the parsed function.
execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, PRE_DISPLACE
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
expressionParsed function expression.
C++ Type:std::string
Controllable:No
Description:Parsed function expression.
function_namesVector of functions used in the parsed function.
C++ Type:std::vector<FunctionName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of functions used in the parsed function.
material_property_namesVector of material properties used in the parsed function.
C++ Type:std::vector<MaterialPropertyName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of material properties used in the parsed function.
postprocessor_namesVector of postprocessor names used in the parsed function.
C++ Type:std::vector<PostprocessorName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of postprocessor names used in the parsed function.
use_dtFalseMake time step (dt) variable available in the function expression.
Default:False
C++ Type:bool
Controllable:No
Description:Make time step (dt) variable available in the function expression.
use_xyztFalseMake coordinate (x,y,z) and time (t) variables available in the function expression.
Default:False
C++ Type:bool
Controllable:No
Description:Make coordinate (x,y,z) and time (t) variables available in the function expression.

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:Yes
Description:Set the enabled status of the MooseObject.
search_methodnearest_node_connected_sidesChoice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
Default:nearest_node_connected_sides
C++ Type:MooseEnum
Options:nearest_node_connected_sides, all_proximate_sides
Controllable:No
Description:Choice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files

(test/tests/kokkos/auxkernels/parsed/kokkos_parsed_aux_test.i)
(test/tests/kokkos/auxkernels/parsed/kokkos_parsed_aux_mat_test.i)
(test/tests/kokkos/auxkernels/parsed/kokkos_xyzt.i)

(test/tests/kokkos/auxkernels/parsed/kokkos_parsed_aux_test.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 1
  ymin = 0
  ymax = 1
  nx = 10
  ny = 10
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []

  [v]
    order = FIRST
    family = LAGRANGE
  []
[]

[AuxVariables]
  [parsed]
    order = FIRST
    family = LAGRANGE
  []
[]

[Kernels]
  [diff_u]
    type = KokkosDiffusion
    variable = u
  []

  [diff_v]
    type = KokkosDiffusion
    variable = v
  []
[]

[BCs]
  [top_u]
    type = KokkosDirichletBC
    variable = u
    boundary = 'top'
    value = 0
  []

  [bottom_u]
    type = KokkosDirichletBC
    variable = u
    boundary = 'bottom'
    value = 1
  []

  [left_v]
    type = KokkosDirichletBC
    variable = v
    boundary = 'left'
    value = 0
  []

  [right_v]
    type = KokkosDirichletBC
    variable = v
    boundary = 'right'
    value = 1
  []
[]

[AuxKernels]
  [set_parsed]
    type = KokkosParsedAux
    variable = parsed
    coupled_variables = 'u v'
    expression = '(u-0.5)^3*v'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/auxkernels/parsed/kokkos_parsed_aux_test.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 1
  ymin = 0
  ymax = 1
  nx = 10
  ny = 10
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []

  [v]
    order = FIRST
    family = LAGRANGE
  []
[]

[AuxVariables]
  [parsed]
    order = FIRST
    family = LAGRANGE
  []
[]

[Kernels]
  [diff_u]
    type = KokkosDiffusion
    variable = u
  []

  [diff_v]
    type = KokkosDiffusion
    variable = v
  []
[]

[BCs]
  [top_u]
    type = KokkosDirichletBC
    variable = u
    boundary = 'top'
    value = 0
  []

  [bottom_u]
    type = KokkosDirichletBC
    variable = u
    boundary = 'bottom'
    value = 1
  []

  [left_v]
    type = KokkosDirichletBC
    variable = v
    boundary = 'left'
    value = 0
  []

  [right_v]
    type = KokkosDirichletBC
    variable = v
    boundary = 'right'
    value = 1
  []
[]

[AuxKernels]
  [set_parsed]
    type = KokkosParsedAux
    variable = parsed
    coupled_variables = 'u v'
    expression = '(u-0.5)^3*v'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/auxkernels/parsed/kokkos_parsed_aux_mat_test.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 1
  ymin = 0
  ymax = 1
  nx = 10
  ny = 10
[]

[Variables]
  [u]
    order = FIRST
    family = LAGRANGE
  []

  [v]
    order = FIRST
    family = LAGRANGE
  []
[]

[AuxVariables]
  [parsed]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[Kernels]
  [diff_u]
    type = KokkosDiffusion
    variable = u
  []

  [diff_v]
    type = KokkosDiffusion
    variable = v
  []
[]

[BCs]
  [left_u]
    type = KokkosDirichletBC
    variable = u
    boundary = top
    value = 0
  []

  [right_u]
    type = KokkosDirichletBC
    variable = u
    boundary = bottom
    value = 1
  []

  [left_v]
    type = KokkosDirichletBC
    variable = v
    boundary = left
    value = 0
  []

  [right_v]
    type = KokkosDirichletBC
    variable = v
    boundary = right
    value = 1
  []
[]

[Materials]
  [u]
    type = KokkosParsedMaterial
    property_name = 'u_mat'
    expression = 'u'
    coupled_variables = 'u'
  []
  [v]
    type = KokkosParsedMaterial
    property_name = 'v_mat'
    expression = 'v'
    coupled_variables = 'v'
  []
[]

[AuxKernels]
  [set_parsed]
    type = KokkosParsedAux
    variable = parsed
    material_property_names = 'u_mat v_mat'
    expression = '(u_mat-0.5)^3*v_mat'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
  hide = 'u v'
[]

(test/tests/kokkos/auxkernels/parsed/kokkos_xyzt.i)

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 4
  ny = 4
  nz = 4
[]

[AuxVariables]
  [xvar]
    family = MONOMIAL
    order = FIRST
  []
  [yvar]
  []
  [zvar]
    family = MONOMIAL
    order = CONSTANT
  []
  [tvar]
  []
[]

[AuxKernels]
  [xvar]
    type = KokkosParsedAux
    variable = xvar
    use_xyzt = true
    expression = 'x+1'
  []
  [yvar]
    type = KokkosParsedAux
    variable = yvar
    use_xyzt = true
    expression = 'y+2'
  []
  [zvar]
    type = KokkosParsedAux
    variable = zvar
    use_xyzt = true
    expression = 'z+3'
  []
  [tvar]
    type = KokkosParsedAux
    variable = tvar
    use_xyzt = true
    expression = 't+0.1*(x+y+z)'
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 3
[]

[Outputs]
  exodus = true
[]

Example Input Syntax
Input Parameters
Input Files