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

.. py:module:: gnome.weatherers.emulsification

.. autoapi-nested-parse::

   model emulsification process



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

Classes
~~~~~~~

.. autoapisummary::

   gnome.weatherers.emulsification.Emulsification




.. py:class:: Emulsification(waves=None, **kwargs)


   Bases: :py:obj:`gnome.weatherers.Weatherer`

   Base Weathering agent.  This is almost exactly like the base Mover
   in the way that it acts upon the model.  It contains the same API
   as the mover as well. Not Serializable since it does is partial
   implementation

   :param conditions: gnome.environment.Conditions object which contains
       things like water temperature
   :param waves: waves object for obtaining emulsification wind speed at specified time
   :type waves: get_emulsification_wind(model_time)

   .. py:attribute:: _schema

      

   .. py:attribute:: _ref_as
      :value: 'emulsification'

      

   .. py:attribute:: _req_refs
      :value: ['waves']

      

   .. py:method:: prepare_for_model_run(sc)

      add water_content key to mass_balance
      Assumes all spills have the same type of oil


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

      Set/update arrays used by emulsification module for this timestep:



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

      weather elements over time_step
      - sets 'water_content' in sc.mass_balance


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

      weather elements over time_step
      - sets 'water_content' in sc.mass_balance


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

      weather elements over time_step
      - sets 'water_content' in sc.mass_balance


   .. py:method:: _H_log(k, x)

      logistic function for turning on emulsification


   .. py:method:: _H_4(k, x)

      symmetric function for turning on emulsification


   .. py:method:: _Bw(x_visc, x_sig_min, x_fasph, x_r, x_s)

              


   .. py:method:: _water_uptake_coeff(points, model_time, substance)

      Use higher of wind or pseudo wind corresponding to wave height

          if (H0 > 0) HU = 2.0286 * sqrt(g * H0)
          if (HU < 4.429) HU = pow(HU / .71, .813)
          if (U < HU) U = HU
          k_emul = 6.0 * K0Y * U * U / d_max