torchgpe.bec2D.gas.Gas.ground_state#

Gas.ground_state(potentials=[], time_step=-0 - 1e-06j, N_iterations=1000, callbacks=[], leave_progress_bar=True)[source]#

Compute the ground state’s wave function.

Use the split-step Fourier method with imaginary time propagation (ITP) to compute the ground state’s wave function of the gas. The potentials acting on the system are specified via the potentials parameter.

Parameters:

potentials (List[Potential]) – Optional. The list of potentials acting on the system. Defaults to [].
time_step (complex) – Optional. The time step to be used in the ITP. Defaults to \(-10^{-6}\,i\).
N_iterations (int) – Optional. The number of steps of ITP to perform. Defaults to \(10^{3}\).
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 time dependent potentials are specified
Exception – If the time step is not a purely imaginary number
Exception – If the imaginary part of 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