New feature for DeployInst

input/growth/deploy_and_manager_insts.xml

@@ -0,0 +1,118 @@
+<simulation>
+  <control>
+    <duration>10</duration>
+    <startmonth>1</startmonth>
+    <startyear>2018</startyear>
+    <decay>never</decay>
+  </control>
+
+  <archetypes>
+    <spec> <lib>cycamore</lib><name>GrowthRegion</name> </spec>
+    <spec> <lib>cycamore</lib><name>DeployInst</name> </spec>
+    <spec> <lib>cycamore</lib><name>ManagerInst</name> </spec>
+    <spec> <lib>cycamore</lib><name>Source</name> </spec>
+    <spec> <lib>cycamore</lib><name>Sink</name> </spec>
+  </archetypes>
+
+  <commodity>
+    <name>commodity1</name>
+    <solution_priority>1.0</solution_priority>
+  </commodity>
+
+  <facility>
+    <name>Source1</name>
+    <config>
+      <Source>
+        <outcommod>commodity1</outcommod>
+        <outrecipe>commod_recipe</outrecipe>
+        <throughput>1</throughput>
+      </Source>
+    </config>
+  </facility>
+
+  <facility>
+    <name>Source2</name>
+    <config>
+      <Source>
+        <outcommod>commodity1</outcommod>
+        <outrecipe>commod_recipe</outrecipe>
+        <throughput>1</throughput>
+      </Source>
+    </config>
+  </facility>
+
+  <facility>
+    <name>Sink</name>
+    <config>
+      <Sink>
+        <in_commods>
+          <val>commodity1</val>
+        </in_commods>
+      </Sink>
+    </config>
+  </facility>
+
+  <region>
+    <name>Single Region</name>
+    <config>
+    <GrowthRegion>
+      <growth>
+        <item>
+          <commod>commodity1</commod>
+          <piecewise_function>
+            <piece>
+              <start>5</start>
+              <function>
+                <type>linear</type>
+                <params>0 5</params>
+              </function>
+            </piece>
+          </piecewise_function>
+        </item>
+      </growth>
+      </GrowthRegion>
+    </config>
+
+    <institution>
+      <name>First Institution</name>
+      <initialfacilitylist>
+        <entry>
+          <prototype>Sink</prototype>
+          <number>1</number>
+        </entry>
+      </initialfacilitylist>
+      <config>
+        <ManagerInst>
+          <prototypes>
+            <val>Source2</val>
+          </prototypes>
+        </ManagerInst>
+      </config>
+    </institution>
+
+    <institution>
+      <name>Second Institution</name>
+      <config>
+        <DeployInst>
+          <prototypes>
+            <val>Source1</val>
+          </prototypes>
+          <build_times>
+            <val>1</val>
+          </build_times>
+          <n_build>
+            <val>1</val>
+          </n_build>
+        </DeployInst>
+      </config>
+    </institution>
+  </region>
+
+  <recipe>
+    <name>commod_recipe</name>
+    <basis>mass</basis>
+    <nuclide> <id>922350000</id> <comp>0.711</comp> </nuclide>
+    <nuclide> <id>922380000</id> <comp>99.289</comp> </nuclide>
+  </recipe>
+
+</simulation>

src/cycamore.h

@@ -8,6 +8,7 @@
 #include "batch_reactor.h"
 #include "batch_reactor_tests.h"
 #include "deploy_inst.h"
+#include "deploy_inst_tests.h"
 #include "enrichment.h"
 #include "enrichment_tests.h"
 #if CYCLUS_HAS_COIN

src/deploy_inst.cc

@@ -68,6 +68,57 @@ void DeployInst::EnterNotify() {
   RecordPosition();
 }
 
