RunModel_CemaNeigeGR4J.R 12 KB
Newer Older
1
RunModel_CemaNeigeGR4J <- function(InputsModel,RunOptions,Param){
Delaigue Olivier's avatar
Delaigue Olivier committed
2

3
  
4
5
6
  ## Initialization of variables
  IsHyst <- inherits(RunOptions, "hysteresis")
  NParam <- ifelse(test = IsHyst, yes = 8L, no = 6L)
7
  NStates <- 4L
8
9
  FortranOutputs <- .FortranOutputs(GR = "GR4J", isCN = TRUE)

10
    
Delaigue Olivier's avatar
Delaigue Olivier committed
11
    ##Arguments_check
12
13
14
15
16
17
18
19
20
      if(inherits(InputsModel,"InputsModel")==FALSE){ stop("InputsModel must be of class 'InputsModel'") }  
      if(inherits(InputsModel,"daily"      )==FALSE){ stop("InputsModel must be of class 'daily'      ") }  
      if(inherits(InputsModel,"GR"         )==FALSE){ stop("InputsModel must be of class 'GR'         ") }  
      if(inherits(InputsModel,"CemaNeige"  )==FALSE){ stop("InputsModel must be of class 'CemaNeige'  ") }  
      if(inherits(RunOptions,"RunOptions"  )==FALSE){ stop("RunOptions must be of class 'RunOptions'  ") }  
      if(inherits(RunOptions,"GR"          )==FALSE){ stop("RunOptions must be of class 'GR'          ") }  
      if(inherits(RunOptions,"CemaNeige"   )==FALSE){ stop("RunOptions must be of class 'CemaNeige'   ") }  
      if(!is.vector(Param) | !is.numeric(Param)){ stop("Param must be a numeric vector") }
      if(sum(!is.na(Param))!=NParam){ stop(paste("Param must be a vector of length ",NParam," and contain no NA",sep="")) }
Delaigue Olivier's avatar
Delaigue Olivier committed
21
22
      Param <- as.double(Param);

23
      Param_X1X3_threshold <- 1e-2
24
      Param_X4_threshold   <- 0.5
25
      if (Param[1L] < Param_X1X3_threshold) {
26
        warning(sprintf("Param[1] (X1: production store capacity [mm]) < %.2f\n X1 set to %.2f", Param_X1X3_threshold, Param_X1X3_threshold))
27
28
29
        Param[1L] <- Param_X1X3_threshold
      }
      if (Param[3L] < Param_X1X3_threshold) {
30
        warning(sprintf("Param[3] (X3: routing store capacity [mm]) < %.2f\n X3 set to %.2f", Param_X1X3_threshold, Param_X1X3_threshold))
31
32
        Param[3L] <- Param_X1X3_threshold
      }
33
34
35
36
      if (Param[4L] < Param_X4_threshold) {
        warning(sprintf("Param[4] (X4: unit hydrograph time constant [d]) < %.2f\n X4 set to %.2f", Param_X4_threshold, Param_X4_threshold))
        Param[4L] <- Param_X4_threshold
      }      
37
      
Delaigue Olivier's avatar
Delaigue Olivier committed
38
39
40
41
42
    ##Input_data_preparation
      if(identical(RunOptions$IndPeriod_WarmUp,as.integer(0))){ RunOptions$IndPeriod_WarmUp <- NULL; }
      IndPeriod1     <- c(RunOptions$IndPeriod_WarmUp,RunOptions$IndPeriod_Run);
      LInputSeries   <- as.integer(length(IndPeriod1))
      IndPeriod2     <- (length(RunOptions$IndPeriod_WarmUp)+1):LInputSeries;
43
      ParamCemaNeige <- Param[(length(Param)-1-2*as.integer(IsHyst)):length(Param)];
44
      NParamMod      <- as.integer(length(Param)-(2+2*as.integer(IsHyst)));
Delaigue Olivier's avatar
Delaigue Olivier committed
45
46
      ParamMod       <- Param[1:NParamMod];
      NLayers        <- length(InputsModel$LayerPrecip);
47
      NStatesMod     <- as.integer(length(RunOptions$IniStates)-NStates*NLayers);
Delaigue Olivier's avatar
Delaigue Olivier committed
48
49
50
      ExportDatesR   <- "DatesR"   %in% RunOptions$Outputs_Sim;
      ExportStateEnd <- "StateEnd" %in% RunOptions$Outputs_Sim;

51
      
Delaigue Olivier's avatar
Delaigue Olivier committed
52
    ##SNOW_MODULE________________________________________________________________________________##
53
    if(inherits(RunOptions,"CemaNeige")==TRUE){
54
55
      if("all" %in% RunOptions$Outputs_Sim){ IndOutputsCemaNeige <- as.integer(1:length(FortranOutputs$CN)); 
      } else { IndOutputsCemaNeige <- which(FortranOutputs$CN %in% RunOptions$Outputs_Sim);  }
Delaigue Olivier's avatar
Delaigue Olivier committed
56
57
      CemaNeigeLayers <- list(); CemaNeigeStateEnd <- NULL; NameCemaNeigeLayers <- "CemaNeigeLayers";

58

Delaigue Olivier's avatar
Delaigue Olivier committed
59
60
    ##Call_DLL_CemaNeige_________________________
      for(iLayer in 1:NLayers){
61
        StateStartCemaNeige <- RunOptions$IniStates[(7+20+40) + c(iLayer, iLayer+NLayers)]
62
        RESULTS <- .Fortran("frun_CemaNeige",PACKAGE="airGR",
Delaigue Olivier's avatar
Delaigue Olivier committed
63
                        ##inputs
64
65
66
67
68
69
70
71
72
73
74
75
                            LInputs=LInputSeries,                                                         ### length of input and output series
                            InputsPrecip=InputsModel$LayerPrecip[[iLayer]][IndPeriod1],                   ### input series of total precipitation [mm/d]
                            InputsFracSolidPrecip=InputsModel$LayerFracSolidPrecip[[iLayer]][IndPeriod1], ### input series of fraction of solid precipitation [0-1]
                            InputsTemp=InputsModel$LayerTemp[[iLayer]][IndPeriod1],                       ### input series of air mean temperature [degC]
                            MeanAnSolidPrecip=RunOptions$MeanAnSolidPrecip[iLayer],                       ### value of annual mean solid precip [mm/y]
                            NParam=as.integer(NParam),                                                    ### number of model parameter = 2
                            Param=as.double(ParamCemaNeige),                                              ### parameter set
                            NStates=as.integer(NStates),                                                  ### number of state variables used for model initialising = 2
                            StateStart=StateStartCemaNeige,                                               ### state variables used when the model run starts
                            IsHyst = as.integer(IsHyst),                                                  ### use of hysteresis
                            NOutputs=as.integer(length(IndOutputsCemaNeige)),                             ### number of output series
                            IndOutputs=IndOutputsCemaNeige,                                               ### indices of output series
Delaigue Olivier's avatar
Delaigue Olivier committed
76
                        ##outputs                                                               
77
78
                            Outputs=matrix(as.double(-999.999),nrow=LInputSeries,ncol=length(IndOutputsCemaNeige)), ### output series [mm]
                            StateEnd=rep(as.double(-999.999),as.integer(NStates))                                   ### state variables at the end of the model run (reservoir levels [mm] and HU)
Delaigue Olivier's avatar
Delaigue Olivier committed
79
80
81
82
83
84
                         )
        RESULTS$Outputs[ round(RESULTS$Outputs ,3)==(-999.999)] <- NA;
        RESULTS$StateEnd[round(RESULTS$StateEnd,3)==(-999.999)] <- NA;

        ##Data_storage
        CemaNeigeLayers[[iLayer]] <- lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]);
85
        names(CemaNeigeLayers[[iLayer]]) <- FortranOutputs$CN[IndOutputsCemaNeige];
Delaigue Olivier's avatar
Delaigue Olivier committed
86
87
88
89
90
91
        IndPliqAndMelt <- which(names(CemaNeigeLayers[[iLayer]]) == "PliqAndMelt");
        if(iLayer==1){ CatchMeltAndPliq <- RESULTS$Outputs[,IndPliqAndMelt]/NLayers; }
        if(iLayer >1){ CatchMeltAndPliq <- CatchMeltAndPliq + RESULTS$Outputs[,IndPliqAndMelt]/NLayers; }
        if(ExportStateEnd){ CemaNeigeStateEnd <- c(CemaNeigeStateEnd,RESULTS$StateEnd); }
        rm(RESULTS); 
      } ###ENDFOR_iLayer
