docs(man): add the 'RunOptions' elements in the 'Value' section of the RunModel_*GR* functions

Refs #111, #123, aad9d1db, dd7ef429

man/RunModel_CemaNeigeGR4H.Rd

@@ -71,6 +71,8 @@ RunModel_CemaNeigeGR4H(InputsModel, RunOptions, Param)
     \emph{$CemaNeigeLayers[[iLayer]]$Temp        } \tab [numeric] series of air temperature [°C]                     \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Gthreshold  } \tab [numeric] series of melt threshold [mm]                      \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Glocalmax   } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/h] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_CemaNeigeGR4J.Rd

@@ -71,6 +71,8 @@ RunModel_CemaNeigeGR4J(InputsModel, RunOptions, Param)
     \emph{$CemaNeigeLayers[[iLayer]]$Temp         } \tab [numeric] series of air temperature [°C]                     \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Gthreshold   } \tab [numeric] series of melt threshold [mm]                      \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Glocalmax    } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/d] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_CemaNeigeGR5H.Rd

@@ -74,6 +74,8 @@ RunModel_CemaNeigeGR5H(InputsModel, RunOptions, Param)
     \emph{$CemaNeigeLayers[[iLayer]]$Temp         } \tab [numeric] series of air temperature [°C]                               \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Gthreshold   } \tab [numeric] series of melt threshold [mm]                                \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Glocalmax    } \tab [numeric] series of local melt threshold for hysteresis [mm]           \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/h] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_CemaNeigeGR5J.Rd

@@ -72,6 +72,8 @@ RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
     \emph{$CemaNeigeLayers[[iLayer]]$Temp        } \tab [numeric] series of air temperature [°C]                     \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Gthreshold  } \tab [numeric] series of melt threshold [mm]                      \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Glocalmax   } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/d] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs

man/RunModel_CemaNeigeGR6J.Rd

@@ -75,6 +75,8 @@ RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param)
     \emph{$CemaNeigeLayers[[iLayer]]$Temp        } \tab [numeric] series of air temperature [°C]                     \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Gthreshold  } \tab [numeric] series of melt threshold [mm]                      \cr
     \emph{$CemaNeigeLayers[[iLayer]]$Glocalmax   } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/d] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs

man/RunModel_GR1A.Rd

@@ -37,6 +37,8 @@ RunModel_GR1A(InputsModel, RunOptions, Param)
     \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/y] \cr
     \emph{$Precip  } \tab [numeric] series of input total precipitation [mm/y]          \cr
     \emph{$Qsim    } \tab [numeric] series of simulated discharge [mm/y]                \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/y] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (NULL) [-]             \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_GR2M.Rd

@@ -46,6 +46,8 @@ RunModel_GR2M(InputsModel, RunOptions, Param)
     \emph{$Prod    } \tab [numeric] series of production store level (S) [mm]                   \cr
     \emph{$Rout    } \tab [numeric] series of routing store level (R1) [mm]                     \cr
     \emph{$Qsim    } \tab [numeric] series of simulated discharge [mm/month] (Q)                \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/month] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                      \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (production store level and routing store level) [mm]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_GR4H.Rd

@@ -55,6 +55,8 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
     \emph{$QR      } \tab [numeric] series of routing store outflow (Qr) [mm/h]                         \cr
     \emph{$QD      } \tab [numeric] series of direct flow from UH2 after exchange (Qd) [mm/h]           \cr
     \emph{$Qsim    } \tab [numeric] series of simulated discharge (Q) [mm/h]                            \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/h] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_GR4J.Rd

