v492 - YEAR in conditions; named constants in FEWS; bug fix

support for YEAR in control structure and water managemetn operating conditions (ControlStructures.cpp;DemandExpressionHandling.cpp)
support for named constants and target stage in FEWS runinfo file (ParseFEWSRunInfo.cpp)
include version # and build date in Raven_errors.txt (RavenMain.cpp) (B. Tolson suggestion)

bug fixes:
-Proper check for leap year in DateStringToTimeStruct() (CommonFunctions.cpp) (found by M. Revel)

clean up/cosmetic:
-renamed GetDemandOptimizer() to GetManagementOptimizer (Model.cpp/.h;ParseManagementFile.cpp;ParseTimeSeriesFile.cpp;Solvers.cpp;WaterDemands.cpp)
-advisory for calling :OutputDirectory instead of using -o flag (ParseInput.cpp)

Author: James Craig

src/CommonFunctions.cpp

@@ -442,7 +442,10 @@ time_struct DateStringToTimeStruct(const string sDate, string sTime, const int c
   if (tt.month==12){tt.julian_day+=30;}
   if ((tt.leap_yr  ) && (tt.month> 2)){tt.julian_day+= 1;}
 
-  if (tt.day_of_month > DAYS_PER_MONTH[tt.month - 1]) {
+  int leap=0;
+  if (tt.leap_yr){leap=1;}
+
+  if (tt.day_of_month > (DAYS_PER_MONTH[tt.month - 1]+leap)) {
     ExitGracefully("DateStringToTimeStruct: Invalid time format used - exceeded max day of month",BAD_DATA);
   }
   if (tt.day_of_month <=0 ) {

src/ControlStructures.cpp

@@ -210,11 +210,11 @@ void    COutflowRegime::AddRegimeConstraint(RegimeConstraint* pCond)
 //
 bool EvaluateCondition(const comparison cond, const double& v, const double& v1, const double& v2)
 {
-  if      (cond==COMPARE_IS_EQUAL   ){return (v==v1); }
-  else if (cond==COMPARE_NOT_EQUAL  ){return (v!=v1); }
+  if      (cond==COMPARE_IS_EQUAL   ){return fabs(v-v1)<REAL_SMALL; }
+  else if (cond==COMPARE_NOT_EQUAL  ){return fabs(v-v1)>REAL_SMALL; }
   else if (cond==COMPARE_GREATERTHAN){return (v>v1);  }
   else if (cond==COMPARE_LESSTHAN   ){return (v<v1);  }
-  else if (cond==COMPARE_BETWEEN    ){return (v>=v1) && (v<=v2); }
+  else if (cond==COMPARE_BETWEEN    ){return (v>=v1) && (v<=v2); }//inclusive
   return false;
 }
 
@@ -236,6 +236,9 @@ bool      COutflowRegime::AreConditionsMet(const time_struct& tt) const
     if      (var == "DATE") {
       if (!EvaluateCondition(comp, tt.model_time, v1, v2)) {return false;}
     }
+    else if (var == "YEAR") {
+      if (!EvaluateCondition(comp, (double)(tt.year), v1, v2)) {return false;}
+    }
     else if ((var == "DOY") || (var=="DAY_OF_YEAR")) {
       if (comp!=COMPARE_BETWEEN){
         if (!EvaluateCondition(comp, tt.julian_day, v1, v2)) {return false;}

src/DemandExpressionHandling.cpp

@@ -1083,6 +1083,10 @@ bool CDemandOptimizer::CheckOpRegimeConditions(const op_regime *pOperRegime, con
       {
         dv_value=(double)(tt.month);
       }
+      else if (pCond->dv_name == "YEAR")
+      {
+        dv_value = (double)(tt.year);
+      }
       else if (pCond->dv_name == "DATE")
       {
         dv_value=0;

src/DemandOptimization.h

@@ -79,7 +79,7 @@ struct decision_var
 //
 struct exp_condition
 {
-  string      dv_name;      //< decision variable name (e.g., Q1023) or "MONTH" or "DATE" or "DAY_OF_YEAR"
+  string      dv_name;      //< decision variable name (e.g., Q1023) or "MONTH" or "DATE" or "DAY_OF_YEAR" or "YEAR"
   double      value;        //< conditional value
   double      value2;       //< second conditional (if COMPARE_BETWEEN)
   string      date_string;  //< conditional value (if date)

src/ForcingGrid.cpp

@@ -466,7 +466,7 @@ void CForcingGrid::ForcingGridInit(const optStruct   &Options)
   // -------------------------------
   // add time shift to data
   //      --> only applied when _interval < 1.0 (daily)
-  //      --> otherwise ignored and warning written to RavenErrors.txt
+  //      --> otherwise ignored and warning written to Raven_errors.txt
   // -------------------------------
   if (_interval >= 1.0) {   // data are not sub-daily
     if ( ceil(_TimeShift) == _TimeShift) {  // time shift of whole days requested

src/Model.cpp

@@ -976,7 +976,7 @@ CEnsemble  *CModel::GetEnsemble() const { return _pEnsemble; }
 /// \brief Returns demand optimizer
 /// \return pointer to demand optimizer
 //
-CDemandOptimizer  *CModel::GetDemandOptimizer() const { return _pDO; }
+CDemandOptimizer  *CModel::GetManagementOptimizer() const { return _pDO; }
 
 /*****************************************************************
    Watershed Diagnostic Functions

src/Model.h

@@ -439,7 +439,7 @@ class CModel: public CModelABC
   CTransportModel     *GetTransportModel              () const;
   CGroundwaterModel   *GetGroundwaterModel            () const;
   CEnsemble           *GetEnsemble                    () const;
-  CDemandOptimizer    *GetDemandOptimizer             () const;
+  CDemandOptimizer    *GetManagementOptimizer         () const;
 
   void              GetParticipatingParamList         (string *aP,
                                                        class_type *aPC,

src/ParseFEWSRunInfo.cpp

@@ -279,6 +279,52 @@ bool ParseNetCDFRunInfoFile(CModel *&pModel, optStruct &Options, bool runname_ov
       if(Options.noisy) { cout << "ParseRunInfoFile: read properties:AssimilateStreamflow from NetCDF: " << (!strcmp(boolean,"true"))  << endl; }
       delete[] boolean;
     }
+
+    // Other attributes with info embedded in attribute name 
+    int nAttributes;
+    char att_name[NC_MAX_NAME];
+    double att_value;
+    retval = nc_inq_varnatts(ncid,varid_props,&nAttributes);
+    if (retval==NC_NOERR){
+      for (int i = 0; i < nAttributes; i++) {
+        retval=nc_inq_attname(ncid,varid_props,i,att_name);
+        if (retval==NO_ERROR){
+          string att_name_s=to_string(att_name);
+
+          // NamedConstant(s) ----------------------------------------------------
+
+          if (att_name_s.substr(0, 14) == "NamedConstant_") {
+            string name=att_name_s.substr(14,att_name_s.length());
+
+            retval=nc_get_att_double(ncid,varid_props,att_name,&att_value);
+
+            cout<<"RUN INFO NAMED CONSTANT = "<<name<<" value = "<<att_value <<endl;
+
+            pModel->GetManagementOptimizer()->AddUserConstant(att_name,att_value);
+          }
+
+          // TargetStageSet_ ----------------------------------------------------
+
+          if (att_name_s.substr(0, 15) == "TargetStageSet_") {
+            string SBID_s=att_name_s.substr(15,att_name_s.length());
+            long long SBID=s_to_ll(SBID_s.c_str());
+            
+            retval = nc_inq_attlen(ncid, varid_props, att_name, &att_len);
+            char* boolean = new char[att_len + 1];
+            retval = nc_get_att_text(ncid,varid_props,att_name,boolean);       HandleNetCDFErrors(retval);// read attribute text
+            boolean[att_len] = '\0';// add string determining character
+
+             if (!strcmp(boolean,"true")) {
+                
+               // LOOK for User Time Series 
+               //pModel->GetManagementOptimizer()->LookForTargetStageInUserTS(SBID);
+               // creates !hSBID = @ts("TargetStage_SBID",0) management goal , ensures units correction applied
+               ExitGracefully("RUN INFO FILE - TARGET STAGE SET ",STUB);
+             }
+          }
+        }
+      }
+    }
   }
   else {
     WriteWarning("ParseNetCDFRunInfoFile: Properties variable not found",Options.noisy);
@@ -306,7 +352,7 @@ bool ParseNetCDFRunInfoFile(CModel *&pModel, optStruct &Options, bool runname_ov
 //  The index i of each entry will be the same as that used by the matrix in part 3.
 // 3)	One or more matrices of size[1:time,1:stations] which includes the state variable being updated,using the
 //  same indexing[i=1:stations] as the vector of HRUIDs. Blank values will not be updated. Raven model HRUs with IDs
-//  not in this list will not be updated. HRUIDs in this list but not in Raven model will throw a warning to RavenErrors.txt.
+//  not in this list will not be updated. HRUIDs in this list but not in Raven model will throw a warning to Raven_errors.txt.
 //  The naming convention of this attribute is equivalent to the raven state variable tag,e.g.,SNOW,PONDED_WATER,SOIL[0].
 //  The state variable corresponding to the model start time will be used for initialization; all other values in the time vector are ignored
 //  Note : this ONLY looks for state variables that are in model, all other state variable arrays will be ignored
@@ -498,7 +544,7 @@ bool ParseNetCDFStateFile(CModel *&pModel,const optStruct &Options)
 //  The index i of each entry will be the same as that used by the matrix in part 3.
 // 3)	One or more matrices of size[1:time,1:stations] which includes the flow/stage state variable being initialized,using the
 //  same indexing[i=1:stations] as the vector of SBIDs. Blank values will not be updated. Raven model subbasins with IDs
-//  not in this list will not be updated. SBIDs in this list but not in Raven model will throw a warning to RavenErrors.txt.
+//  not in this list will not be updated. SBIDs in this list but not in Raven model will throw a warning to Raven_errors.txt.
 // .The state variable corresponding to the model start time will be used for initialization of flow/stage; all other values in the time vector are ignored
 //  The naming convention of this attribute is one of: {QOUT, STAGE,  }
 //

src/ParseInput.cpp

@@ -1510,8 +1510,10 @@ bool ParseMainInputFile (CModel     *&pModel,
         Options.main_output_dir=Options.output_dir;
         PrepareOutputdirectory(Options);
 
-        ofstream WARNINGS((Options.main_output_dir+"Raven_errors.txt").c_str());
+        ofstream WARNINGS((Options.main_output_dir+"Raven_errors.txt").c_str()); //This means RavenErrors.txt was also created in default directory
         WARNINGS.close();
+
+        WriteAdvisory("ParseInput: recommended practice is to specify the output directory from the command line, rather than using the :OutputDirectory command.",Options.noisy);
       }
       else {
         WriteWarning("ParseMainInputFile: :OutputDirectory command was ignored because directory was specified from command line.",Options.noisy);

src/ParseManagementFile.cpp

@@ -95,7 +95,7 @@ bool ParseManagementFile(CModel *&pModel,const optStruct &Options)
   }
   int    nWildcards=0;
 
-  CDemandOptimizer *pDO=pModel->GetDemandOptimizer();
+  CDemandOptimizer *pDO=pModel->GetManagementOptimizer();
 
   pDO->Initialize(pModel,Options); //only requires rvh,.rvt read
 
@@ -968,7 +968,7 @@ bool ParseManagementFile(CModel *&pModel,const optStruct &Options)
           pDemand=new CDemand(demand_ID,demand_name,demandSBID,false,pModel);
           pDemand->SetLocalIndex(demand_ind);
           pSB->AddWaterDemand(pDemand);
-          pModel->GetDemandOptimizer()->AddWaterDemand(pDemand);
+          pModel->GetManagementOptimizer()->AddWaterDemand(pDemand);
         }
         else {
            ExitGracefully("Invalid subbasin ID in :WaterDemand command header.",BAD_DATA_WARN);
@@ -1172,7 +1172,7 @@ bool ParseManagementFile(CModel *&pModel,const optStruct &Options)
             pDemand=new CDemand(demand_ID,demand_name,demandSBID,true,pModel);
             pDemand->SetLocalIndex(demand_ind);
             pSB->GetReservoir()->AddDemand(pDemand);
-            pModel->GetDemandOptimizer()->AddWaterDemand(pDemand);
+            pModel->GetManagementOptimizer()->AddWaterDemand(pDemand);
           }
           else
           {
@@ -1213,7 +1213,7 @@ bool ParseManagementFile(CModel *&pModel,const optStruct &Options)
       CTimeSeries *pTimeSer;
       if(Options.noisy) { cout <<"User-specified Time Series"<<endl; }
       pTimeSer=CTimeSeries::Parse(pp,true,s[1], DOESNT_EXIST, "none", Options);
-      pModel->GetDemandOptimizer()->AddUserTimeSeries(pTimeSer);
+      pModel->GetManagementOptimizer()->AddUserTimeSeries(pTimeSer);
       break;
     }
     default://------------------------------------------------