- timesThe name of the Times object containing the times to hit during the simulation
C++ Type:TimesName
Unit:(no unit assumed)
Controllable:No
Description:The name of the Times object containing the times to hit during the simulation
TimeSequenceFromTimes
Solves the Transient problem at a sequence of time points taken from a specified Times object.
The time sequence of times to hit is retrieved every time the time stepper is asked to step in time. This lets the times to hit evolve dynamically if the times in the Times object are changing.
Input 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.
- 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.
- use_last_dt_after_last_tFalseIf true, uses the final time step size for times after the last time in the sequence, instead of taking a single step directly to the simulation end time
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If true, uses the final time step size for times after the last time in the sequence, instead of taking a single step directly to the simulation end time
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