Merge pull request #267 from xylar/fix-inertial-gravity-wave

Fix inertial gravity wave test

Author: xylar

polaris/ocean/tasks/inertial_gravity_wave/__init__.py

@@ -120,8 +120,10 @@ def __init__(self, component, config, refinement='both'):
                                subdir=f'{self.subdir}/analysis',
                                refinement=refinement,
                                dependencies=analysis_dependencies))
-        self.add_step(Viz(component=component, resolutions=resolutions,
-                          taskdir=self.subdir),
+        self.add_step(Viz(component=component,
+                          taskdir=self.subdir,
+                          refinement=refinement,
+                          dependencies=analysis_dependencies),
                       run_by_default=False)
         config.add_from_package('polaris.ocean.convergence',
                                 'convergence.cfg')

polaris/ocean/tasks/inertial_gravity_wave/forward.yaml

@@ -14,6 +14,7 @@ mpas-ocean:
   debug:
     config_disable_vel_hadv: true
     config_disable_vel_hmix: true
+    config_disable_tr_all_tend: true
   streams:
     mesh:
       filename_template: init.nc

polaris/ocean/tasks/inertial_gravity_wave/viz.py

@@ -6,7 +6,10 @@
 import xarray as xr
 
 from polaris import Step
-from polaris.ocean.resolution import resolution_to_subdir
+from polaris.ocean.convergence import (
+    get_resolution_for_task,
+    get_timestep_for_task,
+)
 from polaris.ocean.tasks.inertial_gravity_wave.exact_solution import (
     ExactSolution,
 )
@@ -20,10 +23,31 @@ class Viz(Step):
 
     Attributes
     ----------
-    resolutions : list of float
-        The resolutions of the meshes that have been run
+    dependencies_dict : dict of dict of polaris.Steps
+        The dependencies of this step must be given as separate keys in the
+        dict:
+
+            mesh : dict of polaris.Steps
+                Keys of the dict correspond to `refinement_factors`
+                Values of the dict are polaris.Steps, which must have the
+                attribute `path`, the path to `base_mesh.nc` of that
+                resolution
+            init : dict of polaris.Steps
+                Keys of the dict correspond to `refinement_factors`
+                Values of the dict are polaris.Steps, which must have the
+                attribute `path`, the path to `initial_state.nc` of that
+                resolution
+            forward : dict of polaris.Steps
+                Keys of the dict correspond to `refinement_factors`
+                Values of the dict are polaris.Steps, which must have the
+                attribute `path`, the path to `forward.nc` of that
+                resolution
+
+    refinement : str, optional
+        Refinement type. One of 'space', 'time' or 'both' indicating both
+        space and time
     """
-    def __init__(self, component, resolutions, taskdir):
+    def __init__(self, component, taskdir, dependencies, refinement='both'):
         """
         Create the step
 
@@ -32,37 +56,81 @@ def __init__(self, component, resolutions, taskdir):
         component : polaris.Component
             The component the step belongs to
 
-        resolutions : list of float
-            The resolutions of the meshes that have been run
-
         taskdir : str
             The subdirectory that the task belongs to
+
+        dependencies : dict of dict of polaris.Steps
+            The dependencies of this step must be given as separate keys in the
+            dict:
+
+                mesh : dict of polaris.Steps
+                    Keys of the dict correspond to `refinement_factors`
+                    Values of the dict are polaris.Steps, which must have the
+                    attribute `path`, the path to `base_mesh.nc` of that
+                    resolution
+                init : dict of polaris.Steps
+                    Keys of the dict correspond to `refinement_factors`
+                    Values of the dict are polaris.Steps, which must have the
+                    attribute `path`, the path to `initial_state.nc` of that
+                    resolution
+                forward : dict of polaris.Steps
+                    Keys of the dict correspond to `refinement_factors`
+                    Values of the dict are polaris.Steps, which must have the
+                    attribute `path`, the path to `forward.nc` of that
+                    resolution
+
+        refinement : str, optional
+            Refinement type. One of 'space', 'time' or 'both' indicating both
+            space and time
         """
         super().__init__(component=component, name='viz', indir=taskdir)
-        self.resolutions = resolutions
+        self.dependencies_dict = dependencies
+        self.refinement = refinement
 
-        for resolution in resolutions:
-            mesh_name = resolution_to_subdir(resolution)
+        self.add_output_file('comparison.png')
+
+    def setup(self):
+        """
+        Add input files based on resolutions, which may have been changed by
+        user config options
+        """
+        super().setup()
+        config = self.config
+        dependencies = self.dependencies_dict
+        if self.refinement == 'time':
+            option = 'refinement_factors_time'
+        else:
+            option = 'refinement_factors_space'
+        refinement_factors = config.getlist('convergence', option,
+                                            dtype=float)
+        for refinement_factor in refinement_factors:
+            base_mesh = dependencies['mesh'][refinement_factor]
+            init = dependencies['init'][refinement_factor]
+            forward = dependencies['forward'][refinement_factor]
             self.add_input_file(
-                filename=f'mesh_{mesh_name}.nc',
-                target=f'../init/{mesh_name}/culled_mesh.nc')
+                filename=f'mesh_r{refinement_factor:02g}.nc',
+                work_dir_target=f'{base_mesh.path}/base_mesh.nc')
             self.add_input_file(
-                filename=f'init_{mesh_name}.nc',
-                target=f'../init/{mesh_name}/initial_state.nc')
+                filename=f'init_r{refinement_factor:02g}.nc',
+                work_dir_target=f'{init.path}/initial_state.nc')
             self.add_input_file(
-                filename=f'output_{mesh_name}.nc',
-                target=f'../forward/{mesh_name}/output.nc')
-
-        self.add_output_file('comparison.png')
+                filename=f'output_r{refinement_factor:02g}.nc',
+                work_dir_target=f'{forward.path}/output.nc')
 
     def run(self):
         """
         Run this step of the test case
         """
         plt.switch_backend('Agg')
         config = self.config
-        resolutions = self.resolutions
-        nres = len(resolutions)
+
+        if self.refinement == 'time':
+            option = 'refinement_factors_time'
+        else:
+            option = 'refinement_factors_space'
+        refinement_factors = config.getlist('convergence', option,
+                                            dtype=float)
+        nres = len(refinement_factors)
 
         section = config['inertial_gravity_wave']
         eta0 = section.getfloat('ssh_amplitude')
@@ -71,11 +139,12 @@ def run(self):
         fig, axes = plt.subplots(nrows=nres, ncols=3, figsize=(12, 2 * nres))
         rmse = []
         error_range = None
-        for i, res in enumerate(resolutions):
-            mesh_name = resolution_to_subdir(res)
-            ds_mesh = xr.open_dataset(f'mesh_{mesh_name}.nc')
-            ds_init = xr.open_dataset(f'init_{mesh_name}.nc')
-            ds = xr.open_dataset(f'output_{mesh_name}.nc')
+        for i, refinement_factor in enumerate(refinement_factors):
+            resolution = get_resolution_for_task(
+                config, refinement_factor, refinement=self.refinement)
+            ds_mesh = xr.open_dataset(f'mesh_r{refinement_factor:02g}.nc')
+            ds_init = xr.open_dataset(f'init_r{refinement_factor:02g}.nc')
+            ds = xr.open_dataset(f'output_r{refinement_factor:02g}.nc')
             exact = ExactSolution(ds_init, config)
 
             t0 = datetime.datetime.strptime(ds.xtime.values[0].decode(),
@@ -112,8 +181,13 @@ def run(self):
         axes[0, 2].set_title('Error (Numerical - Analytical)')
 
         pad = 5
-        for ax, res in zip(axes[:, 0], resolutions):
-            ax.annotate(f'{res}km', xy=(0, 0.5),
+        for ax, refinement_factor in zip(axes[:, 0], refinement_factors):
+            timestep, _ = get_timestep_for_task(
+                config, refinement_factor, refinement=self.refinement)
+            resolution = get_resolution_for_task(
+                config, refinement_factor, refinement=self.refinement)
+
+            ax.annotate(f'{resolution}km\n{timestep}s', xy=(0, 0.5),
                         xytext=(-ax.yaxis.labelpad - pad, 0),
                         xycoords=ax.yaxis.label, textcoords='offset points',
                         size='large', ha='right', va='center')