Merge pull request #37 from KG32/feat/recalculate-all-tissues-with-ma…

…x-gf

Feat/recalculate all tissues with max gf

.github/workflows/rust.yml

@@ -18,7 +18,18 @@ jobs:
     - name: Enforce formatting
       run: cargo fmt --check
 
-  build:
+  clippy:
+    name: Clippy check
+    env:
+      RUSTFLAGS: "-Dwarnings"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run Clippy
+        run: cargo clippy
+
+  build_and_test:
+    name: Build and test
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dive-deco"
-version = "4.2.1"
+version = "4.3.0"
 edition = "2021"
 license = "MIT"
 description = "A dive decompression models library (Buehlmann ZH-L 16C)"

README.md

@@ -71,6 +71,7 @@ Current config options:
 - `ceiling_type` (enum `CeilingType`)
   - `Actual` (default) - both NDL time and ceiling are determined by the current tissues saturation, it counts down to a condition where calculated ceiling is below the surface
   - `Adaptive` - takes into account off-gassing on ascent, determines if real deco obligation assuming direct ascent with set ascent rate
+- `recalc_all_tissues_m_values` - recalculate all tissues considering gradient factors (default: true). If set to false, only leading tissue is recalculated with max gf
 
 ```rust
     // fluid-interface-like built config

examples/config_example.rs

@@ -13,6 +13,7 @@ fn main() {
         deco_ascent_rate: 9.,
         ceiling_type: CeilingType::Actual,
         round_ceiling: false,
+        recalc_all_tissues_m_values: true,
     };
     let model_2 = BuehlmannModel::new(config_instance);
     println!("{:?}", model_2.config());

src/buehlmann/buehlmann_config.rs

@@ -17,6 +17,7 @@ pub struct BuehlmannConfig {
     pub deco_ascent_rate: AscentRatePerMinute,
     pub ceiling_type: CeilingType,
     pub round_ceiling: bool,
+    pub recalc_all_tissues_m_values: bool,
 }
 
 impl BuehlmannConfig {
@@ -48,6 +49,11 @@ impl BuehlmannConfig {
         self.round_ceiling = round_ceiling;
         self
     }
+
+    pub fn with_all_m_values_recalculated(mut self, recalc_all_tissues_m_values: bool) -> Self {
+        self.recalc_all_tissues_m_values = recalc_all_tissues_m_values;
+        self
+    }
 }
 
 impl Default for BuehlmannConfig {
@@ -58,6 +64,7 @@ impl Default for BuehlmannConfig {
             deco_ascent_rate: 10.,
             ceiling_type: CeilingType::Actual,
             round_ceiling: false,
+            recalc_all_tissues_m_values: true,
         }
     }
 }

src/buehlmann/buehlmann_model.rs

@@ -305,19 +305,38 @@ impl BuehlmannModel {
     }
 
     fn recalculate_compartments(&mut self, record: &RecordData) {
+        let (gf_low, gf_high) = self.config.gf;
         for compartment in self.compartments.iter_mut() {
-            compartment.recalculate(record, self.config.gf.1, self.config.surface_pressure);
+            compartment.recalculate(record, gf_high, self.config.surface_pressure);
+        }
+
+        // recalc
+        if gf_high != gf_low {
+            let max_gf = self.max_gf(self.config.gf, record.depth);
+            match self.config.recalc_all_tissues_m_values {
+                true => self.recalculate_all_tisues_with_gf(record, max_gf),
+                false => self.recalculate_leading_compartment_with_gf(record, max_gf),
+            }
         }
-        self.recalculate_leading_compartment_with_gf(record);
     }
 
-    fn recalculate_leading_compartment_with_gf(&mut self, record: &RecordData) {
-        let BuehlmannConfig {
-            gf,
-            surface_pressure,
-            ..
-        } = self.config;
-        let max_gf = self.max_gf(gf, record.depth);
+    fn recalculate_all_tisues_with_gf(&mut self, record: &RecordData, max_gf: GradientFactor) {
+        let recalc_record = RecordData {
+            depth: record.depth,
+            time: 0,
+            gas: record.gas,
+        };
+        for compartment in self.compartments.iter_mut() {
+            compartment.recalculate(&recalc_record, max_gf, self.config.surface_pressure);
+        }
+    }
+
+    fn recalculate_leading_compartment_with_gf(
+        &mut self,
+        record: &RecordData,
+        max_gf: GradientFactor,
+    ) {
+        let surface_pressure = self.config.surface_pressure;
         let leading = self.leading_comp_mut();
 
         // recalculate leading tissue with max gf
@@ -451,7 +470,7 @@ mod tests {
 
         model.record(40., 30 * 60, &air);
         model.record(21., 5 * 60, &air);
-        model.record(14., 0 * 60, &air);
+        model.record(14., 0, &air);
         assert_eq!(model.max_gf(gf, 14.), 40);
     }
 

src/buehlmann/compartment.rs

@@ -120,9 +120,8 @@ impl Compartment {
             self.max_gf_adjusted_zhl_params(weighted_zhl_params, max_gf);
         let p_surf = (surface_pressure as f64) / 1000.;
         let p_amb = p_surf + (depth / 10.);
-        let m_value = a_coeff_adjusted + (p_amb / b_coeff_adjusted);
 
-        m_value
+        a_coeff_adjusted + (p_amb / b_coeff_adjusted)
     }
 
     // tissue inert gasses pressure after record

src/common/gas.rs

@@ -22,9 +22,9 @@ pub enum InertGas {
     Nitrogen,
 }
 
-impl ToString for Gas {
-    fn to_string(&self) -> String {
-        format!("{}/{}", self.o2_pp * 100., self.he_pp * 100.)
+impl std::fmt::Display for Gas {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}/{}", self.o2_pp * 100., self.he_pp * 100.)
     }
 }
 

tests/buehlmann_tests.rs

@@ -138,21 +138,21 @@ fn test_multi_gas_ndl() {
     let air = Gas::new(0.21, 0.);
     let ean_28 = Gas::new(0.28, 0.);
 
-    model.record(30., 0 * 60, &air);
+    model.record(30., 0, &air);
     assert_eq!(model.ndl(), 16);
 
     model.record(30., 10 * 60, &air);
     assert_eq!(model.ndl(), 6);
 
-    model.record(30., 0 * 60, &ean_28);
+    model.record(30., 0, &ean_28);
     assert_eq!(model.ndl(), 10);
 }
 
 #[test]
 fn test_ndl_with_gf() {
     let mut model = fixtures::model_gf((70, 70));
     let air = Gas::new(0.21, 0.);
-    model.record(20., 0 * 60, &air);
+    model.record(20., 0, &air);
     assert_eq!(model.ndl(), 21);
 }