- n_samplesNumber of samples to use for the stochastic volume calculation
C++ Type:unsigned int
Controllable:No
Description:Number of samples to use for the stochastic volume calculation
OpenMCVolumeCalculation
Stochastic volume calculation of the OpenMC cells which map to MOOSE
Description
This user object can be combined with OpenMCCellAverageProblem to compute the volumes of all OpenMC cells which map to the [Mesh] using a stochastic volume calculation.
warningwarning
OpenMC does not yet have the ability to individually estimate volumes of cell _instances_. OpenMC can only stochastically estimates volumes for all instances of a given cell ID at once. So, if your problem has repeated cells, we approximate the volume of each cell instance as the volume across _all_ instances, divided by the number of instances. For most geometries, this is correct - but if your geometry has any cell instances which don't "make it fully into the geometry" (e.g. if they are clipped in some way), this calculation will yield inaccurate volumes.
Example Input Syntax
Below is an example which will calculate the volumes of all OpenMC cells which map to MOOSE.
[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
type = OpenMCCellAverageProblem
power = 100.0
temperature_blocks = '100 200'
density_blocks = '200'
verbose = true
cell_level = 0
initial_properties = xml
volume_calculation = vol
[Tallies<<<{"href": "../../syntax/Problem/Tallies/index.html"}>>>]
[Cell]
type = CellTally<<<{"description": "A class which implements distributed cell tallies.", "href": "../tallies/CellTally.html"}>>>
block<<<{"description": "Subdomains for which to add tallies in OpenMC. If not provided, cell tallies will be applied over the entire mesh."}>>> = '100 200'
name<<<{"description": "Auxiliary variable name(s) to use for OpenMC tallies. If not specified, defaults to the names of the scores"}>>> = heat_source
[]
[]
[]
[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
[vol]
type = OpenMCVolumeCalculation<<<{"description": "Stochastic volume calculation of the OpenMC cells which map to MOOSE", "href": "OpenMCVolumeCalculation.html"}>>>
n_samples<<<{"description": "Number of samples to use for the stochastic volume calculation"}>>> = 10000
[]
[]Input Parameters
- lower_leftLower left of the bounding box inside of which to compute volumes. If not specified, this will default to the lower left of the [Mesh] (which will NOT capture any OpenMC geometry that lies outside the [Mesh] extents.
C++ Type:libMesh::Point
Controllable:No
Description:Lower left of the bounding box inside of which to compute volumes. If not specified, this will default to the lower left of the [Mesh] (which will NOT capture any OpenMC geometry that lies outside the [Mesh] extents.
- triggernoneType of trigger to apply to decide when to terminate the volume calculation
Default:none
C++ Type:MooseEnum
Controllable:No
Description:Type of trigger to apply to decide when to terminate the volume calculation
- trigger_thresholdTrigger threshold to decide when to terminate the volume calculation
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Trigger threshold to decide when to terminate the volume calculation
- upper_rightUpper right of the bounding box inside of which to compute volumes. If not specified, this will default to the upper right of the [Mesh] (which will NOT capture any OpenMC geometry that lies outside the [Mesh] extents.
C++ Type:libMesh::Point
Controllable:No
Description:Upper right of the bounding box inside of which to compute volumes. If not specified, this will default to the upper right of the [Mesh] (which will NOT capture any OpenMC geometry that lies outside the [Mesh] extents.
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).
- 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
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.
- 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.