..
   Generated automatically by cpp2rst

.. highlight:: c
.. role:: red
.. role:: green
.. role:: param


.. _mpi__monitor:

mpi::monitor
============

*#include <mpi.hpp>*

.. rst-class:: cppsynopsis

      class  :red:`monitor`




Member functions
----------------

.. table::
   :widths: 40 60


   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`(constructor) <mpi__monitor__constructor>`                             | Construct a monitor on top of a given mpi::communicator.                                                                          |
   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`operator= <mpi__monitor__operator=>`                                   |                                                                                                                                   |
   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`request_emergency_stop <mpi__monitor__request_emergency_stop>`         | Request an emergency stop.                                                                                                        |
   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`emergency_occured <mpi__monitor__emergency_occured>`                   | Check if an emergency stop has been requested.                                                                                    |
   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`finalize_communications <mpi__monitor__finalize_communications>`       | Finalize all pending communications.                                                                                              |
   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`root_check_nodes_and_bcast <mpi__monitor__root_check_nodes_and_bcast>` | Check if any non-root process has sent a stop request. If so, broadcast to all other processes
 in case it has not been done yet. |
   +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+

.. toctree::
    :hidden:

    monitor/constructor
    monitor/operator=
    monitor/request_emergency_stop
    monitor/emergency_occured
    monitor/finalize_communications
    monitor/root_check_nodes_and_bcast