- functionThe analytic solution to compare against
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The analytic solution to compare against
- variableThe name of the variable that this Indicator operates on
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this Indicator operates on
AnalyticalDiffIndicator
Returns the difference between the function of the analytic solution vs the computed solution
Overview
The AnalyticalDiffIndicator object computes the raw difference between a solution variable and a known function.
For more information about the Indicators System within MOOSE, please see the Indicators System page.
warningwarning:Untested Class
The AnalyticalDiffIndicator object does not have a formalized test, yet. For this reason, users should beware of unforeseen bugs when using AnalyticalDiffIndicator. To report a bug or discuss future contributions to Zapdos, please refer to the Zapdos GitHub Discussions page. For standards on how to contribute to Zapdos and the MOOSE framework, please refer to the MOOSE Contributing page.
Example Input File Syntax
[Adaptivity]
[Indicators]
[diff]
type = AnalyticalDiffIndicator
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
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
- 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
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.