92
      names(CemaNeigeLayers) <- sprintf("Layer%02i", seq_len(NLayers))
Delaigue Olivier's avatar
Delaigue Olivier committed
93
    } ###ENDIF_RunSnowModule
94
    if(inherits(RunOptions,"CemaNeige")==FALSE){
Delaigue Olivier's avatar
Delaigue Olivier committed
95
96
97
98
99
100
      CemaNeigeLayers <- list(); CemaNeigeStateEnd <- NULL; NameCemaNeigeLayers <- NULL;
      CatchMeltAndPliq  <- InputsModel$Precip[IndPeriod1]; }



    ##MODEL______________________________________________________________________________________##
101
102
      if("all" %in% RunOptions$Outputs_Sim){ IndOutputsMod <- as.integer(1:length(FortranOutputs$GR)); 
      } else { IndOutputsMod <- which(FortranOutputs$GR %in% RunOptions$Outputs_Sim);  }
Delaigue Olivier's avatar
Delaigue Olivier committed
103
104

    ##Use_of_IniResLevels
105
      if(!is.null(RunOptions$IniResLevels)){
106
107
        RunOptions$IniStates[1] <- RunOptions$IniResLevels[1]*ParamMod[1];  ### production store level (mm)
        RunOptions$IniStates[2] <- RunOptions$IniResLevels[2]*ParamMod[3];  ### routing store level (mm)
Delaigue Olivier's avatar
Delaigue Olivier committed
108
109
110
      }

    ##Call_fortan
