compass.ocean.tests.isomip_plus.isomip_plus_test.IsomipPlusTest

class compass.ocean.tests.isomip_plus.isomip_plus_test.IsomipPlusTest(test_group, resolution, experiment, vertical_coordinate, time_varying_forcing=False, time_varying_load=None, thin_film_present=False, tidal_forcing=False)[source]

An ISOMIP+ test case

Variables

  • resolution (float) – The horizontal resolution (km) of the test case

  • experiment ({'Ocean0', 'Ocean1', 'Ocean2'}) – The ISOMIP+ experiment

  • vertical_coordinate (str) – The type of vertical coordinate (z-star, z-level, etc.)

  • time_varying_forcing (bool) – Whether the run includes time-varying land-ice forcing

  • thin_film_present (bool) – Whether a thin film is present under land ice

__init__(test_group, resolution, experiment, vertical_coordinate, time_varying_forcing=False, time_varying_load=None, thin_film_present=False, tidal_forcing=False)[source]

Create the test case

Parameters

  • test_group (compass.ocean.tests.isomip_plus.IsomipPlus) – The test group that this test case belongs to

  • resolution (float) – The horizontal resolution (km) of the test case

  • experiment ({'Ocean0', 'Ocean1', 'Ocean2'}) – The ISOMIP+ experiment

  • vertical_coordinate (str) – The type of vertical coordinate (z-star, z-level, etc.)

  • time_varying_forcing (bool, optional) – Whether the run includes time-varying land-ice forcing

  • time_varying_load ({'increasing', 'decreasing', None}, optional) – Only relevant if time_varying_forcing = True. If 'increasing', a doubling of the ice-shelf pressure will be applied over one year. If 'decreasing', the ice-shelf thickness will be reduced to zero over one year. Otherwise, the default behavior is that the ice shelf grows from 10% of its full thickness to its full thickness over 1 year.

  • thin_film_present (bool, optional) – Whether the run includes a thin film below grounded ice

  • tidal_forcing (bool, optional) – Whether the run includes a single-period tidal forcing

Methods

__init__(test_group, resolution, experiment, ...)

Create the test case

add_step(step[, run_by_default])

Add a step to the test case

check_validation()

Check the test case's "validation" dictionary to see if validation failed.

configure()

Modify the configuration options for this test case.

run()

Run each step of the test case

validate()

Perform validation of variables