X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FParaMEDMEM%2FCommInterface.cxx;h=06b9aa1dc3be774df7addc2b369e297303effc92;hb=c41e6035d050073ea10040690daae247865b8b74;hp=dcdfd5486d2b37a0239bc335a6896c7cf70f3e5b;hpb=659f8c67d0348350e12fde38fe8c4de1ff95dffe;p=tools%2Fmedcoupling.git diff --git a/src/ParaMEDMEM/CommInterface.cxx b/src/ParaMEDMEM/CommInterface.cxx index dcdfd5486..06b9aa1dc 100644 --- a/src/ParaMEDMEM/CommInterface.cxx +++ b/src/ParaMEDMEM/CommInterface.cxx @@ -1,4 +1,4 @@ -// Copyright (C) 2007-2014 CEA/DEN, EDF R&D +// Copyright (C) 2007-2016 CEA/DEN, EDF R&D // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public @@ -19,16 +19,19 @@ #include "CommInterface.hxx" -namespace ParaMEDMEM +namespace MEDCoupling { - /*! \defgroup comm_interface CommInterface - Class \a CommInterface is the gateway to the MPI library. - It is a helper class that gathers the calls to the MPI - library that are made in the ParaMEDMEM library. This gathering - allows easier gathering of information about the communication - in the library. + /*! \anchor CommInterface-det + \class CommInterface - 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. + The class \a CommInterface is the gateway to the MPI library. + It is a wrapper around all MPI calls, thus trying to abstract the rest of the code from using the direct MPI API + (but this is not strictly respected overall in practice ...). It is used in all + the \ref parallel "DEC related classes". + + It is typically instanciated after the MPI_Init() call in a program and is afterwards passed as a + parameter to the constructors of various \ref parallel "parallel objects" so that they access the + MPI library via this common interface. As an example, the following code excerpt initializes a processor group made of the zero processor. @@ -40,12 +43,12 @@ namespace ParaMEDMEM { //initialization MPI_Init(&argc, &argv); - ParaMEDMEM::CommInterface comm_interface; + MEDCoupling::CommInterface comm_interface; //setting up a processor group with proc 0 set procs; procs.insert(0); - ParaMEDMEM::ProcessorGroup group(procs, comm_interface); + MEDCoupling::ProcessorGroup group(procs, comm_interface); //cleanup MPI_Finalize();