- burnup_functionThe BurnupFunction name.
C++ Type:BurnupFunctionName
Unit:(no unit assumed)
Controllable:No
Description:The BurnupFunction name.
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
BurnupGrid
Retrieves burnup, fission_rate, concentrations, etc. from the grid used in BurnupFunction. Built by an Action.
This object can be set up automatically by using the Burnup action.
Description
BurnupGrid is a specially designed AuxKernel which interfaces with the BurnupFunction to retrieve the values of burnup, fission rate, and heavy metal isoptope concentrations based on user selections in the input file. BurnupGrid then stores these values into corresponding AuxVariables.
Example Input Syntax
The burnup grid auxkerel is often created by the Burnup action, as shown below:
[Burnup<<<{"href": "../../syntax/Burnup/index.html"}>>>]
[burnup2]
block<<<{"description": "The blocks where radial power factor should be computed."}>>> = 2
base_name<<<{"description": "Base name for the AuxVariables."}>>> = action_block2
rod_ave_lin_pow<<<{"description": "Rod average linear power function."}>>> = power_profile
axial_power_profile<<<{"description": "Axial power peaking function."}>>> = axial_peaking_factors
num_radial<<<{"description": "Number of radial divisions in secondary grid used to compute radial power profile."}>>> = 80
num_axial<<<{"description": "Number of axial divisions in secondary grid used to compute radial power profile."}>>> = 20
a_upper<<<{"description": "The upper axial coordinate of the fuel stack. Required if fuel_pin_geometry is not specified."}>>> = 0.0205
a_lower<<<{"description": "The lower axial coordinate of the fuel stack. Required if fuel_pin_geometry is not specified."}>>> = 0.0105
fuel_inner_radius<<<{"description": "The inner radius of the fuel."}>>> = 0.0
fuel_outer_radius<<<{"description": "The outer radius of the fuel."}>>> = 0.01
fuel_volume_ratio<<<{"description": "Reduction factor for deviation from right circular cylinder fuel. The ratio of actual volume to right circular cylinder volume."}>>> = 1.0
[]
[](test/tests/burnup_action/burnup_with_actions.i)It is also possible to directly use the BurnupGrid in an input file:
[AuxKernels<<<{"href": "../../syntax/AuxKernels/index.html"}>>>]
[BurnupGrid2]
type = BurnupGrid<<<{"description": "Retrieves burnup, fission_rate, concentrations, etc. from the grid used in BurnupFunction. Built by an Action.", "href": "BurnupGrid.html"}>>>
block<<<{"description": "The list of blocks (ids or names) that this object will be applied"}>>> = 2
execute_on<<<{"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."}>>> = 'initial linear'
burnup_function<<<{"description": "The BurnupFunction name."}>>> = burnup2
variable<<<{"description": "The name of the variable that this object applies to"}>>> = fission_rate_2
fission_rate<<<{"description": "The fission_rate aux variable."}>>> = fission_rate_2
[]
[](test/tests/burnup_action/burnup_without_actions.i)where an AuxVariable must also be created for all of the stored values selected in the BurnupGrid block. In this case, only fission_rate_2 is selected; the corresponding AuxVariable is defined as
[AuxVariables<<<{"href": "../../syntax/AuxVariables/index.html"}>>>]
[fission_rate_2]
block = 2
[]
[](test/tests/burnup_action/burnup_without_actions.i)Input Parameters
- N155Specifies that the concentration of 155 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 155 is required.
- N157Specifies that the concentration of 157 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 157 is required.
- N235Specifies that the concentration of 235 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 235 is required.
- N236Specifies that the concentration of 236 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 236 is required.
- N238Specifies that the concentration of 238 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 238 is required.
- N239Specifies that the concentration of 239 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 239 is required.
- N240Specifies that the concentration of 240 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 240 is required.
- N241Specifies that the concentration of 241 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 241 is required.
- N242Specifies that the concentration of 242 is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the concentration of 242 is required.
- RPFSpecifies that the radial power factor is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the radial power factor is required.
- average_burnupSpecifies that the radial average burnup is required.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Specifies that the radial average burnup is required.
- 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
- burnupThe burnup aux variable.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The burnup aux variable.
- 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
- energy_per_fission3.28451e-11Energy released per fission.
Default:3.28451e-11
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Energy released per fission.
- execute_onLINEAR TIMESTEP_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:LINEAR 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.
- fission_rateThe fission_rate aux variable.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The fission_rate aux variable.
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
- 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.