Add wild fire setting switches

config/config.js

@@ -68,6 +68,7 @@
       "baseline": false,
       "dsb": false,
       "dsl": false,
+      //FW_NOTES: Fire will never be on in the pre-run so we don't need a switch?
       "dyn_lai": false
     },
     "eq": {
@@ -78,6 +79,7 @@
       "baseline": true,
       "dsb": false,
       "dsl": true,
+      "fire": false,
       "dyn_lai": true
     },
     "sp": {
@@ -88,6 +90,7 @@
       "baseline": true,
       "dsb": false,
       "dsl": true,
+      "fire": false,
       "dyn_lai": true 
     },
     "tr": {
@@ -98,6 +101,7 @@
       "baseline": true,
       "dsb": false,
       "dsl": true,
+      "fire": false,
       "dyn_lai": true
     },
     "sc": {
@@ -108,6 +112,7 @@
       "baseline": true,
       "dsb": false,
       "dsl": true,
+      "fire": false,
       "dyn_lai": true
     }
 
@@ -120,6 +125,29 @@
 
   },
 
+  "module_settings" {
+    "dsb": {
+      "fire": {
+        // Wildfire ignitions modes: [Note: In development.  Numbers may change!]
+        // 0: Default/old: FRI for [PR/]EQ/SP, explicit for TR/SC.
+        // 1: Use fire return interval for this stage if fire is on.
+        // 2+: Reserved for future use.
+        // Fire is alway off in the PR stage and can only be FRI for EQ/SP so no switches are
+        // provided for these stages.
+        "ignition_tr": 0
+        "ignition_sc": 0
+
+        // More future controls per stage can go here...
+        //"severity_pr":
+        //"severity_eq":
+        // ...
+      },
+      // Future disturbances go here...
+      //"insect": { ... },
+      //"thermokarst":{ ... },
+    }
+  },
+
   "model_settings": {
     "dynamic_lai": 1,                   // from model (1) or from input (0)
     "baseline_start": 1901,  //start year for baseline EQ climate

include/ModelData.h

@@ -109,6 +109,17 @@ class ModelData {
   bool dynamic_LAI; // True: calculate LAI as a function of vegc, False: use static_lai from CohortLookup 
   bool useseverity; // using fire severity inputs
 
+  // FW_MOD_START:
+  // Switches to turn fire off for each run stage.  Fire in never on the pre-run stage:
+  bool fire_on_EQ;
+  bool fire_on_SP;
+  bool fire_on_TR;
+  bool fire_on_SC;
+  // Wildfire ignitions modes: 0: explicit for TR/SC. 1: Use fire return interval, 2+: Reserved for future use.
+  int fire_ignition_tr;
+  int fire_ignition_sc;
+  // FW_MOD_END.
+
   bool outSiteDay;
 
   bool get_envmodule();

include/WildFire.h

@@ -47,7 +47,8 @@ class WildFire {
   void initializeState();
   void set_state_from_restartdata(const RestartData & rdata);
 
-  bool should_ignite(const int yr, const int midx, const std::string& stage);
+  //bool should_ignite(const int yr, const int midx, const std::string& stage);
+  bool should_ignite(const int yr, const int midx, const std::string& stage, const ModelData* md);// FW_MOD
 
   // not used or fully implemented yet...
   //int lookup_severity(const int yr, const int midx, const std::string& stage);
@@ -116,6 +117,7 @@ class WildFire {
   BgcData * bd[NUM_PFT];
   BgcData * bdall;
 
+  bool isFireReturnDate(const int yr, const int midx);// FW_MOD
   double getBurnOrgSoilthick(const int year);
   void getBurnAbgVegetation(const int ipft, const int year);
 

src/Cohort.cpp

@@ -775,7 +775,8 @@ void Cohort::updateMonthly_Fir(const int & year, const int & midx, std::string s
   }
 
   // see if it is an appropriate time to burn
-  if ( fire.should_ignite(year, midx, stage) ) {
+  //if ( fire.should_ignite(year, midx, stage) ) {
+  if ( fire.should_ignite(year, midx, stage, md) ) {//FW_MOD.
 
     BOOST_LOG_SEV(glg, debug) << "Right before fire.burn(..)  " << ground.layer_report_string();
 

src/ModelData.cpp

@@ -120,6 +120,14 @@ ModelData::ModelData(Json::Value controldata):force_cmt(-1) {
   //changeco2     = controldata["model_settings"]["varied_co2"].asInt();
   //useseverity   = controldata["model_settings"]["fire_severity_as_input"].asInt();
 
+  // FW_MOD_START:
+  fire_on_EQ        = controldata["stage_settings"]["eq"]["fire"].asBool();
+  fire_on_SP        = controldata["stage_settings"]["sp"]["fire"].asBool();
+  fire_on_TR        = controldata["stage_settings"]["tr"]["fire"].asBool();
+  fire_on_SC        = controldata["stage_settings"]["sc"]["fire"].asBool();
+  fire_ignition_tr  = controldata["module_settings"]["dsb"]["fire"]["ignition_tr"].asInt();
+  fire_ignition_sc  = controldata["module_settings"]["dsb"]["fire"]["ignition_sc"].asInt();
+  // FW_MOD_END.
 }
 
 /** Update all the appropriate fields in ModelData from an ArgHandler object.

src/TEM.cpp

@@ -581,7 +581,7 @@ void advance_model(const int rowidx, const int colidx,
       runner.calcontroller_ptr->handle_stage_start();
     }
 
-    // turn off everything but env
+    // turn off everything but env // This is no longer true!!!!!
     runner.cohort.md->set_envmodule(runner.cohort.md->pr_env);
     runner.cohort.md->set_bgcmodule(runner.cohort.md->pr_bgc);
     runner.cohort.md->set_nfeed(runner.cohort.md->pr_nfeed);
@@ -629,7 +629,8 @@ void advance_model(const int rowidx, const int colidx,
     runner.cohort.md->set_nfeed(runner.cohort.md->eq_nfeed);
     runner.cohort.md->set_avlnflg(runner.cohort.md->eq_avln);
     runner.cohort.md->set_baseline(runner.cohort.md->eq_baseline);
-    runner.cohort.md->set_dsbmodule(runner.cohort.md->eq_dsb);
+    //runner.cohort.md->set_dsbmodule(runner.cohort.md->eq_dsb);
+    runner.cohort.md->set_dsbmodule(runner.cohort.md->fire_on_EQ);// FW_MOD: Preceded runner.cohort.md->eq_dsb.
     runner.cohort.md->set_dslmodule(runner.cohort.md->eq_dsl);
     runner.cohort.md->set_dynamic_lai_module(runner.cohort.md->eq_dyn_lai);
 
@@ -694,7 +695,8 @@ void advance_model(const int rowidx, const int colidx,
     runner.cohort.md->set_nfeed(runner.cohort.md->sp_nfeed);
     runner.cohort.md->set_avlnflg(runner.cohort.md->sp_avln);
     runner.cohort.md->set_baseline(runner.cohort.md->sp_baseline);
-    runner.cohort.md->set_dsbmodule(runner.cohort.md->sp_dsb);
+    //runner.cohort.md->set_dsbmodule(runner.cohort.md->sp_dsb);
+    runner.cohort.md->set_dsbmodule(runner.cohort.md->fire_on_SP);// FW_MOD: Preceded runner.cohort.md->sp_dsb.
     runner.cohort.md->set_dslmodule(runner.cohort.md->sp_dsl);
     runner.cohort.md->set_dynamic_lai_module(runner.cohort.md->sp_dyn_lai);
 
@@ -748,7 +750,8 @@ void advance_model(const int rowidx, const int colidx,
     runner.cohort.md->set_nfeed(runner.cohort.md->tr_nfeed);
     runner.cohort.md->set_avlnflg(runner.cohort.md->tr_avln);
     runner.cohort.md->set_baseline(runner.cohort.md->tr_baseline);
-    runner.cohort.md->set_dsbmodule(runner.cohort.md->tr_dsb);
+    //runner.cohort.md->set_dsbmodule(runner.cohort.md->tr_dsb);
+    runner.cohort.md->set_dsbmodule(runner.cohort.md->fire_on_TR);// FW_MOD: Preceded runner.cohort.md->tr_dsb
     runner.cohort.md->set_dslmodule(runner.cohort.md->tr_dsl);
     runner.cohort.md->set_dynamic_lai_module(runner.cohort.md->tr_dyn_lai);
 
@@ -798,7 +801,8 @@ void advance_model(const int rowidx, const int colidx,
     runner.cohort.md->set_nfeed(runner.cohort.md->sc_nfeed);
     runner.cohort.md->set_avlnflg(runner.cohort.md->sc_avln);
     runner.cohort.md->set_baseline(runner.cohort.md->sc_baseline);
-    runner.cohort.md->set_dsbmodule(runner.cohort.md->sc_dsb);
+    //runner.cohort.md->set_dsbmodule(runner.cohort.md->sc_dsb);
+    runner.cohort.md->set_dsbmodule(runner.cohort.md->fire_on_SC);// FW_MOD: Preceded runner.cohort.md->sc_dsb.
     runner.cohort.md->set_dslmodule(runner.cohort.md->sc_dsl);
     runner.cohort.md->set_dynamic_lai_module(runner.cohort.md->sc_dyn_lai);
 

src/WildFire.cpp

@@ -127,7 +127,11 @@ void WildFire::set_state_from_restartdata(const RestartData & rdata) {
  *  There are two modes of operation: "FRI" (fire recurrence interval) and
  *  "exp". Pre-run, equilibrium, and spin-up stages all use the FRI settings
  *  for determining whether or not a fire should ignite, while transient and 
- *  scenario stages use explicit dates for fire occurrence.
+ 												*  scenario stages use explicit dates for fire occurrence.
+ FW_MOD:
+ *  scenario stages traditionally used explicit dates for fire occurrence.  This
+ *  remains the default behavior but fire return interval may also be specified
+ *  for all run stages.
  *
  *  The settings for FRI and the data for explicit fire dates are held in data
  *  members of this (WildFire) object. This function looks at those data
@@ -136,46 +140,135 @@ void WildFire::set_state_from_restartdata(const RestartData & rdata) {
  *  NOTE: how to handle fire severity, to be determined.
  *
 */
-bool WildFire::should_ignite(const int yr, const int midx, const std::string& stage) {
+//bool WildFire::should_ignite(const int yr, const int midx, const std::string& stage) {
+bool WildFire::should_ignite(const int yr, const int midx, const std::string& stage,
+                             const ModelData* md) {// FW_MOD
 
   BOOST_LOG_SEV(glg, note) << "determining fire ignition for yr:" << yr
                            << ", monthidx:" << midx << ", stage:" << stage;
 
   bool ignite = false;
-  bool fri_derived = false;
-
-  if ( stage.compare("pre-run") == 0 || stage.compare("eq-run") == 0 || stage.compare("sp-run") == 0 ) {
+  //bool fri_derived = false;// FW_NOTE: Not actually used!
+
+  //if ( stage.compare("pre-run") == 0 || stage.compare("eq-run") == 0 || stage.compare("sp-run") == 0 ) {
+  // FW_MOD_START:
+  // Check that fire is on for the current run stage:
+  if ( stage.compare("pre-run") == 0 ||
+       (stage.compare("eq-run") == 0  && md->fire_on_EQ) ||
+       (stage.compare("sp-run") == 0  && md->fire_on_SP) )
+  {
+    // Currently for the PR, EQ, and SP stages only fire return interval based fire is implemented
+    // so there is no need to check te fire ignition mode.  If fire is on it is FRI based.
+    // This could change in the future.
 
     this->fri_derived = true;
     BOOST_LOG_SEV(glg, debug) << "Determine fire from FRI.";
 
-    if ( (yr % this->fri) == 0 && yr > 0 ) {
-      if (midx == temutil::doy2month(this->fri_jday_of_burn)) {
-        ignite = true;
-      }
-      // do nothing: correct year, wrong month.
+    if (this->isFireReturnDate(yr, midx))
+    {
+      ignite = true;
     }
 
-  } else if ( stage.compare("tr-run") == 0 || stage.compare("sc-run") == 0 ) {
+  //} else if ( stage.compare("tr-run") == 0 || stage.compare("sc-run") == 0 ) {
+  }
+  else if ( (stage.compare("tr-run") == 0 && md->fire_on_TR) ||
+            (stage.compare("sc-run") == 0 && md->fire_on_SC) )
+  {
+    int fire_ignition_mode;
 
-    this->fri_derived = false;
-    BOOST_LOG_SEV(glg, debug) << "Determine fire from explicit fire regime.";
+    if (stage.compare("tr-run")
+    {
+      fire_ignition_mode = md->fire_ignition_tr
+    }
+    else
+    {
+      fire_ignition_mode = md->fire_ignition_sc
+    }
+
+    switch (fire_ignition_mode)
+    {
+      case 0:// Default (old) fire behavior, use explicit fire from input file:
+      {
+        this->fri_derived = false;
+        BOOST_LOG_SEV(glg, debug) << "Determine fire from explicit fire regime.";
 
-    if ( this->exp_burn_mask[yr] == 1 ){
-      if ( temutil::doy2month(this->exp_jday_of_burn[yr]) == midx ) {
-        ignite = true;
+        if ( this->exp_burn_mask[yr] == 1 ){
+          if ( temutil::doy2month(this->exp_jday_of_burn[yr]) == midx ) {
+            ignite = true;
+          }
+          // do nothing: correct year, wrong month
+        }
+        break;
+      }
+      case 1:// Use fire return interval:
+      {
+        this->fri_derived = true;
+        BOOST_LOG_SEV(glg, debug) << "Fire ignition mode = 1. Determine fire from FRI.";
+
+        if (this->isFireReturnDate(yr, midx))
+        {
+          ignite = true;
+        }
+        break;
+      }
+      case 2://Placeholder for future dynamic ignition mode:
+      {
+        BOOST_LOG_SEV(glg, debug) << "Alternate ignition modes are not yet implemented. Set ignition_XX = 0 or 1.";
+        // Should probably terminate here.
+        this->fri_derived = false;
+        ignite = false;
+        break;
+      }
+      default:
+      {
+        BOOST_LOG_SEV(glg, err) << "Undefined ignition mode! (" << stage << ")";
+        break;
       }
-      // do nothing: correct year, wrong month
     }
-  } else {
-    BOOST_LOG_SEV(glg, err) << "Unknown stage! (" << stage << ")";
+  //} else {// FW_NOTE: This check is broken now due to fire switch checks. It requires more logic.
   }
+  // FW_NOTE: This will work:
+  //else if (stage.compare("pre-run") != 0 && stage.compare("eq-run") != 0 &&
+  //         stage.compare("sp-run") != 0 && stage.compare("tr-run") != 0 &&
+  //         stage.compare("sc-run") != 0)
+  // FW_NOTE: But this will be more efficient:
+  else if (!(stage.compare("pre-run") == 0 || stage.compare("eq-run") == 0 ||
+             stage.compare("sp-run") == 0 || stage.compare("tr-run") == 0 ||
+             stage.compare("sc-run") == 0))
+  {
+    BOOST_LOG_SEV(glg, err) << "Unknown stage! (" << stage << ")";
+  }// FW_MOD_END.
 
   BOOST_LOG_SEV(glg, debug) << "Should we ignite a fire?:" << ignite;
 
   return ignite;
 }
 
+// FW_MOD_START:
+/** Determine if the current date, by year and month (index), aligns with the fire return interval.
+ * 
+ * FW_NOTE: 
+ * This code was extracted from should_ignite() to avoid code repetition due to other changes in the
+ * function.
+ *  Should this be moved?  The private functions don't seem to be in a particular place.*/
+bool WildFire::isFireReturnDate(const int yr, const int midx)
+{
+  // The original conditional checks for years that are multiples of the fire return interval:
+  // if ((yr % this->fri) == 0 && yr > 0)
+  // Year zero is ignored to prevent fires from occurring right at the start of the run.  If FRI = 0
+  // a divide by zero error will result.  It makes sense to all accept 0 values for FRI for locations
+  // where fire should not occur.  The following logic handles this safely:
+  if (yr > 0 && this->fri > 0 && (yr % this->fri) == 0)
+  {
+    if (midx == temutil::doy2month(this->fri_jday_of_burn))
+    {
+      return true;
+    }
+    // Do nothing: correct year, wrong month.
+  }
+  return false;
+}// FW_MOD_END.
+
 /** Burning vegetation and soil organic C */
 void WildFire::burn(int year) {
   BOOST_LOG_NAMED_SCOPE("burning");