NekBinnedSideIntegral

Compute the spatially-binned side integral of a field over a boundary of the NekRS mesh

Description

This user objects performs a side integral of a specified field over a sideset in the NekRS mesh that overlap with volume "bins." For a bin on $var element = document.getElementById("moose-equation-3f6608dd-7742-45a0-9f78-43f906a805d4");katex.render("\\Gamma_i", element, {displayMode:false,throwOnError:false});$ (a patch of a sideset), the user object value in that bin is

$var element = document.getElementById("moose-equation-fec86f91-f037-4ca3-b20e-20c7e5b9cbb3");katex.render("p_i=\\int_{\\Gamma_i}f\\ d\\Gamma", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-4b9712f8-3e00-4139-8631-40fffadf11ce");katex.render("p", element, {displayMode:false,throwOnError:false});$ is the value of the user object in bin $var element = document.getElementById("moose-equation-f9558eef-913b-4da7-9525-020ba4895259");katex.render("i", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-3042ef62-4358-45e1-9d99-ff58e133b8cd");katex.render("f", element, {displayMode:false,throwOnError:false});$ is the specified field. In other words, this object integrates on a sideset in the NekRS domain, by splitting up the integral according to a specified volume binning strategy. To be clear, this user object is not evaluated on the NekRSMesh mesh mirror, but instead on the mesh actually used for computation in NekRS.

The field is specified with the field parameter, which may be one of:

pressure: pressure
temperature: temperature, a.k.a. zeroth passive scalar
velocity: magnitude of velocity
velocity_x: $var element = document.getElementById("moose-equation-2583eb88-48d9-47ff-ad80-f5253aeb10db");katex.render("x", element, {displayMode:false,throwOnError:false});$ -component of velocity
velocity_y: $var element = document.getElementById("moose-equation-6e254e9e-4c68-40b0-a2a4-c428fbc66c30");katex.render("y", element, {displayMode:false,throwOnError:false});$ -component of velocity
velocity_z: $var element = document.getElementById("moose-equation-50c1f0f6-9177-470c-b991-37fffc1a35ab");katex.render("z", element, {displayMode:false,throwOnError:false});$ -component of velocity
velocity_x_squared: $var element = document.getElementById("moose-equation-a6337402-cd9f-4c46-8990-ddefed7c0a78");katex.render("x", element, {displayMode:false,throwOnError:false});$ -component of velocity, squared
velocity_y_squared: $var element = document.getElementById("moose-equation-6603a7f5-25da-473a-9903-4e6b84fca478");katex.render("y", element, {displayMode:false,throwOnError:false});$ -component of velocity, squared
velocity_z_squared: $var element = document.getElementById("moose-equation-18dbb252-0a85-4d2e-8154-257bfe9d8d21");katex.render("z", element, {displayMode:false,throwOnError:false});$ -component of velocity, squared
velocity_component: velocity vector dotted against another vector
scalar01: first passive scalar
scalar02: second passive scalar
scalar03: third passive scalar
unity: the value 1.0

Setting field = unity is equivalent to computing the area.

When using field = velocity_component, the manner in which the velocity direction is selected is given by the velocity_component parameter, which may be one of:

normal: normal to the face bins (only valid for the side binning user objects)
user: arbitrary user-specified direction, provided with the velocity_direction parameter

When using a velocity component as the field, this user object computes the dot product of the velocity with the specified direction. To retain the components of the dot product, such as for visualizing vector glyphs of the user object result in Paraview, you can use a NekSpatialBinComponentAux.

If running NekRS in non-dimensional form (and you have indicated the appropriate nondimensional scales with the Dimensionalize sub-block for the [Problem]) then the value of this object is shown in dimensional units.

The bins are specified by providing a list of binning user objects with the bin parameter. Available user objects for specifying spatial bins are:

If more than one bin is provided, then the bins are taken as the product of each individual bin distribution.

tip

You can visualize this user object (i.e., the bin integrals) using a SpatialUserObjectAux.

Example Input Syntax

