ComputeTCScatterMGXSAux

Overview

ComputeTCScatterMGXSAux takes a Multi-Group (MG) isotropic scattering reaction rate variable (p0_scatter_rxn_rate), a list of MG P1 scattering reaction rate variables (p1_scatter_rxn_rates), and a MG scalar flux variable (scalar_flux); these are then used to compute a MG transport corrected isotropic scattering cross section with the following equations:

Example Input Syntax

The example below shows how ComputeTCScatterMGXSAux can be used to compute a MG transport corrected scattering cross section:

$\Sigma_{s,i,0,g'\rightarrow g} = \frac{\langle\sigma_{s}\psi\rangle_{i,0,g\rightarrow g'} - \delta_{gg'}\sum_{g''}\langle\sigma_{s}\psi\rangle_{i,1,g''\rightarrow g}}{\langle\psi\rangle_{i,g}}$

where $\langle\sigma_{s}\psi\rangle_{i,0,g\rightarrow g'}$ is a within-group isotropic scattering cross section, $\langle\nu\sigma_{s}\psi\rangle_{i,1,g'\rightarrow g}$ is a MG P1 scattering reaction rate, and $\langle\psi\rangle_{i,g}$ is a MG scalar flux. This AuxKernel is intended to be added via the MGXS block, see SetupMGXSAction for more information regarding MG cross section generation.

The example below shows how ComputeTCScatterMGXSAux can be used to compute a MG transport corrected isotropic scattering cross section:

[Problem]
  type = OpenMCCellAverageProblem
  initial_properties = xml
  verbose = true
  cell_level = 0
  normalize_by_global_tally = false

  power = 1.0
  source_rate_normalization = 'kappa_fission'

  [Tallies]
    [Cell_KF]
      type = CellTally
      score = 'kappa_fission'
      blocks = '100'
    []
    [Cell_Total_Flux]
      type = CellTally
      score = 'total flux'
      blocks = '100'
      filters = 'Energy'
    []
    [Cell_Scatter]
      type = CellTally
      score = 'nu_scatter'
      blocks = '100'
      filters = 'Energy EnergyOut Legendre'
      estimator = 'analog'
    []
  []
  [Filters]
    [Energy]
      type = EnergyFilter
      energy_boundaries = '0.0 6.25e-1 2.0e7'
      reverse_bins = true
    []
    [EnergyOut]
      type = EnergyOutFilter
      energy_boundaries = '0.0 6.25e-1 2.0e7'
      reverse_bins = true
    []
    [Legendre]
      type = AngularLegendreFilter
      order = 1
    []
  []
[]

Input Parameters

p0_scatter_rxn_rateThe P0 group-wise scattering reaction rates to use for computing the transport-corrected scattering cross section.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The P0 group-wise scattering reaction rates to use for computing the transport-corrected scattering cross section.
p1_scatter_rxn_ratesThe P1 group-wise scattering reaction rates to use for computing the transport-corrected scattering cross section.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The P1 group-wise scattering reaction rates to use for computing the transport-corrected scattering cross section.
scalar_fluxThe group-wise scalar flux used to compute the transport-corrected scattering cross section.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The group-wise scalar flux used to compute the transport-corrected scattering cross section.
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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
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
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, 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.
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
Unit:(no unit assumed)
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.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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

Input Files

(test/tests/neutronics/gen_mgxs/mgxs_aux/mg_tc_scatter_xs.i)

(test/tests/neutronics/gen_mgxs/mgxs_aux/mg_tc_scatter_xs.i)

[Mesh]
  [sphere]
    type = FileMeshGenerator
    file = ../../meshes/sphere.e
  []
  [solid1]
    type = SubdomainIDGenerator
    input = sphere
    subdomain_id = '100'
  []

  allow_renumbering = false
[]

[AuxVariables]
  [scatter_g1_g1_l0]
    type = MooseVariable
    order = CONSTANT
    family = MONOMIAL
  []
  [zero_flux]
    type = MooseVariable
    order = CONSTANT
    family = MONOMIAL
    initial_condition = '0.0'
  []
[]

[AuxKernels]
  [comp_scatter_g1_g1_l0]
    type = ComputeTCScatterMGXSAux
    variable = scatter_g1_g1_l0
    p0_scatter_rxn_rate = 'nu_scatter_g1_gp1_l1'
    p1_scatter_rxn_rates = 'nu_scatter_g1_gp1_l1 nu_scatter_g2_gp1_l1'
    scalar_flux = 'flux_g1'
  []
[]

[Problem]
  type = OpenMCCellAverageProblem
  initial_properties = xml
  verbose = true
  cell_level = 0
  normalize_by_global_tally = false

  power = 1.0
  source_rate_normalization = 'kappa_fission'

  [Tallies]
    [Cell_KF]
      type = CellTally
      score = 'kappa_fission'
      blocks = '100'
    []
    [Cell_Total_Flux]
      type = CellTally
      score = 'total flux'
      blocks = '100'
      filters = 'Energy'
    []
    [Cell_Scatter]
      type = CellTally
      score = 'nu_scatter'
      blocks = '100'
      filters = 'Energy EnergyOut Legendre'
      estimator = 'analog'
    []
  []
  [Filters]
    [Energy]
      type = EnergyFilter
      energy_boundaries = '0.0 6.25e-1 2.0e7'
      reverse_bins = true
    []
    [EnergyOut]
      type = EnergyOutFilter
      energy_boundaries = '0.0 6.25e-1 2.0e7'
      reverse_bins = true
    []
    [Legendre]
      type = AngularLegendreFilter
      order = 1
    []
  []
[]

[Executioner]
  type = Steady
[]

[Postprocessors]
  [result]
    type = PointValue
    point = '0 0 0'
    variable = scatter_g1_g1_l0
  []
[]

[Outputs]
  execute_on = final
  csv = true
[]

(test/tests/neutronics/gen_mgxs/mgxs_aux/mg_tc_scatter_xs.i)

[Mesh]
  [sphere]
    type = FileMeshGenerator
    file = ../../meshes/sphere.e
  []
  [solid1]
    type = SubdomainIDGenerator
    input = sphere
    subdomain_id = '100'
  []

  allow_renumbering = false
[]

[AuxVariables]
  [scatter_g1_g1_l0]
    type = MooseVariable
    order = CONSTANT
    family = MONOMIAL
  []
  [zero_flux]
    type = MooseVariable
    order = CONSTANT
    family = MONOMIAL
    initial_condition = '0.0'
  []
[]

[AuxKernels]
  [comp_scatter_g1_g1_l0]
    type = ComputeTCScatterMGXSAux
    variable = scatter_g1_g1_l0
    p0_scatter_rxn_rate = 'nu_scatter_g1_gp1_l1'
    p1_scatter_rxn_rates = 'nu_scatter_g1_gp1_l1 nu_scatter_g2_gp1_l1'
    scalar_flux = 'flux_g1'
  []
[]

[Problem]
  type = OpenMCCellAverageProblem
  initial_properties = xml
  verbose = true
  cell_level = 0
  normalize_by_global_tally = false

  power = 1.0
  source_rate_normalization = 'kappa_fission'

  [Tallies]
    [Cell_KF]
      type = CellTally
      score = 'kappa_fission'
      blocks = '100'
    []
    [Cell_Total_Flux]
      type = CellTally
      score = 'total flux'
      blocks = '100'
      filters = 'Energy'
    []
    [Cell_Scatter]
      type = CellTally
      score = 'nu_scatter'
      blocks = '100'
      filters = 'Energy EnergyOut Legendre'
      estimator = 'analog'
    []
  []
  [Filters]
    [Energy]
      type = EnergyFilter
      energy_boundaries = '0.0 6.25e-1 2.0e7'
      reverse_bins = true
    []
    [EnergyOut]
      type = EnergyOutFilter
      energy_boundaries = '0.0 6.25e-1 2.0e7'
      reverse_bins = true
    []
    [Legendre]
      type = AngularLegendreFilter
      order = 1
    []
  []
[]

[Executioner]
  type = Steady
[]

[Postprocessors]
  [result]
    type = PointValue
    point = '0 0 0'
    variable = scatter_g1_g1_l0
  []
[]

[Outputs]
  execute_on = final
  csv = true
[]

Overview
Example Input Syntax
Input Parameters
Input Files