KokkosGenericConstantMaterial

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

Example Input Syntax

  [mat]
    type = KokkosGenericConstantMaterial
    prop_names = 'm1 m2'
    prop_values = '-1 15'
  []

Input Parameters

prop_namesThe names of the properties this material will have
C++ Type:std::vector<std::string>
Controllable:No
Description:The names of the properties this material will have
prop_valuesThe values associated with the named properties
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:Yes
Description:The values associated with the named properties

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_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.
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.

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/materials/error/kokkos_overlap.i)
(test/tests/kokkos/vectorpostprocessors/extra_id_integral/kokkos_extra_id_vpp.i)
(test/tests/kokkos/postprocessors/side_integral/kokkos_side_integral_material_property.i)
(test/tests/kokkos/postprocessors/element_integral_material_property/kokkos_element_average_material_property.i)
(test/tests/kokkos/postprocessors/element_integral_material_property/kokkos_element_integral_material_property.i)
(modules/heat_transfer/test/tests/kokkos/kokkos_convective_heat_flux.i)
(test/tests/kokkos/materials/block_prop/kokkos_block_prop_test.i)
(test/tests/kokkos/materials/stateful_prop/kokkos_stateful_prop_on_bnd_only.i)
(test/tests/kokkos/kernels/material_coupled_force/kokkos_material_coupled_force.i)
(test/tests/kokkos/postprocessors/side_integral/kokkos_side_average_material_property.i)

(test/tests/kokkos/kernels/material_coupled_force/kokkos_material_coupled_force.i)

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

[Variables]
  [u]
  []
  [v1]
    initial_condition = 3
  []
[]

[AuxVariables]
  [v2]
  []
[]

[ICs]
  [v2_ic]
    type = FunctionIC
    variable = v2
    function = v2_func
  []
[]

[Functions]
  [v2_func]
    type = ParsedFunction
    expression = 'x + 2 * y'
  []

  [reference]
    type = ParsedFunction
    expression = '3 * (-1) * 3.5 + (x + 2 * y) * 15 * 1.2'
  []
[]

[Materials]
  [mat]
    type = KokkosGenericConstantMaterial
    prop_names = 'm1 m2'
    prop_values = '-1 15'
  []
[]

[Kernels]
  [reaction]
    type = KokkosReaction
    variable = u
  []

  [coupled]
    type = KokkosMatCoupledForce
    variable = u
    v = 'v1 v2'
    coef = '3.5 1.2'
    material_properties = 'm1 m2'
  []

  [constant]
    type = KokkosDiffusion
    variable = v1
  []
[]

[Postprocessors]
  [error]
    type = ElementL2Error
    function = reference
    variable = u
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/materials/error/kokkos_overlap.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 10
    ny = 1
  []
  [left_domain]
    input = gen
    type = SubdomainBoundingBoxGenerator
    bottom_left = '0 0 0'
    top_right = '0.5 1 0'
    block_id = 10
  []
[]


[Variables]
  [u]
    initial_condition = 2
  []
[]

[Kernels]
  [diff]
    type = KokkosMatDiffusionTest
    variable = u
    prop_name = 'p'
  []
[]

[BCs]
  [left]
    type = KokkosDirichletBC
    variable = u
    boundary = left
    value = 2
  []
  [right]
    type = KokkosDirichletBC
    variable = u
    boundary = right
    value = 3
  []
[]

[Materials]

  [all]
    type = KokkosGenericConstantMaterial
    prop_names =  'f f_prime p'
    prop_values = '2 2.5     2.468'
  []

  [left]
    type = KokkosGenericConstantMaterial
    prop_names =  'f f_prime p'
    prop_values = '1 0.5     1.2345'
  []
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  print_linear_residuals = true
  perf_graph = true
[]

(test/tests/kokkos/vectorpostprocessors/extra_id_integral/kokkos_extra_id_vpp.i)

[Mesh]
  [fmg]
    type = FileMeshGenerator
    file = 'extra_id_vpp.e'
    use_for_exodus_restart = true
    exodus_extra_element_integers = 'pin_id assembly_id'
  []
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[AuxVariables]
  [value1]
    order = FIRST
    initial_from_file_var = value1
  []
  [value2]
    order = FIRST
    initial_from_file_var = value2
  []
[]

[Materials]
  [mat1]
    type = KokkosGenericConstantMaterial
    prop_names = 'mat1'
    prop_values = 1
  []
  [mat2]
    type = KokkosGenericConstantMaterial
    prop_names = 'mat2'
    prop_values = 2
  []
[]

[VectorPostprocessors]
  [integral]
    type = KokkosExtraIDIntegralVectorPostprocessor
    variable = 'value1'
    id_name = 'assembly_id'
    calculation_mode = atomic
  []
[]

[Outputs]
  exodus = false
  csv = true
  execute_on = timestep_end
[]

(test/tests/kokkos/postprocessors/side_integral/kokkos_side_integral_material_property.i)

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

[Variables]
  [u]
  []
[]

[Problem]
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 1
[]

[Materials]
  [real]
    type = KokkosGenericConstantMaterial
    prop_names = prop
    prop_values = 1.1
  []
[]

[Postprocessors]
  [integral]
    type = KokkosSideIntegralMaterialProperty
    boundary = bottom
    property = prop
  []
[]

[Outputs]
  csv = true
[]

(test/tests/kokkos/postprocessors/element_integral_material_property/kokkos_element_average_material_property.i)

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

[Variables]
  [u]
  []
[]

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

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

[Materials]
  [mat]
    type = KokkosGenericConstantMaterial
    block = 0
    prop_names = prop
    prop_values = 2.0
  []
