add boiler module

Cargo.toml

@@ -17,6 +17,7 @@ log = "0.4.20"
 nalgebra = "0.32.3"
 rstest = "0.17.0"
 serde = { version = "1.0.164", features = ["derive", "rc"] }
+serde-enum-str = "0.4.0"
 serde_json = "1.0.100"
 variants-struct = "0.1.1"
 

src/core/controls/time_control.rs

@@ -9,6 +9,25 @@ pub enum Control {
     SetpointTimeControl(SetpointTimeControl),
 }
 
+// macro so accessing individual controls through the enum isn't so repetitive
+#[macro_use]
+macro_rules! per_control {
+    ($val:expr, $pattern:pat => { $res:expr }) => {
+        match $val {
+            Control::OnOffTimeControl($pattern) => $res,
+            Control::ToUChargeControl($pattern) => $res,
+            Control::OnOffMinimisingTimeControl($pattern) => $res,
+            Control::SetpointTimeControl($pattern) => $res,
+        }
+    };
+}
+
+impl Control {
+    pub fn is_on(&self, timestep_idx: usize) -> bool {
+        per_control!(self, c => {c.is_on_for_timestep_idx(timestep_idx)})
+    }
+}
+
 /// An object to model a time-only control with on/off (not modulating) operation
 pub struct OnOffTimeControl {
     /// list of boolean values where true means "on" (one entry per hour)
@@ -31,6 +50,10 @@ impl OnOffTimeControl {
     fn is_on(&self, timestep: &SimulationTimeIteration) -> bool {
         self.schedule[timestep.time_series_idx(self.start_day, self.time_series_step)]
     }
+
+    pub fn is_on_for_timestep_idx(&self, timestep_idx: usize) -> bool {
+        self.schedule[timestep_idx]
+    }
 }
 
 /// An object to model a control that governs electrical charging of a heat storage device
@@ -49,6 +72,10 @@ impl ToUChargeControl {
         self.schedule[iteration.time_series_idx(self.start_day, self.time_series_step)]
     }
 
+    pub fn is_on_for_timestep_idx(&self, timestep_idx: usize) -> bool {
+        self.schedule[timestep_idx]
+    }
+
     pub fn target_charge(&self, timestep: &SimulationTimeIteration) -> f64 {
         self.charge_level[timestep.time_series_idx_days(self.start_day, self.time_series_step)]
     }
@@ -114,6 +141,10 @@ impl OnOffMinimisingTimeControl {
     pub fn is_on(&self, timestep: &SimulationTimeIteration) -> bool {
         self.schedule[timestep.time_series_idx(self.start_day, self.time_series_step)]
     }
+
+    pub fn is_on_for_timestep_idx(&self, timestep_idx: usize) -> bool {
+        self.schedule[timestep_idx]
+    }
 }
 
 #[derive(Clone)]
@@ -178,6 +209,10 @@ impl SetpointTimeControl {
     pub fn is_on(&self, timestep: &SimulationTimeIteration) -> bool {
         let schedule_idx = timestep.time_series_idx(self.start_day, self.time_series_step);
 
+        self.is_on_for_timestep_idx(schedule_idx)
+    }
+
+    pub fn is_on_for_timestep_idx(&self, schedule_idx: usize) -> bool {
         let setpnt = self.schedule[schedule_idx];
 
         if setpnt.is_none() {