ElasticRecoil

construction:Undocumented Class

The ElasticRecoil has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Computes recoil cross sections for elastic scattering events. Allows output to csv.

Overview

Example Input File Syntax

Input Parameters

neutron_energy_limitsEnergy limits of the incident neutron in [eV] and descending order
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Energy limits of the incident neutron in [eV] and descending order
neutron_spectrumFunction representing the reactor neutron spectrum
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Function representing the reactor neutron spectrum
recoil_energy_limitsEnergy limits of the recoil atom in [eV] and descending order
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Energy limits of the recoil atom in [eV] and descending order
scattering_lawFunction representing the scattering law for neutrons
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Function representing the scattering law for neutrons
scattering_xsFunctions representing the neutron cross sections. NOTE: this is a vector to allow separate inputs for inelastic modes.
C++ Type:std::vector<FunctionName>
Unit:(no unit assumed)
Controllable:No
Description:Functions representing the neutron cross sections. NOTE: this is a vector to allow separate inputs for inelastic modes.

Required Parameters

atomic_mass1Atomic Mass of the isotope. Default to Hydrogen A = 1
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Atomic Mass of the isotope. Default to Hydrogen A = 1
cross_section_output_filenameName of the output file with the cross section coefficients (.csv)
C++ Type:std::string
Controllable:No
Description:Name of the output file with the cross section coefficients (.csv)
legendre_order10Order of Legendre polynomials where n = 0, ..., 10. Default to P10
Default:10
C++ Type:unsigned int
Controllable:No
Description:Order of Legendre polynomials where n = 0, ..., 10. Default to P10
mu_L_output_filenameName of the output file with the mininum and maximum mu_L (.csv)
C++ Type:std::string
Controllable:No
Description:Name of the output file with the mininum and maximum mu_L (.csv)
quadrature_order400Quadrature order for integration
Default:400
C++ Type:unsigned int
Controllable:No
Description:Quadrature order for integration

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
execute_onTIMESTEP_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:TIMESTEP_END
C++ Type:ExecFlagEnum
Options: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
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.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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.
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

(examples/elastic_recoil_cross_section/erxs_C12_simple.i)
(tests/userobjects/elastic_recoil/C12.i)
(examples/elastic_recoil_cross_section/erxs_C12_spectrum.i)
(examples/elastic_recoil_cross_section/erxs_H1_spectrum_xs.i)
(examples/elastic_recoil_cross_section/angular_distribution_benchmark.i)
(examples/elastic_recoil_cross_section/erxs_H1_spectrum.i)
(tests/userobjects/elastic_recoil/erxs_analytical.i)
(examples/elastic_recoil_cross_section/erxs_H1_simple.i)
(examples/elastic_recoil_cross_section/erxs_C12_spectrum_xs.i)

