feat: ✨ make options a class with validated properties

ImperialCollegeLondon · Aug 9, 2024 · a02bf4a · a02bf4a
1 parent 4cd975c
commit a02bf4a
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 10 deletions.
diff --git a/demo.m b/demo.m
@@ -5,7 +5,7 @@
 %% Inputs
 
 params  = gen_params (); % rock and fluid parameters
-options = gen_options(); % StrataTrapper options
+options = Options();     % StrataTrapper options
 
 %% Downscaling demo
 

diff --git a/src/Options.m b/src/Options.m
@@ -0,0 +1,8 @@
+classdef Options
+    properties
+        sat_num_points (1,1) uint32 {mustBePositive} = 40
+        sat_tol (1,1) double {mustBeNonnegative} = 1e-8
+        subscale (1,1) double {mustBePositive} = 50 * meter();
+    end
+end
+
diff --git a/src/downscale_upscale.m b/src/downscale_upscale.m
@@ -6,7 +6,7 @@
     dr          (1,3) double
     saturations (1,:) double
     params      (1,1) struct
-    options     (1,1) struct
+    options     (1,1) Options
 end
 
 

diff --git a/src/gen_options.m b/src/gen_options.m
diff --git a/strata_trapper.m b/strata_trapper.m
@@ -4,7 +4,7 @@
     rock            (1,1) struct
     mask            (:,1) logical
     params          (1,1) struct
-    options         (1,1) struct
+    options         (1,1) Options = Options();
     enable_waitbar  (1,1) logical = false;
     num_par_workers (1,1) uint32  = Inf;
 end