[]

[Postprocessors]
  [prop_average]
    type = KokkosElementAverageMaterialProperty
    mat_prop = prop
    execute_on = 'initial timestep_end'
  []
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  csv = true
[]

(test/tests/kokkos/postprocessors/element_integral_material_property/kokkos_element_integral_material_property.i)

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

[Variables]
  [u]
  []
[]

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

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

[Materials]
  [mat]
    type = KokkosGenericConstantMaterial
    block = 0
    prop_names = prop
    prop_values = 2.0
  []
[]

[Postprocessors]
  [prop_integral]
    type = KokkosElementIntegralMaterialProperty
    mat_prop = prop
    execute_on = 'initial timestep_end'
  []
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  csv = true
[]

(modules/heat_transfer/test/tests/kokkos/kokkos_convective_heat_flux.i)

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

[Variables]
  [temp]
    initial_condition = 100.0
  []
[]

[Kernels]
  [heat_conduction]
    type = KokkosHeatConduction
    variable = temp
  []
[]

[BCs]
  [left]
    type = KokkosDirichletBC
    variable = temp
    boundary = left
    value = 100.0
  []
  [right]
    type = KokkosConvectiveHeatFluxBC
    variable = temp
    boundary = right
    T_infinity = 200.0
    heat_transfer_coefficient = 10
  []
[]

[Materials]
  [conduction]
    type = KokkosHeatConductionMaterial
    thermal_conductivity = 10
  []
  [bc]
    type = KokkosGenericConstantMaterial
    prop_names = 'Tinf htc'
    prop_values = '200 10'
  []
[]

[Postprocessors]
  [right_flux]
    type = SideDiffusiveFluxAverage
    variable = temp
    boundary = right
    diffusivity = 10
  []
[]

[Executioner]
  type = Steady
  nl_rel_tol = 1e-12
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/materials/block_prop/kokkos_block_prop_test.i)

[Mesh]
  [square]
    type = CartesianMeshGenerator
    dx = '5 5'
    dy = '5 5'
    ix = '5 5'
    iy = '5 5'
    dim = 2
    subdomain_id = '1 2 3 4'
  []
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [diff]
    type = KokkosBlockPropertyDiffusion
    variable = u
    prop_name = coef
  []
[]

[BCs]
  [left]
    type = KokkosDirichletBC
    variable = u
    boundary = 3
    value = 0.0
  []
  [right]
    type = KokkosDirichletBC
    variable = u
    boundary = 1
    value = 1.0
  []
[]

[Materials]
  [mat]
    type = KokkosGenericConstantMaterial
    prop_names = 'coef'
    prop_values = '2.0'
    block = '1 3'
  []
  [dummy]
    type = KokkosGenericConstantMaterial
    prop_names = 'notcoef'
    prop_values = '2.0'
    block = '2 4'
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/materials/stateful_prop/kokkos_stateful_prop_on_bnd_only.i)

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

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

[Kernels]
  [heat]
    type = KokkosMatDiffusionTest
    variable = u
    prop_name = thermal_conductivity
  []

  [ie]
    type = KokkosTimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = KokkosDirichletBC
    variable = u
    boundary = left
    value = 0.0
  []

  [right]
    type = KokkosMTBC
    variable = u
    boundary = right
    grad = 1.0
    prop_name = thermal_conductivity
  []
[]

[Materials]
  [volatile]
    type = KokkosGenericConstantMaterial
    prop_names = 'thermal_conductivity'
    prop_values = 10
    block = 0
  []

  [stateful_on_boundary]
    type = KokkosStatefulSpatialTest
    boundary = right
  []
[]

[Executioner]
  type = Transient

  solve_type = 'PJFNK'

  start_time = 0.0
  num_steps = 5
  dt = .1
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/kernels/material_coupled_force/kokkos_material_coupled_force.i)

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

[Variables]
  [u]
  []
  [v1]
    initial_condition = 3
  []
[]

[AuxVariables]
  [v2]
  []
[]

[ICs]
  [v2_ic]
    type = FunctionIC
    variable = v2
    function = v2_func
  []
[]

[Functions]
  [v2_func]
    type = ParsedFunction
    expression = 'x + 2 * y'
  []

  [reference]
    type = ParsedFunction
    expression = '3 * (-1) * 3.5 + (x + 2 * y) * 15 * 1.2'
  []
[]

[Materials]
  [mat]
    type = KokkosGenericConstantMaterial
    prop_names = 'm1 m2'
    prop_values = '-1 15'
  []
[]

[Kernels]
  [reaction]
    type = KokkosReaction
    variable = u
  []

  [coupled]
    type = KokkosMatCoupledForce
    variable = u
    v = 'v1 v2'
    coef = '3.5 1.2'
    material_properties = 'm1 m2'
  []

  [constant]
    type = KokkosDiffusion
    variable = v1
  []
[]

[Postprocessors]
  [error]
    type = ElementL2Error
    function = reference
    variable = u
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
[]

[Outputs]
  exodus = true
[]

(test/tests/kokkos/postprocessors/side_integral/kokkos_side_average_material_property.i)

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

[Variables]
  [u]
  []
[]

[Problem]
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 1
[]

[Materials]
  [real]
    type = KokkosGenericConstantMaterial
    prop_names = prop
    prop_values = 1.1
  []
[]

[Postprocessors]
  [average]
    type = KokkosSideAverageMaterialProperty
    boundary = bottom
    property = prop
  []
[]

[Outputs]
  csv = true
[]

Example Input Syntax
Input Parameters
Input Files