ArrayParsedAux

Sets field array variable values to the evaluation of a parsed expression.

Overview

This auxiliary kernel is meant to emulate the behavior and syntax of ParsedAux for array variables. Using "expression", one can define a general parsed function dependent on array variables, scalar field variables, mesh coordinates, and time:

var element = document.getElementById("moose-equation-dc065fab-61d3-4f1d-9107-8fbfee29a32f");katex.render("u_i = f(v_{1,i}, v_{2,i},..., w_1, w_2,..., x, y, z, t), \\quad i=1,...,n,", element, {displayMode:true,throwOnError:false});

where $var element = document.getElementById("moose-equation-83f06426-b924-4822-84e9-bf4690f9c3a9");katex.render("u", element, {displayMode:false,throwOnError:false});$ is the array variable specified in "variable" with $var element = document.getElementById("moose-equation-9964b026-08c7-4ad0-87a7-890672520aa3");katex.render("n", element, {displayMode:false,throwOnError:false});$ components, $var element = document.getElementById("moose-equation-7213dd78-b7ee-4d7a-9267-3bb5ea48e5be");katex.render("i", element, {displayMode:false,throwOnError:false});$ is the component index of the variable, $var element = document.getElementById("moose-equation-ea280301-596e-4b0f-9469-d79ead422898");katex.render("v", element, {displayMode:false,throwOnError:false});$ are coupled array variables specified in "coupled_array_variables", $var element = document.getElementById("moose-equation-fe042a18-444d-477a-a592-4382adaec0d6");katex.render("w", element, {displayMode:false,throwOnError:false});$ are coupled field variables specified in "coupled_variables", and $var element = document.getElementById("moose-equation-c7c6719d-15fa-4bd0-9b4c-cd695cccd54f");katex.render("x", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-77da2cad-9425-46fe-b3cd-59ac877454f7");katex.render("y", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-12400996-5f20-4627-840e-5a39f0601efb");katex.render("z", element, {displayMode:false,throwOnError:false});$ , and $var element = document.getElementById("moose-equation-cc1ea184-9738-45fe-916f-3f634dae7246");katex.render("t", element, {displayMode:false,throwOnError:false});$ are coordinates used if "use_xyzt" is true.

Example Input File Syntax

This is an example that defines the following expression:

var element = document.getElementById("moose-equation-3ae74f17-e1eb-4375-88dc-d9c8541d88b8");katex.render("\\texttt{sum} = \\sum_{i=1}^n\\texttt{parsed}_i = \\sum_{i=1}^n(\\texttt{u}_i^2 + \\texttt{v}_i)(x - \\texttt{const})\\pi", element, {displayMode:true,throwOnError:false});

[AuxKernels]
  [parsed_aux]
    type = ArrayParsedAux
    variable = parsed
    expression = '(u^2 + v)*(x - const)*factor'
    coupled_array_variables = 'u v'
    coupled_variables = const
    constant_names = 'factor'
    constant_expressions = '3.14'
    use_xyzt = true
  []
  [sum_aux]
    type = ArrayVarReductionAux
    variable = sum
    array_variable = parsed
  []
[]

Input Parameters

expressionParsed function expression to compute
C++ Type:FunctionExpression
Unit:(no unit assumed)
Controllable:No
Description:Parsed function expression to compute
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
constant_expressionsVector of values for the constants in constant_names (can be an FParser expression)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Vector of values for the constants in constant_names (can be an FParser expression)
constant_namesVector of constants used in the parsed function (use this for kB etc.)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Vector of constants used in the parsed function (use this for kB etc.)
coupled_array_variablesVector of coupled array variable names.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of coupled array variable names.
coupled_variablesVector of coupled variable names.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of coupled variable names.
epsilon1e-12Fuzzy comparison tolerance
Default:1e-12
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Fuzzy comparison tolerance
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.
use_xyztFalseMake coordinate (x,y,z) and time (t) variables available in the function expression.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Make coordinate (x,y,z) and time (t) variables available in the function expression.

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

disable_fpoptimizerFalseDisable the function parser algebraic optimizer
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Disable the function parser algebraic optimizer
enable_ad_cacheTrueEnable caching of function derivatives for faster startup time
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Enable caching of function derivatives for faster startup time
enable_auto_optimizeTrueEnable automatic immediate optimization of derivatives
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Enable automatic immediate optimization of derivatives
enable_jitTrueEnable just-in-time compilation of function expressions for faster evaluation
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Enable just-in-time compilation of function expressions for faster evaluation
evalerror_behaviornanWhat to do if evaluation error occurs. Options are to pass a nan, pass a nan with a warning, throw a error, or throw an exception
Default:nan
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:nan, nan_warning, error, exception
Controllable:No
Description:What to do if evaluation error occurs. Options are to pass a nan, pass a nan with a warning, throw a error, or throw an exception

Parsed Expression Advanced Parameters

(moose/test/tests/auxkernels/array_parsed_aux/array_parsed_aux.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 10
  []
[]

[Variables]
  [u]
    components = 2
  []
  [v]
    components = 2
  []
[]

[AuxVariables]
  [const]
    initial_condition = 0.5
  []
  [parsed]
    components = 2
  []
  [sum]
  []
[]

[Functions]
  [cosx]
    type = ParsedFunction
    expression = 'cos(x)'
  []
  [sinx]
    type = ParsedFunction
    expression = 'sin(x)'
  []
  [px]
    type = ParsedFunction
    expression = 'x'
  []
  [mx]
    type = ParsedFunction
    expression = '-x'
  []
[]

[ICs]
  [uic]
    type = ArrayFunctionIC
    variable = u
    function = 'cosx sinx'
  []
  [vic]
    type = ArrayFunctionIC
    variable = v
    function = 'px mx'
  []
[]

[AuxKernels]
  [parsed_aux]
    type = ArrayParsedAux
    variable = parsed
    expression = '(u^2 + v)*(x - const)*factor'
    coupled_array_variables = 'u v'
    coupled_variables = const
    constant_names = 'factor'
    constant_expressions = '3.14'
    use_xyzt = true
  []
  [sum_aux]
    type = ArrayVarReductionAux
    variable = sum
    array_variable = parsed
  []
[]

[Postprocessors]
  [avg]
    type = ElementAverageValue
    variable = sum
  []
[]

[Outputs]
  exodus = true
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

Overview
Example Input File Syntax
Input Parameters