ElementVectorL2Error

Returns the L2-norm of the difference between a pair of computed and analytical vector-valued solutions.

Overview

The L2-error between a vector-valued solution and a known vector-valued function is written

where denotes the l2-norm in .

The user can specify with either a single nonlinear vector variable, or with up to three nonlinear scalar variables simultaneously, which would each typically represent the x, y, z components of the vector variable.

Likewise, the user can also specify with either a single Function object defining the vectorValue method, e.g. ParsedVectorFunction, or up to three such objects defining the value method, e.g. ParsedFunction.

Example Input File Syntax

With a single nonlinear vector variable and a single vector-valued function:

[Postprocessors]
  [L2Error]
    type = ElementVectorL2Error
    variable = u
    function = f
  []
[]
(test/tests/kernels/vector_fe/coupled_electrostatics.i)

With component-wise specifications for both the nonlinear variable and the function:

[./integral]
  type = ElementVectorL2Error
  var_x = u
  var_y = v
  function_x = bc_u
  function_y = bc_v
  execute_on = 'initial timestep_end'
[../]
(test/tests/postprocessors/element_vec_l2_error_pps/element_vec_l2_error.i)

Input 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

  • 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, POSTCHECK, 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, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

    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, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

  • function0The vector analytical solution to compare against

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:The vector analytical solution to compare against

  • function_x0The analytical solution to compare against in the x direction

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:The analytical solution to compare against in the x direction

  • function_y0The analytical solution to compare against in the y direction

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:The analytical solution to compare against in the y direction

  • function_z0The analytical solution to compare against in the z direction

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:The analytical solution to compare against in the z direction

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

  • var_xThe FE solution in the x direction

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

    Controllable:No

    Description:The FE solution in the x direction

  • var_yThe FE solution in the y direction

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

    Controllable:No

    Description:The FE solution in the y direction

  • var_zThe FE solution in the z direction

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

    Controllable:No

    Description:The FE solution in the z direction

  • variableThe vector FE solution

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

    Controllable:No

    Description:The vector FE solution

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

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

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

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • 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

Input Files

Child Objects