marge3d.numeric
===============

.. py:module:: marge3d.numeric

.. autoapi-nested-parse::

   TODO : documentation ...



Classes
-------

.. autoapisummary::

   marge3d.numeric.NumericalSolver


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

.. py:class:: NumericalSolver(x, w, velocity_field, Nt, order, params=None, **kwargs)

   3D solver for the Maxey–Riley-Gatignol equation (MaRGE)
   using Daitche's Adams–Bashforth methods.

   :Parameters: * **x** (*array_like*) -- Initial particle position (3,)
                * **w** (*array_like*) -- Initial relative velocity (3,)
                * **velocity_field** (*object*) -- Must implement get_velocity, get_gradient, get_dudt
                * **Nt** (*int*) -- Number of time steps
                * **order** (*int*) -- Order of Daitche method (1, 2, or 3)
                * **params** (*DaitcheParameters*) -- Physical parameters of the particle–fluid system


   .. py:attribute:: x


   .. py:attribute:: w


   .. py:attribute:: vel


   .. py:attribute:: order


   .. py:method:: solve(t_v, flag=False)
      :abstractmethod:



   .. py:method:: calculate_G(w1, w2, w3, x, y, z, t)


   .. py:method:: alpha_jn(j, n)


   .. py:method:: alpha_v(N)


   .. py:method:: calc_alpha_mat(N)


   .. py:method:: Euler(t_v, flag=False)


   .. py:method:: beta_jn(j, n)


   .. py:method:: beta_v(N)


   .. py:method:: calc_beta_mat(N)


   .. py:method:: AdamBashf2(t_v, flag=False)


   .. py:method:: gamma_jn(j, n)


   .. py:method:: gamma_v(N)


   .. py:method:: calc_gamma_mat(N)


   .. py:method:: AdamBashf3(t_v, flag=False)