polaris.tasks.ocean.single_column.frazil.Frazil

class polaris.tasks.ocean.single_column.frazil.Frazil(component, subdir, case, depth_limit=False)[source]

A single-column frazil test case that creates the mesh and initial condition for a given melting/freezing case, then performs a forward run for each frazil algorithm ('FixedProperty' and 'teos'). MPAS-Ocean only supports 'FixedProperty', so the 'teos' forward step is removed from the task in configure() when the ocean model is MPAS-Ocean.

Variables:

case (str) – The initial condition/forcing case, either 'melting' or 'freezing'

__init__(component, subdir, case, depth_limit=False)[source]

Create the test case

Parameters:

  • component (polaris.tasks.ocean.Ocean) – The ocean component that this task belongs to

  • subdir (str) – The directory the task is in

  • case (str) – The initial condition/forcing case, either 'melting' or 'freezing'

  • depth_limit (bool, optional) – Run one frazil-only melting timestep and check the depth limit.

Methods

__init__(component, subdir, case[, depth_limit])

Create the test case

add_step([step, subdir, symlink, run_by_default])

Add a step to the task and component (if not already present)

configure()

Remove the teos forward step, and the corresponding entries in the conservation summary and viz comparisons, if the ocean model is MPAS-Ocean, which only supports the 'FixedProperty' algorithm

remove_step(step)

Remove the given step from this task and the component

set_shared_config(config[, link])

Replace the task's config parser with the shared config parser