- burnup_functionBurnup function
C++ Type:BurnupFunctionName
Unit:(no unit assumed)
Controllable:No
Description:Burnup function
- heightHeight at which to compute the radial profile.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Height at which to compute the radial profile.
- quantityOne or more quantities to report: N155 N157 N235 N236 N238 N239 N240 N241 N242 fission_rate RPF burnup ntot_hmNOTE: ntot_hm is required.
C++ Type:MultiMooseEnum
Controllable:No
Description:One or more quantities to report: N155 N157 N235 N236 N238 N239 N240 N241 N242 fission_rate RPF burnup ntot_hmNOTE: ntot_hm is required.
- sort_byWhat to sort the samples by
C++ Type:MooseEnum
Controllable:No
Description:What to sort the samples by
- variableThe names of the variables that this VectorPostprocessor operates on
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The names of the variables that this VectorPostprocessor operates on
RadialProfile
Reports spatially-varying information computed by BurnupFunction on the displaced mesh.
Description
Radial Profile reports radially-varying quantities as computed by BurnupFunction. For a given height, this VectorPostprocessor expects a list of quantities to report. These quantities are N235, N236, N238, N239, N239, N240, N241, N242, fission_rate, RPF, and burnup, which are U, U, Pu, Pu, Pu, Pu, Pu, the fission rate, the radial power factor, and the burnup, respectively.
This VectorPostprocessor is different than the similar named RadialProfile in that the samples displayed are recalculated from the stationary grid used in the BurnupFunction and displayed on the displaced mesh which would occur due to the physical expansion of the fuel due to burnup. The differences are highlighted in the example shown below. ## Example Input Syntax
[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
[Concentrations_on_displaced_mesh]
type = RadialProfileSampler<<<{"description": "Reports spatially-varying information computed by BurnupFunction on the displaced mesh.", "href": "RadialProfileSampler.html"}>>>
variable<<<{"description": "The names of the variables that this VectorPostprocessor operates on"}>>> = 'disp_x'
sort_by<<<{"description": "What to sort the samples by"}>>> = 'id'
burnup_function<<<{"description": "Burnup function"}>>> = burnup
quantity<<<{"description": "One or more quantities to report: N155 N157 N235 N236 N238 N239 N240 N241 N242 fission_rate RPF burnup ntot_hmNOTE: ntot_hm is required."}>>> = 'N235 N236 N238 N239 N240 N241 N242 ntot_hm'
height<<<{"description": "Height at which to compute the radial profile."}>>> = 0.46324
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."}>>> = timestep_end
outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'ConcentrationsDisplaced'
[]
[](examples/Burnup_profile_displaced_mesh/RadialProfileSampler.i)Input Parameters
- _auto_broadcastFalse
Default:False
C++ Type:bool
Controllable:No
- contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
Default:False
C++ Type:bool
Controllable:No
Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
- fuel_typeUO2Fuel type. Choices are UO2 U3Si2
Default:UO2
C++ Type:MooseEnum
Controllable:No
Description:Fuel type. Choices are UO2 U3Si2
- parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
Default:REPLICATED
C++ Type:MooseEnum
Controllable:No
Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
- scaling1The postprocessor that the variables are multiplied with
Default:1
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The postprocessor that the variables are multiplied with
- warn_discontinuous_face_valuesTrueWhether to return a warning if a discontinuous variable is sampled on a face
Default:True
C++ Type:bool
Controllable:No
Description:Whether to return a warning if a discontinuous variable is sampled on a face
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.
- 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.