doc for addMortality and addSettling

modules/slimParticles/dgParticleTracker2D.h

@@ -361,6 +361,12 @@ public:
   }
   
   /** Activate particle mortality and load parameters */
+  /*  mortParams :
+   *    [0] : mortType 
+   *        0 : no mortality
+   *        1 : constant mortality rate given by [1] mortRateMax (by day)
+   *        2 : weibullMortalityRate with [2] lambda  and [3] nu;
+   */
   void addMortality(fullMatrix<double>* mortParams) {
     _mortFlag = true;
     _mortType = static_cast<int>(mortParams->get(0,0)+0.1);
@@ -370,6 +376,22 @@ public:
   }
   
   /** Activate particle settling and load parameters */
+  /*
+   * settleParams :
+   *   [0] : settlingType  :
+   *        0: no settling
+   *        1: flat settling all particles can settle at any time with probabylity given py [4] settleRateMax
+   *        2: all particle can settle with a probability that increases linearly between 0 in [1] tPreComp and [4] settleRateMax in [3] tSettleMax then decreases linearly to 0 in [2] tPostComp
+   *        3: all particles settles when they are competents, competency is aquired and lost with flat rate [5] compAquisitionRate and [6] compLossRate
+   *   [7] : settleOverWhichReefType :
+   *        0: all reefs
+   *        1: only shallow reefs
+   *        2: only deep reefs
+   * reefs :
+   *    a dof container with the id of the reef by element (0 = no reef)
+   * nbOfShallowReefs :
+   *    reefs with id <= nbOfShallowReefs are shallow reefs, the others are deep reefs
+   */
   void addSettling(fullMatrix<double>* settleParams, dgDofContainer* reefs, int nbOfShallowReefs) {
     _settleFlag = true;
     _settleType = static_cast<int>(settleParams->get(0,0)+0.1);