- functionThe analytic solution to compare against
C++ Type:FunctionName
Controllable:No
Description:The analytic solution to compare against
- variableThe name of the variable that this Indicator operates on
C++ Type:VariableName
Controllable:No
Description:The name of the variable that this Indicator operates on
AnalyticalIndicator
Compute the square of the error as the difference between an unknown variable and an analytical solution.
Description
The AnalyticalIndicator object computes the difference between a solution variable and a known function. As the name suggests it is designed for computing the analytical error, but in practice this indicator is used for debugging and verification applications.
Example Input File Syntax
The following example demonstrates the creation of an AnalyticalIndicator object within an input file that uses a ParsedFunction object for computing the known solution.
[Functions]
[solution]
type = ParsedFunction
expression = (exp(x)-1)/(exp(1)-1)
[]
[]
[Adaptivity]
[Indicators]
[error]
type = AnalyticalIndicator
variable = u
function = solution
[]
[]
[]
Input Parameters
- blockANY_BLOCK_ID block ID or name where the object works
Default:ANY_BLOCK_ID
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:block ID or name where the object works
- 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.
Optional Parameters
- 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:No
Description:Set the enabled status of the MooseObject.
- 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
- 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
- (test/tests/markers/error_tolerance_marker/error_tolerance_marker_test.i)
- (test/tests/indicators/analytical_indicator/analytical_indicator_test.i)
- (test/tests/markers/error_fraction_marker/error_fraction_marker_fv.i)
- (test/tests/markers/error_fraction_marker/error_fraction_marker_no_clear_test.i)
- (test/tests/markers/error_fraction_marker/error_fraction_marker_test.i)
- (test/tests/indicators/analytical_indicator/analytical_indicator_fv.i)
- (test/tests/markers/error_tolerance_marker/error_tolerance_marker_adapt_test.i)