DiffusionRodMaterial

Declares material properties based on names and values prescribed by input parameters.

Overview

This material class inherits all group constant-handling functionality in MoltresJsonMaterial and additionally allows for rod cusping correction using polynomial fitting. Rod cusping occurs when the control rod boundaries do not intersect perfectly with mesh element interfaces during rod movement.

This material computes a "corrected rod volume fraction" $var element = document.getElementById("moose-equation-fc46400a-d6f3-4ea5-8787-ff83f5caf92e");katex.render("V_r'", element, {displayMode:false,throwOnError:false});$ using user-provided values as follows:

var element = document.getElementById("moose-equation-bf3fc816-d797-491a-aeeb-c1761eaefaa9");katex.render("V_r' = c V_r^p", element, {displayMode:true,throwOnError:false});

where

var element = document.getElementById("moose-equation-83cd47d7-f73f-44eb-8ec2-3a471a03511c");katex.render("p = \\text{ cusping correction power factor} \\\\ c = \\text{ cusping correction coefficient}.", element, {displayMode:true,throwOnError:false});

Example Input File Syntax

Input Parameters

base_fileThe file containing macroscopic XS.
C++ Type:std::string
Controllable:No
Description:The file containing macroscopic XS.
interp_typeThe type of interpolation to perform.
C++ Type:MooseEnum
Options:bicubic, spline, monotone_cubic, linear, none, least_squares
Controllable:No
Description:The type of interpolation to perform.
material_keyThe file key where the macroscopic XS can be found.
C++ Type:std::string
Controllable:No
Description:The file key where the macroscopic XS can be found.
nonrod_material_keyThe material key for the non-rod material.
C++ Type:std::string
Controllable:No
Description:The material key for the non-rod material.
num_groupsThe number of groups the energy spectrum is divided into.
C++ Type:unsigned int
Controllable:No
Description:The number of groups the energy spectrum is divided into.
num_precursor_groupsThe number of delayed neutron precursor groups.
C++ Type:unsigned int
Controllable:No
Description:The number of delayed neutron precursor groups.
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
rod_height_funcName of function that provides the rod interface height
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Name of function that provides the rod interface height

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
computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Controllable:No
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Options:NONE, ELEMENT, SUBDOMAIN
Controllable:No
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
cusp_correction_coefficient1Rod cusping correction coefficient. The coefficient to which the rod volume fraction is multiplied with.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Rod cusping correction coefficient. The coefficient to which the rod volume fraction is multiplied with.
cusp_correction_power1Rod cusping correction power factor. The power to which the rod volume fraction is raised to.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Rod cusping correction power factor. The power to which the rod volume fraction is raised to.
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.
group_constantsREMXS FISSXS NSF FISSE DIFFCOEF RECIPVEL CHI_T CHI_P CHI_D GTRANSFXS BETA_EFF DECAY_CONSTANT Group constants to be determined.
Default:REMXS FISSXS NSF FISSE DIFFCOEF RECIPVEL CHI_T CHI_P CHI_D GTRANSFXS BETA_EFF DECAY_CONSTANT
C++ Type:std::vector<std::string>
Controllable:No
Description:Group constants to be determined.
sss2_inputTrueWhether serpent 2 was used to generate the input files.
Default:True
C++ Type:bool
Controllable:No
Description:Whether serpent 2 was used to generate the input files.
temperature937.0The temperature field for determining group constants.
Default:937.0
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The temperature field for determining group constants.

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

output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector<std::string>
Controllable:No
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs 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

(tests/materials/sn_rod.i)

[GlobalParams]
  num_groups = 8
  num_precursor_groups = 6
  group_fluxes = 'group1 group2 group3 group4 group5 group6 group7 group8'
  temperature = 900
  sss2_input = true
  account_delayed = false
  use_exp_form = false
  search_value_conflicts = false
[]

[Problem]
  type = EigenProblem
  bx_norm = bnorm
[]

[Mesh]
  [mesh]
    type = CartesianMeshGenerator
    dim = 3
    dx = 10
    dy = 10
    dz = '90 10'
    iz = '90 40'
  []
[]

[AuxVariables]
  [drift1]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift2]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift3]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift4]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift5]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift6]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift7]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
  [drift8]
    order = FIRST
    family = MONOMIAL
    components = 3
  []
[]

[Nt]
  family = LAGRANGE
  order = FIRST
  var_name_base = group
  set_diffcoef_limit = true
  create_temperature_var = false
  eigen = true
[]

[Kernels]
  [group1_drift]
    type = GroupDrift
    variable = group1
    group_drift_var = drift1
  []
  [group2_drift]
    type = GroupDrift
    variable = group2
    group_drift_var = drift2
  []
  [group3_drift]
    type = GroupDrift
    variable = group3
    group_drift_var = drift3
  []
  [group4_drift]
    type = GroupDrift
    variable = group4
    group_drift_var = drift4
  []
  [group5_drift]
    type = GroupDrift
    variable = group5
    group_drift_var = drift5
  []
  [group6_drift]
    type = GroupDrift
    variable = group6
    group_drift_var = drift6
  []
  [group7_drift]
    type = GroupDrift
    variable = group7
    group_drift_var = drift7
  []
  [group8_drift]
    type = GroupDrift
    variable = group8
    group_drift_var = drift8
  []
[]

[Functions]
  [rod_height]
    type = ParsedFunction
    expression = '95'
  []
[]

