polaris.ocean.model.OceanIOStep.add_output_files_for_ocean_model_input
- OceanIOStep.add_output_files_for_ocean_model_input(horiz_mesh_filename=None, vert_coord_filename=None, init_filename=None, base_mesh_filename=None, graph_filename=None, skip_validation=False)[source]
Register output files that will be consumed by the ocean model as inputs (horizontal mesh, initial condition, and model-specific files). Each netCDF file is also checked for CF compliance after the step runs (see
polaris.Step.add_cf_check()), which the component’s write methods make it pass by filling in the metadata.- Parameters:
horiz_mesh_filename (str, optional) – Local filename for the horizontal mesh output; defaults to the
horiz_mesh_filenameoption in[ocean_staged_files].vert_coord_filename (str, optional) – Local filename for the vertical-coordinate output (Omega only); defaults to the
vert_coord_filenameoption in[ocean_staged_files].init_filename (str, optional) – Local filename for the initial-state output; defaults to the
init_filenameoption in[ocean_staged_files].base_mesh_filename (str, optional) – If provided, also register this filename as an output (used when the step writes both a base and a culled mesh, e.g.
'base_mesh.nc').graph_filename (str, optional) – If provided, register this filename as an output for MPAS-Ocean only (e.g.
'culled_graph.info'). Ignored for Omega.