polaris.tasks.ocean.realistic_global.forward.initial_condition.StepInitialCondition

class polaris.tasks.ocean.realistic_global.forward.initial_condition.StepInitialCondition(init_step: Step, min_res: float, approx_cell_count: int | None, forcing_step: Step)

An initial condition provided by an upstream realistic_global/init step, whose work directory holds the mesh, vertical coordinate (Omega), initial state, and graph files.

Variables:

• init_step (polaris.Step) – The initial_state step whose outputs are consumed.

• forcing_step (polaris.Step) – The forcing step whose model-specific forcing file is consumed.

__init__(init_step: Step, min_res: float, approx_cell_count: int | None, forcing_step: Step) → None

Create the source.

Parameters:

• init_step (polaris.Step) – The initial_state step (from get_realistic_init_steps()) whose outputs the forward step consumes.

• min_res (float) – The mesh minimum resolution in km (from the mesh definition).

• approx_cell_count (int or None) – The approximate number of cells in the mesh (from the mesh definition), used to size resources during setup before the mesh file exists.

• forcing_step (polaris.Step) – The forcing step (from the same get_realistic_init_steps() call) that writes the model-specific surface forcing file. Required, because every realistic_global forward run is wind-forced.

Methods

__init__(init_step, min_res, ...)	Create the source.
add_input_files(step)	Link the mesh, vertical coordinate, initial state and surface forcing from the init steps' work directories.
get_forcing_filename(step)	The local filename the model's forcing streams should read.

Attributes

graph_target
min_res
approx_cell_count