marge3d.fields
==============

.. py:module:: marge3d.fields

.. autoapi-nested-parse::

   The 3D velocity field here is (-y, x, 0). This is just the 2D vortex taken along z direction.



Classes
-------

.. autoapisummary::

   marge3d.fields.VelocityField3D
   marge3d.fields.velocity_field_3d_nondim
   marge3d.fields.velocity_field_3d_oscillatory


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

.. py:class:: VelocityField3D(omega)

   .. py:attribute:: omega


   .. py:attribute:: limits
      :value: False



   .. py:attribute:: periodic
      :value: False



   .. py:method:: get_velocity(x, y, z, t)


   .. py:method:: get_gradient(x, y, z, t)


   .. py:method:: get_dudt(x, y, z, t)


.. py:class:: velocity_field_3d_nondim(omega, char_vel, char_time)

   .. py:attribute:: char_vel


   .. py:attribute:: char_time


   .. py:attribute:: char_len


   .. py:attribute:: omega


   .. py:attribute:: limits
      :value: False



   .. py:attribute:: periodic
      :value: False



   .. py:method:: get_velocity(x, y, z, t)


   .. py:method:: get_gradient(x, y, z, t)


   .. py:method:: get_dudt(x, y, z, t)


.. py:class:: velocity_field_3d_oscillatory

   .. py:attribute:: limits
      :value: False



   .. py:attribute:: periodic
      :value: False



   .. py:method:: get_velocity(x, y, z, t)


   .. py:method:: get_gradient(x, y, z, t)


   .. py:method:: get_dudt(x, y, z, t)