LayeredAverage

Computes averages of variables over layers

How to define the layers

The layer definition is handled by the LayeredBase class. It is summarized here. One, or multiple, layers are defined by their direction (normal or axis), their number, and their thicknesses.

The direction of the layers currently may only be along the three Cartesian axes, and can be set using the "direction" parameter.

The number of layers is set using the "num_layers" parameter, unless the "bounds" parameter (see below) is set.

The thicknesses of the layers can be set in three different, and separate, ways:

  • they can be set directly with coordinates along the specified direction using the "bounds" parameter. This will simultaneously set the number of layers, equal to the number of bounds minus one.

  • the minimum and maximum coordinates along the specified directions can be both specified to specify the total extent of equal thickness layers, using the "direction_min" and "direction_max" parameters

  • a vector of bounding domains may be specified using the "layer_bounding_block". The minimum and maximum coordinates along specified direction, which sets the thickness for each layer, are then obtained by looking at the maximum coordinate in the specified bounding block (to set the layers' minimum) and the minimum coordinate in the bounding blocks (to set the layers' maximum).

The layers may be restricted to elements in certain subdomains using the "block" parameter.

How to retrieve the result

The result of a LayeredAverage computation can be saved in an auxiliary variable using a SpatialUserObjectAux. It can be output to a CSV file using a SpatialUserObjectVectorPostprocessor.

Additional computation options

Sampling parameters may be specified to :

  • obtain the layer average directly, by setting the "sample_type" to direct (default)

  • interpolate between layer averages, by setting the "sample_type" to interpolate.

  • average between layers, by setting the "sample_type" to average. The "average_radius" parameter can be specified to tune the distance over which to average results.

Additionally, cumulative averages over layers, in the positive direction, can be computed by setting the "cumulative" to true.

Example input syntax

In this example, the average of variable u is taken over the whole domain in direction y over two layers. The result of this averaging is stored in the variable layered_average using a SpatialUserObjectAux, and output to a CSV file using a SpatialUserObjectVectorPostprocessor.

[UserObjects]
  [./average]
    type = LayeredAverage
    variable = u
    direction = y
    num_layers = 2
  [../]
[]

[AuxKernels]
  [./layered_average]
    type = SpatialUserObjectAux
    variable = layered_average
    execute_on = timestep_end
    user_object = average
  [../]
[]

[VectorPostprocessors]
  [avg]
    type = SpatialUserObjectVectorPostprocessor
    userobject = average
  []
[]
(test/tests/userobjects/layered_average/layered_average.i)

Input Parameters

  • variableThe name of the variable that this object operates on

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

    Controllable:No

    Description:The name of the variable that this object operates on

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

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, 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, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

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

  • 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

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • 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

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

    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

    Controllable:No

    Description:Maximum coordinate along 'direction' that bounds the layers

  • direction_minMinimum coordinate along 'direction' that bounds the layers

    C++ Type:double

    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

Input Files

Child Objects