X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FParaMEDMEM%2FDECOptions.hxx;h=4083f58289437da52f1e86663363827a78e9422c;hb=c41e6035d050073ea10040690daae247865b8b74;hp=c3eb41e2cea443ab7dd61edd92cac0fbfc0b22c1;hpb=48782c06022ca2caa36f849cb5a29ea4fe2aaa83;p=tools%2Fmedcoupling.git

diff --git a/src/ParaMEDMEM/DECOptions.hxx b/src/ParaMEDMEM/DECOptions.hxx
index c3eb41e2c..4083f5828 100644
--- a/src/ParaMEDMEM/DECOptions.hxx
+++ b/src/ParaMEDMEM/DECOptions.hxx
@@ -1,32 +1,52 @@
-//  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 __DECOPTIONS_HXX__
 #define __DECOPTIONS_HXX__
 
 #include <string>
 
-namespace ParaMEDMEM
+namespace MEDCoupling
 {
-  //Enum describing the allToAll method used in the communication pattern
+  //! Enum describing the allToAll method used in the communication pattern
   typedef enum { Native, PointToPoint } AllToAllMethod;
+  //! Enum describing the time interpolation method
   typedef enum { WithoutTimeInterp, LinearTimeInterp } TimeInterpolationMethod;
 
+  /*!
+   This class groups the various options accepted by all \ref para-dec "DECs" (which all inherit from %DECOptions).
+
+   The following code excerpt shows how to set options on a %DEC :
+
+   \code
+   InterpKernelDEC dec(source_group,target_group);
+   dec.setForcedRenormalization(true);
+   dec.attachLocalField(field);
+   dec.synchronize();
+   if (source_group.containsMyRank())
+     dec.sendData();
+   else
+     dec.recvData();
+   \endcode
+   *
+   *
+   */
   class DECOptions
   {
   protected:
@@ -37,10 +57,10 @@ namespace ParaMEDMEM
     bool _forcedRenormalization;
   public:
     DECOptions():_method("P0"),
-                 _timeInterpolationMethod(WithoutTimeInterp),
                  _asynchronous(false),
-                 _forcedRenormalization(false),
-                 _allToAllMethod(Native)
+                 _timeInterpolationMethod(WithoutTimeInterp),
+                 _allToAllMethod(Native),
+                 _forcedRenormalization(false)
     {
     }
     
@@ -53,19 +73,55 @@ namespace ParaMEDMEM
       _allToAllMethod=deco._allToAllMethod;
     }
     
+
+    /*!
+     * \sa setMethod()
+     */
     const std::string& getMethod() const { return _method; }
+    /*!
+     * Set interpolation method. Defaults to "P0".
+     */
     void setMethod(const char *m) { _method=m; }
 
+    /*!
+     * \sa setTimeInterpolationMethod()
+     */
     TimeInterpolationMethod getTimeInterpolationMethod() const { return DECOptions::_timeInterpolationMethod; }
+    /*!
+     * Set time interpolation method. Default to WithoutTimeInterp.
+     */
     void setTimeInterpolationMethod(TimeInterpolationMethod it) { DECOptions::_timeInterpolationMethod=it; }
 
+    /*!
+     * \sa setForcedRenormalization()
+     */
     bool getForcedRenormalization() const { return DECOptions::_forcedRenormalization; }
+
+    /*!
+     * Force renormalization of the field after it has been received so that the total sum
+     * of the field values are the same on both the sending and the receiving side. Defaults to
+     * false.
+     */
     void setForcedRenormalization( bool dr) { DECOptions::_forcedRenormalization = dr; }
 
+
+    /*!
+     * \sa setAsynchronous()
+     */
     bool getAsynchronous() const { return DECOptions::_asynchronous; }
+
+    /*!
+     * Switch to asynchronous data transfer mode. Default is false.
+     */
     void setAsynchronous( bool dr) { DECOptions::_asynchronous = dr; }
      
+    /*!
+     * \sa setAllToAllMethod()
+     */
     AllToAllMethod getAllToAllMethod() const { return _allToAllMethod; }
+    /*!
+     * Set the broadcast method for synchronisation processes. Default to Native.
+     */
     void setAllToAllMethod(AllToAllMethod sp) { _allToAllMethod=sp; }
   };
 }