Source code for compass.ocean.tests.hurricane.forward

from compass.testcase import TestCase
from compass.ocean.tests.hurricane.forward.forward import ForwardStep
from compass.ocean.tests.hurricane.analysis import Analysis
from compass.ocean.tests.hurricane.configure import configure_hurricane
import os


[docs]class Forward(TestCase):
    """
    A test case for performing a forward run for a hurricane case

    Attributes
    ----------
    mesh : compass.ocean.tests.global_ocean.mesh.Mesh
        The test case that produces the mesh for this run

    init : compass.ocean.tests.hurricane.init.Init
        The test case that produces the initial condition for this run
    """
[docs]    def __init__(self, test_group, mesh, storm, init):
        """
        Create test case

        Parameters
        ----------
        test_group : compass.ocean.tests.hurricane.Hurricane
            The test group that this test case belongs to

        mesh : compass.ocean.tests.global_ocean.mesh.Mesh
            The test case that produces the mesh for this run

        storm : str
            The name of the storm to be run

        init : compass.ocean.tests.hurricane.init.Init
            The test case that produces the initial condition for this run
        """
        mesh_name = mesh.mesh_name
        subdir = os.path.join(mesh_name, storm)
        super().__init__(test_group=test_group,
                         subdir=subdir,
                         name=storm)
        self.mesh = mesh

        step = ForwardStep(test_case=self, mesh=mesh, init=init)

        step.add_output_file(filename='output.nc')
        step.add_output_file(filename='pointwiseStats.nc')
        self.add_step(step)

        step = Analysis(test_case=self, storm=storm)
        self.add_step(step)

[docs]    def configure(self):
        """
        Modify the configuration options for this test case
        """
        configure_hurricane(test_case=self, mesh=self.mesh)

[docs]    def run(self):
        """
        Run each step of the testcase
        """
        # run the steps
        super().run()