src/ParaMEDMEM/DECOptions.hxx

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef __DECOPTIONS_HXX__
  21 #define __DECOPTIONS_HXX__
  22
  23 #include <string>
  24
  25 namespace MEDCoupling
  26 {
  27   //! Enum describing the allToAll method used in the communication pattern
  28   typedef enum { Native, PointToPoint } AllToAllMethod;
  29   //! Enum describing the time interpolation method
  30   typedef enum { WithoutTimeInterp, LinearTimeInterp } TimeInterpolationMethod;
  31
  32   /*!
  33    This class groups the various options accepted by all \ref para-dec "DECs" (which all inherit from %DECOptions).
  34
  35    The following code excerpt shows how to set options on a %DEC :
  36
  37    \code
  38    InterpKernelDEC dec(source_group,target_group);
  39    dec.setForcedRenormalization(true);
  40    dec.attachLocalField(field);
  41    dec.synchronize();
  42    if (source_group.containsMyRank())
  43      dec.sendData();
  44    else
  45      dec.recvData();
  46    \endcode
  47    *
  48    *
  49    */
  50   class DECOptions
  51   {
  52   protected:
  53     std::string _method;
  54     bool _asynchronous;
  55     TimeInterpolationMethod _timeInterpolationMethod;
  56     AllToAllMethod _allToAllMethod;
  57     bool _forcedRenormalization;
  58   public:
  59     DECOptions():_method("P0"),
  60                  _asynchronous(false),
  61                  _timeInterpolationMethod(WithoutTimeInterp),
  62                  _allToAllMethod(Native),
  63                  _forcedRenormalization(false)
  64     {
  65     }
  66
  67     DECOptions(const DECOptions& deco)
  68     {
  69       _method=deco._method;
  70       _timeInterpolationMethod=deco._timeInterpolationMethod;
  71       _asynchronous=deco._asynchronous;
  72       _forcedRenormalization=deco._forcedRenormalization;
  73       _allToAllMethod=deco._allToAllMethod;
  74     }
  75
  76
  77     /*!
  78      * \sa setMethod()
  79      */
  80     const std::string& getMethod() const { return _method; }
  81     /*!
  82      * Set interpolation method. Defaults to "P0".
  83      */
  84     void setMethod(const char *m) { _method=m; }
  85
  86     /*!
  87      * \sa setTimeInterpolationMethod()
  88      */
  89     TimeInterpolationMethod getTimeInterpolationMethod() const { return DECOptions::_timeInterpolationMethod; }
  90     /*!
  91      * Set time interpolation method. Default to WithoutTimeInterp.
  92      */
  93     void setTimeInterpolationMethod(TimeInterpolationMethod it) { DECOptions::_timeInterpolationMethod=it; }
  94
  95     /*!
  96      * \sa setForcedRenormalization()
  97      */
  98     bool getForcedRenormalization() const { return DECOptions::_forcedRenormalization; }
  99
 100     /*!
 101      * Force renormalization of the field after it has been received so that the total sum
 102      * of the field values are the same on both the sending and the receiving side. Defaults to
 103      * false.
 104      */
 105     void setForcedRenormalization( bool dr) { DECOptions::_forcedRenormalization = dr; }
 106
 107
 108     /*!
 109      * \sa setAsynchronous()
 110      */
 111     bool getAsynchronous() const { return DECOptions::_asynchronous; }
 112
 113     /*!
 114      * Switch to asynchronous data transfer mode. Default is false.
 115      */
 116     void setAsynchronous( bool dr) { DECOptions::_asynchronous = dr; }
 117
 118     /*!
 119      * \sa setAllToAllMethod()
 120      */
 121     AllToAllMethod getAllToAllMethod() const { return _allToAllMethod; }
 122     /*!
 123      * Set the broadcast method for synchronisation processes. Default to Native.
 124      */
 125     void setAllToAllMethod(AllToAllMethod sp) { _allToAllMethod=sp; }
 126   };
 127 }
 128
 129 #endif