AdamsPredictor

under construction:Undocumented Class

The AdamsPredictor 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 /Executioner/Predictor/AdamsPredictor

Input Parameters

  • scaleThe scale factor for the predictor (can range from 0 to 1)

    C++ Type:double

    Options:

    Description:The scale factor for the predictor (can range from 0 to 1)

Required Parameters

  • skip_timesSkip the predictor if the current solution time is in this list of times

    C++ Type:std::vector

    Options:

    Description:Skip the predictor if the current solution time is in this list of times

  • skip_times_oldSkip the predictor if the previous solution time is in this list of times

    C++ Type:std::vector

    Options:

    Description:Skip the predictor if the previous solution time is in this list of times

  • order2The maximum reachable order of the Adams-Bashforth Predictor

    Default:2

    C++ Type:int

    Options:

    Description:The maximum reachable order of the Adams-Bashforth Predictor

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.

Advanced Parameters

References