Rename: flow => coeff

Closes #602.

Author: alexdewar

examples/simple/process_flows.csv

@@ -1,4 +1,4 @@
-process_id,commodity_id,regions,years,flow,flow_type,flow_cost,is_pac
+process_id,commodity_id,regions,years,coeff,flow_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

@@ -23,7 +23,7 @@ fields:
     type: string
     title: The year(s) to which this entry applies
     description: One or more milestone years separated by semicolons or `all`
-  - name: flow
+  - name: coeff
     type: number
     title: The flow for this commodity
     description: |

src/input/process.rs

@@ -205,9 +205,9 @@ fn validate_sed_commodity(
     for flows in flows.values() {
         let flows = flows.get(&(region_id.clone(), *year)).unwrap();
         if let Some(flow) = flows.get(&commodity_id.clone()) {
-            if flow.flow > 0.0 {
+            if flow.coeff > 0.0 {
                 has_producer = true;
-            } else if flow.flow < 0.0 {
+            } else if flow.coeff < 0.0 {
                 has_consumer = true;
             }
         }
@@ -250,7 +250,7 @@ fn validate_svd_commodity(
             // We're only interested in processes which produce this commodity
             continue;
         };
-        if flow.flow <= 0.0 {
+        if flow.coeff <= 0.0 {
             // Check if it's a producer
             continue;
         }
@@ -305,7 +305,7 @@ mod tests {
             ("GBR".into(), 2010),
             indexmap! { commodity_sed.id.clone() => ProcessFlow {
                 commodity: commodity_sed.into(),
-                flow: -10.0,
+                coeff: -10.0,
                 flow_type: FlowType::Fixed,
                 flow_cost: 1.0,
                 is_pac: false,
@@ -319,7 +319,7 @@ mod tests {
             ("GBR".into(), 2010),
             indexmap! {commodity_sed.id.clone()=>ProcessFlow {
                 commodity: commodity_sed.into(),
-                flow: 10.0,
+                coeff: 10.0,
                 flow_type: FlowType::Fixed,
                 flow_cost: 1.0,
                 is_pac: false,
@@ -380,7 +380,7 @@ mod tests {
                 ("GBR".into(), 2010),
                 indexmap! { commodity_svd.id.clone() => ProcessFlow {
                     commodity: commodity_svd.into(),
-                    flow: 10.0,
+                    coeff: 10.0,
                     flow_type: FlowType::Fixed,
                     flow_cost: 1.0,
                     is_pac: false,

src/input/process/flow.rs

@@ -20,7 +20,7 @@ struct ProcessFlowRaw {
     commodity_id: String,
     years: String,
     regions: String,
-    flow: f64,
+    coeff: f64,
     #[serde(default)]
     flow_type: FlowType,
     flow_cost: Option<f64>,
@@ -31,9 +31,9 @@ impl ProcessFlowRaw {
     fn validate(&self) -> Result<()> {
         // Check that flow is not infinity, nan, 0 etc.
         ensure!(
-            self.flow.is_normal(),
-            "Invalid value for flow ({})",
-            self.flow
+            self.coeff.is_normal(),
+            "Invalid value for coeff ({})",
+            self.coeff
         );
 
         // **TODO**: https://github.com/EnergySystemsModellingLab/MUSE_2.0/issues/300
@@ -108,7 +108,7 @@ where
         // Create ProcessFlow object
         let process_flow = ProcessFlow {
             commodity: Rc::clone(commodity),
-            flow: record.flow,
+            coeff: record.coeff,
             flow_type: record.flow_type,
             flow_cost: record.flow_cost.unwrap_or(0.0),
             is_pac: record.is_pac,
@@ -177,7 +177,7 @@ fn validate_flow_map(flow_map: &IndexMap<CommodityID, ProcessFlow>) -> Result<()
     let mut flow_sign: Option<bool> = None; // False for inputs, true for outputs
     for flow in flow_map.values().filter(|flow| flow.is_pac) {
         // Check that flow sign is consistent
-        let current_flow_sign = flow.flow > 0.0;
+        let current_flow_sign = flow.coeff > 0.0;
         if let Some(flow_sign) = flow_sign {
             ensure!(
                 current_flow_sign == flow_sign,
@@ -202,7 +202,7 @@ mod tests {
     use rstest::{fixture, rstest};
 
     fn create_process_flow_raw(
-        flow: f64,
+        coeff: f64,
         flow_type: FlowType,
         flow_cost: Option<f64>,
         is_pac: bool,
@@ -212,7 +212,7 @@ mod tests {
             commodity_id: "commodity".into(),
             years: "2020".into(),
             regions: "region".into(),
-            flow,
+            coeff,
             flow_type,
             flow_cost,
             is_pac,
@@ -244,10 +244,10 @@ mod tests {
         assert!(invalid.validate().is_err());
     }
 
-    fn create_process_flow(commodity: Rc<Commodity>, flow: f64, is_pac: bool) -> ProcessFlow {
+    fn create_process_flow(commodity: Rc<Commodity>, coeff: f64, is_pac: bool) -> ProcessFlow {
         ProcessFlow {
             commodity,
-            flow,
+            coeff,
             flow_type: FlowType::Fixed,
             flow_cost: 0.0,
             is_pac,

src/process.rs

@@ -77,15 +77,15 @@ impl Process {
     }
 }
 
-/// Represents a maximum annual commodity flow for a given process
+/// Represents a maximum annual commodity coeff for a given process
 #[derive(PartialEq, Debug, Clone)]
 pub struct ProcessFlow {
     /// The commodity produced or consumed by this flow
     pub commodity: Rc<Commodity>,
     /// Maximum annual commodity flow quantity relative to other commodity flows.
     ///
     /// Positive value indicates flow out and negative value indicates flow in.
-    pub flow: f64,
+    pub coeff: f64,
     /// Identifies if a flow is fixed or flexible.
     pub flow_type: FlowType,
     /// Cost per unit flow.