Rename: flow_cost => cost

Author: alexdewar

examples/simple/process_flows.csv

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

@@ -32,7 +32,7 @@ fields:
     type: string
     title: The type of commodity flow
     description: Currently this value must be `fixed`
-  - name: flow_cost
+  - name: cost
     type: number
     title: The cost per unit flow
     description: Optional. If present, must be >0.

src/input/process.rs

@@ -307,7 +307,7 @@ mod tests {
                 commodity: commodity_sed.into(),
                 coeff: -10.0,
                 kind: FlowType::Fixed,
-                flow_cost: 1.0,
+                cost: 1.0,
                 is_pac: false,
             }},
         )])
@@ -321,7 +321,7 @@ mod tests {
                 commodity: commodity_sed.into(),
                 coeff: 10.0,
                 kind: FlowType::Fixed,
-                flow_cost: 1.0,
+                cost: 1.0,
                 is_pac: false,
             }},
         )])
@@ -382,7 +382,7 @@ mod tests {
                     commodity: commodity_svd.into(),
                     coeff: 10.0,
                     kind: FlowType::Fixed,
-                    flow_cost: 1.0,
+                    cost: 1.0,
                     is_pac: false,
                 }},
             )]),

src/input/process/flow.rs

@@ -24,7 +24,7 @@ struct ProcessFlowRaw {
     #[serde(default)]
     #[serde(rename = "type")]
     kind: FlowType,
-    flow_cost: Option<f64>,
+    cost: Option<f64>,
     is_pac: bool,
 }
 
@@ -44,10 +44,10 @@ impl ProcessFlowRaw {
         );
 
         // Check that flow cost is non-negative
-        if let Some(flow_cost) = self.flow_cost {
+        if let Some(cost) = self.cost {
             ensure!(
-                (0.0..f64::INFINITY).contains(&flow_cost),
-                "Invalid value for flow cost ({flow_cost}). Must be >=0."
+                (0.0..f64::INFINITY).contains(&cost),
+                "Invalid value for flow cost ({cost}). Must be >=0."
             )
         }
 
@@ -111,7 +111,7 @@ where
             commodity: Rc::clone(commodity),
             coeff: record.coeff,
             kind: record.kind,
-            flow_cost: record.flow_cost.unwrap_or(0.0),
+            cost: record.cost.unwrap_or(0.0),
             is_pac: record.is_pac,
         };
 
@@ -205,7 +205,7 @@ mod tests {
     fn create_process_flow_raw(
         coeff: f64,
         kind: FlowType,
-        flow_cost: Option<f64>,
+        cost: Option<f64>,
         is_pac: bool,
     ) -> ProcessFlowRaw {
         ProcessFlowRaw {
@@ -215,7 +215,7 @@ mod tests {
             regions: "region".into(),
             coeff,
             kind,
-            flow_cost,
+            cost,
             is_pac,
         }
     }
@@ -250,7 +250,7 @@ mod tests {
             commodity,
             coeff,
             kind: FlowType::Fixed,
-            flow_cost: 0.0,
+            cost: 0.0,
             is_pac,
         }
     }

src/process.rs

@@ -93,7 +93,7 @@ pub struct ProcessFlow {
     /// For example, cost per unit of natural gas produced. The user can apply it to any specified
     /// flow, in contrast to [`ProcessParameter::variable_operating_cost`], which applies only to
     /// PAC flows.
-    pub flow_cost: f64,
+    pub cost: f64,
     /// Whether this flow represents a Primary Activity Commodity
     pub is_pac: bool,
 }