MEDCoupling API renaming - stage #2

[tools/medcoupling.git] / src / ParaMEDMEM / BlockTopology.hxx

diff --git a/src/ParaMEDMEM/BlockTopology.hxx b/src/ParaMEDMEM/BlockTopology.hxx
index d7388c133033369de484c748f276feb0386115bc..3843b05d36f1963f3ee0b25a0e2154b66b5e735e 100644 (file)
--- a/src/ParaMEDMEM/BlockTopology.hxx
+++ b/src/ParaMEDMEM/BlockTopology.hxx
@@ -1,9 +1,9 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D
+// Copyright (C) 2007-2015  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
@@ -25,17 +25,27 @@
 
 #include <vector>
 
-namespace ParaMEDMEM
+namespace MEDCoupling
 {
   class ComponentTopology;
   class MEDCouplingCMesh;
 
   typedef enum{Block,Cycle} CYCLE_TYPE; 
 
+  /*!
+   * \anchor BlockTopology-det
+   *
+   * A BlockTopology typically represents the split of a *structured* mesh among the processors of
+   * a common ProcessorGroup. Each processor gets a contiguous part of the cells in the mesh (a block).
+   *
+   * A BlockTopology can also be used to split a structured domain among the various components of a field.
+   *
+   * \sa ExplicitTopology
+   */
   class BlockTopology : public Topology
   {
   public:
-    BlockTopology() { }
+    BlockTopology();
     BlockTopology(const ProcessorGroup& group, MEDCouplingCMesh *grid); 
     BlockTopology(const BlockTopology& geom_topo, const ComponentTopology& comp_topo);
     BlockTopology(const ProcessorGroup& group, int nb_elem);