ArrayVarReductionAux

Takes an array variable and performs a reduction operation on it (max, min, sum, average) and stores as a standard variable.

Description

This auxiliary kernel performs a reduction operation on the values of an array variable $var element = document.getElementById("moose-equation-44b2f63e-a1c7-4403-b1fa-eabb84baabd3");katex.render("g", element, {displayMode:false,throwOnError:false});$ (indexed as $var element = document.getElementById("moose-equation-70552f7a-093e-4bc9-b86a-4771c90c6e1b");katex.render("g_i", element, {displayMode:false,throwOnError:false});$ ). Reduction operations include max, min, sum, and average. The operations sum and average can optionally use weights by setting the "weights" parameter. These perform the following operations:

sum without weights:

var element = document.getElementById("moose-equation-df6b370e-60c1-468a-9ded-f003f458e988");katex.render("f = \\sum\\limits_{i=1}^I g_i.", element, {displayMode:true,throwOnError:false});

sum with weights:

var element = document.getElementById("moose-equation-bb7b2e42-cae5-4d86-83b6-a13d23787779");katex.render("f = \\sum\\limits_{i=1}^I g_i w_i.", element, {displayMode:true,throwOnError:false});

average without weights:

var element = document.getElementById("moose-equation-ddfff75b-9dcb-4c46-b84f-6d549de03b37");katex.render("f = \\frac{1}{I}\\sum\\limits_{i=1}^I g_i.", element, {displayMode:true,throwOnError:false});

average with weights:

var element = document.getElementById("moose-equation-35f40cb3-8c9f-445b-9ccd-23b49b7343ab");katex.render("f = \\frac{1}{\\sum\\limits_{i=1}^I w_i}\\sum\\limits_{i=1}^I g_i w_i.", element, {displayMode:true,throwOnError:false});

min:

var element = document.getElementById("moose-equation-39b1d472-6b9b-4a0b-9e40-47aa89be3cf9");katex.render("f = \\min\\limits_{i=1,I} g_i.", element, {displayMode:true,throwOnError:false});

max:

var element = document.getElementById("moose-equation-853d1c9a-d4a2-4cf9-aee9-d04d4080c4a3");katex.render("f = \\max\\limits_{i=1,I} g_i.", element, {displayMode:true,throwOnError:false});

Input Parameters

array_variableArray variable to process.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Array variable to process.
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
execute_onLINEAR TIMESTEP_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:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, PRE_DISPLACE
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.
value_typesumType of reduction operation. Options are max, min, sum, and average.
Default:sum
C++ Type:MooseEnum
Options:max, min, sum, average
Controllable:No
Description:Type of reduction operation. Options are max, min, sum, and average.
weightsRelevant when 'value_type' is sum or average. When computing an average, these are the weights for a weighted average and when computing a sum, these weight scale each variable component in the summation.
C++ Type:Eigen::Matrix<double, -1, 1, 0, -1, 1>
Unit:(no unit assumed)
Controllable:No
Description:Relevant when 'value_type' is sum or average. When computing an average, these are the weights for a weighted average and when computing a sum, these weight scale each variable component in the summation.

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

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 Parameters

Usage

Development

Demonstration