utopia.objects.particulate_classes
==================================

.. py:module:: utopia.objects.particulate_classes


Classes
-------

.. autoapisummary::

   utopia.objects.particulate_classes.Particulates
   utopia.objects.particulate_classes.ParticulatesBF
   utopia.objects.particulate_classes.ParticulatesSPM


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

.. py:class:: Particulates(Pname, Pform, Pcomposition, Pdensity_kg_m3, Pshape, PdimensionX_um, PdimensionY_um, PdimensionZ_um, t_half_d=5000, Pnumber_t0=None)

   Class Particulates generates particulate objects, especifically microplastic particle objects. The class defines a particle object by its composition, shape and dimensions


   .. py:attribute:: Pname


   .. py:attribute:: Pform


   .. py:attribute:: Pcomposition


   .. py:attribute:: Pdensity_kg_m3


   .. py:attribute:: Pshape


   .. py:attribute:: PdimensionX_um


   .. py:attribute:: PdimensionY_um


   .. py:attribute:: PdimensionZ_um


   .. py:attribute:: PdimensionX_m


   .. py:attribute:: PdimensionY_m


   .. py:attribute:: PdimensionZ_m


   .. py:attribute:: Pnumber_t0
      :value: None



   .. py:attribute:: diameter_m


   .. py:attribute:: diameter_um


   .. py:attribute:: Pemiss_t_y
      :value: 0



   .. py:attribute:: t_half_d
      :value: 5000



   .. py:method:: __repr__()


   .. py:method:: calc_volume()

      Particle volume calculation. Different formulas for different particle shapes, currently defined for spheres, fibres, cylinders, pellets and irregular fragments



   .. py:method:: calc_numConc(concMass_mg_L, concNum_part_L)


   .. py:method:: assign_compartment(comp)


.. py:class:: ParticulatesBF(parentMP, spm)

   Bases: :py:obj:`Particulates`


   This is a class to create ParticulatesBIOFILM objects


   .. py:attribute:: species
      :value: 'particulate'



   .. py:attribute:: Pname


   .. py:attribute:: Pcomposition


   .. py:attribute:: Pform
      :value: 'biofMP'



   .. py:attribute:: parentMP


   .. py:attribute:: BF_density_kg_m3


   .. py:attribute:: BF_thickness_um


   .. py:attribute:: radius_m


   .. py:attribute:: diameter_m


   .. py:attribute:: diameter_um


   .. py:attribute:: t_half_d
      :value: 25000



   .. py:attribute:: Pshape


   .. py:attribute:: Pdensity_kg_m3


   .. py:attribute:: PdimensionX_m
      :value: 0.0



   .. py:attribute:: PdimensionY_m
      :value: 0.0



   .. py:attribute:: PdimensionZ_m
      :value: 0.0



.. py:class:: ParticulatesSPM(parentSPM, parentMP)

   Bases: :py:obj:`Particulates`


   This is a class to create ParticulatesSPM objects


   .. py:attribute:: species
      :value: 'particulate'



   .. py:attribute:: Pname


   .. py:attribute:: Pcomposition


   .. py:attribute:: parentMP


   .. py:attribute:: parentSPM


   .. py:attribute:: Pdensity_kg_m3


   .. py:attribute:: radius_m


   .. py:attribute:: diameter_m


   .. py:attribute:: diameter_um


   .. py:attribute:: Pshape


   .. py:attribute:: PdimensionX_m
      :value: 0.0



   .. py:attribute:: PdimensionY_m
      :value: 0.0



   .. py:attribute:: PdimensionZ_m
      :value: 0.0



   .. py:method:: calc_volume_heter(parentMP, parentSPM)