RunModel_GR5J.R 6.2 KB
Newer Older
1
RunModel_GR5J <- function(InputsModel,RunOptions,Param) {
2
  
3
4
  
  ## Initialization of variables
5
6
7
  NParam <- 5;
  FortranOutputs <- .FortranOutputs(GR = "GR5J")$GR
  
8
9
  
  ## Arguments_check
10
11
12
13
14
  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(RunOptions,"RunOptions"  ) == FALSE) { stop("'RunOptions' must be of class 'RunOptions'  ") }  
  if (inherits(RunOptions,"GR"          ) == FALSE) { stop("'RunOptions' must be of class 'GR'          ") }  
15
  if (!is.vector(Param) | !is.numeric(Param)) { stop("'Param' must be a numeric vector") }
16
  if (sum(!is.na(Param)) != NParam) { stop(paste("'Param' must be a vector of length ",NParam," and contain no NA",sep = "")) }
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
  Param <- as.double(Param);
  
  Param_X1X3_threshold <- 1e-2
  Param_X4_threshold   <- 0.5
  if (Param[1L] < Param_X1X3_threshold) {
    warning(sprintf("Param[1] (X1: production store capacity [mm]) < %.2f\n X1 set to %.2f", Param_X1X3_threshold, Param_X1X3_threshold))
    Param[1L] <- Param_X1X3_threshold
  }
  if (Param[3L] < Param_X1X3_threshold) {
    warning(sprintf("Param[3] (X3: routing store capacity [mm]) < %.2f\n X3 set to %.2f", Param_X1X3_threshold, Param_X1X3_threshold))
    Param[3L] <- Param_X1X3_threshold
  }
  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
  }      
  
34
  ## Input_data_preparation
35
  if (identical(RunOptions$IndPeriod_WarmUp,as.integer(0))) { RunOptions$IndPeriod_WarmUp <- NULL; }
36
37
  IndPeriod1   <- c(RunOptions$IndPeriod_WarmUp,RunOptions$IndPeriod_Run);
  LInputSeries <- as.integer(length(IndPeriod1))
38
  if ("all" %in% RunOptions$Outputs_Sim) { IndOutputs <- as.integer(1:length(FortranOutputs)); 
39
40
  } else { IndOutputs <- which(FortranOutputs %in% RunOptions$Outputs_Sim);  }
  
41
  ## Output_data_preparation
42
43
44
45
  IndPeriod2     <- (length(RunOptions$IndPeriod_WarmUp)+1):LInputSeries;
  ExportDatesR   <- "DatesR"   %in% RunOptions$Outputs_Sim;
  ExportStateEnd <- "StateEnd" %in% RunOptions$Outputs_Sim;
  
46
  ## Use_of_IniResLevels
47
  if (!is.null(RunOptions$IniResLevels)) {
48
49
    RunOptions$IniStates[1] <- RunOptions$IniResLevels[1]*Param[1]; ### production store level (mm)
    RunOptions$IniStates[2] <- RunOptions$IniResLevels[2]*Param[3]; ### routing store level (mm)
50
51
  }
  
52
  ## Call_fortan
53
  RESULTS <- .Fortran("frun_gr5j",PACKAGE = "airGR",
54
                      ## inputs
55
56
57
58
59
60
61
62
63
                      LInputs = LInputSeries,                             ### length of input and output series
                      InputsPrecip = InputsModel$Precip[IndPeriod1],      ### input series of total precipitation [mm/d]
                      InputsPE = InputsModel$PotEvap[IndPeriod1],         ### input series potential evapotranspiration [mm/d]
                      NParam = as.integer(length(Param)),                 ### number of model parameter
                      Param = Param,                                      ### parameter set
                      NStates = as.integer(length(RunOptions$IniStates)), ### number of state variables used for model initialising
                      StateStart = RunOptions$IniStates,                  ### state variables used when the model run starts
                      NOutputs = as.integer(length(IndOutputs)),          ### number of output series
                      IndOutputs = IndOutputs,                            ### indices of output series
64
                      ## outputs
65
66
                      Outputs = matrix(as.double(-999.999),nrow = LInputSeries,ncol = length(IndOutputs)), ### output series [mm]
                      StateEnd = rep(as.double(-999.999),length(RunOptions$IniStates))                 ### state variables at the end of the model run
67
  )
68
69
  RESULTS$Outputs[ round(RESULTS$Outputs ,3) == (-999.999)] <- NA;
  RESULTS$StateEnd[round(RESULTS$StateEnd,3) == (-999.999)] <- NA;
70
71
72
73
74
75
76
77
78
  if (ExportStateEnd) {
    RESULTS$StateEnd[-3L] <- ifelse(RESULTS$StateEnd[-3L] < 0, 0, RESULTS$StateEnd[-3L]) ### remove negative values except for the ExpStore location
    RESULTS$StateEnd <- CreateIniStates(FUN_MOD = RunModel_GR5J, InputsModel = InputsModel,
                                        ProdStore = RESULTS$StateEnd[1L], RoutStore = RESULTS$StateEnd[2L], ExpStore = NULL,
                                        UH1 = NULL, UH2 = RESULTS$StateEnd[(1:40)+(7+20)],
                                        GCemaNeigeLayers = NULL, eTGCemaNeigeLayers = NULL,
                                        verbose = FALSE)
  }
  
79
80
  ## Output_data_preparation
  ## OutputsModel_only
81
  if (ExportDatesR == FALSE & ExportStateEnd == FALSE) {
82
83
    OutputsModel <- lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]);
    names(OutputsModel) <- FortranOutputs[IndOutputs];      }
84
  ## DatesR_and_OutputsModel_only
85
  if (ExportDatesR == TRUE & ExportStateEnd == FALSE) {
86
87
88
    OutputsModel <- c( list(InputsModel$DatesR[RunOptions$IndPeriod_Run]),
                       lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]) );
    names(OutputsModel) <- c("DatesR",FortranOutputs[IndOutputs]);      }
89
  ## OutputsModel_and_SateEnd_only
90
  if (ExportDatesR == FALSE & ExportStateEnd == TRUE) {
91
92
93
    OutputsModel <- c( lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                       list(RESULTS$StateEnd) );
    names(OutputsModel) <- c(FortranOutputs[IndOutputs],"StateEnd");      }
94
  ## DatesR_and_OutputsModel_and_SateEnd
95
  if ((ExportDatesR == TRUE & ExportStateEnd == TRUE) | "all" %in% RunOptions$Outputs_Sim) {
96
97
98
99
100
    OutputsModel <- c( list(InputsModel$DatesR[RunOptions$IndPeriod_Run]),
                       lapply(seq_len(RESULTS$NOutputs), function(i) RESULTS$Outputs[IndPeriod2,i]),
                       list(RESULTS$StateEnd) );
    names(OutputsModel) <- c("DatesR",FortranOutputs[IndOutputs],"StateEnd");      }
  
101
  ## End
102
103
104
105
  rm(RESULTS); 
  class(OutputsModel) <- c("OutputsModel","daily","GR");
  return(OutputsModel);
  
Delaigue Olivier's avatar
Delaigue Olivier committed
106
}