Merge pull request cyclus#1894 from dean-krueger/matl-value

Add unit_value to Resource Objects and Children

Author: gonuke

CHANGELOG.rst

@@ -7,6 +7,7 @@ Since last release
 
 **Added:**
 
+* Added a unit value to Resource, Material, and Product objects (#1894)
 * Added clang-format protections to .cycpp.h and query_backend.h files, modified .clang-format file (#1880)
 * Added a function to facility_cost.cycpp.h to calculate unit price of a DRE bid (#1870 ,#1877, #1884, #1889, #1890)
 * Added code injection for matl_buy/sell_policy (#1866)

src/material.cc

@@ -15,14 +15,18 @@ const ResourceType Material::kType = "Material";
 Material::~Material() {}
 
 Material::Ptr Material::Create(Agent* creator, double quantity,
-                               Composition::Ptr c, std::string package_name) {
-  Material::Ptr m(new Material(creator->context(), quantity, c, package_name));
+                               Composition::Ptr c, std::string package_name,
+                               double unit_value) {
+  Material::Ptr m(
+      new Material(creator->context(), quantity, c, package_name, unit_value));
   m->tracker_.Create(creator);
   return m;
 }
 
-Material::Ptr Material::CreateUntracked(double quantity, Composition::Ptr c) {
-  Material::Ptr m(new Material(NULL, quantity, c, Package::unpackaged_name()));
+Material::Ptr Material::CreateUntracked(double quantity, Composition::Ptr c,
+                                        double unit_value) {
+  Material::Ptr m(
+      new Material(NULL, quantity, c, Package::unpackaged_name(), unit_value));
   return m;
 }
 
@@ -86,7 +90,8 @@ Material::Ptr Material::ExtractComp(double qty, Composition::Ptr c,
   }
 
   qty_ -= qty;
-  Material::Ptr other(new Material(ctx_, qty, c, Package::unpackaged_name()));
+  Material::Ptr other(
+      new Material(ctx_, qty, c, Package::unpackaged_name(), UnitValue()));
 
   // Decay called on the extracted material should have the same dt as for
   // this material regardless of composition.
@@ -117,8 +122,11 @@ void Material::Absorb(Material::Ptr mat) {
   if (qty_ < mat->qty_) {
     prev_decay_time_ = mat->prev_decay_time_;
   }
-
-  qty_ += mat->qty_;
+  double tot_mass = qty_ + mat->quantity();
+  double avg_unit_value =
+      (qty_ * UnitValue() + mat->quantity() * mat->UnitValue()) / tot_mass;
+  SetUnitValue(avg_unit_value);
+  qty_ = tot_mass;
   mat->qty_ = 0;
   tracker_.Absorb(&mat->tracker_);
 }
@@ -146,7 +154,8 @@ Resource::Ptr Material::PackageExtract(double qty,
   }
 
   qty_ -= qty;
-  Material::Ptr other(new Material(ctx_, qty, comp_, new_package_name));
+  Material::Ptr other(
+      new Material(ctx_, qty, comp_, new_package_name, UnitValue()));
 
   // Decay called on the extracted material should have the same dt as for
   // this material regardless of composition.
@@ -263,13 +272,14 @@ Composition::Ptr Material::comp() {
 }
 
 Material::Material(Context* ctx, double quantity, Composition::Ptr c,
-                   std::string package_name)
+                   std::string package_name, double unit_value)
     : qty_(quantity),
       comp_(c),
       tracker_(ctx, this),
       ctx_(ctx),
       prev_decay_time_(0),
       package_name_(package_name) {
+  SetUnitValue(unit_value);
   if (ctx != NULL) {
     prev_decay_time_ = ctx->time();
   } else {

src/material.h

@@ -82,11 +82,13 @@ class Material : public Resource {
   /// "this" pointer). All future output data recorded will be done using the
   /// creator's context.
   static Ptr Create(Agent* creator, double quantity, Composition::Ptr c,
-                    std::string package_name = Package::unpackaged_name());
+                    std::string package_name = Package::unpackaged_name(),
+                    double unit_value = kUnsetUnitValue);
 
   /// Creates a new material resource that does not actually exist as part of
   /// the simulation and is untracked.
-  static Ptr CreateUntracked(double quantity, Composition::Ptr c);
+  static Ptr CreateUntracked(double quantity, Composition::Ptr c,
+                             double unit_value = kUnsetUnitValue);
 
   /// Returns the id of the material's internal nuclide composition.
   virtual int qual_id() const;
@@ -168,7 +170,8 @@ class Material : public Resource {
 
  protected:
   Material(Context* ctx, double quantity, Composition::Ptr c,
-           std::string package_name = Package::unpackaged_name());
+           std::string package_name = Package::unpackaged_name(),
+           double unit_value = kUnsetUnitValue);
 
  private:
   Context* ctx_;

src/product.cc

@@ -13,7 +13,8 @@ int Product::next_qualid_ = 1;
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Product::Ptr Product::Create(Agent* creator, double quantity,
-                             std::string quality, std::string package_name) {
+                             std::string quality, std::string package_name,
+                             double unit_value) {
   if (qualids_.count(quality) == 0) {
     qualids_[quality] = next_qualid_++;
     creator->context()
@@ -24,15 +25,16 @@ Product::Ptr Product::Create(Agent* creator, double quantity,
   }
 
   // the next lines must come after qual id setting
-  Product::Ptr r(
-      new Product(creator->context(), quantity, quality, package_name));
+  Product::Ptr r(new Product(creator->context(), quantity, quality,
+                             package_name, unit_value));
   r->tracker_.Create(creator);
   return r;
 }
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Product::Ptr Product::CreateUntracked(double quantity, std::string quality) {
-  Product::Ptr r(new Product(NULL, quantity, quality));
+  Product::Ptr r(new Product(NULL, quantity, quality,
+                             Package::unpackaged_name(), kUnsetUnitValue));
   r->tracker_.DontTrack();
   return r;
 }
@@ -50,7 +52,12 @@ void Product::Absorb(Product::Ptr other) {
   if (other->quality() != quality()) {
     throw ValueError("incompatible resource types.");
   }
-  quantity_ += other->quantity();
+  double tot_qty = quantity_ + other->quantity();
+  double avg_unit_value =
+      (quantity_ * UnitValue() + other->quantity() * other->UnitValue()) /
+      tot_qty;
+  SetUnitValue(avg_unit_value);
+  quantity_ = tot_qty;
   other->quantity_ = 0;
 
   tracker_.Absorb(&other->tracker_);
@@ -64,7 +71,8 @@ Product::Ptr Product::Extract(double quantity) {
 
   quantity_ -= quantity;
 
-  Product::Ptr other(new Product(ctx_, quantity, quality_, package_name_));
+  Product::Ptr other(
+      new Product(ctx_, quantity, quality_, package_name_, UnitValue()));
   tracker_.Extract(&other->tracker_);
   return other;
 }
@@ -78,14 +86,16 @@ std::string Product::package_name() {
   return package_name_;
 }
 
+// Not sure what to do here with the unit value and packaging...
 Resource::Ptr Product::PackageExtract(double qty,
                                       std::string new_package_name) {
   if (qty > quantity_) {
     throw ValueError("Attempted to extract more quantity than exists.");
   }
 
   quantity_ -= qty;
-  Product::Ptr other(new Product(ctx_, qty, quality_, new_package_name));
+  Product::Ptr other(
+      new Product(ctx_, qty, quality_, new_package_name, UnitValue()));
 
   // this call to res_tracker must come first before the parent resource
   // state id gets modified
@@ -119,11 +129,13 @@ void Product::ChangePackage(std::string new_package_name) {
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Product::Product(Context* ctx, double quantity, std::string quality,
-                 std::string package_name)
+                 std::string package_name, double unit_value)
     : quality_(quality),
       quantity_(quantity),
       tracker_(ctx, this),
       ctx_(ctx),
-      package_name_(package_name) {}
+      package_name_(package_name) {
+  SetUnitValue(unit_value);
+}
 
 }  // namespace cyclus

src/product.h

@@ -28,7 +28,8 @@ class Product : public Resource {
   /// "this" pointer). All future output data recorded will be done using the
   /// creator's context.
   static Ptr Create(Agent* creator, double quantity, std::string quality,
-                    std::string package_name = Package::unpackaged_name());
+                    std::string package_name = Package::unpackaged_name(),
+                    double unit_value = kUnsetUnitValue);
 
   /// Creates a new product that does not actually exist as part of
   /// the simulation and is untracked.
@@ -79,7 +80,8 @@ class Product : public Resource {
   /// @param quantity is a double indicating the quantity
   /// @param quality the resource quality
   Product(Context* ctx, double quantity, std::string quality,
-          std::string package_name = Package::unpackaged_name());
+          std::string package_name = Package::unpackaged_name(),
+          double unit_value = kUnsetUnitValue);
 
   // map<quality, quality_id>
   static std::map<std::string, int> qualids_;

src/res_tracker.cc

@@ -104,6 +104,7 @@ void ResTracker::Record(bool bumpId) {
       ->AddVal("TimeCreated", ctx_->time())
       ->AddVal("Quantity", res_->quantity())
       ->AddVal("Units", res_->units())
+      ->AddVal("UnitValue", res_->UnitValue())
       ->AddVal("QualId", res_->qual_id())
       ->AddVal("PackageName", res_->package_name())
       ->AddVal("Parent1", parent1_)

src/resource.h

@@ -26,7 +26,8 @@ class Resource {
  public:
   typedef boost::shared_ptr<Resource> Ptr;
 
-  Resource() : state_id_(nextstate_id_++), obj_id_(nextobj_id_++) {}
+  Resource()
+      : state_id_(nextstate_id_++), unit_value_(0.0), obj_id_(nextobj_id_++) {}
 
   virtual ~Resource() {}
 
@@ -35,6 +36,12 @@ class Resource {
   /// You should NOT track resources by pointer.
   const int obj_id() const { return obj_id_; }
 
+  /// Returns the unit value of this resource.
+  double UnitValue() const { return unit_value_; }
+
+  /// Sets the unit value of this resource.
+  void SetUnitValue(double unit_value) { unit_value_ = unit_value; }
+
   /// Returns the unique id corresponding to this resource and its current
   /// state.  All resource id's are unique - even across different resource
   /// types/implementations. Runtime tracking of resources should generally
@@ -108,7 +115,12 @@ class Resource {
   /// restrictions, the remainder is left in the resource object.
   template <class T> std::vector<typename T::Ptr> Package(Package::Ptr pkg);
 
+ protected:
+  constexpr static double kUnsetUnitValue =
+      std::numeric_limits<double>::quiet_NaN();
+
  private:
+  double unit_value_;
   static int nextstate_id_;
   static int nextobj_id_;
   int state_id_;