Layered2DArray

Description

Layered2DArray simplifies creation of arrays of meshes built by Layered2DMeshGenerator. Without this class, input files for analyses of arrays of meshes must create the meshes one at a time, with each mesh requiring a rotation and translation step. Additionally, a final combining step to merge all the meshes together is also necessary.

Layered2DArray creates an associated Layered2DFuelPinGeometry object for each mesh object created.

The indexing used to identify fuel rods is i_j where i is the x-index (column) and j is the y-index (row). Index i is defined from left to right, and index j is defined from bottom to top. The i_j label is prepended to the block names. That is, 0_1_fuel would be the block name for the fuel block in the zeroth column and first row in the array. The same i_j label is prepended to the names of the Layered2DFuelPinGeometry objects. The name corresponding to the 0_1 position would be 0_1_fuel_pin_geometry.

Block and boundary ids increase from rod to rod by the amount specified by the id_offset parameter (10 is the default).

These conventions are shown in Figure 1.

Figure 1: Diagram of a the numbering convention for meshes built with Layered2DArray. Block and boundary id offsets are in white. The fuel rod identifiers i_j are shown in black with row and column indices also in black.

New sidesets are created named left, bottom, right, and top. These are along the appropriate sides of rods along the edges of the domain.

Example Input Syntax

[Mesh<<<{"href": "../index.html"}>>>]
  [Layered2DArray<<<{"href": "index.html"}>>>]
    axial_direction<<<{"description": "The direction perpendicular to the circular cross section."}>>> = z
    num_sectors<<<{"description": "Number of azimuthal sectors in each quadrant. 'num_sectors' must be an even number."}>>> = 10
    slices_per_block<<<{"description": "For cases with only cladding, this is a single number providing the total number of slices for the cladding.  For cases with fuel, this is the number of slices per fuel block. Multiple values are provided if multiple fuel blocks are used."}>>> = 1
    clad_thickness<<<{"description": "Thickness of cladding."}>>> = 0.56e-3
    clad_gap_width<<<{"description": "Gap between maximum outer radius of pellet and inside surface of cladding."}>>> = 8e-5
    fuel_height<<<{"description": "Height of the fuel."}>>> = 0.1
    include_plenum<<<{"description": "Whether to include the plenum."}>>> = true
    plenum_height<<<{"description": "Height of the plenum, including above and below the fuel."}>>> = 0.05
    pellet_bottom_coor<<<{"description": "Axial location of the start of the fuel stack."}>>> = 0.0
    pellet_outer_radius<<<{"description": "Pellet outer radius.  If more than one given, number must match number of fuel blocks."}>>> = 0.0041
    pellet_mesh_density<<<{"description": "Sets the mesh density of the pellet (coarse, medium, fine, customize)."}>>> = coarse
    clad_mesh_density<<<{"description": "Sets the mesh density of the cladding (coarse, medium, fine, customize)."}>>> = coarse
    compress_boundary_ids<<<{"description": "Whether to compress the boundary IDs into a consecutive list."}>>> = true
    id_offset<<<{"description": "The offset to use for boundary and block ids between rods."}>>> = 100
  []
[]

Input Parameters

num_sectorsNumber of azimuthal sectors in each quadrant. 'num_sectors' must be an even number.
C++ Type:unsigned int
Controllable:No
Description:Number of azimuthal sectors in each quadrant. 'num_sectors' must be an even number.
number_of_columnsNumber of columns.
C++ Type:unsigned int
Controllable:No
Description:Number of columns.
number_of_rowsNumber of rows.
C++ Type:unsigned int
Controllable:No
Description:Number of rows.
pitchPitch between rods.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Pitch between rods.
slices_per_blockFor cases with only cladding, this is a single number providing the total number of slices for the cladding. For cases with fuel, this is the number of slices per fuel block. Multiple values are provided if multiple fuel blocks are used.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:For cases with only cladding, this is a single number providing the total number of slices for the cladding. For cases with fuel, this is the number of slices per fuel block. Multiple values are provided if multiple fuel blocks are used.

Required Parameters

