FunctionDPAUserObject

This userobject computes the displacement per atoms caused by neutron irradiation for displacement functions $var element = document.getElementById("moose-equation-0d7a90dc-bb42-4217-9dce-1d5a16cfab44");katex.render("\\nu_{i,j}(T)", element, {displayMode:false,throwOnError:false});$ provided by functions. In these MOOSE functions the time argument is reinterpreted as the energy ( $var element = document.getElementById("moose-equation-bea8d9b5-c9a8-42f9-b30c-2b7bc0738c46");katex.render("T", element, {displayMode:false,throwOnError:false});$ ) slot. Background information can be found here.

Example Input File Syntax

#
# Constant spectrum (one everywhere between 0 and 1e-6), constant cross section (one)
# K-P model, C-12 atoms, Ed = 30 eV
#
# correct answer 1.183 x 10^9
# computed: 1.183432e+09
#
Ed = 30

[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
  type = GeneratedMesh
  dim = 1
  xmin = 0
  xmax = 1
  nx = 2
[]

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables<<<{"href": "../../syntax/Variables/index.html"}>>>]
  [test_var]
  []
[]

[Functions<<<{"href": "../../syntax/Functions/index.html"}>>>]
  [KP]
    type = ParsedFunction<<<{"description": "Function created by parsing a string", "href": "../functions/MooseParsedFunction.html"}>>>
    expression<<<{"description": "The user defined function."}>>> = 't / 2 / ${Ed}'
  []
[]

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [KPtest]
    type = FunctionDPAUserObject<<<{"description": "Computes the dose in dpa from composition, cross section, damage type, and neutron flux. The damage functions are provided as MOOSE functions where energy is provided via the time arg slot.", "href": "FunctionDPAUserObject.html"}>>>
    damage_reaction_types<<<{"description": "The neutron reaction causing radiation damage"}>>> = 'elastic'
    damage_functions<<<{"description": "Damage functions for each combinations of projectiles and targets."}>>> = 'KP'
    irradiation_time<<<{"description": "Irradiation time used "}>>> = 1
    Z<<<{"description": "The atomic numbers of all present isotopes"}>>> = '6'
    A<<<{"description": "The mass numbers of all present isotopes"}>>> = '12'
    number_densities<<<{"description": "The number densities of all present isotopes"}>>> = '1'

    scalar_flux<<<{"description": "The values of the neutron scalar flux by energy group starting with the highest energy group"}>>> = '1e6'
    energy_group_boundaries<<<{"description": "The neutron flux energy group boundaries in units of eV starting with the highest energy group"}>>> = '1e6 0'
    cross_section<<<{"description": "The values of the cross sections. Each semicolon separated vector contains cross sections for a particular nuclide and reaction type. Each entry must be number of energy groups entries long. One vector must be provided for each nuclide/reaction type combination. The ordering is as follows: if there are reaction typesa and b, and nuclides i, k, and l, the ordering will be xs_ai; xs_ak; xs_al; xs_bi; xs_bk, xs_bl"}>>> = '1'
  []
[]

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [dpa]
    type = DPAPostprocessor<<<{"description": "Retrieves the value of the dpa from a DPAUserObjectBase.", "href": "../postprocessors/DPAPostprocessor.html"}>>>
    dpa_object<<<{"description": "The neutronics damage object."}>>> = KPtest
  []
[]

[Executioner<<<{"href": "../../syntax/Executioner/index.html"}>>>]
  type = Steady
[]

[Outputs<<<{"href": "../../syntax/Outputs/index.html"}>>>]
  csv<<<{"description": "Output the scalar variable and postprocessors to a *.csv file using the default CSV output."}>>> = true
[]

Computes the dose in dpa from composition, cross section, damage type, and neutron flux. The damage functions are provided as MOOSE functions where energy is provided via the time arg slot.

Input Parameters

damage_functionsDamage functions for each combinations of projectiles and targets.
C++ Type:std::vector<std::vector<FunctionName>>
Unit:(no unit assumed)
Controllable:No
Description:Damage functions for each combinations of projectiles and targets.

Required Parameters

