:py:mod:`gnome.weatherers.manual_beaching`
==========================================

.. py:module:: gnome.weatherers.manual_beaching

.. autoapi-nested-parse::

   For Adios behavior with no trajectory processing and no map,
   we add beaching events manually.
   This class controls the manual addition of beaching events in our
   model run.
   It is modeled as a weathering process.



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

Classes
~~~~~~~

.. autoapisummary::

   gnome.weatherers.manual_beaching.Beaching




.. py:class:: Beaching(active_range, units='m^3', timeseries=None, water=None, **kwargs)


   Bases: :py:obj:`gnome.weatherers.cleanup.RemoveMass`, :py:obj:`gnome.weatherers.Weatherer`

   It isn't really a response/cleanup option; however, it works in the same
   manner in that Beaching removes mass at a user specified rate. Mixin the
   RemoveMass functionality.

   Initialization for the manual beaching events.

   :param timeseries: array containing the volume of oil beached at
       specified time. The time corresponds with end time of the beaching
       contains: [(t0, v0), (t1, v1), ..]
       Assumes the delta time (t1 - t0) is larger than model's time_step.

   .. note:: Assumes the model's
       time_step is smaller than the timeseries timestep, meaning the
   fixme: water is never used -- it should be removed.

   .. py:property:: timeseries


   .. py:property:: units


   .. py:attribute:: _schema

      

   .. py:method:: convert_to_internal_volume()


   .. py:method:: prepare_for_model_run(sc)

      Preparation of data arrays related to beaching


   .. py:method:: _remove_mass(time_step, model_time, substance)

      returns the mass to be removed over time interval:
          (model_time, model_time + time_step)

      .. note:: invoked by weather_elements only if object is active for
          the step.

      fixme: the conversion to mass should happen all at once when the
             timeseries is set. and it should use substance.standard_density



   .. py:method:: weather_elements(sc, time_step, model_time)

      remove equal fraction of mass from each component.