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

3
4
5
6
7
8
9
10
11
  
  ## Arguments_check
  if (!is.logical(IsHyst) | length(IsHyst) != 1L) {
    stop("'IsHyst' must be a 'logical' of length 1")
    return(NULL)
  }
  
  NParam <- ifelse(IsHyst, 8L, 6L)
  NStates <- 4L
12
13
  FortranOutputs <- .FortranOutputs(GR = "GR4J", isCN = TRUE)

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

27
      Param_X1X3_threshold <- 1e-2
28
      Param_X4_threshold   <- 0.5
29
      if (Param[1L] < Param_X1X3_threshold) {
30
        warning(sprintf("Param[1] (X1: production store capacity [mm]) < %.2f\n X1 set to %.2f", Param_X1X3_threshold, Param_X1X3_threshold))
31
32
33
        Param[1L] <- Param_X1X3_threshold
      }
      if (Param[3L] < Param_X1X3_threshold) {
34
        warning(sprintf("Param[3] (X3: routing store capacity [mm]) < %.2f\n X3 set to %.2f", Param_X1X3_threshold, Param_X1X3_threshold))
35
36
        Param[3L] <- Param_X1X3_threshold
      }
37
38
39
40
      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
      }      
41
      
Delaigue Olivier's avatar
Delaigue Olivier committed
42
43
44
45
46
    ##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;
47
      ParamCemaNeige <- Param[(length(Param)-1-2*as.integer(IsHyst)):length(Param)];
48
      NParamMod      <- as.integer(length(Param)-(2+2*as.integer(IsHyst)));
Delaigue Olivier's avatar
Delaigue Olivier committed
49
50
      ParamMod       <- Param[1:NParamMod];
      NLayers        <- length(InputsModel$LayerPrecip);
51
      NStatesMod     <- as.integer(length(RunOptions$IniStates)-NStates*NLayers);
Delaigue Olivier's avatar
Delaigue Olivier committed
52
53
54
      ExportDatesR   <- "DatesR"   %in% RunOptions$Outputs_Sim;
      ExportStateEnd <- "StateEnd" %in% RunOptions$Outputs_Sim;

55
      
Delaigue Olivier's avatar
Delaigue Olivier committed
56
    ##SNOW_MODULE________________________________________________________________________________##
57
    if(inherits(RunOptions,"CemaNeige")==TRUE){
58
59
      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
60
61
      CemaNeigeLayers <- list(); CemaNeigeStateEnd <- NULL; NameCemaNeigeLayers <- "CemaNeigeLayers";

62

Delaigue Olivier's avatar
Delaigue Olivier committed
63
64
    ##Call_DLL_CemaNeige_________________________
      for(iLayer in 1:NLayers){
65
        StateStartCemaNeige <- RunOptions$IniStates[(7+20+40) + c(iLayer, iLayer+NLayers)]
66
        RESULTS <- .Fortran("frun_CemaNeige",PACKAGE="airGR",
Delaigue Olivier's avatar
Delaigue Olivier committed
67
68
69
70
71
72
                        ##inputs
                            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]
73
74
75
                            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
Delaigue Olivier's avatar
Delaigue Olivier committed
76
                            StateStart=StateStartCemaNeige,                                                ### state variables used when the model run starts
77
                        IsHyst = as.integer(IsHyst),                                                    ### use of hysteresis
Delaigue Olivier's avatar
Delaigue Olivier committed
78
79
80
81
                            NOutputs=as.integer(length(IndOutputsCemaNeige)),                              ### number of output series
                            IndOutputs=IndOutputsCemaNeige,                                                ### indices of output series
                        ##outputs                                                               
                            Outputs=matrix(as.double(-999.999),nrow=LInputSeries,ncol=length(IndOutputsCemaNeige)),  ### output series [mm]
82
                            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
83
84
85
86
87
88
                         )
        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]);
89
        names(CemaNeigeLayers[[iLayer]]) <- FortranOutputs$CN[IndOutputsCemaNeige];
Delaigue Olivier's avatar
Delaigue Olivier committed
90
91
92
93
94
95
        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
96
      names(CemaNeigeLayers) <- sprintf("Layer%02i", seq_len(NLayers))
Delaigue Olivier's avatar
Delaigue Olivier committed
97
    } ###ENDIF_RunSnowModule
98
    if(inherits(RunOptions,"CemaNeige")==FALSE){
Delaigue Olivier's avatar
Delaigue Olivier committed
99
100
101
102
103
104
      CemaNeigeLayers <- list(); CemaNeigeStateEnd <- NULL; NameCemaNeigeLayers <- NULL;
      CatchMeltAndPliq  <- InputsModel$Precip[IndPeriod1]; }



    ##MODEL______________________________________________________________________________________##
105
106
      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
107
108

    ##Use_of_IniResLevels
109
      if(!is.null(RunOptions$IniResLevels)){
110
111
        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
112
113
114
      }

    ##Call_fortan
115
      RESULTS <- .Fortran("frun_GR4J",PACKAGE="airGR",
Delaigue Olivier's avatar
Delaigue Olivier committed
116
117
118
119
120
121
122
123
124
125
126
127
                 ##inputs
                     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
                     StateStart=RunOptions$IniStates[1:NStatesMod], ### state variables used when the model run starts
                     NOutputs=as.integer(length(IndOutputsMod)),   ### number of output series
                     IndOutputs=IndOutputsMod,                     ### indices of output series
                 ##outputs                                        
                     Outputs=matrix(as.double(-999.999),nrow=LInputSeries,ncol=length(IndOutputsMod)),  ### output series [mm]
128
                     StateEnd=rep(as.double(-999.999),NStatesMod)                     ### state variables at the end of the model run
Delaigue Olivier's avatar
Delaigue Olivier committed
129
130
131
                     )
      RESULTS$Outputs[ round(RESULTS$Outputs ,3)==(-999.999)] <- NA;
      RESULTS$StateEnd[round(RESULTS$StateEnd,3)==(-999.999)] <- NA;
132
133
      if (ExportStateEnd) {
        idNStates <- seq_len(NStates*NLayers) %% NStates
134
135
136
        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)],
137
138
139
140
                                            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]],
141
142
                                            verbose = FALSE)
      }
143
      
144
      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
145
146
147
148
149
150

    ##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) );
151
        names(OutputsModel) <- c(FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers); }
Delaigue Olivier's avatar
Delaigue Olivier committed
152
153
154
155
156
      ##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) );
157
        names(OutputsModel) <- c("DatesR",FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers);      }
Delaigue Olivier's avatar
Delaigue Olivier committed
158
159
160
161
      ##OutputsModel_and_SateEnd_only
      if(ExportDatesR==FALSE & ExportStateEnd==TRUE){
        OutputsModel <- c( lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                           list(CemaNeigeLayers),
162
                           list(RESULTS$StateEnd) );
163
        names(OutputsModel) <- c(FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers,"StateEnd");      }
Delaigue Olivier's avatar
Delaigue Olivier committed
164
165
166
167
168
      ##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),
169
                           list(RESULTS$StateEnd) );
170
        names(OutputsModel) <- c("DatesR",FortranOutputs$GR[IndOutputsMod],NameCemaNeigeLayers,"StateEnd");      }
Delaigue Olivier's avatar
Delaigue Olivier committed
171
172
173

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

}