v1.4.3.34 NEW: Added outputs to RunModel_GR4H function (Pn, Ps, AExch1, AExch2) #29

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.4.3.33
-Date: 2020-01-14
+Version: 1.4.3.34
+Date: 2020-01-15
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
   person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),

NEWS.md

@@ -2,7 +2,7 @@
 
 
 
-### 1.4.3.33 Release Notes (2020-01-14)
+### 1.4.3.34 Release Notes (2020-01-15)
 
 
 #### New features
@@ -20,6 +20,11 @@
 - Fixed bug in the <code>.ErrorCrit()</code> function. The Box-Cox transformation formula is now corrected when the <code>ErrorCrit&#42;()</code> functions are used.
 
 
+#### Major user-visible changes
+
+- Added outputs to <code>RunModel_GR4H()</code> function (Pn, Ps, AExch1, AExch2).
+
+
 #### Minor user-visible changes
 
 - Added the diagram of GR2M in the <code>RunModel_GR2M()</code> documentation.

R/Utils.R

@@ -33,15 +33,6 @@
                "Perc", "PR",
                "Rout", "Exch",
                "Qsim")
-  } else if (GR == "GR4H") {
-    outGR <- c("PotEvap", "Precip", "Prod",
-               "AE",
-               "Perc", "PR",
-               "Q9", "Q1",
-               "Rout", "Exch",
-               "AExch", "QR",
-               "QD",
-               "Qsim")
   } else if (GR == "GR5H") {
     outGR <- c("PotEvap", "Precip", "Interc", "Prod", "Pn", "Ps",
                "AE", "EI", "ES",
@@ -52,7 +43,7 @@
                "AExch", "QR",
                "QD",
                "Qsim")
-  } else if (GR %in% c("GR4J", "GR5J")) {
+  } else if (GR %in% c("GR4J", "GR5J", "GR4H")) {
     outGR <- c("PotEvap", "Precip", "Prod", "Pn", "Ps",
                "AE",
                "Perc", "PR",

man/RunModel_GR4H.Rd

@@ -31,21 +31,25 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
 \value{
 [list] 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/h]         \cr
-    \emph{$Precip  } \tab [numeric] series of input total precipitation [mm/h]                  \cr
-    \emph{$Prod    } \tab [numeric] series of production store level [mm]                       \cr
-    \emph{$AE      } \tab [numeric] series of actual evapotranspiration [mm/h]                  \cr
-    \emph{$Perc    } \tab [numeric] series of percolation (PERC) [mm/h]                         \cr
-    \emph{$PR      } \tab [numeric] series of PR=Pn-Ps+Perc [mm/h]                              \cr
-    \emph{$Q9      } \tab [numeric] series of UH1 outflow (Q9) [mm/h]                           \cr
-    \emph{$Q1      } \tab [numeric] series of UH2 outflow (Q1) [mm/h]                           \cr
-    \emph{$Rout    } \tab [numeric] series of routing store level [mm]                          \cr
-    \emph{$Exch    } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
-    \emph{$AExch   } \tab [numeric] series of actual exchange between catchments (1+2) [mm/h]   \cr
-    \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 [mm/h]                        \cr
+    \emph{$DatesR  } \tab [POSIXlt] series of dates                                                 \cr
+    \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h]             \cr
+    \emph{$Precip  } \tab [numeric] series of input total precipitation [mm/h]                      \cr
+    \emph{$Prod    } \tab [numeric] series of production store level [mm]                           \cr
+    \emph{$Pn      } \tab [numeric] series of net rainfall [mm/h]                         			    \cr
+    \emph{$Ps      } \tab [numeric] series of the part of Pn filling the production store [mm/h]    \cr    
+    \emph{$AE      } \tab [numeric] series of actual evapotranspiration [mm/h]                      \cr
+    \emph{$Perc    } \tab [numeric] series of percolation (PERC) [mm/h]                             \cr
+    \emph{$PR      } \tab [numeric] series of PR=Pn-Ps+Perc [mm/h]                                  \cr
+    \emph{$Q9      } \tab [numeric] series of UH1 outflow (Q9) [mm/h]                               \cr
+    \emph{$Q1      } \tab [numeric] series of UH2 outflow (Q1) [mm/h]                               \cr
+    \emph{$Rout    } \tab [numeric] series of routing store level [mm]                              \cr
+    \emph{$Exch    } \tab [numeric] series of potential semi-exchange between catchments [mm/h]     \cr
+    \emph{$AExch1  } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h]\cr
+    \emph{$AExch2  } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h]\cr    
+    \emph{$AExch   } \tab [numeric] series of actual exchange between catchments (1+2) [mm/h]       \cr
+    \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 [mm/h]                            \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)

