torchgpe.bec2D.gas.Gas.propagate#

Gas.propagate(final_time, time_step=1e-06, potentials=[], callbacks=[], leave_progress_bar=True)[source]#

Propagate the wave function in real time.

Use the split-step Fourier method with real time propagation (RTP) to propagate the gas wave function to final_time. The potentials acting on the system are specified via the potentials parameter.

Note

The time step is adjusted such that final_time is always reached.

Parameters:
  • final_time (float) – The final time up to which the wave function whould be propagated.

  • time_step (float) – Optional. The time step to be used in the RTP. Defaults to \(10^{-6}\).

  • potentials (List[Potential]) – Optional. The list of potentials acting on the system. Defaults to [].

  • callbacks (List[Callback]) – Optional. List of callbacks to be evaluated during the evolution. Defaults to [].

  • leave_progress_bar (bool) – Optional. Whether to leave the progress bar on screen after the propagation ends. Defaults to True.

Raises:
  • Exception – If the time step is not a floating point number

  • Exception – If the time step is not positive

  • Exception – If neither the wave function in real space nor in the one in momentum space have been initialized