Improve error reporting for case files. (#437)

* Partially complete typechecking

* fix nonsense comment

* It appears to work!

Only thing I'd maybe change past this point is the error reporting

* sate the linter

* remove new python syntax -- cluster versions are before 3.10

* Refactor and fix new Python syntax

I implemented something halfway between what I currently have and what
we discussed last night

* Remove redundant check in test runner

* sate linter again

* refactor, document, and add example

* decouple MFCInputFile constructor and validation

* remove bad case

* Fix macOS CI

* regex refactor, remove unnecessary validation

* fix trailing whitespace

* toolchain: Give context for jsonschema errors

---------

Co-authored-by: Henry LE BERRE <[email protected]>

Author: AiredaleDev

.github/workflows/test.yml

@@ -50,10 +50,10 @@ jobs:
       - name: Setup MacOS
         if:   matrix.os == 'macos'
         run: |
-          echo "CC=gcc-13"      >> $GITHUB_ENV
-          echo "CXX=g++-13"     >> $GITHUB_ENV
-          echo "FC=gfortran-13" >> $GITHUB_ENV
-          brew install wget make python make cmake coreutils gcc@13
+          brew install wget make python make cmake coreutils gcc@14
+          echo "CC=gcc-14"      >> $GITHUB_ENV
+          echo "CXX=g++-14"     >> $GITHUB_ENV
+          echo "FC=gfortran-14" >> $GITHUB_ENV
           
       - name: (MacOS) Build OpenMPI
         if:   matrix.os == 'macos' && matrix.mpi == 'mpi'

docs/documentation/case.md

@@ -354,7 +354,7 @@ Details of implementation of viscosity in MFC can be found in [Coralic (2015)](r
 | `mpp_lim`	             | Logical | Mixture physical parameters limits |
 | `mixture_err`          | Logical | Mixture properties correction |
 | `time_stepper`         | Integer | Runge--Kutta order [1-3] |
-| `adap_dt`              | Loginal | Strang splitting scheme with adaptive time stepping |
+| `adap_dt`              | Logical | Strang splitting scheme with adaptive time stepping |
 | `weno_order`	         | Integer | WENO order [1,3,5] |
 | `weno_eps`	           | Real    | WENO perturbation (avoid division by zero) |
 | `mapped_weno`	         | Logical | WENO with mapping of nonlinear weights |

examples/2D_riemann_test/case.py

@@ -33,7 +33,7 @@
     'mixture_err'                  : 'T',
     'time_stepper'                 : 3,
     'mp_weno'                      : 'F',
-    'recon_type'                   : 1,
+    # 'recon_type'                   : 1,
     'weno_order'                   : 5,
     'weno_eps'                     : 1e-16,
     #'muscl_order'                  : 2,

toolchain/mfc/build.py

@@ -287,6 +287,7 @@ def build(targets = None, case: input.MFCInputFile = None, history: typing.Set[s
 
     targets = get_targets(list(REQUIRED_TARGETS) + targets)
     case    = case or input.load(ARG("input"), ARG("arguments"), {})
+    case.validate_params()
 
     if len(history) == 0:
         cons.print(__generate_header("Build", targets))

toolchain/mfc/case.py

@@ -1,4 +1,5 @@
-import re, json, math, copy, dataclasses
+import re, json, math, copy, dataclasses, jsonschema
+import jsonschema.exceptions
 
 from . import common
 from . import build
@@ -65,6 +66,19 @@ def get_inp(self, _target) -> str:
 
         return f"&user_inputs\n{dict_str}&end/\n"
 
+    def validate_params(self, origin_txt: str = None):
+        '''Typechecks parameters read from case file. If a parameter
+        is assigned a vlaie of the wrong type, this method throws an exception
+        highlighting the violating parameter and specifying what it expects.'''
+        try:
+            jsonschema.validate(self.params, case_dicts.SCHEMA)
+        except jsonschema.exceptions.ValidationError as e:
+            exception_txt = f"Case parameter '{e.path[0]}' is of the wrong type. Expected type: '{e.schema['type']}'. Got value '{e.instance}' of type '{type(e.instance).__name__}'."
+            if origin_txt:
+                exception_txt = f"Origin: {origin_txt}. {exception_txt}"
+
+            raise common.MFCException(exception_txt)
+
     def __get_ndims(self) -> int:
         return 1 + min(int(self.params.get("n", 0)), 1) + min(int(self.params.get("p", 0)), 1)