[Materials]
  [rod_fuel]
    type = DiffusionRodMaterial
    base_file = '../../property_file_dir/sn-test/absorber-air-lattice-ref.json'
    material_key = 'ctrlrod'
    nonrod_material_key = 'fuel'
    rod_height_func = rod_height
    interp_type = 'none'
  []
[]

[Executioner]
  type = Eigenvalue
  free_power_iterations = 2

  fixed_point_abs_tol = 1e-10
  fixed_point_rel_tol = 1e-10
  fixed_point_max_its = 15
  accept_on_max_fixed_point_iteration = false

  nl_abs_tol = 1e-10
  nl_rel_tol = 1e-50

  solve_type = 'PJFNK'
  petsc_options = '-snes_converged_reason -ksp_converged_reason -snes_linesearch_monitor'
  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart'
  petsc_options_value = 'hypre boomeramg 200'
  line_search = 'none'
[]

[MultiApps]
  [sub]
    type = FullSolveMultiApp
    input_files = sn_rod_sub.i
    execute_on = timestep_end
    keep_solution_during_restore = true
  []
[]

[Transfers]
  [to_sub]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'group1 group2 group3 group4 group5 group6 group7 group8'
    variable = 'group1 group2 group3 group4 group5 group6 group7 group8'
    to_multi_app = sub
  []
  [to_sub_k]
    type = MultiAppPostprocessorTransfer
    from_postprocessor = eigenvalue
    to_postprocessor = eigenvalue
    to_multi_app = sub
  []
  [from_sub_drift1]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift1 drift1 drift1'
    variable = 'drift1 drift1 drift1'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift2]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift2 drift2 drift2'
    variable = 'drift2 drift2 drift2'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift3]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift3 drift3 drift3'
    variable = 'drift3 drift3 drift3'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift4]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift4 drift4 drift4'
    variable = 'drift4 drift4 drift4'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift5]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift5 drift5 drift5'
    variable = 'drift5 drift5 drift5'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift6]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift6 drift6 drift6'
    variable = 'drift6 drift6 drift6'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift7]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift7 drift7 drift7'
    variable = 'drift7 drift7 drift7'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
  [from_sub_drift8]
    type = MultiAppGeneralFieldShapeEvaluationTransfer
    source_variable = 'drift8 drift8 drift8'
    variable = 'drift8 drift8 drift8'
    from_multi_app = sub
    source_variable_components = '0 1 2'
    target_variable_components = '0 1 2'
  []
[]

[Postprocessors]
  [bnorm]
    type = ElmIntegTotFissNtsPostprocessor
    execute_on = 'initial linear timestep_end'
  []
  [eigenvalue]
    type = VectorPostprocessorComponent
    vectorpostprocessor = eigenvalues
    vector_name = eigen_values_real
    index = 0
  []
[]

[VectorPostprocessors]
  [eigenvalues]
    type = Eigenvalues
    inverse_eigenvalue = true
    outputs = console
  []
[]

[Outputs]
  [exodus]
    type = Exodus
    discontinuous = true
  []
[]

(tests/materials/diffusion_rod.i)

[GlobalParams]
  num_groups = 8
  num_precursor_groups = 6
  group_fluxes = 'group1 group2 group3 group4 group5 group6 group7 group8'
  temperature = 900
  sss2_input = true
  account_delayed = false
  use_exp_form = false
[]

[Problem]
  type = EigenProblem
  bx_norm = bnorm
[]

[Mesh]
  [mesh]
    type = CartesianMeshGenerator
    dim = 3
    dx = 10
    dy = 10
    dz = '90 10'
    iz = '90 40'
  []
[]

[Nt]
  family = LAGRANGE
  order = FIRST
  var_name_base = group
  create_temperature_var = false
  eigen = true
[]

[Functions]
  [rod_height]
    type = ParsedFunction
    expression = '95'
  []
[]

[Materials]
  [rod_fuel]
    type = DiffusionRodMaterial
    base_file = '../../property_file_dir/sn-test/absorber-air-lattice-ref.json'
    material_key = 'ctrlrod'
    nonrod_material_key = 'fuel'
    rod_height_func = rod_height
    interp_type = 'none'
  []
[]

[Executioner]
  type = Eigenvalue
  free_power_iterations = 2

  fixed_point_abs_tol = 1e-10
  fixed_point_rel_tol = 1e-8
  fixed_point_max_its = 8
  accept_on_max_fixed_point_iteration = false

  nl_abs_tol = 1e-10
  nl_rel_tol = 1e-50

  solve_type = 'PJFNK'
  petsc_options = '-snes_converged_reason -ksp_converged_reason -snes_linesearch_monitor'
  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart'
  petsc_options_value = 'hypre boomeramg 200'
  line_search = 'none'
[]

[Postprocessors]
  [bnorm]
    type = ElmIntegTotFissNtsPostprocessor
    execute_on = 'initial linear timestep_end'
  []
  [eigenvalue]
    type = VectorPostprocessorComponent
    vectorpostprocessor = eigenvalues
    vector_name = eigen_values_real
    index = 0
  []
[]

[VectorPostprocessors]
  [eigenvalues]
    type = Eigenvalues
    inverse_eigenvalue = true
    outputs = console
  []
[]

[Outputs]
  perf_graph = true
  [exodus]
    type = Exodus
    discontinuous = true
    execute_on = 'initial timestep_end failed'
  []
[]

Overview
Example Input File Syntax
Input Parameters
Input Files