utopia.objects.compartment_classes
==================================

.. py:module:: utopia.objects.compartment_classes


Classes
-------

.. autoapisummary::

   utopia.objects.compartment_classes.Compartment
   utopia.objects.compartment_classes.compartment_water
   utopia.objects.compartment_classes.compartment_surfaceSea_water
   utopia.objects.compartment_classes.compartment_sediment
   utopia.objects.compartment_classes.compartment_soil_surface
   utopia.objects.compartment_classes.compartment_deep_soil
   utopia.objects.compartment_classes.compartment_air


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

.. py:class:: Compartment(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)

   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: Cname


   .. py:attribute:: Cdepth_m
      :value: None



   .. py:attribute:: Clength_m
      :value: None



   .. py:attribute:: Cwidth_m
      :value: None



   .. py:attribute:: Cvolume_m3
      :value: None



   .. py:attribute:: CsurfaceArea_m2
      :value: None



   .. py:attribute:: particles


   .. py:attribute:: processess
      :value: ['degradation', 'fragmentation', 'heteroaggregation', 'heteroaggregate_breackup', 'biofouling',...



   .. py:attribute:: connexions
      :value: []



   .. py:method:: assign_box(Box)


   .. py:method:: add_particles(particle)


   .. py:method:: calc_volume()


   .. py:method:: calc_vol_fromBox()


   .. py:method:: calc_particleConcentration_Nm3_initial()


.. py:class:: compartment_water(Cname, SPM_mgL, waterFlow_m3_s, T_K, G, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None, flowVelocity_m_s=None)

   Bases: :py:obj:`Compartment`


   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: SPM_mgL


   .. py:attribute:: flowVelocity_m_s
      :value: None



   .. py:attribute:: waterFlow_m3_s


   .. py:attribute:: T_K


   .. py:attribute:: G


   .. py:attribute:: processess
      :value: ['discorporation', 'fragmentation', 'heteroaggregation', 'heteroaggregate_breackup',...



.. py:class:: compartment_surfaceSea_water(Cname, SPM_mgL, waterFlow_m3_s, T_K, G, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None, flowVelocity_m_s=None)

   Bases: :py:obj:`Compartment`


   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: SPM_mgL


   .. py:attribute:: flowVelocity_m_s
      :value: None



   .. py:attribute:: waterFlow_m3_s


   .. py:attribute:: T_K


   .. py:attribute:: G


   .. py:attribute:: processess
      :value: ['discorporation', 'fragmentation', 'heteroaggregation', 'heteroaggregate_breackup',...



.. py:class:: compartment_sediment(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)

   Bases: :py:obj:`Compartment`


   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: processess
      :value: ['discorporation', 'fragmentation', 'sediment_resuspension', 'burial']



.. py:class:: compartment_soil_surface(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)

   Bases: :py:obj:`Compartment`


   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: processess
      :value: ['discorporation', 'fragmentation', 'runoff_transport', 'percolation', 'soil_air_resuspension',...



.. py:class:: compartment_deep_soil(Cname, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None)

   Bases: :py:obj:`Compartment`


   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: processess
      :value: ['discorporation', 'fragmentation', 'sequestration_deep_soils', 'soil_convection']



.. py:class:: compartment_air(Cname, T_K=None, wind_speed_m_s=None, I_rainfall_mm=None, Cdepth_m=None, Clength_m=None, Cwidth_m=None, Cvolume_m3=None, CsurfaceArea_m2=None, flowVelocity_m_s=None)

   Bases: :py:obj:`Compartment`


   Class Compartment (parent class) generates compartment objects that belong by default to an assigned model box (Cbox). Each compartment contains four different particle objects corresponding to the 4 described aggregation states of UTOPIA (freeMP, heterMP, biofMP, heterBiofMP) and the processes that can occur in the compartment are listed under the processess attribute. Each compartment has a set of connexions withing the UTOPIA box listed in the conexions attribute wich will be asigned by reading on the conexions input file of the model.


   .. py:attribute:: T_K
      :value: None



   .. py:attribute:: wind_speed_m_s
      :value: None



   .. py:attribute:: I_rainfall_mm
      :value: None



   .. py:attribute:: flowVelocity_m_s
      :value: None



   .. py:attribute:: processess
      :value: ['discorporation', 'fragmentation', 'wind_trasport', 'dry_deposition', 'wet_deposition']