ElementL2ErrorFunctionAux

A class for computing the element-wise error (actually error, if you set the value of p to something other than 2) of the difference between an exact solution (typically represented by a ParsedFunction) and the coupled solution variable. The base class implements the compute() function.

Example syntax


[./l2_error_aux]
  type = ElementL2ErrorFunctionAux
  variable = element_l2_error
  # A function representing the exact solution for the solution
  function = exact_fn
  # The nonlinear variable representing the FEM solution
  coupled_variable = u
[../]
(../moose/test/tests/auxkernels/error_function_aux/error_function_aux.i)

A class for computing the element-wise L^2 (Euclidean) error between a function and a coupled variable.

Input Parameters

  • functionFunction representing the exact solution

    C++ Type:FunctionName

    Description:Function representing the exact solution

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Description:The name of the variable that this object applies to

  • coupled_variableThe variable to compute the norm of.

    C++ Type:std::vector

    Description:The variable to compute the norm of.

Required Parameters

  • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Description:The list of block ids (SubdomainID) that this object will be applied

  • p2The exponent used in the norm.

    Default:2

    C++ Type:double

    Description:The exponent used in the norm.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    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

    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