compass.ocean.tests.global_ocean.forward.ForwardTestCase¶
- class compass.ocean.tests.global_ocean.forward.ForwardTestCase(test_group, mesh, init, time_integrator, name)[source]¶
A parent class for test cases for forward runs with global MPAS-Ocean mesh
- Variables:
mesh (compass.ocean.tests.global_ocean.mesh.Mesh) – The test case that produces the mesh for this run
init (compass.ocean.tests.global_ocean.init.Init) – The test case that produces the initial condition for this run
time_integrator ({'split_explicit_ab2', 'RK4'}) – The time integrator to use for the forward run
- __init__(test_group, mesh, init, time_integrator, name)[source]¶
Create test case
- Parameters:
test_group (compass.ocean.tests.global_ocean.GlobalOcean) – The global ocean 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
init (compass.ocean.tests.global_ocean.init.Init) – The test case that produces the initial condition for this run
time_integrator ({'split_explicit_ab2', 'RK4'}) – The time integrator to use for the forward run
name (str) – the name of the test case
Methods
__init__
(test_group, mesh, init, ...)Create 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.
Modify the configuration options for this test case
run
()This method is deprecated.
validate
()Test cases can override this method to perform validation of variables and timers