Merge pull request #966 from EnergySystemsModellingLab/add-optional-decommission-year-for-assets

add max_decommission year to asset file

Author: Aurashk

schemas/input/assets.yaml

@@ -22,3 +22,10 @@ fields:
       This value can be any integer >=0. If it is before the start of the simulation, it will
       already be commissioned in the first year and if it after the end of the simulation then it
       will never be commissioned.
+  - name: max_decommission_year
+    type: integer
+    description: The latest year in which this asset can be decommissioned
+    notes: |
+      This value can be any integer that satisfies max_decommission_year >= commission_year >=0.
+      If it is set before the simulation starting year, the asset will not be commissioned during the
+      simulation.

src/asset.rs

@@ -95,6 +95,8 @@ pub struct Asset {
     capacity: Capacity,
     /// The year the asset was/will be commissioned
     commission_year: u32,
+    /// The maximum year that the asset could be decommissioned
+    max_decommission_year: u32,
 }
 
 impl Asset {
@@ -111,6 +113,7 @@ impl Asset {
             region_id,
             capacity,
             commission_year,
+            None,
         )
     }
 
@@ -125,12 +128,13 @@ impl Asset {
     }
 
     /// Create a new future asset
-    pub fn new_future(
+    pub fn new_future_with_max_decommission(
         agent_id: AgentID,
         process: Rc<Process>,
         region_id: RegionID,
         capacity: Capacity,
         commission_year: u32,
+        max_decommission_year: Option<u32>,
     ) -> Result<Self> {
         check_capacity_valid_for_asset(capacity)?;
         Self::new_with_state(
@@ -139,6 +143,25 @@ impl Asset {
             region_id,
             capacity,
             commission_year,
+            max_decommission_year,
+        )
+    }
+
+    /// Create a new future asset
+    pub fn new_future(
+        agent_id: AgentID,
+        process: Rc<Process>,
+        region_id: RegionID,
+        capacity: Capacity,
+        commission_year: u32,
+    ) -> Result<Self> {
+        Self::new_future_with_max_decommission(
+            agent_id,
+            process,
+            region_id,
+            capacity,
+            commission_year,
+            None,
         )
     }
 
@@ -160,6 +183,7 @@ impl Asset {
             region_id,
             capacity,
             commission_year,
+            None,
         )
     }
 
@@ -170,6 +194,7 @@ impl Asset {
         region_id: RegionID,
         capacity: Capacity,
         commission_year: u32,
+        max_decommission_year: Option<u32>,
     ) -> Result<Self> {
         check_region_year_valid_for_process(&process, &region_id, commission_year)?;
         ensure!(capacity >= Capacity(0.0), "Capacity must be non-negative");
@@ -214,6 +239,13 @@ impl Asset {
             })?
             .clone();
 
+        let max_decommission_year =
+            max_decommission_year.unwrap_or(commission_year + process_parameter.lifetime);
+        ensure!(
+            max_decommission_year >= commission_year,
+            "Max decommission year must be after/same as commission year"
+        );
+
         Ok(Self {
             state,
             process,
@@ -223,6 +255,7 @@ impl Asset {
             region_id,
             capacity,
             commission_year,
+            max_decommission_year,
         })
     }
 
@@ -238,7 +271,7 @@ impl Asset {
 
     /// The last year in which this asset should be decommissioned
     pub fn max_decommission_year(&self) -> u32 {
-        self.commission_year + self.process_parameter.lifetime
+        self.max_decommission_year
     }
 
     /// Get the activity limits for this asset in a particular time slice
@@ -1503,8 +1536,8 @@ mod tests {
     }
 
     #[rstest]
-    #[case::early_decommission_within_lifetime(2024, 2024)]
-    #[case::decommission_at_maximum_year(2026, 2025)]
+    #[case::commission_during_process_lifetime(2024, 2024)]
+    #[case::decommission_after_process_lifetime_ends(2026, 2025)]
     fn test_asset_decommission(
         #[case] requested_decommission_year: u32,
         #[case] expected_decommission_year: u32,
@@ -1530,6 +1563,38 @@ mod tests {
         assert_eq!(asset.decommission_year(), Some(expected_decommission_year));
     }
 
+    #[rstest]
+    #[case::decommission_after_predefined_max_year(2026, 2025, Some(2025))]
+    #[case::decommission_before_predefined_max_year(2024, 2024, Some(2025))]
+    #[case::decommission_during_process_lifetime_end_no_max_year(2024, 2024, None)]
+    #[case::decommission_after_process_lifetime_end_no_max_year(2026, 2025, None)]
+    fn test_asset_decommission_with_max_decommission_year_predefined(
+        #[case] requested_decommission_year: u32,
+        #[case] expected_decommission_year: u32,
+        #[case] max_decommission_year: Option<u32>,
+        process: Process,
+    ) {
+        // Test successful commissioning of Future asset
+        let process_rc = Rc::new(process);
+        let mut asset = Asset::new_future_with_max_decommission(
+            "agent1".into(),
+            Rc::clone(&process_rc),
+            "GBR".into(),
+            Capacity(1.0),
+            2020,
+            max_decommission_year,
+        )
+        .unwrap();
+        asset.commission(AssetID(1), "");
+        assert!(asset.is_commissioned());
+        assert_eq!(asset.id(), Some(AssetID(1)));
+
+        // Test successful decommissioning
+        asset.decommission(requested_decommission_year, "");
+        assert!(!asset.is_commissioned());
+        assert_eq!(asset.decommission_year(), Some(expected_decommission_year));
+    }
+
     #[rstest]
     #[should_panic(expected = "Assets with state Candidate cannot be commissioned")]
     fn test_commission_wrong_states(process: Process) {

src/input/asset.rs

@@ -15,13 +15,15 @@ use std::rc::Rc;
 
 const ASSETS_FILE_NAME: &str = "assets.csv";
 
-#[derive(Deserialize, PartialEq)]
+#[derive(Default, Deserialize, PartialEq)]
 struct AssetRaw {
     process_id: String,
     region_id: String,
     agent_id: String,
     capacity: Capacity,
     commission_year: u32,
+    #[serde(default)]
+    max_decommission_year: Option<u32>,
 }
 
 /// Read assets CSV file from model directory.
@@ -76,12 +78,13 @@ where
             .with_context(|| format!("Invalid process ID: {}", &asset.process_id))?;
         let region_id = region_ids.get_id(&asset.region_id)?;
 
-        Asset::new_future(
+        Asset::new_future_with_max_decommission(
             agent_id.clone(),
             Rc::clone(process),
             region_id.clone(),
             asset.capacity,
             asset.commission_year,
+            asset.max_decommission_year,
         )
     })
     .try_collect()
@@ -102,7 +105,10 @@ mod tests {
     }
 
     #[rstest]
+    #[case::max_decommission_year_provided(Some(2015))]
+    #[case::max_decommission_year_not_provided(None)]
     fn test_read_assets_from_iter_valid(
+        #[case] max_decommission_year: Option<u32>,
         agent_ids: IndexSet<AgentID>,
         processes: ProcessMap,
         region_ids: IndexSet<RegionID>,
@@ -113,13 +119,15 @@ mod tests {
             region_id: "GBR".into(),
             capacity: Capacity(1.0),
             commission_year: 2010,
+            max_decommission_year: max_decommission_year,
         };
-        let asset_out = Asset::new_future(
+        let asset_out = Asset::new_future_with_max_decommission(
             "agent1".into(),
             Rc::clone(processes.values().next().unwrap()),
             "GBR".into(),
             Capacity(1.0),
             2010,
+            max_decommission_year,
         )
         .unwrap();
         assert_equal(
@@ -136,20 +144,31 @@ mod tests {
             region_id: "GBR".into(),
             capacity: Capacity(1.0),
             commission_year: 2010,
+            max_decommission_year: None,
         })]
     #[case(AssetRaw { // Bad agent ID
             agent_id: "agent2".into(),
             process_id: "process1".into(),
             region_id: "GBR".into(),
             capacity: Capacity(1.0),
             commission_year: 2010,
+            max_decommission_year: None,
         })]
     #[case(AssetRaw { // Bad region ID: not in region_ids
             agent_id: "agent1".into(),
             process_id: "process1".into(),
             region_id: "FRA".into(),
             capacity: Capacity(1.0),
             commission_year: 2010,
+            max_decommission_year: None,
+        })]
+    #[case(AssetRaw { // Bad max_decommission_year: before commission_year
+            agent_id: "agent1".into(),
+            process_id: "process1".into(),
+            region_id: "GBR".into(),
+            capacity: Capacity(1.0),
+            commission_year: 2010,
+            max_decommission_year: Some(2005),
         })]
     fn test_read_assets_from_iter_invalid(
         #[case] asset: AssetRaw,