AThe mass numbers of all present isotopes
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The mass numbers of all present isotopes
QThe Q values by reaction type and then isotope. Assumed zero if not provided.
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:The Q values by reaction type and then isotope. Assumed zero if not provided.
ZThe atomic numbers of all present isotopes
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The atomic numbers of all present isotopes
cross_sectionThe values of the cross sections. Each semicolon separated vector contains cross sections for a particular nuclide and reaction type. Each entry must be number of energy groups entries long. One vector must be provided for each nuclide/reaction type combination. The ordering is as follows: if there are reaction typesa and b, and nuclides i, k, and l, the ordering will be xs_ai; xs_ak; xs_al; xs_bi; xs_bk, xs_bl
C++ Type:std::vector<std::vector<double>>
Unit:(no unit assumed)
Controllable:No
Description:The values of the cross sections. Each semicolon separated vector contains cross sections for a particular nuclide and reaction type. Each entry must be number of energy groups entries long. One vector must be provided for each nuclide/reaction type combination. The ordering is as follows: if there are reaction typesa and b, and nuclides i, k, and l, the ordering will be xs_ai; xs_ak; xs_al; xs_bi; xs_bk, xs_bl
damage_reaction_typesThe neutron reaction causing radiation damage
C++ Type:MultiMooseEnum
Options:elastic, inelastic
Controllable:No
Description:The neutron reaction causing radiation damage
energy_group_boundariesThe neutron flux energy group boundaries in units of eV starting with the highest energy group
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The neutron flux energy group boundaries in units of eV starting with the highest energy group
irradiation_timeIrradiation time used
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Irradiation time used
max_energy_step_size100The maximum energy step size used for integration and interpolation. Default is 100 eV.
Default:100
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The maximum energy step size used for integration and interpolation. Default is 100 eV.
number_densitiesThe number densities of all present isotopes
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The number densities of all present isotopes
scalar_fluxThe values of the neutron scalar flux by energy group starting with the highest energy group
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The values of the neutron scalar flux by energy group starting with the highest energy group

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

(tests/userobjects/dpa/verification_2.i)
(tests/userobjects/dpa/huang_ghoniem_92.i)
(tests/userobjects/dpa/verification_1.i)

References

No citations exist within this document.

(tests/userobjects/dpa/verification_1.i)

#
# Constant spectrum (one everywhere between 0 and 1e-6), constant cross section (one)
# K-P model, C-12 atoms, Ed = 30 eV
#
# correct answer 1.183 x 10^9
# computed: 1.183432e+09
#
Ed = 30

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

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[Functions]
  [KP]
    type = ParsedFunction
    expression = 't / 2 / ${Ed}'
  []
[]

[UserObjects]
  [KPtest]
    type = FunctionDPAUserObject
    damage_reaction_types = 'elastic'
    damage_functions = 'KP'
    irradiation_time = 1
    Z = '6'
    A = '12'
    number_densities = '1'

    scalar_flux = '1e6'
    energy_group_boundaries = '1e6 0'
    cross_section = '1'
  []
[]

[Postprocessors]
  [dpa]
    type = DPAPostprocessor
    dpa_object = KPtest
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

(tests/userobjects/dpa/verification_2.i)

#
# 1 / E spectrum, sigma(E) = 1 / (1 + sqrt(E))
# K-P model, C-12 atoms, Ed = 30 eV, Emin = 1e-5, Emax = 1e6 eV
#
# correct answer: 4.701
# answer ng = 63: 4.76
#        ng = 25; 4.93
#        ng = 7 ; 8.17
#
#  ng   error   order
#   7   3.469
#  25   0.23    2.13
#  63   0.06    1.45
#
Ed = 30

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

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[Functions]
  [KP]
    type = ParsedFunction
    expression = 't / 2 / ${Ed}'
  []
[]