+void DeployInst::BuildNotify(Agent* a) {
+  Register_(a);
+}
+
+void DeployInst::DecomNotify(Agent* a) {
+  Unregister_(a);
+}
+
+void DeployInst::Register_(Agent* a) {
+  using cyclus::toolkit::CommodityProducer;
+  using cyclus::toolkit::CommodityProducerManager;
+
+  CommodityProducer* cp_cast = dynamic_cast<CommodityProducer*>(a);
+  if (cp_cast != NULL) {
+    LOG(cyclus::LEV_INFO3, "mani") << "Registering agent "
+                                   << a->prototype() << a->id()
+                                   << " as a commodity producer.";
+    CommodityProducerManager::Register(cp_cast);
+  }
+}
+
+void DeployInst::Unregister_(Agent* a) {
+  using cyclus::toolkit::CommodityProducer;
+  using cyclus::toolkit::CommodityProducerManager;
+
+  CommodityProducer* cp_cast = dynamic_cast<CommodityProducer*>(a);
+  if (cp_cast != NULL)
+    CommodityProducerManager::Unregister(cp_cast);
+}
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+void DeployInst::WriteProducerInformation(
+  cyclus::toolkit::CommodityProducer* producer) {
+  using std::set;
+  set<cyclus::toolkit::Commodity,
+      cyclus::toolkit::CommodityCompare> commodities =
+          producer->ProducedCommodities();
+  set<cyclus::toolkit::Commodity, cyclus::toolkit::CommodityCompare>::
+      iterator it;
+
+  LOG(cyclus::LEV_DEBUG3, "maninst") << " Clone produces " << commodities.size()
+                                     << " commodities.";
+  for (it = commodities.begin(); it != commodities.end(); it++) {
+    LOG(cyclus::LEV_DEBUG3, "maninst") << " Commodity produced: " << it->name();
+    LOG(cyclus::LEV_DEBUG3, "maninst") << "           capacity: " <<
+                                       producer->Capacity(*it);
+    LOG(cyclus::LEV_DEBUG3, "maninst") << "               cost: " <<
+                                       producer->Cost(*it);
+  }
+}
+
 void DeployInst::RecordPosition() {
   std::string specification = this->spec();
   context()

src/deploy_inst.h

@@ -19,14 +19,17 @@ typedef std::map<int, std::vector<std::string> > BuildSched;
 // lifetimes.  The same prototype can be specified multiple times with any
 // combination of the same or different build times, build number, and
 // lifetimes.
-class DeployInst : public cyclus::Institution,
+class DeployInst : 
+  public cyclus::Institution, 
+  public cyclus::toolkit::CommodityProducerManager,
   public cyclus::toolkit::Position {
   #pragma cyclus note { \
     "doc": \
       "Builds and manages agents (facilities) according to a manually" \
       " specified deployment schedule. Deployed agents are automatically" \
-      " decommissioned at the end of their lifetime.  The user specifies a" \
-      " list of prototypes for" \
+      " decommissioned at the end of their lifetime.  Deployed and" \
+      " decommissioned agents are registered and unregistered with a" \
+      " region. The user specifies a list of prototypes for" \
       " each and corresponding build times, number to build, and (optionally)" \
       " lifetimes.  The same prototype can be specified multiple times with" \
       " any combination of the same or different build times, build number," \
@@ -45,6 +48,19 @@ class DeployInst : public cyclus::Institution,
 
   virtual void EnterNotify();
 
+  virtual void BuildNotify(Agent* m);
+  virtual void DecomNotify(Agent* m);
+  /// write information about a commodity producer to a stream
+  /// @param producer the producer
+  void WriteProducerInformation(cyclus::toolkit::CommodityProducer*
+                                producer);
+
+  /// register a child
+  void Register_(cyclus::Agent* agent);
+
+  /// unregister a child
+  void Unregister_(cyclus::Agent* agent);
+
  protected:
   #pragma cyclus var { \
     "doc": "Ordered list of prototypes to build.", \

src/deploy_inst_tests.cc

@@ -1,18 +1,38 @@
-#include <gtest/gtest.h>
 
-#include "context.h"
-#include "deploy_inst.h"
-#include "institution_tests.h"
-#include "agent_tests.h"
+#include "deploy_inst_tests.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
 // in order to deal with lifetime setting.
 
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+TestProducer::TestProducer(cyclus::Context* ctx) : cyclus::Facility(ctx) {}
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+TestProducer::~TestProducer() {}
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+void DeployInstTests::SetUp() {
+  ctx_ = new cyclus::Context(&ti_, &rec_);
+  src_inst = new cycamore::DeployInst(ctx_);
+  producer = new TestProducer(ctx_);
+  commodity = cyclus::toolkit::Commodity("commod");
+  capacity = 5;
+  producer->cyclus::toolkit::CommodityProducer::Add(commodity);
+  producer->SetCapacity(commodity, capacity);
+}
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+void DeployInstTests::TearDown() {
+  delete producer;
+  delete src_inst;
+  delete ctx_;
+}
+
 using cyclus::QueryResult;
 
-TEST(DeployInstTests, ProtoNames) {
+TEST_F(DeployInstTests, ProtoNames) {
   std::string config =
      "<prototypes>  <val>foobar</val> </prototypes>"
      "<build_times> <val>1</val>      </build_times>"
@@ -32,7 +52,7 @@ TEST(DeployInstTests, ProtoNames) {
   EXPECT_EQ(3, stmt->GetInt(0));
 }
 
-TEST(DeployInstTests, BuildTimes) {
+TEST_F(DeployInstTests, BuildTimes) {
   std::string config =
      "<prototypes>  <val>foobar</val> <val>foobar</val> </prototypes>"
      "<build_times> <val>1</val>      <val>3</val>      </build_times>"
@@ -59,7 +79,7 @@ TEST(DeployInstTests, BuildTimes) {
 
 // make sure that specified lifetimes are honored both in agent's table record
 // and in decommissioning.
-TEST(DeployInstTests, FiniteLifetimes) {
+TEST_F(DeployInstTests, FiniteLifetimes) {
   std::string config =
      "<prototypes>  <val>foobar</val> <val>foobar</val> <val>foobar</val> </prototypes>"
      "<build_times> <val>1</val>      <val>1</val>      <val>2</val>      </build_times>"
@@ -112,7 +132,7 @@ TEST(DeployInstTests, FiniteLifetimes) {
   EXPECT_EQ(8, stmt->GetInt(0));
 }
 
-TEST(DeployInstTests, NoDupProtos) {
+TEST_F(DeployInstTests, NoDupProtos) {
   std::string config =
      "<prototypes>  <val>foobar</val> <val>foobar</val> <val>foobar</val> </prototypes>"
      "<build_times> <val>1</val>      <val>1</val>      <val>2</val>      </build_times>"
@@ -141,7 +161,7 @@ TEST(DeployInstTests, NoDupProtos) {
   EXPECT_EQ(1, stmt->GetInt(0));
 }
 
-TEST(DeployInstTests, PositionInitialize) {
+TEST_F(DeployInstTests, PositionInitialize) {
   std::string config =
      "<prototypes>  <val>foobar</val> </prototypes>"
      "<build_times> <val>1</val>      </build_times>"
@@ -158,7 +178,7 @@ TEST(DeployInstTests, PositionInitialize) {
   EXPECT_EQ(qr.GetVal<double>("Longitude"), 0.0);
 }
 
-TEST(DeployInstTests, PositionInitialize2) {
+TEST_F(DeployInstTests, PositionInitialize2) {
   std::string config =
      "<prototypes>  <val>foobar</val> </prototypes>"
      "<longitude>   -20.0             </longitude>"
@@ -177,6 +197,28 @@ TEST(DeployInstTests, PositionInitialize2) {
   EXPECT_EQ(qr.GetVal<double>("Longitude"), -20.0);
 }
 
+TEST_F(DeployInstTests, producerexists) {
+  using std::set;
+  ctx_->AddPrototype("foop", producer);
+  set<cyclus::toolkit::CommodityProducer*>::iterator it;
+  for (it = src_inst->cyclus::toolkit::CommodityProducerManager::
+          producers().begin();
+       it != src_inst->cyclus::toolkit::CommodityProducerManager::
+          producers().end();
+       it++) {
+    EXPECT_EQ(dynamic_cast<TestProducer*>(*it)->prototype(),
+              producer->prototype());
+  }
+}
+
+TEST_F(DeployInstTests, productioncapacity) {
+  EXPECT_EQ(src_inst->TotalCapacity(commodity), 0);
+  src_inst->BuildNotify(producer);
+  EXPECT_EQ(src_inst->TotalCapacity(commodity), capacity);
+  src_inst->DecomNotify(producer);
+  EXPECT_EQ(src_inst->TotalCapacity(commodity), 0);
+}
+
 // required to get functionality in cyclus agent unit tests library
 cyclus::Agent* DeployInstitutionConstructor(cyclus::Context* ctx) {
   return new cycamore::DeployInst(ctx);