.. _connections:

tab "Connections"
==================

This tab is mandatory.

A :term:`connection` is connecting two volumes between them. Its geometry and
behaviour will define how the mass of air in those volumes will be exchanged
between them.

Basically, a connection always connect two volumes (*aka* vol I and vol J) and
is therefore located at an :term:`interface`.

When defining a connection, take care to always set volume I ID to the lowest
ID of both volumes.

Example: let say you have two volumes to connect, ID2 and ID7, Volume I will
**always be** volume ID2 and Volume J will always be volume ID7.

.. seealso::  :ref:`tuto2` is dedicated to decompression features whereas
              :ref:`tuto3` is dedicated to doors


Parameters
-----------

.. tabularcolumns:: |p{0.2\linewidth}|p{0.10\linewidth}|p{0.2\linewidth}|p{0.2\linewidth}|

.. table:: Connections parameters
   :class: longtable

   +-------------------------+--------------------------------+---------------+--------------+
   |                         | description                    | default       | units        |
   +=========================+================================+===============+==============+
   | id                      | Connection ID                  | **mandatory** | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | vol_i                   | ID of volume I                 | **mandatory** | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | vol_j                   | ID of volume J                 | **mandatory** | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | comments                | Free text                      |               | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | door                    | Door Frame Area                | 0             | [m^2 | in^2] |
   +-------------------------+--------------------------------+---------------+--------------+
   | opening_latency         | Feature opening latency time   | 0             | [sec]        |
   +-------------------------+--------------------------------+---------------+--------------+
   | vent_area_i_to_j        | Decompression raw area         | 0             | [m^2 | in^2] |
   +-------------------------+--------------------------------+---------------+--------------+
   | opening_pressure_i_to_j | Pressure Threshold             | 0             | [bar | psi]  |
   +-------------------------+--------------------------------+---------------+--------------+
   | opening_time_i_to_j     | Feature Opening Time           | 0             | [sec]        |
   +-------------------------+--------------------------------+---------------+--------------+
   | cp_i_to_j               | Discharge Coefficient          | 0             | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | vent_area_j_to_i        | Decompression raw area         | *blank*       | [m^2 | in^2] |
   +-------------------------+--------------------------------+---------------+--------------+
   | opening_pressure_j_to_i | Pressure Threshold             | *blank*       | [bar | psi]  |
   +-------------------------+--------------------------------+---------------+--------------+
   | opening_time_j_to_i     | Feature Opening Time           | *blank*       | [sec]        |
   +-------------------------+--------------------------------+---------------+--------------+
   | cp_j_to_i               | Discharge Coefficient          | *blank*       | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | exvar                   | Exploded Volume Area Reduction | 0             | no units     |
   +-------------------------+--------------------------------+---------------+--------------+
   | ovar                    | Occupied Volume Area Reduction | 0             | no units     |
   +-------------------------+--------------------------------+---------------+--------------+


.. _connections_id:
.. include:: parameters/.connections_id.rst
.. include:: parameters/connections_id.rst

.. _connections_vol_i:
.. include:: parameters/.connections_vol_i.rst
.. include:: parameters/connections_vol_i.rst

.. _connections_vol_j:
.. include:: parameters/.connections_vol_j.rst
.. include:: parameters/connections_vol_j.rst

.. _connections_comments:
.. include:: parameters/.connections_comments.rst
.. include:: parameters/connections_comments.rst

.. _connections_door:
.. include:: parameters/.connections_door.rst
.. include:: parameters/connections_door.rst

.. _connections_opening_latency:
.. include:: parameters/.connections_opening_latency.rst
.. include:: parameters/connections_opening_latency.rst

.. _connections_vent_area_i_to_j:
.. include:: parameters/.connections_vent_area_i_to_j.rst
.. include:: parameters/connections_vent_area_i_to_j.rst

.. _connections_opening_pressure_i_to_j:
.. include:: parameters/.connections_opening_pressure_i_to_j.rst
.. include:: parameters/connections_opening_pressure_i_to_j.rst

.. _connections_opening_time_i_to_j:
.. include:: parameters/.connections_opening_time_i_to_j.rst
.. include:: parameters/connections_opening_time_i_to_j.rst

.. _connections_cp_i_to_j:
.. include:: parameters/.connections_cp_i_to_j.rst
.. include:: parameters/connections_cp_i_to_j.rst

.. _connections_vent_area_j_to_i:
.. include:: parameters/.connections_vent_area_j_to_i.rst
.. include:: parameters/connections_vent_area_j_to_i.rst

.. _connections_opening_pressure_j_to_i:
.. include:: parameters/.connections_opening_pressure_j_to_i.rst
.. include:: parameters/connections_opening_pressure_j_to_i.rst

.. _connections_opening_time_j_to_i:
.. include:: parameters/.connections_opening_time_j_to_i.rst
.. include:: parameters/connections_opening_time_j_to_i.rst

.. _connections_cp_j_to_i:
.. include:: parameters/.connections_cp_j_to_i.rst
.. include:: parameters/connections_cp_j_to_i.rst

.. _connections_exvar:
.. include:: parameters/.connections_exvar.rst
.. include:: parameters/connections_exvar.rst

.. _connections_ovar:
.. include:: parameters/.connections_ovar.rst
.. include:: parameters/connections_ovar.rst

.. include:: connections_specific.rst