[UserObjects]
  [KPtest]
    type = FunctionDPAUserObject
    damage_reaction_types = 'elastic'
    damage_functions = 'KP'
    irradiation_time = 1
    Z = '6'
    A = '12'
    number_densities = '1'
    scalar_flux = '2.30258509  2.30258509  2.30258509  2.30258509  2.30258509  2.30258509 11.51292546'
    ## more refined scalar fluxes:
    #value = ' 0.22314355  0.47000363  0.22314355  0.47000363  0.91629073  0.22314355
    #          0.47000363  0.22314355  0.47000363  0.91629073  0.22314355  0.47000363
    #          0.22314355  0.47000363  0.91629073  0.69314718  1.60943791  0.22314355
    #          0.47000363  1.60943791  0.69314718  1.60943791  0.69314718  0.69314718
    #         10.1266311'
    #value = '1.00503359e-02 1.52674721e-02 2.59754864e-02 2.66682471e-02
    #         2.73989742e-02 2.81708770e-02 2.89875369e-02 2.98529631e-02
    #         3.07716587e-02 3.17486983e-02 3.27898228e-02 3.39015517e-02
    #         3.50913198e-02 3.63676442e-02 3.77403280e-02 3.92207132e-02
    #         4.08219945e-02 8.70113770e-02 9.53101798e-02 5.12932944e-02
    #         5.40672213e-02 5.71584138e-02 6.06246218e-02 6.45385211e-02
    #         6.89928715e-02 7.41079722e-02 8.00427077e-02 8.70113770e-02
    #         9.53101798e-02 1.05360516e-01 1.17783036e-01 1.33531393e-01
    #         1.54150680e-01 1.82321557e-01 2.23143551e-01 1.05360516e-01
    #         1.17783036e-01 1.33531393e-01 1.54150680e-01 1.82321557e-01
    #         2.23143551e-01 2.87682072e-01 4.05465108e-01 6.93147181e-01
    #         1.05360516e-01 1.17783036e-01 1.33531393e-01 1.54150680e-01
    #         1.82321557e-01 2.23143551e-01 2.87682072e-01 4.05465108e-01
    #         6.93147181e-01 6.93147181e-01 1.60943791e+00 2.23143551e-01
    #         4.70003629e-01 1.60943791e+00 6.93147181e-01 1.60943791e+00
    #         6.93147181e-01 6.93147181e-01 1.01266311e+01'

    energy_group_boundaries = '1.e+06 1.e+05 1.e+04 1.e+03 1.e+02 1.e+01 1.e+00 1.e-05'
    ## more refined energy group boundaries
    #value = '1.0e+06 8.0e+05 5.0e+05 4.0e+05 2.5e+05 1.0e+05 8.0e+04 5.0e+04 4.0e+04
    #         2.5e+04 1.0e+04 8.0e+03 5.0e+03 4.0e+03 2.5e+03 1.0e+03 5.0e+02 1.0e+02
    #         8.0e+01 5.0e+01 1.0e+01 5.0e+00 1.0e+00 5.0e-01 2.5e-01 1.0e-05'
    #value = '1.00e+06 9.90e+05 9.75e+05 9.50e+05 9.25e+05 9.00e+05 8.75e+05 8.50e+05
    #         8.25e+05 8.00e+05 7.75e+05 7.50e+05 7.25e+05 7.00e+05 6.75e+05 6.50e+05
    #         6.25e+05 6.00e+05 5.50e+05 5.00e+05 4.75e+05 4.50e+05 4.25e+05 4.00e+05
    #         3.75e+05 3.50e+05 3.25e+05 3.00e+05 2.75e+05 2.50e+05 2.25e+05 2.00e+05
    #         1.75e+05 1.50e+05 1.25e+05 1.00e+05 9.00e+04 8.00e+04 7.00e+04 6.00e+04
    #         5.00e+04 4.00e+04 3.00e+04 2.00e+04 1.00e+04 9.00e+03 8.00e+03 7.00e+03
    #         6.00e+03 5.00e+03 4.00e+03 3.00e+03 2.00e+03 1.00e+03 5.00e+02 1.00e+02
    #         8.00e+01 5.00e+01 1.00e+01 5.00e+00 1.00e+00 5.00e-01 2.50e-01 1.00e-05'

    cross_section = '0.00187423 0.00590036 0.0183991  0.05574353 0.15587673 0.3633979 0.88013648'
    ## more refined cross sections
    #value = '0.0010568  0.00125874 0.00149389 0.00177919 0.00253039 0.00333427
    #         0.00396962 0.00470886 0.00560463 0.0079575  0.01046834 0.01244572
    #         0.01474048 0.01751023 0.02473112 0.03640536 0.06407202 0.09566219
    #         0.11187534 0.17707499 0.27373741 0.40201256 0.54310661 0.6268184
    #         0.92054459'
    #value = '0.00100151 0.00100787 0.00101831 0.00103178 0.00104581 0.00106043
    #         0.00107567 0.00109159 0.00110825 0.00112569 0.00114398 0.00116319
    #         0.0011834  0.00120471 0.00122721 0.00125102 0.00127628 0.00131775
    #         0.00137914 0.00143046 0.00146858 0.00150993 0.00155499 0.00160435
    #         0.00165873 0.00171905 0.00178649 0.00186256 0.00194929 0.00204941
    #         0.00216679 0.00230707 0.00247883 0.00269604 0.00298331 0.00323654
    #         0.00342169 0.00364291 0.00391373 0.00425614 0.00470886 0.00534867
    #         0.00635954 0.00837959 0.0101637  0.01074084 0.01142982 0.01227241
    #         0.0133363  0.01474048 0.01672028 0.01983693 0.02602255 0.03640536
    #         0.06407202 0.09566219 0.11187534 0.17707499 0.27373741 0.40201256
    #         0.54310661 0.6268184  0.92054459'
  []
