LayeredPlenumTemperatureUserObject

Computes the current heights of the layers to be used in the plenum temperature calculation.

Description

LayeredPlenumTemperatureUserObject estimates the current slice heights and temperatures in a layered simulation for use in the LayeredPlenumTemperaturePostprocessor to calculate the plenum temperature. This object can only be used for meshes created by the Layered1DMeshGenerator and the Layered2DMeshGenerator .

note

This object is typically created by an action (see LayeredPlenumTemperatureAction)

Example Input Syntax

[LayeredPlenumTemperature<<<{"href": "../../syntax/LayeredPlenumTemperature/index.html"}>>>]
  [plenum_temp]
    boundary<<<{"description": "The boundary ID or name over which the plenum temperature should be measured."}>>> = 5
    fuel_pin_geometry<<<{"description": "Name of the UserObject that reads the pin geometry from the mesh."}>>> = pin_geometry
    out_of_plane_strain<<<{"description": "The out-of-plane strain nodal variable."}>>> = strain_yy_0
    inner_surfaces<<<{"description": "The inner surfaces (e.g. fuel not on inner radius)."}>>> = '5'
    outer_surfaces<<<{"description": "The outer surfaces (e.g. cladding)."}>>> = '10'
    temperature<<<{"description": "Coupled temperature (K)"}>>> = temp
  []
[]

Input Parameters

cladding_temperatureName of the UserObject that contains the layered side average of the cladding inner surface temperature.
C++ Type:UserObjectName
Controllable:No
Description:Name of the UserObject that contains the layered side average of the cladding inner surface temperature.
fuel_pin_geometryName of the UserObject that reads the pin geometry from the mesh.
C++ Type:UserObjectName
Controllable:No
Description:Name of the UserObject that reads the pin geometry from the mesh.
fuel_temperatureName of the UserObject that contains the layered side average value of the fuel outer surface temperature.
C++ Type:UserObjectName
Controllable:No
Description:Name of the UserObject that contains the layered side average value of the fuel outer surface temperature.
out_of_plane_strain_claddingName of the UserObject that contains the layered average out_of_plane_strain in the cladding.
C++ Type:UserObjectName
Controllable:No
Description:Name of the UserObject that contains the layered average out_of_plane_strain in the cladding.
out_of_plane_strain_fuelName of the UserObject that contains the layered average out_of_plane_strain in the fuel.
C++ Type:UserObjectName
Controllable:No
Description:Name of the UserObject that contains the layered average out_of_plane_strain in the fuel.

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of block ids (SubdomainID) that this object will be applied
layer_bounding_blockList of block ids (SubdomainID) that are used to determine the upper and lower geometric bounds for all layers. If this is not specified, the ids specified in 'block' are used for this purpose.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:List of block ids (SubdomainID) that are used to determine the upper and lower geometric bounds for all layers. If this is not specified, the ids specified in 'block' are used for this purpose.

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
Options:XFEM_MARK, NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM
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

average_radius1When using 'average' sampling this is how the number of values both above and below the layer that will be averaged.
Default:1
C++ Type:unsigned int
Controllable:No
Description:When using 'average' sampling this is how the number of values both above and below the layer that will be averaged.
cumulativeFalseWhen true the value in each layer is the sum of the values up to and including that layer
Default:False
C++ Type:bool
Controllable:No
Description:When true the value in each layer is the sum of the values up to and including that layer
positive_cumulative_directionTrueWhen 'cumulative' is true, whether the direction for summing the cumulative value is the positive direction or negative direction
Default:True
C++ Type:bool
Controllable:No
Description:When 'cumulative' is true, whether the direction for summing the cumulative value is the positive direction or negative direction
sample_typedirectHow to sample the layers. 'direct' means get the value of the layer the point falls in directly (or average if that layer has no value). 'interpolate' does a linear interpolation between the two closest layers. 'average' averages the two closest layers.
Default:direct
C++ Type:MooseEnum
Options:direct, interpolate, average
Controllable:No
Description:How to sample the layers. 'direct' means get the value of the layer the point falls in directly (or average if that layer has no value). 'interpolate' does a linear interpolation between the two closest layers. 'average' averages the two closest layers.