(examples/elastic_recoil_cross_section/erxs_C12_simple.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = erxs_C_simple_out.csv
    mu_L_output_filename = erxs_C_simple_mu_L_out.csv
    atomic_mass = 12
    legendre_order = 7
    neutron_energy_limits = '1e7 1e6 1e5 1e4 1e3 1e2 1e1 1e0'
    recoil_energy_limits = '2097152 1048576 524288 262144 131072 65536 32768 16384 8192 4096 2048 1024 512 256 128 64 32 16 8 4 2 1 0'

    # Functions
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs

    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to Ei
  [scattering_xs]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(tests/userobjects/elastic_recoil/C12.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil
    cross_section_output_filename = C12_out.csv
    mu_L_output_filename = C12_mu_L_out.csv
    atomic_mass = 12
    legendre_order = 4
    neutron_energy_limits = '203240 145000'
    recoil_energy_limits = '1e4 1000 0'
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs
    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1/t'
  []

  # t is equal to Ei
  [scattering_xs]
    type = PiecewiseLinear
    data_file = C12_xs.csv
    xy_in_file_only = false
    format = columns
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5+0.1*t'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(examples/elastic_recoil_cross_section/erxs_C12_spectrum.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = erxs_C_spectrum_out.csv
    mu_L_output_filename = erxs_C_spectrum_mu_L_out.csv
    atomic_mass = 12
    legendre_order = 5
    neutron_energy_limits = '1e7 1e6 1e5 1e4 1e3 1e2 1e1 1e0'
    recoil_energy_limits = '2097152 1048576 524288 262144 131072 65536 32768 16384 8192 4096 2048 1024 512 256 128 64 32 16 8 4 2 1 0'

    # Functions
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs

    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1/t'
  []

  # t is equal to Ei
  [scattering_xs]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(examples/elastic_recoil_cross_section/erxs_H1_spectrum_xs.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = erxs_H_spectrum_xs_out.csv
    mu_L_output_filename = erxs_H_spectrum_xs_mu_L_out.csv
    atomic_mass = 1
    legendre_order = 7
    # 14 group CASMO lib
    neutron_energy_limits = '10000000  2231000  821000  5530  48.052  4  1.15  0.972  0.625  0.35  0.28  0.14  0.058  0.03  0.00001'
    # 25 group CASMO lib
    recoil_energy_limits = '10000000  6065500  3679000  2231000  1353000  821000  500000  111000  9118  5530  148.728  15.968  9.877
                             4  1.855  1.15  1.097  1.02  0.972  0.625  0.35  0.28  0.14  0.058  0.03  0.00001'
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs
    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1/t'
  []

  # t is equal to Ei
  [scattering_xs]
    type = PiecewiseLinear
    data_file = C12_input.csv
    xy_in_file_only = false
    format = columns
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(examples/elastic_recoil_cross_section/angular_distribution_benchmark.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = angular_distribution_out.csv
    mu_L_output_filename = angular_distribution_mu_L_out.csv
    atomic_mass = 2
    legendre_order = 20
    quadrature_order = 800
    neutron_energy_limits = '1.2 1 0.8'
    recoil_energy_limits = '1 0.95 0.9 0.85 0.8 0.75 0.7 0.65 0.6 0.55
                             0.5 0.45 0.4 0.35 0.3 0.25 0.2 0.15 0.1 0.05 0'

    # Functions
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs

    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to Ei
  [scattering_xs]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(examples/elastic_recoil_cross_section/erxs_H1_spectrum.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = erxs_H_spectrum_out.csv
    mu_L_output_filename = erxs_H_spectrum_mu_L_out.csv
    atomic_mass = 1
    legendre_order = 7
    neutron_energy_limits = '1e7 1e6 1e5 1e4 1e3 1e2 1e1 1e0'
    recoil_energy_limits = '2097152 1048576 524288 262144 131072 65536 32768 16384 8192 4096 2048 1024 512 256 128 64 32 16 8 4 2 1 0'

    # Functions
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs

    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1/t'
  []

  # t is equal to Ei
  [scattering_xs]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(tests/userobjects/elastic_recoil/erxs_analytical.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil
    cross_section_output_filename = erxs_analytical_out.csv
    mu_L_output_filename = erxs_analytical_mu_L_out.csv
    atomic_mass = 12
    legendre_order = 2
    neutron_energy_limits = '2 1'
    recoil_energy_limits = '1.0 0.9 0.8 0.7 0.6 0.5 0.4 0.3'
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs
    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to Ei
  [scattering_xs]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(examples/elastic_recoil_cross_section/erxs_H1_simple.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = erxs_H_simple_out.csv
    mu_L_output_filename = erxs_H_simple_mu_L_out.csv
    atomic_mass = 1
    legendre_order = 7
    neutron_energy_limits = '1e7 1e6 1e5 1e4 1e3 1e2 1e1 1e0'
    recoil_energy_limits = '2097152 1048576 524288 262144 131072 65536 32768 16384 8192 4096 2048 1024 512 256 128 64 32 16 8 4 2 1 0'

    # Functions
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs

    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to Ei
  [scattering_xs]
    type = ParsedFunction
    expression = '1'
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

(examples/elastic_recoil_cross_section/erxs_C12_spectrum_xs.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[UserObjects]
  [XSGenerator]
    type = ElasticRecoil

    # Inputs
    cross_section_output_filename = erxs_C_spectrum_xs_out.csv
    mu_L_output_filename = erxs_C_spectrum_xs_mu_L_out.csv
    atomic_mass = 12
    legendre_order = 7
    # 14 group CASMO lib
    neutron_energy_limits = '10000000  2231000  821000  5530  48.052  4  1.15  0.972  0.625  0.35  0.28  0.14  0.058  0.03  0.00001'
    # 25 group CASMO lib
    recoil_energy_limits = '10000000  6065500  3679000  2231000  1353000  821000  500000  111000  9118  5530  148.728  15.968  9.877
                             4  1.855  1.15  1.097  1.02  0.972  0.625  0.35  0.28  0.14  0.058  0.03  0.00001'
    neutron_spectrum = neutron_spectrum
    scattering_law = scattering_law
    scattering_xs = scattering_xs
    execute_on = timestep_end
  []
[]

# t is equal to Ei
[Functions]
  [neutron_spectrum]
    type = ParsedFunction
    expression = '1/t'
  []

  # t is equal to Ei
  [scattering_xs]
    type = PiecewiseLinear
    data_file = C12_input.csv
    xy_in_file_only = false
    format = columns
  []

  # t is equal to mu_c
  [scattering_law]
    type = ParsedFunction
    expression = '0.5'
  []
[]

[Postprocessors]
  [test]
    type = AverageNodalVariableValue
    variable = test_var
  []
[]

[Executioner]
  type = Steady
[]

Overview
Example Input File Syntax
Input Parameters
Input Files