import time
from compass.model import run_model
from compass.step import Step
[docs]
class Forward(Step):
"""
A step for performing forward MPAS-Ocean runs as part of the cosine bell
test case
Attributes
----------
resolution : int
The resolution of the (uniform) mesh in km
mesh_name : str
The name of the mesh
"""
[docs]
def __init__(self, test_case, resolution, mesh_name):
"""
Create a new step
Parameters
----------
test_case : compass.ocean.tests.global_convergence.cosine_bell.CosineBell
The test case this step belongs to
resolution : int
The resolution of the (uniform) mesh in km
mesh_name : str
The name of the mesh
""" # noqa: E501
super().__init__(test_case=test_case,
name=f'{mesh_name}_forward',
subdir=f'{mesh_name}/forward')
self.resolution = resolution
self.mesh_name = mesh_name
# make sure output is double precision
self.add_streams_file('compass.ocean.streams', 'streams.output')
self.add_namelist_file(
'compass.ocean.tests.global_convergence.cosine_bell',
'namelist.forward')
self.add_streams_file(
'compass.ocean.tests.global_convergence.cosine_bell',
'streams.forward')
self.add_input_file(filename='init.nc',
target='../init/initial_state.nc')
self.add_input_file(filename='graph.info',
target='../mesh/graph.info')
self.add_model_as_input()
self.add_output_file(filename='output.nc')
[docs]
def setup(self):
"""
Set namelist options base on config options
"""
dt = self.get_dt()
self.add_namelist_options({'config_dt': dt})
self._get_resources()
def constrain_resources(self, available_resources):
"""
Update resources at runtime from config options
"""
self._get_resources()
super().constrain_resources(available_resources)
[docs]
def run(self):
"""
Run this step of the testcase
"""
# update dt in case the user has changed dt_per_km
dt = self.get_dt()
self.update_namelist_at_runtime(options={'config_dt': dt},
out_name='namelist.ocean')
run_model(self)
[docs]
def get_dt(self):
"""
Get the time step
Returns
-------
dt : str
the time step in HH:MM:SS
"""
config = self.config
# dt is proportional to resolution: default 30 seconds per km
dt_per_km = config.getint('cosine_bell', 'dt_per_km')
dt = dt_per_km * self.resolution
# https://stackoverflow.com/a/1384565/7728169
dt = time.strftime('%H:%M:%S', time.gmtime(dt))
return dt
def _get_resources(self):
mesh_name = self.mesh_name
config = self.config
self.ntasks = config.getint('cosine_bell', f'{mesh_name}_ntasks')
self.min_tasks = config.getint('cosine_bell', f'{mesh_name}_min_tasks')