dedalus.core.coords
===================

.. py:module:: dedalus.core.coords

.. autoapi-nested-parse::

   Coordinates and coordinate sytems.





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

.. py:class:: CartesianCoordinates(*names, right_handed=True)



   .. py:method:: backward_vector_intertwiner(subaxis, group)


   .. py:method:: forward_vector_intertwiner(subaxis, group)


   .. py:method:: unit_vector_fields(dist)


   .. py:attribute:: coords


   .. py:attribute:: curvilinear
      :value: False



   .. py:attribute:: default_nonconst_groups
      :value: ()



   .. py:attribute:: dim
      :value: 0



   .. py:attribute:: names
      :value: ()



.. py:class:: Coordinate(name, cs=None)



   .. py:method:: backward_vector_intertwiner(subaxis, group)


   .. py:method:: check_bounds(bounds)


   .. py:method:: forward_vector_intertwiner(subaxis, group)


   .. py:attribute:: coords


   .. py:attribute:: cs
      :value: None



   .. py:attribute:: curvilinear
      :value: False



   .. py:attribute:: default_nonconst_groups
      :value: (1,)



   .. py:attribute:: dim
      :value: 1



   .. py:attribute:: name


.. py:class:: DirectProduct(*coordsystems, right_handed=None)



   .. py:method:: backward_vector_intertwiner(subaxis, group)


   .. py:method:: curvilinear()


   .. py:method:: default_nonconst_groups()


   .. py:method:: forward_vector_intertwiner(subaxis, group)


   .. py:method:: subaxis_by_cs()


   .. py:attribute:: coords


   .. py:attribute:: coordsystems
      :value: ()



   .. py:attribute:: dim


.. py:class:: PolarCoordinates(azimuth, radius)



   Polar coordinate system: (azimuth, radius)
   Coord component ordering: (azimuth, radius)
   Spin component ordering: (-, +)


   .. py:method:: backward_vector_intertwiner(subaxis, group)


   .. py:method:: cartesian(phi, r)
      :staticmethod:



   .. py:method:: forward_vector_intertwiner(subaxis, group)


   .. py:attribute:: azimuth


   .. py:attribute:: coords


   .. py:attribute:: default_nonconst_groups
      :value: (0, 0)



   .. py:attribute:: dim
      :value: 2



   .. py:attribute:: names


   .. py:attribute:: radius


   .. py:attribute:: spin_ordering


.. py:class:: S2Coordinates(azimuth, colatitude)



   S2 coordinate system: (azimuth, colatitude)
   Coord component ordering: (azimuth, colatitude)
   Spin component ordering: (-, +)


   .. py:method:: backward_vector_intertwiner(subaxis, group)


   .. py:method:: forward_vector_intertwiner(subaxis, group)


   .. py:attribute:: azimuth


   .. py:attribute:: colatitude


   .. py:attribute:: coords


   .. py:attribute:: default_nonconst_groups
      :value: (0, 1)



   .. py:attribute:: dim
      :value: 2



   .. py:attribute:: names


   .. py:attribute:: spin_ordering


.. py:class:: SphericalCoordinates(azimuth, colatitude, radius)



   Spherical coordinate system: (azimuth, colatitude, radius)
   Coord component ordering: (azimuth, colatitude, radius)
   Spin component ordering: (-, +, 0)
   Regularity component ordering: (-, +, 0)


   .. py:method:: backward_intertwiner(subaxis, order, group)


   .. py:method:: cartesian(phi, theta, r)
      :staticmethod:



   .. py:method:: check_bounds(coord, bounds)


   .. py:method:: forward_intertwiner(subaxis, order, group)


   .. py:method:: sub_cs(other)


   .. py:attribute:: S2coordsys


   .. py:attribute:: azimuth


   .. py:attribute:: colatitude


   .. py:attribute:: coords


   .. py:attribute:: default_nonconst_groups
      :value: (0, 1, 0)



   .. py:attribute:: dim
      :value: 3



   .. py:attribute:: names


   .. py:attribute:: radius


   .. py:attribute:: reg_ordering


   .. py:attribute:: right_handed
      :value: False



   .. py:attribute:: spin_ordering