pygpe.spintwo.wavefunction.SpinTwoWavefunction#

class pygpe.spintwo.wavefunction.SpinTwoWavefunction(grid)#

Represents the spin-2 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:

plus2_component – The real-space +2 component array.
plus1_component – The real-space +1 component array.
zero_component – The real-space 0 component array.
minus1_component – The real-space -1 component array.
minus2_component – The real-space -2 component array.
fourier_plus2_component – The Fourier-space +2 component array.
fourier_plus1_component – The Fourier-space +1 component array.
fourier_zero_component – The Fourier-space 0 component array.
fourier_minus1_component – The Fourier-space -1 component array.
fourier_minus2_component – The Fourier-space -2 component array.
atom_num_plus2 – The atom number of the +2 component.
atom_num_plus1 – The atom number of the +1 component.
atom_num_zero – The atom number of the 0 component.
atom_num_minus1 – The atom number of the -1 component.
atom_num_minus2 – The atom number of the -2 component.
grid – 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`([plus2_component, ...])	Sets the wavefunction components to the specified arrays.