Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add cumulative cap handling to storage #588

Merged
merged 1 commit into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cycamore Change Log
* GitHub workflows for building/testing on a PR and push to `main` (#549, #564, #573, #582, #583)
* Add functionality for random behavior on the size (#550) and frequency (#565) of a sink
* GitHub workflow to check that the CHANGELOG has been updated (#562)
* Added inventory policies to Storage through the material buy policy (#574)
* Added inventory policies to Storage through the material buy policy (#574, #588)

**Changed:**

Expand Down
8 changes: 7 additions & 1 deletion src/storage.cc
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,18 @@ void Storage::EnterNotify() {
cyclus::Facility::EnterNotify();

inventory_tracker.set_capacity(max_inv_size);
if (reorder_point < 0) {
if (reorder_point < 0 && cumulative_cap <= 0) {
InitBuyPolicyParameters();
buy_policy.Init(this, &inventory, std::string("inventory"),
&inventory_tracker, throughput, active_dist_,
dormant_dist_, size_dist_);
}
else if (cumulative_cap > 0) {
InitBuyPolicyParameters();
buy_policy.Init(this, &inventory, std::string("inventory"),
&inventory_tracker, throughput, cumulative_cap,
dormant_dist_);
}
else if (reorder_quantity > 0) {
if (reorder_point + reorder_quantity > max_inv_size) {
throw cyclus::ValueError(
Expand Down
8 changes: 8 additions & 0 deletions src/storage.h
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,14 @@ class Storage
"uilabel":"Reorder Quantity"}
double reorder_quantity;

#pragma cyclus var {"default": -1,\
"tooltip": "Total amount of material that can be recieved per cycle.",\
"doc": "After receiving this much material cumulatively, the agent will go dormant. "\
"Must be paired with dormant_buying_frequency_type and any other dormant parameters. "\
"The per-time step demand is unchanged except the cycle cap is almost reached.",\
"uilabel": "Cumulative Cap"}
double cumulative_cap;

#pragma cyclus var {"tooltip":"Incoming material buffer"}
cyclus::toolkit::ResBuf<cyclus::Material> inventory;

Expand Down
36 changes: 36 additions & 0 deletions src/storage_tests.cc
Original file line number Diff line number Diff line change
Expand Up @@ -833,6 +833,42 @@ TEST_F(StorageTest, sS_Inventory) {
EXPECT_EQ(5, qr.GetVal<double>("Quantity", 0));
}

TEST_F(StorageTest, CCap_Inventory) {
std::string config =
" <in_commods> <val>spent_fuel</val> </in_commods> "
" <out_commods> <val>dry_spent</val> </out_commods> "
" <throughput>1</throughput> "
" <cumulative_cap>2</cumulative_cap> "
" <dormant_buying_frequency_type>Fixed</dormant_buying_frequency_type> "
" <dormant_buying_val>2</dormant_buying_val> ";

int simdur = 9;

cyclus::MockSim sim(cyclus::AgentSpec (":cycamore:Storage"), config, simdur);

sim.AddSource("spent_fuel").capacity(5).Finalize();
sim.AddSink("dry_spent").Finalize();

int id = sim.Run();

std::vector<cyclus::Cond> conds;
conds.push_back(cyclus::Cond("Commodity", "==", std::string("spent_fuel")));
cyclus::QueryResult qr = sim.db().Query("Transactions", &conds);
int n_trans = qr.rows.size();
EXPECT_EQ(5, n_trans) << "expected 5 transactions, got " << n_trans;
// check that the transactions occur at the expected time (0, 1, 4, 5, 8)
EXPECT_EQ(0, qr.GetVal<int>("Time", 0));
EXPECT_EQ(1, qr.GetVal<int>("Time", 1));
EXPECT_EQ(4, qr.GetVal<int>("Time", 2));
EXPECT_EQ(5, qr.GetVal<int>("Time", 3));
EXPECT_EQ(8, qr.GetVal<int>("Time", 4));

// check that transactions are of size 1
qr = sim.db().Query("Resources", NULL);
EXPECT_EQ(1, qr.GetVal<double>("Quantity", 0));
EXPECT_EQ(1, qr.GetVal<double>("Quantity", 4));
}


} // namespace cycamore

Expand Down
Loading