compass.ocean.tests.global_ocean.mesh.Mesh¶
- class compass.ocean.tests.global_ocean.mesh.Mesh(test_group, mesh_name, high_res_topography)[source]¶
A test case for creating a global MPAS-Ocean mesh
- Variables:
package (str) – The python package for the mesh
mesh_config_filename (str) – The name of the mesh config file
with_ice_shelf_cavities (bool) – Whether the mesh includes ice-shelf cavities
high_res_topography (bool) – Whether to remap a high resolution topography data set. A lower res data set is used for low resolution meshes.
- __init__(test_group, mesh_name, high_res_topography)[source]¶
Create test case for creating a global MPAS-Ocean mesh
- Parameters:
test_group (compass.ocean.tests.global_ocean.GlobalOcean) – The global ocean test group that this test case belongs to
mesh_name (str) – The name of the mesh
high_res_topography (bool) – Whether to remap a high resolution topography data set. A lower res data set is used for low resolution meshes.
Methods
__init__
(test_group, mesh_name, ...)Create test case for creating a global MPAS-Ocean mesh
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
([config])Modify the configuration options for this test case
get_cull_mesh_path
()Get the path of the cull mesh step (for input files) :returns: cull_mesh_path (str) -- The path to the work directory of the cull mesh step.
run
()This method is deprecated.
validate
()Test cases can override this method to perform validation of variables and timers