pygpe.spinone.wavefunction.SpinOneWavefunction

class pygpe.spinone.wavefunction.SpinOneWavefunction(grid)

Represents the spin-1 BEC wavefunction. This class contains the wavefunction arrays, in addition to various useful functions for manipulating and using the wavefunction.

Parameters:

grid (Grid) – The numerical grid.

Variables:

• plus_component – The real-space plus component array.

• zero_component – The real-space zero component array.

• minus_component – The real-space minus component array.

• fourier_plus_component – The Fourier-space plus component array.

• fourier_zero_component – The Fourier-space zero component array.

• fourier_minus_component – The Fourier-space minus component array.

• atom_num_plus – The atom number of the plus component.

• atom_num_zero – The atom number of the zero component.

• atom_num_minus – The atom number of the minus component.

• grid – A reference to the grid object of the simulation.

__init__(grid)

Constructs the wavefunction object.

Methods

__init__(grid)	Constructs the wavefunction object.
add_noise(components, mean, std_dev)	Adds noise to the specified wavefunction components using a normal distribution.
apply_phase(phase[, components])	Applies a phase to specified components.
density()	Returns an array of the total condensate density.
fft()	Fourier transforms real-space components and updates Fourier-space components.
ifft()	Inverse Fourier transforms Fourier-space components and updates real-space components.
set_ground_state(ground_state, params)	Sets the components of the wavefunction according to the ground state we wish to be in.
set_wavefunction([plus_component, ...])	Sets the wavefunction components to the specified arrays.