Add wave mesh generation for global_ocean mesh test cases

compass/ocean/tests/global_ocean/__init__.py

@@ -13,6 +13,7 @@
 from compass.ocean.tests.global_ocean.performance_test import PerformanceTest
 from compass.ocean.tests.global_ocean.restart_test import RestartTest
 from compass.ocean.tests.global_ocean.threads_test import ThreadsTest
+from compass.ocean.tests.global_ocean.wave_mesh import WaveMesh
 from compass.testgroup import TestGroup
 
 
@@ -62,10 +63,15 @@ def __init__(self, mpas_core):
         # A test case for making E3SM support files from an existing mesh
         self.add_test_case(FilesForE3SM(test_group=self))
 
+        # Test cases for creating waves mesh
+        self.add_test_case(WaveMesh(test_group=self))
+        self._add_tests(mesh_names=['Icos'], include_wave_mesh=True)
+
     def _add_tests(self, mesh_names, high_res_topography=True,
                    include_rk4=False,
                    include_regression=False, include_phc=False,
-                   include_en4_1900=False):
+                   include_en4_1900=False,
+                   include_wave_mesh=False):
         """ Add test cases for the given mesh(es) """
 
         default_ic = 'WOA23'
@@ -116,10 +122,10 @@ def _add_tests(self, mesh_names, high_res_topography=True,
                 time_integrator=time_integrator)
             self.add_test_case(dynamic_adjustment_test)
 
-            self.add_test_case(
-                FilesForE3SM(
-                    test_group=self, mesh=mesh_test, init=init_test,
-                    dynamic_adjustment=dynamic_adjustment_test))
+            e3sm_files_test = FilesForE3SM(
+                test_group=self, mesh=mesh_test, init=init_test,
+                dynamic_adjustment=dynamic_adjustment_test)
+            self.add_test_case(e3sm_files_test)
 
             if include_rk4:
                 time_integrator = 'RK4'
@@ -167,3 +173,8 @@ def _add_tests(self, mesh_names, high_res_topography=True,
                     FilesForE3SM(
                         test_group=self, mesh=mesh_test, init=init_test,
                         dynamic_adjustment=dynamic_adjustment_test))
+
+            if include_wave_mesh:
+                self.add_test_case(
+                    WaveMesh(test_group=self, ocean_mesh=mesh_test,
+                             ocean_init=init_test))

compass/ocean/tests/global_ocean/wave_mesh/__init__.py

@@ -0,0 +1,99 @@
+# from compass.ocean.tests.global_ocean.metadata import (
+#     get_author_and_email_from_git,
+# )
+from compass.ocean.tests.global_ocean.wave_mesh.base_mesh import WavesBaseMesh
+from compass.ocean.tests.global_ocean.wave_mesh.cull_mesh import WavesCullMesh
+from compass.ocean.tests.global_ocean.wave_mesh.remap_files import (
+    WavesRemapFiles,
+)
+from compass.ocean.tests.global_ocean.wave_mesh.rotate_mesh import (
+    WavesRotateMesh,
+)
+from compass.ocean.tests.global_ocean.wave_mesh.scrip_file import (
+    WavesScripFile,
+)
+from compass.ocean.tests.global_ocean.wave_mesh.uost_files import (
+    WavesUostFiles,
+)
+from compass.testcase import TestCase
+
+# from compass.validate import compare_variables
+
+
+class WaveMesh(TestCase):
+    """
+    A test case for creating a global MPAS-Ocean mesh
+
+    Attributes
+    ----------
+    """
+    def __init__(self, test_group, ocean_mesh=None, ocean_init=None):
+        """
+        Create test case for creating a global MPAS-Ocean mesh
+
+        Parameters
+        ----------
+        test_group : compass.ocean.tests.global_ocean.GlobalOcean
+            The global ocean test group that this test case belongs to
+
+        """
+        name = 'wave_mesh'
+        if ocean_mesh is not None:
+            subdir = f'{ocean_mesh.mesh_name}/{name}'
+        else:
+            subdir = name
+
+        super().__init__(test_group=test_group, name=name, subdir=subdir)
+
+        self.package = 'compass.ocean.tests.global_ocean.wave_mesh'
+        self.mesh_config_filename = 'wave_mesh.cfg'
+
+        base_mesh_step = WavesBaseMesh(test_case=self,
+                                       ocean_base_mesh=ocean_mesh,
+                                       ocean_culled_mesh=ocean_init)
+        self.add_step(base_mesh_step)
+
+        cull_mesh_step = WavesCullMesh(test_case=self,
+                                       ocean_mesh=ocean_init,
+                                       wave_base_mesh=base_mesh_step)
+        self.add_step(cull_mesh_step)
+
+        scrip_file_step = WavesScripFile(test_case=self,
+                                         wave_culled_mesh=cull_mesh_step,
+                                         ocean_mesh=ocean_init)
+        self.add_step(scrip_file_step)
+
+        remap_file_step = WavesRemapFiles(test_case=self,
+                                          wave_scrip=scrip_file_step)
+        self.add_step(remap_file_step)
+
+        rotate_mesh_step = WavesRotateMesh(test_case=self,
+                                           wave_culled_mesh=cull_mesh_step)
+        self.add_step(rotate_mesh_step)
+
+        uost_file_step = WavesUostFiles(test_case=self,
+                                        wave_culled_mesh=cull_mesh_step,
+                                        wave_rotate_mesh=rotate_mesh_step)
+        self.add_step(uost_file_step)
+
+    def configure(self, config=None):
+        """
+        Modify the configuration options for this test case
+
+        config : compass.config.CompassConfigParser, optional
+            Configuration options to update if not those for this test case
+        """
+        if config is None:
+            config = self.config
+        config.add_from_package('compass.mesh', 'mesh.cfg', exception=True)
+
+        # get_author_and_email_from_git(config)
+
+#    def validate(self):
+#        """
+#        Test cases can override this method to perform validation of variables
+#        and timers
+#        """
+#        variables = ['xCell', 'yCell', 'zCell']
+#        compare_variables(test_case=self, variables=variables,
+#                          filename1='cull_mesh/culled_mesh.nc')