111
      RESULTS <- .Fortran("frun_GR4J",PACKAGE="airGR",
Delaigue Olivier's avatar
Delaigue Olivier committed
112
                 ##inputs
113
114
115
116
117
118
                     LInputs=LInputSeries,                          ### length of input and output series
                     InputsPrecip=CatchMeltAndPliq,                 ### input series of total precipitation [mm/d]
                     InputsPE=InputsModel$PotEvap[IndPeriod1],      ### input series potential evapotranspiration [mm/d]
                     NParam=NParamMod,                              ### number of model parameter
                     Param=ParamMod,                                ### parameter set
                     NStates=NStatesMod,                            ### number of state variables used for model initialising
Delaigue Olivier's avatar
Delaigue Olivier committed
119
                     StateStart=RunOptions$IniStates[1:NStatesMod], ### state variables used when the model run starts
120
121
                     NOutputs=as.integer(length(IndOutputsMod)),    ### number of output series
                     IndOutputs=IndOutputsMod,                      ### indices of output series
Delaigue Olivier's avatar
Delaigue Olivier committed
122
                 ##outputs                                        
123
124
                     Outputs=matrix(as.double(-999.999),nrow=LInputSeries,ncol=length(IndOutputsMod)), ### output series [mm]
                     StateEnd=rep(as.double(-999.999),NStatesMod)                                      ### state variables at the end of the model run
Delaigue Olivier's avatar
Delaigue Olivier committed
125
126
127
                     )
      RESULTS$Outputs[ round(RESULTS$Outputs ,3)==(-999.999)] <- NA;
      RESULTS$StateEnd[round(RESULTS$StateEnd,3)==(-999.999)] <- NA;
