Two Pumps
~~~~~~~~~

.. image:: ../../images/dongerdielen.jpg
  :alt: Property of Wetterskip Fryslân

.. note::

  This example focuses on how to put multiple pumps in a hydraulic model, and
  assumes basic exposure to RTC-Tools and the :py:class:`~rtctools_hydraulic_structures.pumping_station_mixin.PumpingStationMixin`.
  To start with basics of pump modeling, see :doc:`basic-pumping-station`.

The purpose of this example is to understand the technical setup of a model
with multiple pumps.

The scenario of this example is equal to that of :doc:`basic-pumping-station`,
but with two pumps available instead of one. The folder
``examples/pumping_station/two_pumps`` contains the complete RTC- Tools
optimization problem. The discussion below will focus on the differences from
the :doc:`basic-pumping-station`.


The Model
---------

The pumping station object ``MyPumpingStation`` looks as follows in its
diagram representation in OpenModelica:

.. image:: ../../images/two-pumps-mypumpingstation-medit.png

When modeling multiple pumps of the same type, it makes sense to define a
model, which can then be instantiated into multiple objects. In the file
``Example.mo`` this can be seen in the submodel ``MyPump`` of
``MyPumpingStation``:

.. literalinclude:: ../../_build/_stripped_examples/pumping_station/two_pumps/model/Example.mo
  :language: modelica
  :lines: 8-26
  :lineno-match:

The data of this pump is exactly equal to that used in :doc:`basic-pumping-
station`, but is not instantiated yet. To instantiate two pumps using this
data, we define two components ``pump1`` and ``pump2``:

.. literalinclude:: ../../_build/_stripped_examples/pumping_station/two_pumps/model/Example.mo
  :language: modelica
  :lines: 28-29
  :lineno-match:

Lastly, it is important not to forget to set the right number of pumps on the
pumping station object:

.. literalinclude:: ../../_build/_stripped_examples/pumping_station/two_pumps/model/Example.mo
  :language: modelica
  :lines: 3-6
  :lineno-match:


The Optimization Problem
------------------------

When using multiple pumps it is important to specify the right order of pumps.
This order should match the order of pumps in the
:cpp:var:`~Deltares::HydraulicStructures::PumpingStation::PumpingStation::pump_switching_matrix`.

.. literalinclude:: ../../../examples/pumping_station/two_pumps/src/example.py
  :language: python
  :pyobject: Example.__init__
  :lineno-match:
  :start-after: output_folder