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-fcd69cc7-ae9f-408d-a244-07a82dbef684");katex.render("g", element, {displayMode:false,throwOnError:false});$ (indexed as $var element = document.getElementById("moose-equation-4a9e9a77-b8b0-442f-a217-3232a2f69fef");katex.render("g_i", element, {displayMode:false,throwOnError:false});$ ). Reduction operations include max, min, sum, and average. These perform the following operations:

sum:

var element = document.getElementById("moose-equation-0652b582-2cc5-46fb-a599-2a6bf42aafce");katex.render("f = \\sum\\limits_{i=1}^I g_i.", element, {displayMode:true,throwOnError:false});

average:

var element = document.getElementById("moose-equation-0f7fc20e-253b-4221-9b18-07d109bc2e4e");katex.render("f = \\frac{1}{I}\\sum\\limits_{i=1}^I g_i.", element, {displayMode:true,throwOnError:false});

min:

var element = document.getElementById("moose-equation-2dd5c76f-7d4e-405a-844b-c293a4611257");katex.render("f = \\min\\limits_{i=1,I} g_i.", element, {displayMode:true,throwOnError:false});

max:

var element = document.getElementById("moose-equation-6d7ca15b-92e2-4984-894d-b15e940aa1ef");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>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, 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.
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
Unit:(no unit assumed)
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.
value_typesumType of reduction operation. Options are max, min, sum, and average.
Default:sum
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:max, min, sum, average
Controllable:No
Description:Type of reduction operation. Options are max, min, sum, and average.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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

Input Parameters