KokkosParsedMaterial

This is the Kokkos version of ParsedMaterial. 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

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

Input Parameters

property_nameName of the parsed material property
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Name of the parsed material property

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
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.
constant_onNONEWhen ELEMENT or SUBDOMAIN, computeQpProperties() will be only called once for each element/face or subdomain, respectively. Material properties will be only stored for each element/face or subdomain accordingly. The 'qp' argument wlll be ignored.
Default:NONE
C++ Type:MooseEnum
Options:NONE, ELEMENT, SUBDOMAIN
Controllable:No
Description:When ELEMENT or SUBDOMAIN, computeQpProperties() will be only called once for each element/face or subdomain, respectively. Material properties will be only stored for each element/face or subdomain accordingly. The 'qp' argument wlll be ignored.
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.
declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.
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.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
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

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_mat_test.i)
(test/tests/kokkos/materials/parsed/kokkos_parsed_material.i)

(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
[]

(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/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 Input Syntax
Input Parameters
Input Files