[]

[Postprocessors]
  [dpa]
    type = DPAPostprocessor
    dpa_object = KPtest
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

(tests/userobjects/dpa/huang_ghoniem_92.i)

#
# This test follows the Huang & Ghoniem "Neutron displacement damage cross sections for SiC"
# J. of Nucl. Mat. 199, (1993), 221-230
#
[Mesh]
 type = GeneratedMesh
 dim = 1
 xmin = 0
 xmax = 1
 nx = 2
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [./test_var]
  [../]
[]

[Functions]
  [./HG_SiSi]
    type = PiecewiseLinear
    data_file = 'HG_SiSi.csv'
    format = columns
  [../]

  [./HG_SiC]
    type = PiecewiseLinear
    data_file = 'HG_SiC.csv'
    format = columns
  [../]

  [./HG_CSi]
    type = PiecewiseLinear
    data_file = 'HG_CSi.csv'
    format = columns
  [../]

  [./HG_CC]
    type = PiecewiseLinear
    data_file = 'HG_CC.csv'
    format = columns
  [../]
[]

[UserObjects]
  [./parkin_coulter]
     type = ParkinCoulterDPAUserObject
     damage_reaction_types = 'elastic inelastic'
     irradiation_time = 1

     Z = '6 14'
     A = '12 28'
     number_densities = '0.5 0.5'
     scalar_flux = '0.048138819 0.16809268 0.142519665 0.122144812 0.104682829
                    0.08971709 0.04904444 0.04213553 0.233524136'
     energy_group_boundaries = '3.455e6 1e6 1e5 1e4 1e3 1e2 10.0 2.4 0.625 1e-5'
     cross_section = '2.136 3.7 4.622 4.737 4.748 4.75 4.75 4.757 13.198;
                      2.938 4.205 1.980 1.918 1.952 1.956 1.957 1.959 4.034;
                      0     0     0     0     0     0     0     0     0;
                      0.10848 0   0     0     0     0     0     0     0'
     Q = '0 0; 0 -1.779e+6'

     displacement_thresholds = '16.3 92.6'
     logarithmic_energy_spacing = 1.25
  [../]

  [./huang_ghoniem_CSV]
     type = FunctionDPAUserObject
     damage_reaction_types = 'elastic inelastic'
     damage_functions = 'HG_CC HG_CSi; HG_SiC HG_SiSi'
     irradiation_time = 1

     Z = '6 14'
     A = '12 28'
     number_densities = '0.5 0.5'
     scalar_flux = '0.048138819 0.16809268 0.142519665 0.122144812 0.104682829
                    0.08971709 0.04904444 0.04213553 0.233524136'
     energy_group_boundaries = '3.455e6 1e6 1e5 1e4 1e3 1e2 10.0 2.4 0.625 1e-5'
     cross_section = '2.136 3.7 4.622 4.737 4.748 4.75 4.75 4.757 13.198;
                      2.938 4.205 1.980 1.918 1.952 1.956 1.957 1.959 4.034;
                      0     0     0     0     0     0     0     0     0;
                      0.10848 0   0     0     0     0     0     0     0'
     Q = '0 0; 0 -1.779e+6'
  [../]
[]

[Postprocessors]
  [./dpa_from_function]
    type = DPAPostprocessor
    dpa_object = huang_ghoniem_CSV
  [../]

  [./dpa_from_parkin_coulter]
    type = DPAPostprocessor
    dpa_object = parkin_coulter
  [../]
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

(tests/userobjects/dpa/verification_1.i)

#
# Constant spectrum (one everywhere between 0 and 1e-6), constant cross section (one)
# K-P model, C-12 atoms, Ed = 30 eV
#
# correct answer 1.183 x 10^9
# computed: 1.183432e+09
#
Ed = 30

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

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Variables]
  [test_var]
  []
[]

[Functions]
  [KP]
    type = ParsedFunction
    expression = 't / 2 / ${Ed}'
  []
[]

[UserObjects]
  [KPtest]
    type = FunctionDPAUserObject
    damage_reaction_types = 'elastic'
    damage_functions = 'KP'
    irradiation_time = 1
    Z = '6'
    A = '12'
    number_densities = '1'

    scalar_flux = '1e6'
    energy_group_boundaries = '1e6 0'
    cross_section = '1'
  []
[]

[Postprocessors]
  [dpa]
    type = DPAPostprocessor
    dpa_object = KPtest
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
[]

Example Input File Syntax
Input Parameters
Input Files
References