AnalyticalIndicator

under construction:Undocumented Class

The AnalyticalIndicator has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Adaptivity/Indicators/AnalyticalIndicator

Input Parameters

  • functionThe analytic solution to compare against

    C++ Type:FunctionName

    Options:

    Description:The analytic solution to compare against

  • variableThe name of the variable that this Indicator operates on

    C++ Type:VariableName

    Options:

    Description:The name of the variable that this Indicator operates on

Required Parameters

  • blockANY_BLOCK_ID block ID or name where the object works

    Default:ANY_BLOCK_ID

    C++ Type:std::vector

    Options:

    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

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    Options:

    Description:Determines whether this object is calculated using an implicit or explicit form

  • 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

    Options:

    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.

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

    C++ Type:std::vector

    Options:

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

Advanced Parameters

Input Files

References