- filter_idsThe filter IDs to apply in the tally
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:Yes
Description:The filter IDs to apply in the tally
- nuclidesThe nuclides to apply in the tally
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:Yes
Description:The nuclides to apply in the tally
- scoresThe scores to apply in the tally
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:Yes
Description:The scores to apply in the tally
- tally_idThe ID of the tally to modify
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:The ID of the tally to modify
OpenMCTallyEditor
A UserObject for creating and managing OpenMC tallies
Description
This user object can be used to change the nuclides, filters, and scores on a given OpenMC tally. This object is primarily used for facilitating depletion coupling of OpenMC to MOOSE, where new tallies need to be registered with controllable parameters to account for changing compositions during depletion.
Example Input Syntax
Below is an example which will create an OpenMC tally with controllable parameters to obtain an absorption rate from only U-238, ignoring the all other nuclides in the problem.
[UserObjects]
[tally_scatter]
type = OpenMCTallyEditor
create_tally = true
tally_id = 100
scores = 'absorption'
filter_ids = ''
nuclides = 'U238'
[]
[]
Input Parameters
- create_tallyFalseWhether to create the tally if it doesn't exist
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to create the tally if it doesn't exist
- 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
Unit:(no unit assumed)
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.
- multiply_densityTrueWhether to multiply the tally by the current material's atom density
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:Yes
Description:Whether to multiply the tally by the current material's atom density
- 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
- 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
Unit:(no unit assumed)
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).
- 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.
- 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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- 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/userobjects/openmc_tally_editor/tally_param_checks.i)
- (test/tests/userobjects/openmc_tally_editor/u235_absorption.i)
- (test/tests/userobjects/openmc_tally_editor/add_filter.i)
- (test/tests/userobjects/openmc_tally_editor/nuclide_absorption.i)
- (test/tests/userobjects/openmc_tally_editor/clashing_tally_ids.i)
- (test/tests/userobjects/openmc_tally_editor/u235_scatter.i)
- (test/tests/userobjects/openmc_tally_editor/clash_mapped_tally.i)
- (test/tests/userobjects/openmc_tally_editor/scatter.i)