..
   Generated automatically by cpp2rst

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


.. _mpi__communicator:

mpi::communicator
=================

*#include <mpi.hpp>*

.. rst-class:: cppsynopsis

      class  :red:`communicator`




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

.. table::
   :widths: 40 60


   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`(constructor) <mpi__communicator__constructor>` |                                                                                                           |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`get <mpi__communicator__get>`                   |                                                                                                           |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`rank <mpi__communicator__rank>`                 | Get the rank of the calling process in the communicator.                                                  |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`size <mpi__communicator__size>`                 | Get the size of the communicator.                                                                         |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`split <mpi__communicator__split>`               | Split the communicator into disjoint subgroups.                                                           |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`abort <mpi__communicator__abort>`               | If mpi::has_env is true, `MPI_Abort` is called with the given error code, otherwise std::abort is called. |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
   | :ref:`barrier <mpi__communicator__barrier>`           | Barrier synchronization.                                                                                  |
   +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+

.. toctree::
    :hidden:

    communicator/constructor
    communicator/get
    communicator/rank
    communicator/size
    communicator/split
    communicator/abort
    communicator/barrier