As an example, the input below defines three individual bin distributions (named x, y, and z to represent 1-D binning in each coordinate direction). These bins are then combined to integrate over sideset 2 in $var element = document.getElementById("moose-equation-3b6368d7-d22b-4d22-8c8c-4c180d8a25c5");katex.render("2*2*3", element, {displayMode:false,throwOnError:false});$ equal-size spatial bins.

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [x]
    type = LayeredBin<<<{"description": "Creates a unique spatial bin for layers in a specified direction", "href": "LayeredBin.html"}>>>
    direction<<<{"description": "The direction of the layers (x, y, or z)"}>>> = x
    num_layers<<<{"description": "The number of layers between the bounding box of the domain"}>>> = 2
  []
  [y]
    type = LayeredBin<<<{"description": "Creates a unique spatial bin for layers in a specified direction", "href": "LayeredBin.html"}>>>
    direction<<<{"description": "The direction of the layers (x, y, or z)"}>>> = y
    num_layers<<<{"description": "The number of layers between the bounding box of the domain"}>>> = 2
  []
  [z]
    type = LayeredBin<<<{"description": "Creates a unique spatial bin for layers in a specified direction", "href": "LayeredBin.html"}>>>
    direction<<<{"description": "The direction of the layers (x, y, or z)"}>>> = z
    num_layers<<<{"description": "The number of layers between the bounding box of the domain"}>>> = 3
  []
  [avg_T]
    type = NekBinnedSideAverage<<<{"description": "Compute the spatially-binned average of a field over a sideset of the NekRS mesh", "href": "NekBinnedSideAverage.html"}>>>
    bins<<<{"description": "Userobjects providing a spatial bin given a point"}>>> = 'x y z'
    field<<<{"description": "Field to apply this object to"}>>> = temperature
    boundary<<<{"description": "Boundary ID(s) over which to compute the bin values"}>>> = '2'
  []
  [avg_p]
    type = NekBinnedSideAverage<<<{"description": "Compute the spatially-binned average of a field over a sideset of the NekRS mesh", "href": "NekBinnedSideAverage.html"}>>>
    bins<<<{"description": "Userobjects providing a spatial bin given a point"}>>> = 'x y z'
    field<<<{"description": "Field to apply this object to"}>>> = pressure
    boundary<<<{"description": "Boundary ID(s) over which to compute the bin values"}>>> = '2'
  []
  [avg_v]
    type = NekBinnedSideAverage<<<{"description": "Compute the spatially-binned average of a field over a sideset of the NekRS mesh", "href": "NekBinnedSideAverage.html"}>>>
    bins<<<{"description": "Userobjects providing a spatial bin given a point"}>>> = 'x y z'
    field<<<{"description": "Field to apply this object to"}>>> = velocity
    boundary<<<{"description": "Boundary ID(s) over which to compute the bin values"}>>> = '2'
  []
  [integral_T]
    type = NekBinnedSideIntegral<<<{"description": "Compute the spatially-binned side integral of a field over a boundary of the NekRS mesh", "href": "NekBinnedSideIntegral.html"}>>>
    bins<<<{"description": "Userobjects providing a spatial bin given a point"}>>> = 'x y z'
    field<<<{"description": "Field to apply this object to"}>>> = temperature
    boundary<<<{"description": "Boundary ID(s) over which to compute the bin values"}>>> = '2'
  []
  [integral_p]
    type = NekBinnedSideIntegral<<<{"description": "Compute the spatially-binned side integral of a field over a boundary of the NekRS mesh", "href": "NekBinnedSideIntegral.html"}>>>
    bins<<<{"description": "Userobjects providing a spatial bin given a point"}>>> = 'x y z'
    field<<<{"description": "Field to apply this object to"}>>> = pressure
    boundary<<<{"description": "Boundary ID(s) over which to compute the bin values"}>>> = '2'
  []
  [integral_v]
    type = NekBinnedSideIntegral<<<{"description": "Compute the spatially-binned side integral of a field over a boundary of the NekRS mesh", "href": "NekBinnedSideIntegral.html"}>>>
    bins<<<{"description": "Userobjects providing a spatial bin given a point"}>>> = 'x y z'
    field<<<{"description": "Field to apply this object to"}>>> = velocity
    boundary<<<{"description": "Boundary ID(s) over which to compute the bin values"}>>> = '2'
  []
[]

The result of the user object can then be visualized with a SpatialUserObjectAux.

Input Parameters