Value Sampling / Aggregating Parameters

boundsThe 'bounding' positions of the layers i.e.: '0, 1.2, 3.7, 4.2' will mean 3 layers between those positions.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The 'bounding' positions of the layers i.e.: '0, 1.2, 3.7, 4.2' will mean 3 layers between those positions.
directionThe direction of the layers.
C++ Type:MooseEnum
Options:x, y, z
Controllable:No
Description:The direction of the layers.
direction_maxMaximum coordinate along 'direction' that bounds the layers
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Maximum coordinate along 'direction' that bounds the layers
direction_minMinimum coordinate along 'direction' that bounds the layers
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Minimum coordinate along 'direction' that bounds the layers
num_layersThe number of layers.
C++ Type:unsigned int
Controllable:No
Description:The number of layers.

Layers Extent And Definition 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.

Material Property Retrieval Parameters

References

No citations exist within this document.

(test/tests/layered_1D/layered_plenum_temperature.i)

#
# Mesh contains one fuel and clad slice of height 1 and a plenum
# slice of height 9.  The gap between the fuel and clad is set to 1.
# The fuel and clad surface temperature is set to 90.
# The plenum temperature is set to 50.
#
# The layered plenum temperature, which estimates the average temperature in the
# gap is calculated as:
#
# T_p = (50 * 9 * 2  + 90 * 1 * 1) / (9 * 2 + 1 * 1) = 52.10526
#

[GlobalParams]
  order = FIRST
  family = LAGRANGE
[]

[Mesh]
  coord_type = RZ
  [layered1D_mesh]
    type = Layered1DMeshGenerator
    uniform_slice_heights = true
    fuel_height = 1.0
    slices_per_block = 1
    include_fuel = true
    include_plenum = true
    plenum_height = 9.0
    pellet_bottom_coor = 0
    pellet_outer_radius = 1.0
    clad_gap_width = 1.0
    clad_thickness = 1.0
    elem_type = EDGE2
  []
[]

[Functions]
  [temp1]
    type = PiecewiseLinear
    x = '0 1'
    y = '0 90'
  []
  [temp2]
    type = PiecewiseLinear
    x = '0 1'
    y = '0 50'
  []
[]

[Variables]
  [temp]
    initial_condition = 0
  []
[]

[Kernels]
  [heat]
    type = HeatConduction
    variable = temp
  []
[]

[AuxVariables]
  [strain_yy_0]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[BCs]
  [temp1]
    type = FunctionDirichletBC
    boundary = '10002 10003'
    variable = temp
    function = temp1
  []
  [temp2]
    type = FunctionDirichletBC
    boundary = 10023
    variable = temp
    function = temp2
  []
[]

[UserObjects]
  [pin_geometry]
    type = Layered1DFuelPinGeometry
    mesh_generator = layered1D_mesh
  []
[]

[LayeredPlenumTemperature]
  [plenum_temp]
    boundary = 5
    fuel_pin_geometry = pin_geometry
    out_of_plane_strain = strain_yy_0
    inner_surfaces = '5'
    outer_surfaces = '10'
    temperature = temp
  []
[]

[Materials]
  [heat1]
    type = HeatConductionMaterial
    block = 'fuel clad'
    specific_heat = 1.0
    thermal_conductivity = 100000000.0
  []
  [density]
    type = ParsedMaterial
    block = 'fuel clad'
    property_name = density
    expression = 1.0
  []
[]

[Executioner]
  type = Transient

  solve_type = 'PJFNK'

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

  line_search = 'none'

  nl_abs_tol = 1e-10
  nl_rel_tol = 1e-12

  l_tol = 1e-8
  l_max_its = 100

  start_time = 0.0
  dt = 1.0
  end_time = 1.0
[]

[Outputs]
  csv = true
[]

Description
Example Input Syntax
Input Parameters
References