Skip to main content
Ctrl+K

PyGPE 2.0.0 documentation

  • Starter Guide
  • API Reference
  • Starter Guide
  • API Reference

Section Navigation

  • The Grid class
    • pygpe.shared.grid.Grid
  • Condensate and time parameters
  • Wavefunction
    • Scalar BEC wavefunction
      • pygpe.scalar.wavefunction.ScalarWavefunction
      • pygpe.scalar.wavefunction.ScalarWavefunction.set_wavefunction
      • pygpe.scalar.wavefunction.ScalarWavefunction.add_noise
      • pygpe.scalar.wavefunction.ScalarWavefunction.apply_phase
      • pygpe.scalar.wavefunction.ScalarWavefunction.fft
      • pygpe.scalar.wavefunction.ScalarWavefunction.ifft
      • pygpe.scalar.wavefunction.ScalarWavefunction.density
    • Two-component BEC wavefunction
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction.set_wavefunction
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction.add_noise
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction.apply_phase
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction.fft
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction.ifft
      • pygpe.spinhalf.wavefunction.SpinHalfWavefunction.density
    • Spin-1 BEC wavefunction
      • pygpe.spinone.wavefunction.SpinOneWavefunction
      • pygpe.spinone.wavefunction.SpinOneWavefunction.set_ground_state
      • pygpe.spinone.wavefunction.SpinOneWavefunction.set_wavefunction
      • pygpe.spinone.wavefunction.SpinOneWavefunction.add_noise
      • pygpe.spinone.wavefunction.SpinOneWavefunction.apply_phase
      • pygpe.spinone.wavefunction.SpinOneWavefunction.fft
      • pygpe.spinone.wavefunction.SpinOneWavefunction.ifft
      • pygpe.spinone.wavefunction.SpinOneWavefunction.density
    • Spin-2 BEC wavefunction
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.set_ground_state
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.set_wavefunction
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.add_noise
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.apply_phase
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.fft
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.ifft
      • pygpe.spintwo.wavefunction.SpinTwoWavefunction.density
  • Evolution functions
    • Scalar BEC evolution functions
      • pygpe.scalar.evolution.step_wavefunction
    • Two-component BEC evolution functions
      • pygpe.spinhalf.evolution.step_wavefunction
    • Spin-1 BEC evolution functions
      • pygpe.spinone.evolution.step_wavefunction
    • Spin-2 BEC evolution functions
      • pygpe.spinone.evolution.step_wavefunction
  • The DataManager class
    • Scalar BEC DataManager
      • pygpe.scalar.data_manager.DataManager
      • pygpe.scalar.data_manager.DataManager.save_wavefunction
    • Two-component BEC DataManager
      • pygpe.spinhalf.data_manager.DataManager
      • pygpe.spinhalf.data_manager.DataManager.save_wavefunction
    • Spin-1 BEC DataManager
      • pygpe.spinone.data_manager.DataManager
      • pygpe.spinone.data_manager.DataManager.save_wavefunction
    • Spin-2 BEC DataManager
      • pygpe.spintwo.data_manager.DataManager
      • pygpe.spintwo.data_manager.DataManager.save_wavefunction
  • Vortices
    • pygpe.shared.vortices.vortex_phase_profile
  • PyGPE API Reference
  • Wavefunction

Wavefunction#

PyGPE provides a wavefunction class for use in simulating BEC dynamics. The class aims to encapsulate all the details of the wavefunction in one object. There are subtle differences between the wavefunction classes for different BEC types, see below for further details

  • Scalar BEC wavefunction
  • Two-component BEC wavefunction
  • Spin-1 BEC wavefunction
  • Spin-2 BEC wavefunction

previous

Condensate and time parameters

next

Scalar BEC wavefunction

Show Source

© Copyright 2024, Matt Wheeler.

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.15.1.