binsUserobjects providing a spatial bin given a point
C++ Type:std::vector<UserObjectName>
Controllable:No
Description:Userobjects providing a spatial bin given a point
boundaryBoundary ID(s) over which to compute the bin values
C++ Type:std::vector<int>
Controllable:No
Description:Boundary ID(s) over which to compute the bin values
fieldField to apply this object to
C++ Type:MooseEnum
Options:velocity_x, velocity_y, velocity_z, velocity, velocity_component, velocity_x_squared, velocity_y_squared, velocity_z_squared, temperature, pressure, scalar01, scalar02, scalar03, unity, usrwrk00, usrwrk01, usrwrk02
Controllable:No
Description:Field to apply this object to

Required Parameters

check_zero_contributionsTrueWhether to throw an error if no GLL points/element centroids in the NekRS mesh map to a spatial bin; this can be used to ensure that the bins are sufficiently big to get at least one contributing point from the NekRS mesh.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to throw an error if no GLL points/element centroids in the NekRS mesh map to a spatial bin; this can be used to ensure that the bins are sufficiently big to get at least one contributing point from the NekRS mesh.
interval1Frequency (in number of time steps) with which to execute this user object; user objects can be expensive and not necessary to evaluate on every single time step. NOTE: you probably want to match with 'time_step_interval' in the Output
Default:1
C++ Type:unsigned int
Controllable:No
Description:Frequency (in number of time steps) with which to execute this user object; user objects can be expensive and not necessary to evaluate on every single time step. NOTE: you probably want to match with 'time_step_interval' in the Output
map_space_by_qpFalseWhether to map the NekRS spatial domain to a bin according to the element centroids (true) or quadrature point locations (false).
Default:False
C++ Type:bool
Controllable:No
Description:Whether to map the NekRS spatial domain to a bin according to the element centroids (true) or quadrature point locations (false).
velocity_componentuserDirection in which to evaluate velocity when 'field = velocity_component.' Options: user (you then need to specify a direction with 'velocity_direction'); normal
Default:user
C++ Type:MooseEnum
Options:normal, user
Controllable:No
Description:Direction in which to evaluate velocity when 'field = velocity_component.' Options: user (you then need to specify a direction with 'velocity_direction'); normal
velocity_directionUnit vector to dot with velocity, for 'field = velocity_component'. For example, velocity_direction = '1 1 0' will get the velocity dotted with (1/sqrt(2), 1/sqrt(2), 0).
C++ Type:libMesh::Point
Controllable:No
Description:Unit vector to dot with velocity, for 'field = velocity_component'. For example, velocity_direction = '1 1 0' will get the velocity dotted with (1/sqrt(2), 1/sqrt(2), 0).

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

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

Input Files

(test/tests/userobjects/sideset_layered/invalid_boundary.i)
(test/tests/userobjects/sideset_layered/z_bins_by_centroid.i)
(test/tests/userobjects/side/dimensional/nek.i)
(test/tests/userobjects/sideset_layered/z_bins.i)
(test/tests/userobjects/side/nondimensional/nek.i)

(test/tests/userobjects/side/nondimensional/nek.i)

[GlobalParams]
  check_boundary_restricted = false
[]

[Mesh]
  type = NekRSMesh
  volume = true
  scaling = 7.646e-3
[]

[Problem]
  type = NekRSProblem
  casename = 'sfr_7pin'

  [Dimensionalize]
    L = 7.646e-3
    T = 100.0
    dT = 50.0
    U = 2.0
    rho = 834.5
    Cp = 1228.0
  []

  [FieldTransfers]
    [temp]
      type = NekFieldVariable
      direction = from_nek
      field = temperature
    []
    [P]
      type = NekFieldVariable
      direction = from_nek
      field = pressure
    []
    [vel_x]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_x
    []
    [vel_y]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_y
    []
    [vel_z]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_z
    []
  []
[]