@@ -36,25 +36,27 @@ RunModel_GR4J(InputsModel, RunOptions, Param)
 \value{
 [list] containing the function outputs organised as follows:
   \tabular{ll}{
-    \emph{$DatesR  } \tab [POSIXlt] series of dates                                                          \cr
-    \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] (E)                  \cr
-    \emph{$Precip  } \tab [numeric] series of input total precipitation (P) [mm/d]                           \cr
-    \emph{$Prod    } \tab [numeric] series of production store level (S) [mm]                                \cr
-    \emph{$Pn      } \tab [numeric] series of net rainfall (Pn) [mm/d]                                       \cr
-    \emph{$Ps      } \tab [numeric] series of the part of Pn filling the production store (Ps) [mm/d]        \cr
-    \emph{$AE      } \tab [numeric] series of actual evapotranspiration [mm/d]                               \cr
-    \emph{$Perc    } \tab [numeric] series of percolation (Perc) [mm/d]                                      \cr
-    \emph{$PR      } \tab [numeric] series of Pr=Pn-Ps+Perc (Pr) [mm/d]                                      \cr
-    \emph{$Q9      } \tab [numeric] series of UH1 outflow (Q9) [mm/d]                                        \cr
-    \emph{$Q1      } \tab [numeric] series of UH2 outflow (Q1) [mm/d]                                        \cr
-    \emph{$Rout    } \tab [numeric] series of routing store level (R1) [mm]                                  \cr
-    \emph{$Exch    } \tab [numeric] series of potential semi-exchange between catchments [mm/d]              \cr
-    \emph{$AExch1  } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d]         \cr
-    \emph{$AExch2  } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d]         \cr
-    \emph{$AExch   } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d]                \cr
-    \emph{$QR      } \tab [numeric] series of routing store outflow (Qr) [mm/d]                              \cr
-    \emph{$QD      } \tab [numeric] series of direct flow from UH2 after exchange (Qd) [mm/d]                \cr
-    \emph{$Qsim    } \tab [numeric] series of simulated discharge (Q) [mm/d]                                 \cr
+    \emph{$DatesR  } \tab [POSIXlt] series of dates                                                   \cr
+    \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] (E)           \cr
+    \emph{$Precip  } \tab [numeric] series of input total precipitation (P) [mm/d]                    \cr
+    \emph{$Prod    } \tab [numeric] series of production store level (S) [mm]                         \cr
+    \emph{$Pn      } \tab [numeric] series of net rainfall (Pn) [mm/d]                                \cr
+    \emph{$Ps      } \tab [numeric] series of the part of Pn filling the production store (Ps) [mm/d] \cr
+    \emph{$AE      } \tab [numeric] series of actual evapotranspiration [mm/d]                        \cr
+    \emph{$Perc    } \tab [numeric] series of percolation (Perc) [mm/d]                               \cr
+    \emph{$PR      } \tab [numeric] series of Pr=Pn-Ps+Perc (Pr) [mm/d]                               \cr
+    \emph{$Q9      } \tab [numeric] series of UH1 outflow (Q9) [mm/d]                                 \cr
+    \emph{$Q1      } \tab [numeric] series of UH2 outflow (Q1) [mm/d]                                 \cr
+    \emph{$Rout    } \tab [numeric] series of routing store level (R1) [mm]                           \cr
+    \emph{$Exch    } \tab [numeric] series of potential semi-exchange between catchments [mm/d]       \cr
+    \emph{$AExch1  } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d]  \cr
+    \emph{$AExch2  } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d]  \cr
+    \emph{$AExch   } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d]         \cr
+    \emph{$QR      } \tab [numeric] series of routing store outflow (Qr) [mm/d]                       \cr
+    \emph{$QD      } \tab [numeric] series of direct flow from UH2 after exchange (Qd) [mm/d]         \cr
+    \emph{$Qsim    } \tab [numeric] series of simulated discharge (Q) [mm/d]                          \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/d] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_GR5H.Rd

@@ -59,6 +59,8 @@ RunModel_GR5H(InputsModel, RunOptions, Param)
     \emph{$QR      } \tab [numeric] series of routing store outflow (Qr) [mm/h]                                                 \cr
     \emph{$QD      } \tab [numeric] series of direct flow from UH after exchange (Qd) [mm/h]                                    \cr
     \emph{$Qsim    } \tab [numeric] series of simulated discharge (Q) [mm/h]                                                    \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/h]                  \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                                   \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH levels) [mm]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_GR5J.Rd

@@ -56,6 +56,8 @@ RunModel_GR5J(InputsModel, RunOptions, Param)
     \emph{$QR      } \tab [numeric] series of routing store outflow (Qr) [mm/d]                         \cr
     \emph{$QD      } \tab [numeric] series of direct flow from UH after exchange (Qd) [mm/d]            \cr
     \emph{$Qsim    } \tab [numeric] series of simulated discharge (Q) [mm/d]                            \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/d] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH levels) [mm]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.

man/RunModel_GR6J.Rd

@@ -59,6 +59,8 @@ RunModel_GR6J(InputsModel, RunOptions, Param)
     \emph{$Exp     } \tab [numeric] series of exponential store level (negative) (R2) [mm]              \cr
     \emph{$QD      } \tab [numeric] series of direct flow from UH2 after exchange (Qd) [mm/d]           \cr
     \emph{$Qsim    } \tab [numeric] series of simulated discharge (Q) [mm/d]                            \cr
+    \emph{RunOptions$WarmUpQsim} \tab [numeric] series of simulated discharge (Q) on the warm-up period [mm/d] \cr
+    \emph{RunOptions$Param     } \tab [numeric] parameter set parameter set used by the model                  \cr
     \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm]. See \code{\link{CreateIniStates}} for more details \cr
   }
 Refer to the provided references or to the package source code for further details on these model outputs.