Merge branch 'develop' into fix-thermo-test-fail

Author: bhargavakula01

oscps-lib/src/blocks.rs

@@ -14,18 +14,20 @@ use uom::si::f64::Mass;
 use uom::si::mass::kilogram;
 
 #[allow(dead_code)]
-/// Minimum error allowed for energy difference. TODO: Change this to a 
-/// relative scale instead of an absolute scale.
+/// Minimum error allowed for energy difference. 
+/// TODO: Change this to a relative scale instead of an absolute scale.
 pub static TOLERENCE_ENERGY: Lazy<Energy> = 
     Lazy::new(|| Energy::new::<joule>(5.0));
 
 #[allow(dead_code)]
-/// Minimum error allowed for mass difference. TODO: Change this to a relative
-/// scale instead of an absolute scale.
+/// Minimum error allowed for mass difference. 
+/// TODO: Change this to a relative scale instead of an absolute scale.
 pub static TOLERENCE_MASS: Lazy<Mass> = 
     Lazy::new(|| Mass::new::<kilogram>(5.0));
 
 #[allow(dead_code)]
+/// # MassBalance
+///
 /// Trait for ensuring the overall mass balance is maintained in a flowsheet.
 ///
 /// This trait can be implemented by any block that needs to ensure mass 
@@ -169,6 +171,9 @@ impl Mixer {
     fn compute_outlet_pressure(&self) {}
 }
 
+/// # Block Tests
+/// 
+/// The following module holds all the unit test cases for the blocks module
 #[cfg(test)]
 mod block_tests {
     use crate::connector::{Econnector, Mconnector};
@@ -179,6 +184,7 @@ mod block_tests {
     use uom::si::mass::pound;
 
     #[test]
+    /// checks whether the mass balance check function was implemented properly
     fn test_mass_balance_check_steady_state_for_mixer() {
         // here you will need to check that the mass into the mixer = mass out of mixer
 
@@ -197,6 +203,7 @@ mod block_tests {
     }
 
     #[test]
+    /// checks if the 'energy_balance_check' function was implemented properly
     fn test_energy_balance_check_steady_state_for_mixer() {
         // energy into mixer = energy out of mixer
         let mixer_test_obj = Mixer {
@@ -214,6 +221,7 @@ mod block_tests {
     }
 
     #[test]
+    /// checking functionality of 'compute_total_outlet_mass_flow'
     fn test_compute_total_outlet_mass_flow() {
         let in_streams_mass = vec![
             Mconnector {
@@ -231,6 +239,7 @@ mod block_tests {
     }
 
     #[test]
+    /// checking functionality of 'compute_outlet_energy_flows'
     fn test_compute_outlet_energy_flows() {
         let in_streams_energy = vec![
             Econnector {

oscps-lib/src/thermodynamics.rs

@@ -81,6 +81,8 @@ pub struct SpeciesListPair {
 
 #[allow(dead_code)]
 /// Implementation of ThermoState
+/// This struct holds the functionality to perform thermodynamic calculations for a stream or for
+/// an individual species
 impl ThermoState {
     /// Constructor for creating a ThermoState
     pub fn new(
@@ -132,6 +134,7 @@ mod thermo_tests {
     use uom::si::thermodynamic_temperature::kelvin;
 
     #[test]
+    ///Test case generates an instance of the 'ThermoState' struct
     fn test_create_thermo_state() {
         // Create some test data for ThermoMoleFrac (mole fractions)
         let water = Chemical {
@@ -175,6 +178,7 @@ mod thermo_tests {
     }
 
     #[test]
+    ///Tests the mass fraction function within the 'ThermoState struct'
     fn test_mass_fraction_calculation() {
         let water = Chemical {
             pubchem_obj: pubchem::Compound::new(962),