polaris.tasks.ocean.realistic_global.forward.initial_condition.InitialCondition

class polaris.tasks.ocean.realistic_global.forward.initial_condition.InitialCondition

An abstraction for where a forward step’s model inputs come from.

A concrete subclass knows how to add the horizontal-mesh, vertical- coordinate, and initial-state input files to a forward step and, where relevant, which graph partition file the step should use. The forward step holds one of these and defers all questions of provenance to it, so a new source can be added without changing the step or the run-settings logic.

Variables:

• min_res (float) – The mesh minimum resolution in km, used to scale per-km time steps.

• approx_cell_count (int or None) – The approximate number of cells in the mesh, used to size resources during setup before the mesh file exists. None when it cannot be estimated for the mesh.

• graph_target (str or None) – The graph partition file for the step to use (a work-directory-relative path), or None when no existing graph file is provided.

__init__()

Methods

__init__()
add_input_files(step)	Add the model input files this source provides to step.
get_forcing_filename(step)	The local filename the model's forcing streams should read.

Attributes

graph_target
min_res
approx_cell_count