polaris.tasks.ocean.realistic_global.init.task.RealisticGlobalInit

class polaris.tasks.ocean.realistic_global.init.task.RealisticGlobalInit(component, mesh_name)[source]

A task for creating a realistic global ocean initial condition on one MPAS mesh for the configured target ocean model.

The target model is determined by the [ocean] model config option (resolved from 'detect' to 'omega' or 'mpas-ocean' during component setup). All steps up to and including RealisticPStarInitStep are model-independent; only InitialStateStep branches on the resolved model at run time.

__init__(component, mesh_name)[source]

Create the task.

Parameters:

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

  • mesh_name (str) – The name of the MPAS mesh (e.g. 'icos240km').

Methods

__init__(component, mesh_name)

Create the task.

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

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

configure()

Modify the configuration options for this task.

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