MED33 porting

[tools/medcoupling.git] / src / ParaMEDMEM / CommInterface.cxx

diff --git a/src/ParaMEDMEM/CommInterface.cxx b/src/ParaMEDMEM/CommInterface.cxx
index 9aa280bec7593c3453414c59972b7cf8cd511e37..06b9aa1dc3be774df7addc2b369e297303effc92 100644 (file)
--- a/src/ParaMEDMEM/CommInterface.cxx
+++ b/src/ParaMEDMEM/CommInterface.cxx
@@ -1,9 +1,9 @@
-// Copyright (C) 2007-2013  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
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -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<int> procs;
     procs.insert(0);
-    ParaMEDMEM::ProcessorGroup group(procs, comm_interface);
+    MEDCoupling::ProcessorGroup group(procs, comm_interface);
 
     //cleanup
     MPI_Finalize();