from polaris import Task as Task
from polaris.tasks.ocean.baroclinic_channel.forward import Forward as Forward
from polaris.tasks.ocean.baroclinic_channel.rpe.analysis import (
Analysis as Analysis,
)
[docs]
class Rpe(Task):
"""
The baroclinic channel reference potential energy (RPE) test case performs
a 20-day integration of the model forward in time at 5 different values of
the viscosity at the given resolution.
Attributes
----------
resolution : float
The resolution of the test case in km
"""
[docs]
def __init__(self, component, resolution, indir, init, config):
"""
Create the test case
Parameters
----------
component : polaris.tasks.ocean.Ocean
The ocean component that this task belongs to
resolution : float
The resolution of the test case in km
indir : str
The directory the task is in, to which ``name`` will be appended
init : polaris.tasks.ocean.baroclinic_channel.init.Init
A shared step for creating the initial state
config : polaris.config.PolarisConfigParser
A shared config parser
"""
super().__init__(component=component, name='rpe', indir=indir)
self.resolution = resolution
# this needs to be added before we can use the config options it
# brings in to set up the steps
self.set_shared_config(config, link='baroclinic_channel.cfg')
self.add_step(init, symlink='init')
self._add_rpe_and_analysis_steps()
def _add_rpe_and_analysis_steps(self):
"""Add the steps in the test case either at init or set-up"""
config = self.config
for step_name in list(self.steps.keys()):
step = self.steps[step_name]
if step_name.startswith('nu') or step_name == 'analysis':
# remove previous RPE forward or analysis steps
self.remove_step(step)
init = self.steps['init']
component = self.component
resolution = self.resolution
nus = config.getlist(
'baroclinic_channel_rpe', 'viscosities', dtype=float
)
for nu in nus:
name = f'nu_{nu:g}'
step = Forward(
component=component,
name=name,
indir=self.subdir,
ntasks=None,
min_tasks=None,
openmp_threads=1,
resolution=resolution,
nu=nu,
graph_target=f'{init.path}/culled_graph.info',
)
step.add_yaml_file(
'polaris.tasks.ocean.baroclinic_channel.rpe', 'forward.yaml'
)
self.add_step(step)
self.add_step(
Analysis(
component=component,
resolution=resolution,
nus=nus,
indir=self.subdir,
)
)