- functionThe analytic solution to compare against
C++ Type:FunctionName
Description:The analytic solution to compare against
- variableThe name of the scalar variable
C++ Type:VariableName
Description:The name of the scalar variable
ScalarL2Error
The ScalarL2Error has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
# ScalarL2Error
!syntax description /Postprocessors/ScalarL2Error
## Overview
!! Replace these lines with information regarding the ScalarL2Error object.
## Example Input File Syntax
!! Describe and include an example of how to use the ScalarL2Error object.
!syntax parameters /Postprocessors/ScalarL2Error
!syntax inputs /Postprocessors/ScalarL2Error
!syntax children /Postprocessors/ScalarL2Error
Compute L2 error of a scalar variable using analytic function.
Input Parameters
- execute_onTIMESTEP_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: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.
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
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>
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.
- force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
Default:False
C++ Type:bool
Description:Forces the GeneralUserObject to be executed in PREAUX
- force_preicFalseForces the GeneralUserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Description:Forces the GeneralUserObject to be executed in PREIC during initial setup
- outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
- 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
Input Files
- (test/tests/kernels/ode/ode_sys_impl_test.i)
- (examples/ex18_scalar_kernel/ex18_parsed.i)
- (test/tests/time_integrators/scalar/scalar.i)
- (test/tests/time_integrators/scalar/stiff.i)
- (modules/tensor_mechanics/test/tests/global_strain/global_strain_hydrostat.i)
- (test/tests/kernels/ode/parsedode_sys_impl_test.i)
- (examples/ex18_scalar_kernel/ex18.i)
- (test/tests/kernels/ode/parsedode_pp_test.i)
- (test/tests/tag/scalar_tag_vector.i)
- (test/tests/time_integrators/explicit_ssp_runge_kutta/explicit_ssp_runge_kutta.i)