src/ParaMEDMEM/CommInterface.cxx

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "CommInterface.hxx"
  21
  22 namespace ParaMEDMEM
  23 {
  24   /*! \anchor CommInterface-det
  25      \class CommInterface
  26
  27     The class \a CommInterface is the gateway to the MPI library.
  28
  29     It is a helper class that gathers the calls to the MPI
  30     library that are made in the %ParaMEDMEM library. This gathering
  31     allows easier gathering of information about the communication
  32     in the library.
  33
  34     It is typically called after the MPI_Init() call in a program. It is afterwards passed as a parameter to the constructors of %ParaMEDMEM objects so that they access the MPI library via the CommInterface.
  35
  36     As an example, the following code excerpt initializes a processor group made of the zero processor.
  37
  38     \verbatim
  39     #include "CommInterface.hxx"
  40     #include "ProcessorGroup.hxx"
  41
  42     int main(int argc, char** argv)
  43     {
  44     //initialization
  45     MPI_Init(&argc, &argv);
  46     ParaMEDMEM::CommInterface comm_interface;
  47
  48     //setting up a processor group with proc 0
  49     set<int> procs;
  50     procs.insert(0);
  51     ParaMEDMEM::ProcessorGroup group(procs, comm_interface);
  52
  53     //cleanup
  54     MPI_Finalize();
  55     }
  56     \endverbatim
  57   */
  58
  59   CommInterface::CommInterface()
  60   {
  61   }
  62
  63   CommInterface::~CommInterface()
  64   {
  65   }
  66 }