Salome HOME
Minor doxygen fix
[tools/medcoupling.git] / src / ParaMEDMEM / ComponentTopology.hxx
index 7653822c0b6683cab027757f7cfd64c1f893170c..3a5613cb92b6d788a9dc8e005db558c46ce7c56f 100644 (file)
@@ -1,31 +1,41 @@
-//  Copyright (C) 2007-2008  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.
+// 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, 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
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//  Lesser General Public License for more details.
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
-//  You should have received a copy of the GNU Lesser General Public
-//  License along with this library; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
+
 #ifndef __COMPONENTTOPOLOGY_HXX__
 #define __COMPONENTTOPOLOGY_HXX__
 
-#include "ProcessorGroup.hxx"
 #include "Topology.hxx"
 
 #include <vector>
 
-namespace ParaMEDMEM
+namespace MEDCoupling
 {
+  class ProcessorGroup;
+
+  /*!
+   * \anchor ComponentTopology-det
+   *
+   * The ComponentTopology can be used when building a ParaFIELD. It allows the splitting of the components
+   * of the field among different processors within a single processor group.
+   *
+   * \sa ParaFIELD::ParaFIELD(TypeOfField , TypeOfTimeDiscretization , ParaMESH* , const ComponentTopology& )
+   */
   class ComponentTopology
   {
   public: