LogConstantDT

Sets the time step so that it is constant in the logarithmic space. The initial time step must be set up independently.

TimeStepper which imposes a time step constant in the logarithmic space

Input Parameters

  • first_dtInitial time step (in absolute time)

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial time step (in absolute time)

  • log_dtTime step in log10(time)

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time step in log10(time)

Required Parameters

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

    Default:0.5

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

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

  • growth_factor2Maximum ratio of new to previous timestep sizes following a step that required the time step to be cut due to a failed solve.

    Default:2

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Maximum ratio of new to previous timestep sizes following a step that required the time step to be cut due to a failed solve.

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

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

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

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

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

  • enableTruewhether or not to enable the time stepper

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:Yes

    Description:whether or not to enable the time stepper

Advanced Parameters