update comments

imrn99 · Oct 25, 2024 · a436820 · a436820
1 parent 618d434
commit a436820
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/examples/examples/expression.rs b/examples/examples/expression.rs
@@ -10,8 +10,12 @@
 // - b  = 0.5    m
 // - q  = 1.0e-6 C
 
+// --- IMPORTS
+
 use integraal::{ComputeMethod, DomainDescriptor, FunctionDescriptor, Integraal};
 
+// --- CONTENT
+
 const E0: f64 = 100.0;
 const Q: f64 = 1.0e-6;
 const EXPECTED: f64 = 1.6094379124341003e-4;

diff --git a/examples/examples/measurements.rs b/examples/examples/measurements.rs
@@ -1,7 +1,15 @@
+// we compute the superficial velocity of a fluid at a pipe section, using sampled data
+//
+// see `README.md` for more details.
+
+// --- IMPORTS
+
 use csv::ReaderBuilder;
 use integraal::{ComputeMethod, DomainDescriptor, FunctionDescriptor, Integraal};
 use std::path::Path;
 
+// --- CONTENT
+
 const RMAX: f64 = 41.;
 
 #[rustfmt::skip]
@@ -29,6 +37,8 @@ fn main() {
     println!("   superficial velocity:     {:7.3} m/s"   , volume_velocity / area);
 }
 
+// file parsing using the `csv` crate; retrieve radius & velocity samples
+
 fn parse_csv(path: impl AsRef<Path>) -> (Vec<f64>, Vec<f64>) {
     let mut builder = ReaderBuilder::new();
     builder.has_headers(true).delimiter(b';');