128
129
      if (ExportStateEnd) {
        idNStates <- seq_len(NStates*NLayers) %% NStates
130
131
132
        RESULTS$StateEnd <- CreateIniStates(FUN_MOD = RunModel_CemaNeigeGR4J, InputsModel = InputsModel,
                                            ProdStore = RESULTS$StateEnd[1L], RoutStore = RESULTS$StateEnd[2L], ExpStore = NULL,
                                            UH1 = RESULTS$StateEnd[(1:20)+7], UH2 = RESULTS$StateEnd[(1:40)+(7+20)],
133
134
135
136
                                            GCemaNeigeLayers       = CemaNeigeStateEnd[seq_len(NStates*NLayers)[idNStates == 3]],
                                            eTGCemaNeigeLayers     = CemaNeigeStateEnd[seq_len(NStates*NLayers)[idNStates == 2]],
                                            GthrCemaNeigeLayers    = CemaNeigeStateEnd[seq_len(NStates*NLayers)[idNStates == 1]], 
                                            GlocmaxCemaNeigeLayers = CemaNeigeStateEnd[seq_len(NStates*NLayers)[idNStates == 0]],
137
138
                                            verbose = FALSE)
      }
139
      
140
      if(inherits(RunOptions,"CemaNeige")==TRUE & "Precip" %in% RunOptions$Outputs_Sim){ RESULTS$Outputs[,which(FortranOutputs$GR[IndOutputsMod]=="Precip")] <- InputsModel$Precip[IndPeriod1]; }
Delaigue Olivier's avatar
Delaigue Olivier committed
141
142
143
144
145
146

    ##Output_data_preparation
      ##OutputsModel_only
      if(ExportDatesR==FALSE & ExportStateEnd==FALSE){
        OutputsModel <- c( lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                           list(CemaNeigeLayers) );
147
        names(OutputsModel) <- c(FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers); }
Delaigue Olivier's avatar
Delaigue Olivier committed
148
149
150
151
152
      ##DatesR_and_OutputsModel_only
      if(ExportDatesR==TRUE & ExportStateEnd==FALSE){
        OutputsModel <- c( list(InputsModel$DatesR[RunOptions$IndPeriod_Run]),
                           lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                           list(CemaNeigeLayers) );
153
        names(OutputsModel) <- c("DatesR",FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers);      }
Delaigue Olivier's avatar
Delaigue Olivier committed
154
155
156
157
      ##OutputsModel_and_SateEnd_only
      if(ExportDatesR==FALSE & ExportStateEnd==TRUE){
        OutputsModel <- c( lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                           list(CemaNeigeLayers),
158
                           list(RESULTS$StateEnd) );
159
        names(OutputsModel) <- c(FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers,"StateEnd");      }
Delaigue Olivier's avatar
Delaigue Olivier committed
160
161
162
163
164
      ##DatesR_and_OutputsModel_and_SateEnd
      if(ExportDatesR==TRUE & ExportStateEnd==TRUE){
        OutputsModel <- c( list(InputsModel$DatesR[RunOptions$IndPeriod_Run]),
                           lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                           list(CemaNeigeLayers),
165
                           list(RESULTS$StateEnd) );
166
        names(OutputsModel) <- c("DatesR",FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers,"StateEnd");      }
Delaigue Olivier's avatar
Delaigue Olivier committed
167
168
169

    ##End
      rm(RESULTS); 
170
   
171
172
173
174
      class(OutputsModel) <- c("OutputsModel","daily","GR","CemaNeige");
      if(IsHyst) {
        class(OutputsModel) <- c(class(OutputsModel), "hysteresis")
      }
Delaigue Olivier's avatar
Delaigue Olivier committed
175
176
177
178
      return(OutputsModel);

}