syscdotimestepf Interface Reference

Provide a function to check whether to do a coupling time step.

This function should be called to check if another coupling time step should be done. If the previous coupling time step is finished and another time step should be performed, then calling this function will tell System Coupling that the coupling participant is going to advance to the next time step (i.e. calling syscDoTimeStepF() will cause syscDoIterationF() to change from returning false to returning true, under the conditions described above).

This function only makes sense for transient analysis. It will always return false for steady analysis.

Returns

true if another coupling time step is required, otherwise it returns false.

Definition at line 681 of file syscSystemCouplingF.fi.