- bundle_pitchBundle pitch, or flat-to-flat distance across bundle
C++ Type:double
Controllable:No
Description:Bundle pitch, or flat-to-flat distance across bundle
- n_ringsNumber of pin rings, including the centermost pin as a 'ring'
C++ Type:unsigned int
Controllable:No
Description:Number of pin rings, including the centermost pin as a 'ring'
- pin_diameterPin outer diameter
C++ Type:double
Controllable:No
Description:Pin outer diameter
- pin_pitchPin pitch, or distance between pin centers
C++ Type:double
Controllable:No
Description:Pin pitch, or distance between pin centers
HexagonalSubchannelBin
Creates a unique spatial bin for each subchannel in a hexagonal lattice
Description
This user object bins the spatial domain according to a unique index for each channel in a subchannel discretization of an array of pins in a triangular lattice enclosed by a hexagonal prism. Subchannels are numbered first for the interior channels, followed by the edge channels, and concluded with the corner channels. Numbering moves in a counterclockwise direction.
Alternatively, if you set pin_centered_bins to true, then the bins are centered on the pins (as opposed to a channel-based discretization). This will create one hexagonal prism around each pin, with a single bin area forming any remaining area of the bundle (i.e. between the outer ring of pins and the duct). The bins are numbered first by ring and then in a counterclockwise direction.
When using pin_centered_bins = false, this user object can be paired with integrals/averages over subchannels. When using pin_centered_bins = true, this user object can be paired with side integrals/averages to compute quantities on the pin surfaces.
Example Input Syntax
Below is an example input file that computes channel indices (bins) for a subchannel discretization.
[UserObjects]
[subchannel_bins]
type = HexagonalSubchannelBin
bundle_pitch = ${bundle_pitch}
pin_pitch = 0.0089656996
pin_diameter = 7.646e-3
n_rings = 3
[]
[]
The value of the userobject is shown below; numbers superimposed over each channel are the channel indices for this 19-pin geometry.
Figure 1: Subchannel bin indices for a 19-pin hexagonal geometry
Below is a second example that sets pin_centered_bins to true, which instead defines bins as hexagons centered on the pins.
bundle_pitch = 4.0
pin_pitch = 0.8
pin_diameter = 0.6
[Mesh]
[graphite_pin]
type = PolygonConcentricCircleMeshGenerator
num_sides = 6
polygon_size = ${fparse pin_pitch / 2.0}
num_sectors_per_side = '2 2 2 2 2 2'
[]
[bundle]
type = PatternedHexMeshGenerator
inputs = 'graphite_pin'
hexagon_size = ${fparse bundle_pitch / 2.0}
pattern = '0 0 0;
0 0 0 0;
0 0 0 0 0;
0 0 0 0;
0 0 0'
rotate_angle = 0
[]
[extrude]
type = AdvancedExtruderGenerator
input = bundle
heights = 0.5
num_layers = 2
direction = '0 0 1'
[]
[]
[Problem]
solve = false
type = FEProblem
[]
[AuxVariables]
[bin]
family = MONOMIAL
order = CONSTANT
[]
[]
[AuxKernels]
[bin]
type = SpatialUserObjectAux
variable = bin
user_object = subchannel_bins
[]
[]
[UserObjects]
[subchannel_bins]
type = HexagonalSubchannelBin
bundle_pitch = ${bundle_pitch}
pin_pitch = ${pin_pitch}
pin_diameter = ${pin_diameter}
n_rings = 3
pin_centered_bins = true
[]
[]
[Executioner]
type = Steady
[]
[Outputs]
exodus = true
[]
The value of the userobject is shown below; numbers superimposed over each bin are the pin indices (plus one additional index for the peripheral region) for this 19-pin geometry.
Figure 2: Pin-centered bin indices for a 19-pin hexagonal geometry
Input Parameters
- axiszvertical axis of the reactor (x, y, or z) along which pins are aligned
Default:z
C++ Type:MooseEnum
Controllable:No
Description:vertical axis of the reactor (x, y, or z) along which pins are aligned
- execute_onTIMESTEP_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.
Default: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.
- pin_centered_binsFalseWhether the bins should be channel-centered (false) or pin-centered (true)
Default:False
C++ Type:bool
Controllable:No
Description:Whether the bins should be channel-centered (false) or pin-centered (true)
- 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
- 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).
- 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.
- 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
- 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
- (tutorials/subchannel/nek.i)
- (test/tests/userobjects/subchannel_layered/1d.i)
- (test/tests/userobjects/volume/nondimensional/nek.i)
- (test/tests/userobjects/subchannel_layered/nek.i)
- (test/tests/userobjects/volume/dimensional/nek.i)
- (test/tests/nek_errors/invalid_field/nek_uo.i)
- (test/tests/userobjects/hexagonal_subchannel_bin/pin_centered.i)
- (test/tests/userobjects/hexagonal_subchannel_bin/subchannel.i)
- (test/tests/nek_errors/invalid_settings/problem_uo.i)
- (test/tests/userobjects/gap/nondimensional/nek.i)
- (test/tests/userobjects/subchannel_layered/user_component.i)
- (test/tests/userobjects/hexagonal_gap_layered/nek_axial.i)
- (test/tests/userobjects/subchannel_layered/duplicate_directions.i)
- (test/tests/userobjects/gap/dimensional/nek.i)
- (test/tests/userobjects/subchannel_layered/pin_1d.i)
- (test/tests/userobjects/hexagonal_gap_layered/normals/nek_axial.i)
- (test/tests/userobjects/hexagonal_subchannel_bin/pin_centered_3.i)
- (test/tests/nek_errors/invalid_scalar/nek_uo.i)
- (test/tests/userobjects/subchannel_layered/order_error.i)