.. _sourceEventFile:

sourceEventFile class
=====================

Description
-----------

Event file handler/reader for the porousMultiphaseFoam toolbox which contain *m* dates with *n* source points where (mass) flow rate is expressed in kg/s or m3/s. Source terms are applied in the closest cells to the given point. Intermediate values are computed by linear interpolation. Source terms before *time1* and after *timem* are equal to 0. 

Format
------

The class reads the file :

.. code::

    date time1
    x1 y1 z1 sourceTerm11
    x2 y2 z2 sourceTerm12
    ...
    xn yn zn sourceTerm1n
    date time2
    x1 y1 z1 sourceTerm21
    x2 y2 z2 sourceTerm22
    ...
    date timem
    ...
    xn yn zn sourceTermmn

Usage
-----
To use source event file, you should specify the file in **transportProperties** as

.. code::

    sourceEventFileWater "path/to/the/eventFile";

if considering a *flow rate source* and 

.. code::

    sourceEventFileTracer "path/to/the/eventFile";

if considering a *tracer source*.

Restrictions
------------

The *flow rate source* event file can be used in:

- :ref:`anisoImpesFoam`
- :ref:`groundwaterFoam`
- :ref:`groundwaterTransportFoam`
- :ref:`impesFoam`

The *tracer rate* event file can be used in:

- :ref:`groundwaterTransportFoam`
- :ref:`groundwaterTransport2DFoam`
- :ref:`porousScalarTransportFoam`
- :ref:`porousScalarTransport2DFoam`