[AuxVariables]
  [avg_T]
    family = MONOMIAL
    order = CONSTANT
  []
  [avg_p]
    family = MONOMIAL
    order = CONSTANT
  []
  [avg_v]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_T]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_p]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_v]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [avg_T]
    type = SpatialUserObjectAux
    variable = avg_T
    user_object = avg_T
    boundary = '2'
  []
  [avg_p]
    type = SpatialUserObjectAux
    variable = avg_p
    user_object = avg_p
    boundary = '2'
  []
  [avg_v]
    type = SpatialUserObjectAux
    variable = avg_v
    user_object = avg_v
    boundary = '2'
  []
  [integral_T]
    type = SpatialUserObjectAux
    variable = integral_T
    user_object = integral_T
    boundary = '2'
  []
  [integral_p]
    type = SpatialUserObjectAux
    variable = integral_p
    user_object = integral_p
    boundary = '2'
  []
  [integral_v]
    type = SpatialUserObjectAux
    variable = integral_v
    user_object = integral_v
    boundary = '2'
  []
[]

[UserObjects]
  [x]
    type = LayeredBin
    direction = x
    num_layers = 2
  []
  [y]
    type = LayeredBin
    direction = y
    num_layers = 2
  []
  [z]
    type = LayeredBin
    direction = z
    num_layers = 3
  []
  [avg_T]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = temperature
    boundary = '2'
  []
  [avg_p]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = pressure
    boundary = '2'
  []
  [avg_v]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = velocity
    boundary = '2'
  []
  [integral_T]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = temperature
    boundary = '2'
  []
  [integral_p]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = pressure
    boundary = '2'
  []
  [integral_v]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = velocity
    boundary = '2'
  []
[]

[Executioner]
  type = Transient

  [TimeStepper]
    type = NekTimeStepper
  []
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/sideset_layered/invalid_boundary.i)

[Mesh]
  type = NekRSMesh
  volume = true
[]

[Problem]
  type = NekRSProblem
  casename = 'sfr_7pin'
[]

[UserObjects]
  [x]
    type = LayeredBin
    direction = x
    num_layers = 3
  []
  [vol_avg]
    type = NekBinnedSideIntegral
    bins = 'x'
    field = temperature
    boundary = '5'
  []
[]

[Executioner]
  type = Transient

  [TimeStepper]
    type = NekTimeStepper
  []
[]

(test/tests/userobjects/sideset_layered/z_bins_by_centroid.i)

[GlobalParams]
  check_boundary_restricted = false
  map_space_by_qp = false
[]

[Mesh]
  type = NekRSMesh
  volume = true
[]

[Problem]
  type = NekRSProblem
  casename = 'sfr_7pin'
[]

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

[AuxKernels]
  [T1_bin3]
    type = SpatialUserObjectAux
    variable = T1_bin3
    user_object = T1_bin3
    boundary = '1'
  []
[]

[UserObjects]
  [z3]
    type = LayeredBin
    direction = z
    num_layers = 3
  []
  [T1_bin3]
    type = NekBinnedSideIntegral
    bins = 'z3'
    field = temperature
    boundary = '1'
  []
[]

[Executioner]
  type = Transient

  [TimeStepper]
    type = NekTimeStepper
  []
[]

[VectorPostprocessors]
  [T]
    type = SpatialUserObjectVectorPostprocessor
    userobject = T1_bin3
  []
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/side/dimensional/nek.i)

[GlobalParams]
  check_boundary_restricted = false
[]

[Mesh]
  type = NekRSMesh
  volume = true
[]

[Problem]
  type = NekRSProblem
  casename = 'sfr_7pin'

  [FieldTransfers]
    [temp]
      type = NekFieldVariable
      direction = from_nek
      field = temperature
    []
    [P]
      type = NekFieldVariable
      direction = from_nek
      field = pressure
    []
    [vel_x]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_x
    []
    [vel_y]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_y
    []
    [vel_z]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_z
    []
  []

[]

[AuxVariables]
  [avg_T]
    family = MONOMIAL
    order = CONSTANT
  []
  [avg_p]
    family = MONOMIAL
    order = CONSTANT
  []
  [avg_v]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_T]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_p]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_v]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [avg_T]
    type = SpatialUserObjectAux
    variable = avg_T
    user_object = avg_T
    boundary = '2'
  []
  [avg_p]
    type = SpatialUserObjectAux
    variable = avg_p
    user_object = avg_p
    boundary = '2'
  []
  [avg_v]
    type = SpatialUserObjectAux
    variable = avg_v
    user_object = avg_v
    boundary = '2'
  []
  [integral_T]
    type = SpatialUserObjectAux
    variable = integral_T
    user_object = integral_T
    boundary = '2'
  []
  [integral_p]
    type = SpatialUserObjectAux
    variable = integral_p
    user_object = integral_p
    boundary = '2'
  []
  [integral_v]
    type = SpatialUserObjectAux
    variable = integral_v
    user_object = integral_v
    boundary = '2'
  []