src/frun_GR4H.f90

@@ -302,17 +302,21 @@
       MISC( 1)=E             ! PE     ! [numeric] observed potential evapotranspiration [mm/hour]
       MISC( 2)=P1            ! Precip ! [numeric] observed total precipitation [mm/hour]
       MISC( 3)=St(1)         ! Prod   ! [numeric] production store level (St(1)) [mm]
-      MISC( 4)=AE            ! AE     ! [numeric] actual evapotranspiration [mm/hour]
-      MISC( 5)=PERC          ! Perc   ! [numeric] percolation (PERC) [mm/hour]
-      MISC( 6)=PR            ! PR     ! [numeric] PR=PN-PS+PERC [mm/hour]
-      MISC( 7)=StUH1(1)      ! Q9     ! [numeric] outflow from UH1 (Q9) [mm/hour]
-      MISC( 8)=StUH2(1)      ! Q1     ! [numeric] outflow from UH2 (Q1) [mm/hour]
-      MISC( 9)=St(2)         ! Rout   ! [numeric] routing store level (St(2)) [mm]
-      MISC(10)=EXCH          ! Exch   ! [numeric] potential semi-exchange between catchments (EXCH) [mm/hour]
-      MISC(11)=AEXCH1+AEXCH2 ! AExch  ! [numeric] actual total exchange between catchments (AEXCH1+AEXCH2) [mm/hour]
-      MISC(12)=QR            ! QR     ! [numeric] outflow from routing store (QR) [mm/hour]
-      MISC(13)=QD            ! QD     ! [numeric] outflow from UH2 branch after exchange (QD) [mm/hour]
-      MISC(14)=Q             ! Qsim   ! [numeric] simulated outflow at catchment outlet [mm/hour]
+      MISC( 4)=PN            ! Pn     ! [numeric] net rainfall [mm/day]
+      MISC( 5)=PS            ! Ps     ! [numeric] part of Ps filling the production store [mm/day]
+      MISC( 6)=AE            ! AE     ! [numeric] actual evapotranspiration [mm/hour]
+      MISC( 7)=PERC          ! Perc   ! [numeric] percolation (PERC) [mm/hour]
+      MISC( 8)=PR            ! PR     ! [numeric] PR=PN-PS+PERC [mm/hour]
+      MISC( 9)=StUH1(1)      ! Q9     ! [numeric] outflow from UH1 (Q9) [mm/hour]
+      MISC(10)=StUH2(1)      ! Q1     ! [numeric] outflow from UH2 (Q1) [mm/hour]
+      MISC(11)=St(2)         ! Rout   ! [numeric] routing store level (St(2)) [mm]
+      MISC(12)=EXCH          ! Exch   ! [numeric] potential semi-exchange between catchments (EXCH) [mm/hour]
+      MISC(13)=AEXCH1        ! AExch1 ! [numeric] actual exchange between catchments from routing store (AEXCH1) [mm/day]
+      MISC(14)=AEXCH2        ! AExch2 ! [numeric] actual exchange between catchments from direct branch (after UH2) (AEXCH2) [mm/day]
+      MISC(15)=AEXCH1+AEXCH2 ! AExch  ! [numeric] actual total exchange between catchments (AEXCH1+AEXCH2) [mm/hour]
+      MISC(16)=QR            ! QR     ! [numeric] outflow from routing store (QR) [mm/hour]
+      MISC(17)=QD            ! QD     ! [numeric] outflow from UH2 branch after exchange (QD) [mm/hour]
+      MISC(18)=Q             ! Qsim   ! [numeric] simulated outflow at catchment outlet [mm/hour]