polaris.ocean.model.OceanIOStep.add_vert_coord_input_file

OceanIOStep.add_vert_coord_input_file(filename=None, **kwargs) None

Add the vertical-coordinate input file.

When filename is None (the default), the '<<<vert_coord>>>' placeholder is used. The placeholder is resolved at process_inputs_and_outputs() time and silently dropped for MPAS-Ocean (no separate vert_coord file exists). Safe to call from __init__().

When filename is provided explicitly (e.g. 'vert_coord_r04.nc' for multi-resolution steps), the entry is added directly for Omega only and must be called from setup() or later (requires self.config).

Parameters:
  • filename (str, optional) – Explicit local filename, overriding the placeholder.

  • **kwargs – Additional keyword arguments forwarded to polaris.Step.add_input_file().