[]

[UserObjects]
  [x]
    type = LayeredBin
    direction = x
    num_layers = 2
  []
  [y]
    type = LayeredBin
    direction = y
    num_layers = 2
  []
  [z]
    type = LayeredBin
    direction = z
    num_layers = 3
  []
  [avg_T]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = temperature
    boundary = '2'
  []
  [avg_p]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = pressure
    boundary = '2'
  []
  [avg_v]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = velocity
    boundary = '2'
  []
  [integral_T]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = temperature
    boundary = '2'
  []
  [integral_p]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = pressure
    boundary = '2'
  []
  [integral_v]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = velocity
    boundary = '2'
  []
[]

[Executioner]
  type = Transient

  [TimeStepper]
    type = NekTimeStepper
  []
[]

[Outputs]
  exodus = true
  file_base = nek_dim
[]

(test/tests/userobjects/sideset_layered/z_bins.i)

[GlobalParams]
  check_boundary_restricted = false
  map_space_by_qp = true
[]

[Mesh]
  type = NekRSMesh
  volume = true
[]

[Problem]
  type = NekRSProblem
  casename = 'sfr_7pin'
[]

[AuxVariables]
  [uo1_bin1]
    family = MONOMIAL
    order = CONSTANT
  []
  [uo1_bin3]
    family = MONOMIAL
    order = CONSTANT
  []
  [uo2_bin1]
    family = MONOMIAL
    order = CONSTANT
  []
  [uo2_bin3]
    family = MONOMIAL
    order = CONSTANT
  []
  [uo_1_2_bin3]
    family = MONOMIAL
    order = CONSTANT
  []
  [T1_bin1]
    family = MONOMIAL
    order = CONSTANT
  []
  [T1_bin3]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [T1_bin1]
    type = SpatialUserObjectAux
    variable = T1_bin1
    user_object = T1_bin1
    boundary = '1'
  []
  [T1_bin3]
    type = SpatialUserObjectAux
    variable = T1_bin3
    user_object = T1_bin3
    boundary = '1'
  []
  [uo1_bin1]
    type = SpatialUserObjectAux
    variable = uo1_bin1
    user_object = side1_bin1
    boundary = '1'
  []
  [uo2_bin1]
    type = SpatialUserObjectAux
    variable = uo2_bin1
    user_object = side2_bin1
    boundary = '2'
  []
  [uo1_bin3]
    type = SpatialUserObjectAux
    variable = uo1_bin3
    user_object = side1_bin3
    boundary = '1'
  []
  [uo2_bin3]
    type = SpatialUserObjectAux
    variable = uo2_bin3
    user_object = side2_bin3
    boundary = '2'
  []
  [uo_1_2_bin3]
    type = SpatialUserObjectAux
    variable = uo_1_2_bin3
    user_object = side_1_2_bin3
    boundary = '1 2'
  []
[]

[UserObjects]
  [z1]
    type = LayeredBin
    direction = z
    num_layers = 1
  []
  [side1_bin1]
    type = NekBinnedSideIntegral
    bins = 'z1'
    field = unity
    boundary = '1'
  []
  [side2_bin1]
    type = NekBinnedSideIntegral
    bins = 'z1'
    field = unity
    boundary = '2'
  []
  [side_1_2_bin1] # should equal the sum of side1_bin1 and side1_bin2
    type = NekBinnedSideIntegral
    bins = 'z1'
    field = unity
    boundary = '1 2'
  []
  [T1_bin1]
    type = NekBinnedSideIntegral
    bins = 'z1'
    field = temperature
    boundary = '1'
  []

  [z3]
    type = LayeredBin
    direction = z
    num_layers = 3
  []
  [side1_bin3]
    type = NekBinnedSideIntegral
    bins = 'z3'
    field = unity
    boundary = '1'
  []
  [side2_bin3]
    type = NekBinnedSideIntegral
    bins = 'z3'
    field = unity
    boundary = '2'
  []
  [side_1_2_bin3] # should equal the sum of side1_bin3 and side2_bin3
    type = NekBinnedSideIntegral
    bins = 'z3'
    field = unity
    boundary = '1 2'
  []
  [T1_bin3]
    type = NekBinnedSideIntegral
    bins = 'z3'
    field = temperature
    boundary = '1'
  []
