AB2PredictorCorrector

under construction:Undocumented Class

The AB2PredictorCorrector 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.


# AB2PredictorCorrector

!syntax description /Executioner/TimeStepper/AB2PredictorCorrector

## Overview

!! Replace these lines with information regarding the AB2PredictorCorrector object.

## Example Input File Syntax

!! Describe and include an example of how to use the AB2PredictorCorrector object.

!syntax parameters /Executioner/TimeStepper/AB2PredictorCorrector

!syntax inputs /Executioner/TimeStepper/AB2PredictorCorrector

!syntax children /Executioner/TimeStepper/AB2PredictorCorrector

!syntax description /Executioner/TimeStepper/AB2PredictorCorrector

Input Parameters

  • dtInitial time step size

    C++ Type:double

    Options:

    Description:Initial time step size

  • e_maxMaximum acceptable error.

    C++ Type:double

    Options:

    Description:Maximum acceptable error.

  • e_tolTarget error tolerance.

    C++ Type:double

    Options:

    Description:Target error tolerance.

Required Parameters

  • cutback_factor_at_failure0.5Factor to apply to timestep if it a time step fails to convergence.

    Default:0.5

    C++ Type:double

    Options:

    Description:Factor to apply to timestep if it a time step fails to convergence.

  • max_increase1e+09Maximum ratio that the time step can increase.

    Default:1e+09

    C++ Type:double

    Options:

    Description:Maximum ratio that the time step can increase.

  • reset_dtFalseUse when restarting a calculation to force a change in dt.

    Default:False

    C++ Type:bool

    Options:

    Description:Use when restarting a calculation to force a change in dt.

  • scaling_parameter0.8scaling parameter for dt selection

    Default:0.8

    C++ Type:double

    Options:

    Description:scaling parameter for dt selection

  • start_adapting2when to start taking adaptive time steps

    Default:2

    C++ Type:int

    Options:

    Description:when to start taking adaptive time steps

  • steps_between_increase1the number of time steps before recalculating dt

    Default:1

    C++ Type:int

    Options:

    Description:the number of time steps before recalculating dt

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

Input Files