Merge pull request #677 from meg-krieg/deployinst_664

Author: gonuke

CHANGELOG.rst

@@ -14,6 +14,7 @@ Since last release
 * Added default keep packaging to reactor (#618, #619)
 * Added support for Ubuntu 24.04 (#633)
 * Added (negative)binomial distributions for disruption modeling to storage (#635)
+* Added new variable to Deploy Institution to shift the deployment times (#677)
 
 **Changed:**
 * Cleaned up manual definitions of Position in favor of code injection (#641)

src/deploy_inst.cc

@@ -1,5 +1,6 @@
 // Implements the DeployInst class
 #include "deploy_inst.h"
+#include "error.h"
 
 namespace cycamore {
 
@@ -12,12 +13,20 @@ void DeployInst::Build(cyclus::Agent* parent) {
   cyclus::Institution::Build(parent);
   BuildSched::iterator it;
   std::set<std::string> protos;
+
+  int sim_start = 12*(context()->sim_info().y0) + 
+                            context()->sim_info().m0;
+  int d_t = 0;
+  if(deployyear!=-1){
+    d_t += deployyear*12 - sim_start;
+  }
+
   for (int i = 0; i < prototypes.size(); i++) {
     std::string proto = prototypes[i];
 
     std::stringstream ss;
     ss << proto;
-
+    
     if (lifetimes.size() == prototypes.size()) {
       cyclus::Agent* a = context()->CreateAgent<Agent>(proto);
       if (a->lifetime() != lifetimes[i]) {
@@ -36,13 +45,26 @@ void DeployInst::Build(cyclus::Agent* parent) {
       }
     }
 
-    int t = build_times[i];
+    int t_build = build_times[i] + d_t;
+
+    if(t_build < 0){
+      std::stringstream ss;
+      ss << "Deploy year is before simulation start. Adjust deployment time." ;
+      throw cyclus::ValueError(ss.str());
+    }
+    else if(t_build >= context()->sim_info().duration){
+      cyclus::Warn<cyclus::VALUE_WARNING>(
+      "Deployment year must be less than simulation duration;"
+      "A facility will not be deployed during the simulation.");
+    }
+
     for (int j = 0; j < n_build[i]; j++) {
-      context()->SchedBuild(this, proto, t);
+      context()->SchedBuild(this, proto, t_build);
     }
   }
 }
 
+
 void DeployInst::EnterNotify() {
   cyclus::Institution::EnterNotify();
   int n = prototypes.size();
@@ -62,7 +84,6 @@ void DeployInst::EnterNotify() {
        << " lifetimes vals, expected " << n;
     throw cyclus::ValueError(ss.str());
   }
-
   InitializePosition();
 }
 

src/deploy_inst.h

@@ -84,6 +84,12 @@ class DeployInst :
   }
   std::vector<int> n_build;
 
+  #pragma cyclus var { \
+    "doc": "Year to start deploying prototypes.", \
+    "default": -1, \
+    "uilabel": "deploy year",\
+  }
+  int deployyear;
 
   #pragma cyclus var {							\
     "doc": "Lifetimes for each prototype in prototype list (same order)." \

src/deploy_inst_tests.cc

@@ -1,5 +1,6 @@
 #include "deploy_inst_tests.h"
-
+#include "error.h"
+#include "deploy_inst.h"
 // make sure that the deployed agent's prototype name is identical to the
 // originally specified prototype name - this is important to test because
 // DeployInst does some mucking around with registering name-modded prototypes
@@ -154,6 +155,65 @@ TEST_F(DeployInstTests, NoDupProtos) {
   EXPECT_EQ(1, stmt->GetInt(0));
 }
 
+TEST_F(DeployInstTests, DeployYear) {
+  std::string config =
+     "<prototypes>  <val>foobar</val> </prototypes>"
+     "<build_times> <val>2</val>      </build_times>"
+     "<n_build>     <val>3</val>      </n_build>"
+     "<deployyear>     2012           </deployyear>"
+     ;
+
+  int simdur = 30;
+  //MockSim starts in 2010 by default
+  cyclus::MockSim sim(cyclus::AgentSpec(":cycamore:DeployInst"), config, simdur);
+  sim.DummyProto("foobar");
+  int id = sim.Run();
+  // 2 years and 2 months after MockSim start is 25 time steps 
+  cyclus::SqlStatement::Ptr stmt = sim.db().db().Prepare(
+      "SELECT COUNT(*) FROM AgentEntry WHERE Prototype = 'foobar' AND EnterTime = '25';"
+      );
+  stmt->Step();
+  EXPECT_EQ(3, stmt->GetInt(0)); 
+}
+
+TEST_F(DeployInstTests, DeployYearEarlyError) {
+  std::string config =
+     "<prototypes>  <val>foobar</val> </prototypes>"
+     "<build_times> <val>2</val>      </build_times>"
+     "<n_build>     <val>3</val>      </n_build>"
+     "<deployyear>    2000            </deployyear>"
+     ;
+
+  int simdur = 5;
+  cyclus::MockSim sim(cyclus::AgentSpec(":cycamore:DeployInst"), config, simdur);
+
+  EXPECT_THROW(sim.Run(),cyclus::ValueError); 
+}
+
+TEST_F(DeployInstTests, DeployYearLateWarn) {
+  std::string config =
+     "<prototypes>  <val>foobar</val> </prototypes>"
+     "<build_times> <val>2</val>      </build_times>"
+     "<n_build>     <val>3</val>      </n_build>"
+     "<deployyear>    2030          </deployyear>"
+     ;
+
+  int simdur = 5;
+  cyclus::MockSim sim(cyclus::AgentSpec(":cycamore:DeployInst"), config, simdur);
+
+  cyclus::warn_as_error = true;
+  EXPECT_THROW(sim.Run(),
+               cyclus::ValueError);
+  cyclus::warn_as_error = false;
+
+  int id = sim.Run();
+  cyclus::SqlStatement::Ptr stmt = sim.db().db().Prepare(
+      "SELECT COUNT(*) FROM AgentEntry WHERE Prototype = 'foobar';"
+      );
+  stmt->Step();
+  EXPECT_EQ(0, stmt->GetInt(0));
+}
+
 TEST_F(DeployInstTests, PositionInitialize) {
   std::string config =
      "<prototypes>  <val>foobar</val> </prototypes>"