ElementOpticalDepthIndicator

Description

ElementOpticalDepthIndicator computes an estimate of the per-element optical depth using a reaction rate and a score from a tally in the tallies block. The estimated optical depth is computed as:

(1)

where is the estimated optical depth from reaction , is the reaction rate (rxn_rate), is the scalar flux, and is an estimate of the chord length through the element traversed by neutrons/photons. There are three options for which can be set in h_type: the maximum vertex separation in an element (max), the minimum vertex separation in an element (min), and the cube root of the element volume (cube_root).

Example Input File Syntax

The listing below shows sample usage of the ElementOpticalDepthIndicator to compute per-element optical depths for different h_types.

[Adaptivity<<<{"href": "../../syntax/Adaptivity/index.html"}>>>]
  [Indicators<<<{"href": "../../syntax/Adaptivity/Indicators/index.html"}>>>]
    [optical_depth_hmin]
      type = ElementOpticalDepthIndicator<<<{"description": "A class which returns the estimate of a given element's optical depth under the assumption that elements with a large optical depth experience large solution gradients.", "href": "ElementOpticalDepthIndicator.html"}>>>
      rxn_rate<<<{"description": "The reaction rate to use for computing the optical depth."}>>> = 'total'
      h_type<<<{"description": "The estimate for the length of the element used to compute the optical depth. Options are the minimum vertex separation (min), the maximum vertex separation (max), and the cube root of the element volume (cube_root)."}>>> = 'min'
    []
    [optical_depth_hmax]
      type = ElementOpticalDepthIndicator<<<{"description": "A class which returns the estimate of a given element's optical depth under the assumption that elements with a large optical depth experience large solution gradients.", "href": "ElementOpticalDepthIndicator.html"}>>>
      rxn_rate<<<{"description": "The reaction rate to use for computing the optical depth."}>>> = 'total'
      h_type<<<{"description": "The estimate for the length of the element used to compute the optical depth. Options are the minimum vertex separation (min), the maximum vertex separation (max), and the cube root of the element volume (cube_root)."}>>> = 'max'
    []
    [optical_depth_cuberoot]
      type = ElementOpticalDepthIndicator<<<{"description": "A class which returns the estimate of a given element's optical depth under the assumption that elements with a large optical depth experience large solution gradients.", "href": "ElementOpticalDepthIndicator.html"}>>>
      rxn_rate<<<{"description": "The reaction rate to use for computing the optical depth."}>>> = 'total'
      h_type<<<{"description": "The estimate for the length of the element used to compute the optical depth. Options are the minimum vertex separation (min), the maximum vertex separation (max), and the cube root of the element volume (cube_root)."}>>> = 'cube_root'
    []
  []
[]
(cardinal/test/tests/neutronics/indicators/od/openmc.i)

Input Parameters

  • rxn_rateThe reaction rate to use for computing the optical depth.

    C++ Type:MooseEnum

    Options:heating, heating_local, kappa_fission, fission_q_prompt, fission_q_recoverable, damage_energy, flux, H3_production, total, absorption, scatter, nu_scatter, fission, nu_fission, inverse_velocity

    Controllable:No

    Description:The reaction rate to use for computing the optical depth.

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

  • h_typemaxThe estimate for the length of the element used to compute the optical depth. Options are the minimum vertex separation (min), the maximum vertex separation (max), and the cube root of the element volume (cube_root).

    Default:max

    C++ Type:MooseEnum

    Options:min, max, cube_root

    Controllable:No

    Description:The estimate for the length of the element used to compute the optical depth. Options are the minimum vertex separation (min), the maximum vertex separation (max), and the cube root of the element volume (cube_root).

  • invertFalseWhether the optical depth is computed as the optical depth (false) or the inverse of the optical depth (true).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether the optical depth is computed as the optical depth (false) or the inverse of the optical depth (true).

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

    Description:Set the enabled status of the MooseObject.

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    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

  • 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