[]

[Postprocessors]
  [area1] # should match the value of the side1_bin1 user object
    type = NekSideIntegral
    field = unity
    boundary = '1'
  []
  [area_divided1] # should match the value of the side1_bin3 user object
    type = LinearCombinationPostprocessor
    pp_names = 'area1'
    pp_coefs = '${fparse 1.0 / 3.0}'
  []
  [area2] # should match the value of the side2_bin1 user object
    type = NekSideIntegral
    field = unity
    boundary = '2'
  []
  [area_divided2] # should match the value of the side2_bin3 user object
    type = LinearCombinationPostprocessor
    pp_names = 'area2'
    pp_coefs = '${fparse 1.0 / 3.0}'
  []
  [T1] # should match the value of the T1_bin1 user object
    type = NekSideIntegral
    field = temperature
    boundary = '1'
  []
[]

[Executioner]
  type = Transient

  [TimeStepper]
    type = NekTimeStepper
  []
[]

[Outputs]
  execute_on = 'final'
  exodus = true
[]

(test/tests/userobjects/side/nondimensional/nek.i)

[GlobalParams]
  check_boundary_restricted = false
[]

[Mesh]
  type = NekRSMesh
  volume = true
  scaling = 7.646e-3
[]

[Problem]
  type = NekRSProblem
  casename = 'sfr_7pin'

  [Dimensionalize]
    L = 7.646e-3
    T = 100.0
    dT = 50.0
    U = 2.0
    rho = 834.5
    Cp = 1228.0
  []

  [FieldTransfers]
    [temp]
      type = NekFieldVariable
      direction = from_nek
      field = temperature
    []
    [P]
      type = NekFieldVariable
      direction = from_nek
      field = pressure
    []
    [vel_x]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_x
    []
    [vel_y]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_y
    []
    [vel_z]
      type = NekFieldVariable
      direction = from_nek
      field = velocity_z
    []
  []
[]

[AuxVariables]
  [avg_T]
    family = MONOMIAL
    order = CONSTANT
  []
  [avg_p]
    family = MONOMIAL
    order = CONSTANT
  []
  [avg_v]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_T]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_p]
    family = MONOMIAL
    order = CONSTANT
  []
  [integral_v]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [avg_T]
    type = SpatialUserObjectAux
    variable = avg_T
    user_object = avg_T
    boundary = '2'
  []
  [avg_p]
    type = SpatialUserObjectAux
    variable = avg_p
    user_object = avg_p
    boundary = '2'
  []
  [avg_v]
    type = SpatialUserObjectAux
    variable = avg_v
    user_object = avg_v
    boundary = '2'
  []
  [integral_T]
    type = SpatialUserObjectAux
    variable = integral_T
    user_object = integral_T
    boundary = '2'
  []
  [integral_p]
    type = SpatialUserObjectAux
    variable = integral_p
    user_object = integral_p
    boundary = '2'
  []
  [integral_v]
    type = SpatialUserObjectAux
    variable = integral_v
    user_object = integral_v
    boundary = '2'
  []
[]

[UserObjects]
  [x]
    type = LayeredBin
    direction = x
    num_layers = 2
  []
  [y]
    type = LayeredBin
    direction = y
    num_layers = 2
  []
  [z]
    type = LayeredBin
    direction = z
    num_layers = 3
  []
  [avg_T]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = temperature
    boundary = '2'
  []
  [avg_p]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = pressure
    boundary = '2'
  []
  [avg_v]
    type = NekBinnedSideAverage
    bins = 'x y z'
    field = velocity
    boundary = '2'
  []
  [integral_T]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = temperature
    boundary = '2'
  []
  [integral_p]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = pressure
    boundary = '2'
  []
  [integral_v]
    type = NekBinnedSideIntegral
    bins = 'x y z'
    field = velocity
    boundary = '2'
  []
[]

[Executioner]
  type = Transient

  [TimeStepper]
    type = NekTimeStepper
  []
[]

[Outputs]
  exodus = true
[]

Description
Example Input Syntax
Input Parameters
Input Files