Merge pull request #39 from NREL/fix/change-DirT-to-enum

calbaker · web-flow · commit 63bbd41554b8 · 2024-02-14T14:11:05.000-07:00
compiles with `DirT` replaced by an enum but 3 tests fail
diff --git a/rust/altrios-core/src/lin_search_hint.rs b/rust/altrios-core/src/lin_search_hint.rs
@@ -1,18 +1,11 @@
 use crate::imports::*;
 use crate::si;
 
-// Per Geordie, we could probably get rid of this `DirT` code
-pub type DirT = u8;
-
-#[allow(non_snake_case)]
-pub mod Dir {
-    pub use super::*;
-    #[allow(non_upper_case_globals)]
-    pub const Unk: DirT = 0;
-    #[allow(non_upper_case_globals)]
-    pub const Fwd: DirT = 1;
-    #[allow(non_upper_case_globals)]
-    pub const Bwd: DirT = 2;
+#[derive(PartialEq)]
+pub enum Dir {
+    Unk,
+    Fwd,
+    Bwd,
 }
 
 /// Has method that returns offset from start of PathTpc
@@ -26,16 +19,12 @@ pub trait GetOffset {
 pub trait LinSearchHint {
     /// Calculate the index immediately before `offset` given the previous calculated index, `idx`,
     /// and a direction `DirT`.
-    fn calc_idx<const DIR: DirT>(&self, offset: si::Length, idx: usize) -> anyhow::Result<usize>;
+    fn calc_idx(&self, offset: si::Length, idx: usize, dir: &Dir) -> anyhow::Result<usize>;
 }
 
 impl<T: GetOffset + core::fmt::Debug> LinSearchHint for &[T] {
-    fn calc_idx<const DIR: DirT>(
-        &self,
-        offset: si::Length,
-        mut idx: usize,
-    ) -> anyhow::Result<usize> {
-        if DIR != Dir::Bwd {
+    fn calc_idx(&self, offset: si::Length, mut idx: usize, dir: &Dir) -> anyhow::Result<usize> {
+        if dir != &Dir::Bwd {
             ensure!(
                 offset <= self.last().unwrap().get_offset(),
                 "{}\nOffset larger than last slice offset!",
@@ -44,8 +33,7 @@ impl<T: GetOffset + core::fmt::Debug> LinSearchHint for &[T] {
             while self[idx + 1].get_offset() < offset {
                 idx += 1;
             }
-        }
-        if DIR != Dir::Fwd {
+        } else if dir != &Dir::Fwd {
             ensure!(
                 self.first().unwrap().get_offset() <= offset,
                 "{}\nOffset smaller than first slice offset!",
diff --git a/rust/altrios-core/src/train/braking_point.rs b/rust/altrios-core/src/train/braking_point.rs
@@ -81,7 +81,7 @@ impl BrakingPoints {
         let mut train_res = train_res.clone();
         train_state.offset = path_tpc.offset_end();
         train_state.speed = si::Velocity::ZERO;
-        train_res.update_res::<{ Dir::Unk }>(&mut train_state, path_tpc)?;
+        train_res.update_res(&mut train_state, path_tpc, &Dir::Unk)?;
         let speed_points = path_tpc.speed_points();
         let mut idx = path_tpc.speed_points().len();
 
@@ -101,9 +101,19 @@ impl BrakingPoints {
 
                     train_state.offset = bp_curr.offset;
                     train_state.speed = bp_curr.speed_limit;
-                    train_res.update_res::<{ Dir::Bwd }>(&mut train_state, path_tpc)?;
+                    train_res.update_res(&mut train_state, path_tpc, &Dir::Bwd)?;
 
-                    assert!(fric_brake.force_max + train_state.res_net() > si::Force::ZERO);
+                    ensure!(
+                        fric_brake.force_max + train_state.res_net() > si::Force::ZERO,
+                        format!(
+                            "{}\n{}\n{}",
+                            format_dbg!(
+                                fric_brake.force_max + train_state.res_net() > si::Force::ZERO
+                            ),
+                            format_dbg!(fric_brake.force_max),
+                            format_dbg!(train_state.res_net()),
+                        )
+                    );
                     let vel_change = train_state.dt
                         * (fric_brake.force_max + train_state.res_net())
                         / train_state.mass_static;
diff --git a/rust/altrios-core/src/train/resistance/kind/path_res.rs b/rust/altrios-core/src/train/resistance/kind/path_res.rs
@@ -14,15 +14,16 @@ pub struct Point {
 impl Point {
     pub fn new(vals: &[PathResCoeff], state: &TrainState) -> anyhow::Result<Self> {
         Ok(Self {
-            idx: vals.calc_idx::<{ Dir::Fwd }>(state.offset - state.length * 0.5, 0)?,
+            idx: vals.calc_idx(state.offset - state.length * 0.5, 0, &Dir::Fwd)?,
         })
     }
-    pub fn calc_res<const DIR: DirT>(
+    pub fn calc_res(
         &mut self,
         vals: &[PathResCoeff],
         state: &TrainState,
+        dir: &Dir,
     ) -> anyhow::Result<si::Force> {
-        self.idx = vals.calc_idx::<DIR>(state.offset - state.length * 0.5, self.idx)?;
+        self.idx = vals.calc_idx(state.offset - state.length * 0.5, self.idx, dir)?;
         Ok(calc_res_val(vals[self.idx].res_coeff, state))
     }
     pub fn res_coeff_front(&self, vals: &[PathResCoeff]) -> si::Ratio {
@@ -61,31 +62,43 @@ impl Strap {
                 idx_back: 0,
             })
         } else {
-            let idx_back = vals.calc_idx::<{ Dir::Fwd }>(state.offset - state.length, 0)?;
+            let idx_back = vals.calc_idx(state.offset - state.length, 0, &Dir::Fwd)?;
             Ok(Self {
                 idx_back,
-                idx_front: vals.calc_idx::<{ Dir::Fwd }>(state.offset, idx_back)?,
+                idx_front: vals.calc_idx(state.offset, idx_back, &Dir::Fwd)?,
             })
         }
     }
-    pub fn calc_res<const DIR: DirT>(
+    pub fn calc_res(
         &mut self,
         vals: &[PathResCoeff],
         state: &TrainState,
+        dir: &Dir,
     ) -> anyhow::Result<si::Force> {
-        if DIR == Dir::Fwd || DIR == Dir::Unk {
-            self.idx_front = vals.calc_idx::<DIR>(state.offset, self.idx_front)?;
-        }
-        if DIR == Dir::Bwd || DIR == Dir::Unk {
-            self.idx_back = vals.calc_idx::<DIR>(state.offset_back, self.idx_back)?;
+        match dir {
+            Dir::Fwd => {
+                self.idx_front = vals.calc_idx(state.offset, self.idx_front, dir)?;
+            }
+            Dir::Bwd => {
+                self.idx_back = vals.calc_idx(state.offset_back, self.idx_back, dir)?;
+            }
+            Dir::Unk => {
+                self.idx_front = vals.calc_idx(state.offset, self.idx_front, dir)?;
+                self.idx_back = vals.calc_idx(state.offset_back, self.idx_back, dir)?;
+            }
         }
+
         let res_coeff = if self.idx_front == self.idx_back {
             vals[self.idx_front].res_coeff
         } else {
-            if DIR == Dir::Fwd {
-                self.idx_back = vals.calc_idx::<DIR>(state.offset_back, self.idx_back)?;
-            } else if DIR == Dir::Bwd {
-                self.idx_front = vals.calc_idx::<DIR>(state.offset, self.idx_front)?;
+            match dir {
+                Dir::Fwd => {
+                    self.idx_back = vals.calc_idx(state.offset_back, self.idx_back, dir)?;
+                }
+                Dir::Bwd => {
+                    self.idx_front = vals.calc_idx(state.offset, self.idx_front, dir)?;
+                }
+                _ => {}
             }
             vals.calc_res_strap(self.idx_front, self.idx_back, state)
         };
diff --git a/rust/altrios-core/src/train/resistance/method/point.rs b/rust/altrios-core/src/train/resistance/method/point.rs
@@ -16,19 +16,20 @@ pub struct Point {
 }
 
 impl ResMethod for Point {
-    fn update_res<const DIR: DirT>(
+    fn update_res(
         &mut self,
         state: &mut TrainState,
         path_tpc: &PathTpc,
+        dir: &Dir,
     ) -> anyhow::Result<()> {
         state.offset_back = state.offset - state.length;
         state.weight_static = state.mass_static * uc::ACC_GRAV;
         state.res_bearing = self.bearing.calc_res();
         state.res_rolling = self.rolling.calc_res(state);
         state.res_davis_b = self.davis_b.calc_res(state);
         state.res_aero = self.aerodynamic.calc_res(state);
-        state.res_grade = self.grade.calc_res::<DIR>(path_tpc.grades(), state)?;
-        state.res_curve = self.curve.calc_res::<DIR>(path_tpc.curves(), state)?;
+        state.res_grade = self.grade.calc_res(path_tpc.grades(), state, dir)?;
+        state.res_curve = self.curve.calc_res(path_tpc.curves(), state, dir)?;
         state.grade_front = self.grade.res_coeff_front(path_tpc.grades());
         state.elev_front = self.grade.res_net_front(path_tpc.grades(), state);
         Ok(())
diff --git a/rust/altrios-core/src/train/resistance/method/strap.rs b/rust/altrios-core/src/train/resistance/method/strap.rs
@@ -35,19 +35,20 @@ impl Strap {
     }
 }
 impl ResMethod for Strap {
-    fn update_res<const DIR: DirT>(
+    fn update_res(
         &mut self,
         state: &mut TrainState,
         path_tpc: &PathTpc,
+        dir: &Dir,
     ) -> anyhow::Result<()> {
         state.offset_back = state.offset - state.length;
         state.weight_static = state.mass_static * uc::ACC_GRAV;
         state.res_bearing = self.bearing.calc_res();
         state.res_rolling = self.rolling.calc_res(state);
         state.res_davis_b = self.davis_b.calc_res(state);
         state.res_aero = self.aerodynamic.calc_res(state);
-        state.res_grade = self.grade.calc_res::<DIR>(path_tpc.grades(), state)?;
-        state.res_curve = self.curve.calc_res::<DIR>(path_tpc.curves(), state)?;
+        state.res_grade = self.grade.calc_res(path_tpc.grades(), state, dir)?;
+        state.res_curve = self.curve.calc_res(path_tpc.curves(), state, dir)?;
         state.grade_front = self.grade.res_coeff_front(path_tpc.grades());
         state.elev_front = self.grade.res_net_front(path_tpc.grades(), state);
         Ok(())
diff --git a/rust/altrios-core/src/train/resistance/mod.rs b/rust/altrios-core/src/train/resistance/mod.rs
@@ -8,10 +8,11 @@ use crate::train::TrainState;
 
 #[enum_dispatch]
 pub trait ResMethod {
-    fn update_res<const DIR: DirT>(
+    fn update_res(
         &mut self,
         state: &mut TrainState,
         path_tpc: &PathTpc,
+        dir: &Dir,
     ) -> anyhow::Result<()>;
     fn fix_cache(&mut self, link_point_del: &LinkPoint);
 }
diff --git a/rust/altrios-core/src/train/set_speed_train_sim.rs b/rust/altrios-core/src/train/set_speed_train_sim.rs
@@ -314,7 +314,7 @@ impl SetSpeedTrainSim {
         self.loco_con
             .set_cur_pwr_max_out(None, self.speed_trace.dt(self.state.i))?;
         self.train_res
-            .update_res::<{ Dir::Fwd }>(&mut self.state, &self.path_tpc)?;
+            .update_res(&mut self.state, &self.path_tpc, &Dir::Fwd)?;
         self.solve_required_pwr(self.speed_trace.dt(self.state.i));
         self.loco_con.solve_energy_consumption(
             self.state.pwr_whl_out,
diff --git a/rust/altrios-core/src/train/speed_limit_train_sim.rs b/rust/altrios-core/src/train/speed_limit_train_sim.rs
@@ -287,7 +287,7 @@ impl SpeedLimitTrainSim {
         self.loco_con.set_pwr_aux(Some(true))?;
         self.loco_con.set_cur_pwr_max_out(None, self.state.dt)?;
         self.train_res
-            .update_res::<{ Dir::Fwd }>(&mut self.state, &self.path_tpc)?;
+            .update_res(&mut self.state, &self.path_tpc, &Dir::Fwd)?;
         self.solve_required_pwr()?;
         self.loco_con.solve_energy_consumption(
             self.state.pwr_whl_out,
