gnome.tamoc.tamoc_spill
=======================

.. py:module:: gnome.tamoc.tamoc_spill

.. autoapi-nested-parse::

   tamoc_spill.py

   This file contains the definitions to create a TAMOC simulation in GNOME and
   run the simulation in a seemless integration with GNOME.



Classes
-------

.. autoapisummary::

   gnome.tamoc.tamoc_spill.TamocSpill


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

.. py:class:: TamocSpill(num_elements=1000, num_per_timestep=None, start_position=(0.0, 0.0, 1000.0), release_time=datetime.now(), release_rate=0.0, release_duration=timedelta(hours=1), units='bbl/day', substance=None, release=None, water=None, gor=None, d0=0.0, phi_0=-np.pi / 2.0, theta_0=0.0, windage_range=(0.01, 0.04), windage_persist=900, on=True, name=None, **kwargs)

   Bases: :py:obj:`gnome.spills.spill.Spill`


   Models a TAMOC spill by combining the near-field model with Release
   and Substance objects

   # This really should be based in a BaseSpill Class!


   Spills used by the gnome model.

   :param on=True: Whether this spill is turned on (used at run time)

   :param num_elements=1000: number of elements to use

   :param amount=0: Amount of the release -- can be volume or mass.
                    which is determined by the units
   :type amount: float (volume or mass)

   :param units: units of the amount: can be volume or mass, any units
                 supported by nucos. (e.g. tonnes, kg, bbl, gal, )
   :type units: str

   :param release: an object defining how elements are to be released
   :type release: derived from :class:`~gnome.spills.release.Release`

   :param substance: an object defining the substance of this spill. Defaults to
                     :class:`~gnome.spills.substance.NonWeatheringSubstance`
   :type substance: derived from :class:`~gnome.spills.substance.Substance`

   **Optional parameters:**

   :param name: Human-usable Name of this spill
   :type name: str

   :param amount_uncertainty_scale=0.0: scale value in range 0-1
                                        that adds uncertainty to the
                                        spill amount.
                                        Maximum uncertainty scale
                                        is (2/3) * spill_amount.
   :type amount_uncertainty_scale: float

   .. note::
       Define either volume or mass in 'amount' attribute and provide
       appropriate 'units'.


   .. py:attribute:: release_time
      :value: None



   .. py:attribute:: end_release_time
      :value: None



   .. py:attribute:: start_position
      :value: None



   .. py:attribute:: num_elements
      :value: None



   .. py:property:: substance


   .. py:attribute:: release_mass


   .. py:attribute:: release
      :value: None



   .. py:attribute:: frac_coverage
      :value: 1.0



   .. py:method:: rewind()

      rewinds the release to original status (before anything has been
      released).