Salome HOME
MEDCoupling API renaming - stage #2
[tools/medcoupling.git] / src / ParaMEDMEM / BlockTopology.hxx
index eabc2ec2de519dee666239b1df6a991185c866b4..3843b05d36f1963f3ee0b25a0e2154b66b5e735e 100644 (file)
 
 #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);