from compass.step import Step
from compass.ocean.iceshelf import adjust_ssh
from compass.ocean.tests.isomip_plus.forward import get_time_steps
[docs]class SshAdjustment(Step):
"""
A step for iteratively adjusting the pressure from the weight of the ice
shelf to match the sea-surface height as part of ice-shelf 2D test cases
"""
[docs] def __init__(self, test_case, resolution, ntasks=1, min_tasks=None,
openmp_threads=1, vertical_coordinate='z-star',
thin_film_present=False):
"""
Create the step
Parameters
----------
test_case : compass.TestCase
The test case this step belongs to
resolution : float
The horizontal resolution (km) of the test case
ntasks : int, optional
the number of tasks the step would ideally use. If fewer tasks
are available on the system, the step will run on all available
tasks as long as this is not below ``min_tasks``
min_tasks : int, optional
the number of tasks the step requires. If the system has fewer
than this number of tasks, the step will fail
openmp_threads : int, optional
the number of OpenMP threads the step will use
"""
if min_tasks is None:
min_tasks = ntasks
super().__init__(test_case=test_case, name='ssh_adjustment',
ntasks=ntasks, min_tasks=min_tasks,
openmp_threads=openmp_threads)
# generate the namelist, replacing a few default options
# start with the same namelist settings as the forward run
self.add_namelist_file('compass.ocean.tests.isomip_plus',
'namelist.forward_and_ssh_adjust')
if vertical_coordinate == 'single_layer':
self.add_namelist_file('compass.ocean.tests.isomip_plus',
'namelist.single_layer.forward_and_ssh_adjust')
if thin_film_present:
self.add_namelist_file('compass.ocean.tests.isomip_plus',
'namelist.thin_film.forward_and_ssh_adjust')
# we don't want the global stats AM for this run
options = dict()
if not thin_film_present:
options = get_time_steps(resolution)
options['config_AM_globalStats_enable'] = '.false.'
self.add_namelist_options(options)
# we want a shorter run and no freshwater fluxes under the ice shelf
# from these namelist options
self.add_namelist_file('compass.ocean.namelists',
'namelist.ssh_adjust')
self.add_streams_file('compass.ocean.streams', 'streams.ssh_adjust')
self.add_input_file(filename='adjusting_init0.nc',
target='../initial_state/initial_state.nc')
self.add_input_file(filename='graph.info',
target='../initial_state/culled_graph.info')
self.add_model_as_input()
self.add_output_file(filename='adjusted_init.nc')
# no setup() is needed
[docs] def run(self):
"""
Run this step of the test case
"""
config = self.config
iteration_count = config.getint('ssh_adjustment', 'iterations')
adjust_ssh(variable='landIcePressure', iteration_count=iteration_count,
step=self)