src/ParaMEDMEM/CommInterface.cxx

   1 // Copyright (C) 2007-2014  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   /*! \defgroup comm_interface CommInterface
  25     Class \a CommInterface is the gateway to the MPI library.
  26     It is a helper class that gathers the calls to the MPI
  27     library that are made in the ParaMEDMEM library. This gathering
  28     allows easier gathering of information about the communication
  29     in the library.
  30
  31     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.
  32
  33     As an example, the following code excerpt initializes a processor group made of the zero processor.
  34
  35     \verbatim
  36     #include "CommInterface.hxx"
  37     #include "ProcessorGroup.hxx"
  38
  39     int main(int argc, char** argv)
  40     {
  41     //initialization
  42     MPI_Init(&argc, &argv);
  43     ParaMEDMEM::CommInterface comm_interface;
  44
  45     //setting up a processor group with proc 0
  46     set<int> procs;
  47     procs.insert(0);
  48     ParaMEDMEM::ProcessorGroup group(procs, comm_interface);
  49
  50     //cleanup
  51     MPI_Finalize();
  52     }
  53     \endverbatim
  54   */
  55
  56   CommInterface::CommInterface()
  57   {
  58   }
  59
  60   CommInterface::~CommInterface()
  61   {
  62   }
  63 }