polaris.ocean.model.OceanModelFilesMixin

class polaris.ocean.model.OceanModelFilesMixin

Mixin providing access to the [ocean_staged_files] config section and the shared placeholder mechanism for the three canonical ocean dataset files (horizontal mesh, vertical coordinate, initial state).

Must be combined with a Step subclass that sets self.config and provides self.add_input_file(). The add_*_input_file() methods are safe to call from __init__() because the model check is deferred to _resolve_model_file_placeholders(), which is called at process_inputs_and_outputs() time.

__init__()

Methods

__init__()
add_horiz_mesh_input_file(**kwargs)	Add the horizontal-mesh input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.
add_init_input_file(**kwargs)	Add the initial-condition input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.
add_input_file([filename, target, database, ...])	Provided by polaris.Step.
add_vert_coord_input_file([filename])	Add the vertical-coordinate input file.
get_horiz_mesh_filename()	Get the configured local filename for the horizontal mesh file.
get_init_filename()	Get the configured local filename for the initial-condition file.
get_vert_coord_filename()	Get the configured local filename for the vertical coordinate file.

Attributes

component
config
input_data