LayeredInternalVolume

Computes the volume of an enclosed area by performing an integral over a user-supplied boundary over a user specified number of layers.

Description

LayeredInternalVolume computes the bounded volume of an enclosed space of a number of specified layers. The complete boundary of the enclosed space must be represented by the user specified side set. The volume of the domain is calculated as the integral over the surface of the domain, where the domain surface is specified by the boundary.

warningwarning:For Layered1D or Layered2D simulations

LayeredInternalVolume only works for geometries represented by discrete slices as in Layered1D and Layered2D simulations.

If the given side set points outward, LayeredInternalVolume will report a negative volume.

As an example, consider where F is a field, is the normal of the surface, V is the volume of the domain, and S is the surface of the domain.

For simplicity in this example, we choose

such that the integral becomes

The volume of the domain is the integral over the surface of the domain of the x position of the surface times the x-component of the normal of the surface. If a block is specified, the bounds of the specified block are used to limit the integral. The calculated integral is reported over a user specified number of layers.

Example Input Syntax

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [layered_internal_volume]
    type = LayeredInternalVolume<<<{"description": "Computes the volume of an enclosed area by performing an integral over a user-supplied boundary over a user specified number of layers.", "href": "LayeredInternalVolume.html"}>>>
    fuel_pin_geometry<<<{"description": "Name of Layered1DFuelPinGeometry or Layered2DFuelPinGeometry UserObject"}>>> = pin_geometry
    out_of_plane_strain<<<{"description": "The out-of-plane strain nodal variable"}>>> = strain_yy
    boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = 9
    block<<<{"description": "The list of block ids (SubdomainID) that this object will be applied"}>>> = fuel
    direction<<<{"description": "The direction of the layers."}>>> = y
    num_layers<<<{"description": "The number of layers."}>>> = 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 timestep_end'
  []
[]
(test/tests/layered_1D/layered_internal_volume.i)

Input Parameters

  • boundaryThe list of boundary IDs from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundary IDs from the mesh where this object applies

  • fuel_pin_geometryName of Layered1DFuelPinGeometry or Layered2DFuelPinGeometry UserObject

    C++ Type:UserObjectName

    Controllable:No

    Description:Name of Layered1DFuelPinGeometry or Layered2DFuelPinGeometry UserObject

  • out_of_plane_strainThe out-of-plane strain nodal variable

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The out-of-plane strain nodal variable

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

  • component0The component to use in the integration

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The component to use in the integration

  • 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.

  • offset0Distance from the origin to the local coordinate system origin in the 'component' direction.

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Distance from the origin to the local coordinate system origin in the 'component' direction.

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_meshTrueWhether 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:True

    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

Input Files