utopia.objects.box_class
========================

.. py:module:: utopia.objects.box_class


Classes
-------

.. autoapisummary::

   utopia.objects.box_class.Box


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

.. py:class:: Box(Bname, Bdepth_m=None, Blength_m=None, Bwidth_m=None, Bvolume_m3=None, Bconexions=None)

   Class box generates one object box representing the unit world in the case of the UTOPIA parameterization that can contain 17 compartments and that can have connexions to other boxes (for example if conecting several UTOPIA boxes to give spatial resolution to a global model)


   .. py:attribute:: description
      :value: 'Generic Box class'



   .. py:attribute:: Bname


   .. py:attribute:: Bdepth_m
      :value: None



   .. py:attribute:: Blength_m
      :value: None



   .. py:attribute:: Bwidth_m
      :value: None



   .. py:attribute:: Bvolume_m3
      :value: None



   .. py:attribute:: compartments
      :value: []



   .. py:attribute:: Bconexions
      :value: None



   .. py:method:: __repr__()


   .. py:method:: add_compartment(comp)


   .. py:method:: calc_Bvolume_m3()