- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Controllable:No
Description:The name of the variable that this object applies to
- volume_typeWhich notion of cell volume to display. For 'mapped', this shows only the volume of the MOOSE elements which map to each cell (this is mostly for testing). For 'actual', this will map to the [Mesh] the actual volumes of OpenMC cells obtained from a stochastic calculation
C++ Type:MooseEnum
Controllable:No
Description:Which notion of cell volume to display. For 'mapped', this shows only the volume of the MOOSE elements which map to each cell (this is mostly for testing). For 'actual', this will map to the [Mesh] the actual volumes of OpenMC cells obtained from a stochastic calculation
CellVolumeAux
Display the OpenMC cell volumes mapped to MOOSE
Description
Displays the OpenMC cell mapped volumes (mesh units) on the mesh mirror. This auxkernel has two options:
volume_type = mappedwill display the magnitude of the mesh element volumes that each OpenMC cell maps to. So, if you have an sphere OpenMC cell with a volume of 1.0 that maps to a set of MOOSE mesh elements with a total volume of 0.95, this option will display 0.95 mapped to the[Mesh].volume_type = actualwill display the actual OpenMC cell volumes, computed from a stochastic volume calculation. Using the same sphere example, this will then display the stochastic estimate of OpenMC's cell volume, which would be something like 0.98 +/- 0.0021 (with the magnitude of the standard deviation determined by the number of samples taken in the stochastic volume calculation). With theactualoption, this auxkernel would display 0.98 mapped to the[Mesh].
If a MOOSE element did not map at all to an OpenMC cell, then this auxiliary kernel returns .
Example Input Syntax
As an example, the cell_volume auxiliary kernel will extract the mapped OpenMC cell volume and display it on the MOOSE elements corresponding to each OpenMC cell.
[AuxKernels]
[cell_volume]
type = CellVolumeAux
variable = cell_volume
volume_type = mapped
[]
[]
Input 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
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
- 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
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.
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:Yes
Description:Set the enabled status of the MooseObject.
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
- 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
Input Files
- (test/tests/neutronics/heat_source/cell_volumes.i)
- (test/tests/userobjects/volume_calculation/no_vol.i)
- (test/tests/neutronics/tally_system/multi_cell.i)
- (test/tests/userobjects/volume_calculation/openmc.i)
- (test/tests/userobjects/volume_calculation/instances/openmc.i)
- (test/tests/userobjects/volume_calculation/scaling.i)
- (test/tests/userobjects/volume_calculation/user_bb.i)