TimeGUI:

Path: Common/GUIs

% A GUI displaying the time remaining and estimated completion time.
 Useful for simulations and other slow tasks.
 Computes the time left to go in the simulation, the predicted finish
 time and the ratio of simulation time to real time. This routine
 should be called at regular intervals. It will update the GUI no faster 
 then 5 times a second to prevent the graphics from slowing down the
 simulation.

 Type TimeGUI( 'close' ) to close the GUI.

 See also TimeGUIDemo.

 Since version 2.
--------------------------------------------------------------------------
   Form:
   [ rRT, tToGoMem, tToGo, tDone ] = TimeGUI( totalSteps, stepsDone, tToGoMem, rRT, dT, name )
--------------------------------------------------------------------------

   ------
   Inputs
   ------
   totalSteps             Total number of steps in the simulation
   stepsDone              Number of steps completed
   tToGoMem               Memory [lastJD, lastStepsDone, number of averages done]
   rRT                    Ratio of simulation time to real time
   dT                     Simulation time step (sec) 
   name                   Name of simulation          

   -------
   Outputs
   -------
   rRT                    Ratio of simulation time to real time
   tToGoMem               Memory [lastJD, lastStepsDone, number of averages done]
   tToGo                  Time left in the simulation
   tDone                  Predicted clock time of finish

--------------------------------------------------------------------------

Children:

Common: General/CloseIfHandle

Back to the Common Module page