Rename: flow_type to type/kind

Author: alexdewar

examples/simple/process_flows.csv

@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,coeff,flow_type,flow_cost,is_pac
+process_id,commodity_id,regions,years,coeff,type,flow_cost,is_pac
 GASDRV,GASPRD,all,all,1.0,fixed,,true
 GASPRC,GASPRD,all,all,-1.05,fixed,,false
 GASPRC,GASNAT,all,all,1.0,fixed,,true

schemas/input/process_flows.yaml

@@ -28,7 +28,7 @@ fields:
     title: The flow for this commodity
     description: |
       Can be <0, indicating an input flow, or >0, indicating an output flow. Cannot be zero.
-  - name: flow_type
+  - name: type
     type: string
     title: The type of commodity flow
     description: Currently this value must be `fixed`

src/input/process.rs

@@ -306,7 +306,7 @@ mod tests {
             indexmap! { commodity_sed.id.clone() => ProcessFlow {
                 commodity: commodity_sed.into(),
                 coeff: -10.0,
-                flow_type: FlowType::Fixed,
+                kind: FlowType::Fixed,
                 flow_cost: 1.0,
                 is_pac: false,
             }},
@@ -320,7 +320,7 @@ mod tests {
             indexmap! {commodity_sed.id.clone()=>ProcessFlow {
                 commodity: commodity_sed.into(),
                 coeff: 10.0,
-                flow_type: FlowType::Fixed,
+                kind: FlowType::Fixed,
                 flow_cost: 1.0,
                 is_pac: false,
             }},
@@ -381,7 +381,7 @@ mod tests {
                 indexmap! { commodity_svd.id.clone() => ProcessFlow {
                     commodity: commodity_svd.into(),
                     coeff: 10.0,
-                    flow_type: FlowType::Fixed,
+                    kind: FlowType::Fixed,
                     flow_cost: 1.0,
                     is_pac: false,
                 }},

src/input/process/flow.rs

@@ -22,7 +22,8 @@ struct ProcessFlowRaw {
     regions: String,
     coeff: f64,
     #[serde(default)]
-    flow_type: FlowType,
+    #[serde(rename = "type")]
+    kind: FlowType,
     flow_cost: Option<f64>,
     is_pac: bool,
 }
@@ -38,7 +39,7 @@ impl ProcessFlowRaw {
 
         // **TODO**: https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues/300
         ensure!(
-            self.flow_type == FlowType::Fixed,
+            self.kind == FlowType::Fixed,
             "Commodity flexible assets are not currently supported"
         );
 
@@ -109,7 +110,7 @@ where
         let process_flow = ProcessFlow {
             commodity: Rc::clone(commodity),
             coeff: record.coeff,
-            flow_type: record.flow_type,
+            kind: record.kind,
             flow_cost: record.flow_cost.unwrap_or(0.0),
             is_pac: record.is_pac,
         };
@@ -203,7 +204,7 @@ mod tests {
 
     fn create_process_flow_raw(
         coeff: f64,
-        flow_type: FlowType,
+        kind: FlowType,
         flow_cost: Option<f64>,
         is_pac: bool,
     ) -> ProcessFlowRaw {
@@ -213,7 +214,7 @@ mod tests {
             years: "2020".into(),
             regions: "region".into(),
             coeff,
-            flow_type,
+            kind,
             flow_cost,
             is_pac,
         }
@@ -248,7 +249,7 @@ mod tests {
         ProcessFlow {
             commodity,
             coeff,
-            flow_type: FlowType::Fixed,
+            kind: FlowType::Fixed,
             flow_cost: 0.0,
             is_pac,
         }

src/process.rs

@@ -87,7 +87,7 @@ pub struct ProcessFlow {
     /// Positive value indicates flow out and negative value indicates flow in.
     pub coeff: f64,
     /// Identifies if a flow is fixed or flexible.
-    pub flow_type: FlowType,
+    pub kind: FlowType,
     /// Cost per unit flow.
     ///
     /// For example, cost per unit of natural gas produced. The user can apply it to any specified