StatRelErrorIndicator

Description

The StatRelErrorIndicator provides the relative error associated with the tally score to the indicator system for use in adaptivity. A tally score must be specified, and if any external filter bins have been added through the use of the filter system ext_filter_bin index should be provided. Additionally, the tally scoring score must be outputting the relative error of the tally. This can be done by specifying output = unrelaxed_tally_rel_error in the tally object you wish to use for adaptivity.

Example Input File Syntax

[Adaptivity<<<{"href": "../../syntax/Adaptivity/index.html"}>>>]
  [Indicators<<<{"href": "../../syntax/Adaptivity/Indicators/index.html"}>>>]
    [stat_err]
      type = StatRelErrorIndicator<<<{"description": "An Indicator which reports the maximum relative error of all bins associated with a tally variable.", "href": "StatRelErrorIndicator.html"}>>>
      score<<<{"description": "The tally score used for the relative error."}>>> = 'kappa_fission'
    []
  []
[]
(cardinal/test/tests/neutronics/indicators/rel_err/openmc.i)

Input Parameters

  • scoreThe tally score used for the relative error.

    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 tally score used for the relative error.

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

  • ext_filter_bin0The filter bin for the case where any filters are added to this tally with [Filters] (bin indices start at 0). This parameter should be specified if you wish to extract the relative error of a different non-spatial tally bin.

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The filter bin for the case where any filters are added to this tally with [Filters] (bin indices start at 0). This parameter should be specified if you wish to extract the relative error of a different non-spatial tally bin.

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