gpe.gpu.bec
===========

.. py:module:: gpe.gpu.bec

.. autoapi-nested-parse::

   GPU versions of the code.

   Requires cupy and the various NVIDIA dependencies.



Attributes
----------

.. autoapisummary::

   gpe.gpu.bec.u


Classes
-------

.. autoapisummary::

   gpe.gpu.bec.StateBase


Module Contents
---------------

.. py:data:: u

.. py:class:: StateBase(basis=None, Nxyz=(2**5, 2**5, 2**5), Lxyz=(30 * u.micron, 50 * u.micron, 50 * u.micron), symmetric_grid=False, twist=None, **kw)

   Bases: :py:obj:`pytimeode.mixins_gpu.GPUArrayStateMixin`, :py:obj:`gpe.bec.StateBase`


   Mixin providing support for states with a single GPU data array.


   .. py:attribute:: xp


   .. py:attribute:: asnumpy


   .. py:method:: init()

      Initialize the state.

      This method defines the basis positions, momenta, etc. for use later
      on.  We define these here rather than in the constructor `__init__()`
      so that the user can change them later and the reinitialize the state.
      We also call this function from the `pre_evolve_hook()` so that it is
      called before any evolution takes place.  For this reason, we should
      not modify the state here.



   .. py:method:: get_metric_GPU()