Skip to content
GitLab
Select Git revision
  • code_refactor
  • board_v4
  • EGU23
  • revert-559ef012
  • MUX_board_v2024
  • master default
  • battery_charger
  • mqtt
  • dev2
  • Ohmpi_1.0x
  • v2023.0.0
  • V1.02
  • v1.01
  • v1
Find file BlameHistoryPermalink
Forked from reversaal / OhmPi
Source project has a limited visibility.
CreateRunOptions.R 15.89 KiB
1 
CreateRunOptions <- function(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run, IniStates = NULL, IniResLevels = NULL,
2 
                             Outputs_Cal = NULL, Outputs_Sim = "all", RunSnowModule, MeanAnSolidPrecip = NULL,  verbose = TRUE) {
3
4 
  if (!missing(RunSnowModule)) {
5 
    warning("argument RunSnowModule is deprecated; please adapt FUN_MOD instead.", call. = FALSE)
6 
  }
7
8 
  ObjectClass <- NULL
9
10 
  ##check_FUN_MOD
11 
    BOOL <- FALSE;
12 
    if(identical(FUN_MOD,RunModel_GR4H)){
13 
      ObjectClass <- c(ObjectClass,"GR","hourly");
14 
      BOOL <- TRUE;
15 
    }
16 
    if(identical(FUN_MOD,RunModel_GR4J) | identical(FUN_MOD,RunModel_GR5J) | identical(FUN_MOD,RunModel_GR6J)){
17 
      ObjectClass <- c(ObjectClass,"GR","daily");
18 
      BOOL <- TRUE;
19 
    }
20 
    if(identical(FUN_MOD,RunModel_GR2M)){
21 
      ObjectClass <- c(ObjectClass,"GR","monthly");
22 
      BOOL <- TRUE;
23 
    }
24 
    if(identical(FUN_MOD,RunModel_GR1A)){
25 
      ObjectClass <- c(ObjectClass,"GR","yearly");
26 
      BOOL <- TRUE;
27 
    }
28 
    if(identical(FUN_MOD,RunModel_CemaNeige)){
29 
      ObjectClass <- c(ObjectClass,"CemaNeige","daily");
30 
      BOOL <- TRUE;
31 
    }
32 
    if(identical(FUN_MOD,RunModel_CemaNeigeGR4J) | identical(FUN_MOD,RunModel_CemaNeigeGR5J) | identical(FUN_MOD,RunModel_CemaNeigeGR6J)){
33 
      ObjectClass <- c(ObjectClass,"GR","CemaNeige","daily");
34 
      BOOL <- TRUE;
35 
    }
36 
    if(!BOOL){ stop("incorrect FUN_MOD for use in CreateRunOptions \n"); return(NULL); }
37
38
39 
  ##check_InputsModel
40 
    if(!inherits(InputsModel,"InputsModel")){
41 
      stop("InputsModel must be of class 'InputsModel' \n"); return(NULL); }
42 
    if("GR" %in% ObjectClass & !inherits(InputsModel,"GR")){
43 
      stop("InputsModel must be of class 'GR' \n"); return(NULL); }
44 
    if("CemaNeige" %in% ObjectClass & !inherits(InputsModel,"CemaNeige")){
45 
      stop("InputsModel must be of class 'CemaNeige' \n"); return(NULL); }
46 
    if("hourly" %in% ObjectClass & !inherits(InputsModel,"hourly")){
47 
      stop("InputsModel must be of class 'hourly' \n"); return(NULL); }
48 
    if("daily" %in% ObjectClass & !inherits(InputsModel,"daily")){
49 
      stop("InputsModel must be of class 'daily' \n"); return(NULL); }
50 
    if("monthly" %in% ObjectClass & !inherits(InputsModel,"monthly")){
51 
      stop("InputsModel must be of class 'monthly' \n"); return(NULL); }
52 
    if("yearly" %in% ObjectClass & !inherits(InputsModel,"yearly")){
53 
      stop("InputsModel must be of class 'yearly' \n"); return(NULL); }
54
55
56 
  ##check_IndPeriod_Run
57 
    if(!is.vector( IndPeriod_Run)){ stop("IndPeriod_Run must be a vector of numeric values \n"); return(NULL); }
58 
    if(!is.numeric(IndPeriod_Run)){ stop("IndPeriod_Run must be a vector of numeric values \n"); return(NULL); }
59 
    if(identical(as.integer(IndPeriod_Run),as.integer(seq(from=IndPeriod_Run[1],to=tail(IndPeriod_Run,1),by=1)))==FALSE){
60 
      stop("IndPeriod_Run must be a continuous sequence of integers \n"); return(NULL); }
61 
    if(storage.mode(IndPeriod_Run)!="integer"){ stop("IndPeriod_Run should be of type integer \n"); return(NULL); }
62
63
64 
  ##check_IndPeriod_WarmUp
65 
    WTxt <- NULL;
66 
    if(is.null(IndPeriod_WarmUp)){
67 
      WTxt <- paste(WTxt,"\t Model warm-up period not defined -> default configuration used \n",sep="");
68 
      ##If_the_run_period_starts_at_the_very_beginning_of_the_time_series
69 
      if(IndPeriod_Run[1]==as.integer(1)){
70 
        IndPeriod_WarmUp <- as.integer(0);