Scalar BEC wavefunction

The scalar BEC wavefunction class contains the wavefunction array plus an assortment of useful functions for manipulating and using the wavefunction.

Constructing the Wavefunction object is done through the constructor

ScalarWavefunction(grid)

Represents the scalar BEC wavefunction.

Here, the parameter grid is a Grid object defined prior to instantiating the Wavefunction class.

Wavefunction methods

Initial state

Below are the methods associated with the initial state.

ScalarWavefunction.set_wavefunction(wavefunction)	Sets the wavefunction to the specified state.
ScalarWavefunction.add_noise(mean, std_dev)	Adds noise to the wavefunction using a normal distribution.
ScalarWavefunction.apply_phase(phase, **kwargs)	Applies a phase to the wavefunction.

The set_wavefunction method is used to set the initial state to whatever we desire. The add_noise method adds noise to each grid point of the wavefunction where the noise is drawn from a uniform distribution with the mean and standard deviation specified in the function signature. Finally, apply_phase applies a user-defined phase to the wavefunction as \(\psi\rightarrow\psi e^{i\phi}\) for phase \(\phi\).

Other methods

The methods below fall under the miscellaneous category and are self-explanatory.

ScalarWavefunction.fft()	Fourier transforms real-space component and updates Fourier-space component.
ScalarWavefunction.ifft()	Inverse Fourier transforms Fourier-space component and updates real-space component.
ScalarWavefunction.density()	return: An array of the condensate density.

Attributes

See ScalarWavefunction for list of class attributes (variables).