- scaleThe scale factor for the predictor (can range from 0 to 1)
C++ Type:double
Description:The scale factor for the predictor (can range from 0 to 1)
AdamsPredictor
under construction:Undocumented Class
The AdamsPredictor 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.
# AdamsPredictor
!syntax description /Executioner/Predictor/AdamsPredictor
## Overview
!! Replace these lines with information regarding the AdamsPredictor object.
## Example Input File Syntax
!! Describe and include an example of how to use the AdamsPredictor object.
!syntax parameters /Executioner/Predictor/AdamsPredictor
!syntax inputs /Executioner/Predictor/AdamsPredictor
!syntax children /Executioner/Predictor/AdamsPredictor
!syntax description /Executioner/Predictor/AdamsPredictor
Input Parameters
- order2The maximum reachable order of the Adams-Bashforth Predictor
Default:2
C++ Type:int
Description:The maximum reachable order of the Adams-Bashforth Predictor
- skip_timesSkip the predictor if the current solution time is in this list of times
C++ Type:std::vector
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
Description:Skip the predictor if the previous solution time is in this list of times
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
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.