active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
additional_block_namesThe names assigned to the blocks representing the additional rings.
C++ Type:std::vector<std::string>
Controllable:No
Description:The names assigned to the blocks representing the additional rings.
additional_elements_per_ringThe number of elements through the additional rings. Must be the same length as additional_ring_thicknesses.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:The number of elements through the additional rings. Must be the same length as additional_ring_thicknesses.
additional_ring_thicknessesThe thicknesses of additional rings.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The thicknesses of additional rings.
all_bottom_leftFalseWhether to generate sidesets for every bottom and left surface of mesh blocks.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to generate sidesets for every bottom and left surface of mesh blocks.
axial_directionzThe direction perpendicular to the circular cross section.
Default:z
C++ Type:MooseEnum
Options:x, y, z
Controllable:No
Description:The direction perpendicular to the circular cross section.
clad_gap_width2.5e-05Gap between maximum outer radius of pellet and inside surface of cladding.
Default:2.5e-05
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Gap between maximum outer radius of pellet and inside surface of cladding.
clad_mesh_densitymediumSets the mesh density of the cladding (coarse, medium, fine, customize).
Default:medium
C++ Type:MooseEnum
Options:coarse, medium, fine, customize
Controllable:No
Description:Sets the mesh density of the cladding (coarse, medium, fine, customize).
clad_thickness0.00041Thickness of cladding.
Default:0.00041
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Thickness of cladding.
compress_boundary_idsFalseWhether to compress the boundary IDs into a consecutive list.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to compress the boundary IDs into a consecutive list.
elem_typequad8Whether to generate quad8 or quad4 elements.
Default:quad8
C++ Type:MooseEnum
Options:quad4, quad8
Controllable:No
Description:Whether to generate quad8 or quad4 elements.
fuel_heightHeight of the fuel.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Height of the fuel.
id_offset2000The offset to use for boundary and block ids between rods.
Default:2000
C++ Type:short
Controllable:No
Description:The offset to use for boundary and block ids between rods.
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
include_cladTrueWhether to include the clad block.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to include the clad block.
include_fuelTrueWhether to include the fuel block.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to include the fuel block.
include_plenumTrueWhether to include the plenum.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to include the plenum.
liner_thickness0Thickness of liner on interior of cladding.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Thickness of liner on interior of cladding.
mps_depth0 Radial depth of MPS. If more than one given, number must match the number of fuel blocks.
Default:0
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Radial depth of MPS. If more than one given, number must match the number of fuel blocks.
name_prefixIf provided, prefix the built in boundary names with this string
C++ Type:std::string
Controllable:No
Description:If provided, prefix the built in boundary names with this string
nr_c2Number of cladding elements in radial direction.
Default:2
C++ Type:unsigned int
Controllable:No
Description:Number of cladding elements in radial direction.
nr_p4Number of fuel elements in radial direction of the outer ring outside the inner quadrilateral portion of the fuel mesh.
Default:4
C++ Type:unsigned int
Controllable:No
Description:Number of fuel elements in radial direction of the outer ring outside the inner quadrilateral portion of the fuel mesh.
offsetsOffset of each fuel slice block (x and y for each block).
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Offset of each fuel slice block (x and y for each block).
pellet_bottom_coor0.00324Axial location of the start of the fuel stack.
Default:0.00324
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Axial location of the start of the fuel stack.
pellet_inner_radius0 Pellet inner radius. If more than one given, number must match number of fuel blocks.
Default:0
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Pellet inner radius. If more than one given, number must match number of fuel blocks.
pellet_mesh_densitymediumSets the mesh density of the pellet (coarse, medium, fine, customize).
Default:medium
C++ Type:MooseEnum
Options:coarse, medium, fine, customize
Controllable:No
Description:Sets the mesh density of the pellet (coarse, medium, fine, customize).
pellet_outer_radius0.0041 Pellet outer radius. If more than one given, number must match number of fuel blocks.
Default:0.0041
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Pellet outer radius. If more than one given, number must match number of fuel blocks.
plenum_heightHeight of the plenum, including above and below the fuel.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Height of the plenum, including above and below the fuel.
portionfullControl of which part of mesh is created
Default:full
C++ Type:MooseEnum
Options:full, top_right, right_half, top_half
Controllable:No
Description:Control of which part of mesh is created
slice_heightsNeeded if uniform_slice_heights is false. Height of each slice. The number of slices provided must be the total number of fuel slices, plus one slice for the plenum, if a plenum is used, plus one slice for the lower plenum, if a lower plenum is used. This equals the number of slices in the cladding.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Needed if uniform_slice_heights is false. Height of each slice. The number of slices provided must be the total number of fuel slices, plus one slice for the plenum, if a plenum is used, plus one slice for the lower plenum, if a lower plenum is used. This equals the number of slices in the cladding.
slices_within_upper_plenum1Number of slices within the upper plenum. By default, the upper plenum is treated as a single volume (#slices = 1).
Default:1
C++ Type:unsigned int
Controllable:No
Description:Number of slices within the upper plenum. By default, the upper plenum is treated as a single volume (#slices = 1).
uniform_slice_heightsTrueWhether heights of fuel/cladding slices are uniform, excluding plenum height.
Default:True
C++ Type:bool
Controllable:No
Description:Whether heights of fuel/cladding slices are uniform, excluding plenum height.
use_legacy_block_idsTrueWhether to use legacy block id convention.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to use legacy block id convention.

Optional Parameters

enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
save_with_nameKeep the mesh from this mesh generator in memory with the name specified
C++ Type:std::string
Controllable:No
Description:Keep the mesh from this mesh generator in memory with the name specified

Advanced Parameters

nemesisFalseWhether or not to output the mesh file in the nemesisformat (only if output = true)
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to output the mesh file in the nemesisformat (only if output = true)
outputFalseWhether or not to output the mesh file after generating the mesh
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to output the mesh file after generating the mesh
show_infoFalseWhether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)

Debugging Parameters

(test/tests/layered2D/arrayAction.i)

#
# Simple 2x2 array (four quarter rods)
# The 0_0, 1_0, and 1_1 rods have the same power and should give identical results.
# The 0_1 rod has a higher power
#

pitch = 0.0126
fuel_density = 10431.0
initial_temperature = 293

[GlobalParams]
  order = SECOND
  family = LAGRANGE
  displacements = 'disp_x disp_y'
  number_of_rows = 2
  number_of_columns = 2
  pitch = ${pitch}
  #rod_ave_lin_pow = 'power1 power1 power2 power1'
[]

[Problem]
  type = ReferenceResidualProblem
  reference_vector = 'ref'
  extra_tag_vectors = 'ref'
  group_variables = 'disp_x disp_y;
  scalar_strain_zz_0_0_pellets0 scalar_strain_zz_1_0_pellets0 scalar_strain_zz_0_1_pellets0 scalar_strain_zz_1_1_pellets0;
  scalar_strain_zz_0_0_clad0 scalar_strain_zz_1_0_clad0 scalar_strain_zz_0_1_clad0 scalar_strain_zz_1_1_clad0
  scalar_strain_zz_0_0_clad1 scalar_strain_zz_1_0_clad1 scalar_strain_zz_0_1_clad1 scalar_strain_zz_1_1_clad1;'
[]

[Mesh]
  [Layered2DArray]
    axial_direction = z
    num_sectors = 10
    slices_per_block = 1
    clad_thickness = 0.56e-3
    clad_gap_width = 8e-5
    fuel_height = 0.1
    include_plenum = true
    plenum_height = 0.05
    pellet_bottom_coor = 0.0
    pellet_outer_radius = 0.0041
    pellet_mesh_density = coarse
    clad_mesh_density = coarse
    compress_boundary_ids = true
    id_offset = 100
  []
  partitioner = centroid
  centroid_partitioner_direction = z
  patch_update_strategy = iteration #auto
[]

[Functions]
  [power1]
    type = ParsedFunction
    expression = 'if(t<=0, 0, 10000)'
  []
  [power2]
    type = ParsedFunction
    expression = 'if(t<=0, 0, 20000)'
  []
  [axial_power_factor]
    type = ParsedFunction
    expression = '1'
  []
  [temperature_func]
    type = PiecewiseLinear
    x = '-200 0 180'
    y = '${initial_temperature} 300 320'
  []
  [pressure_ramp]
    type = PiecewiseLinear
    x = '-200 0'
    y = '0 1'
  []
  [system_pressure]
    type = CompositeFunction
    functions = '15.5e6 pressure_ramp'
  []
[]

[Burnup]
  [illinois]
    block = fuel
    axial_power_profile = axial_power_factor
    rpf_active = true
    num_radial = 11
    num_axial = 2
    a_lower = 0
    a_upper = 0.1
    fuel_inner_radius = 0
    fuel_outer_radius = .0041
    fuel_volume_ratio = 1.0
    density = ${fuel_density}
    average_burnup = average_burnup
    axial_direction = z
    order = CONSTANT
    family = MONOMIAL
  []
[]

[NuclearMaterials]
  fission_operation = normal
  physics = 'mechanics thermal'
  strain = FINITE
  initial_temperature = ${initial_temperature}
  stress_free_temperature = ${initial_temperature}
  temperature = temperature
  temperature_bc_function = temperature_func
  bc_types = 'Displacement PlenumPressure SystemPressure Temperature'
  contact_types = 'fuel_cladding'
  fuel_pin_geometry = fred
  initial_plenum_pressure = 4.0e6
  system_pressure_function = system_pressure
  axial_direction = z
  [UO2]
    [pellets]
      block = fuel
      uo2_models = 'elastic relocation swelling thermalexpansion'
      burnup_function = illinois
      axial_power_profile = axial_power_factor
      density = ${fuel_density}
      extra_vector_tags = 'ref'
    []
  []
  [ZirconiumAlloy]
    [clad]
      block = clad
      cladding_models = 'elastic creep thermalexpansion irradiationgrowth'
      extra_vector_tags = 'ref'
    []
  []
[]

[ThermalContact]
  [thermal_contact_0_0]
    type = GasGapHeatTransfer
    variable = temperature
    primary = 0_0_cladding_interior
    secondary = 0_0_fuel_outer_radial
    initial_moles = 0_0_initial_moles
    gas_released = 0_0_fission_gas_released
    quadrature = true
  []
  [thermal_contact_1_0]
    type = GasGapHeatTransfer
    variable = temperature
    primary = 1_0_cladding_interior
    secondary = 1_0_fuel_outer_radial
    initial_moles = 1_0_initial_moles
    gas_released = 1_0_fission_gas_released
    quadrature = true
  []
  [thermal_contact_0_1]
    type = GasGapHeatTransfer
    variable = temperature
    primary = 0_1_cladding_interior
    secondary = 0_1_fuel_outer_radial
    initial_moles = 0_1_initial_moles
    gas_released = 0_1_fission_gas_released
    quadrature = true
  []
  [thermal_contact_1_1]
    type = GasGapHeatTransfer
    variable = temperature
    primary = 1_1_cladding_interior
    secondary = 1_1_fuel_outer_radial
    initial_moles = 1_1_initial_moles
    gas_released = 1_1_fission_gas_released
    quadrature = true
  []
[]

[Executioner]
  type = Transient

  solve_type = PJFNK

  petsc_options = '-snes_ksp_ew'
  petsc_options_iname = '-pc_type -pc_factor_mat_solver_package'
  petsc_options_value = 'lu       superlu_dist'

  line_search = 'none'

  l_max_its = 100
  nl_max_its = 100
  nl_rel_tol = 1e-6
  nl_abs_tol = 1e-8
  l_tol = 1e-3
  start_time = -200
  n_startup_steps = 1
  end_time = 5e5
  dt = 2e2
  num_steps = 3
[]

[Outputs]
  [out]
    type = Exodus
    output_dimension = 3
    execute_on = 'initial timestep_end'
    show = 'burnup disp_x disp_y temperature'
    hide = 'conductivity_temperature paired_k_temperature paired_temperature qpoint_penetration strain_zz'
  []
[]

Description
Example Input Syntax
Input Parameters