mom_get_input module reference

Reads the only Fortran name list needed to boot-strap the model.

More…

Data Types

directories

Container for paths and parameter file names.

Functions/Subroutines

get_mom_input()

Get the names of the I/O directories and initialization file.

Detailed Description

The name list parameters indicate which directories to use for certain types of input and output, and which files to look in for the full parsable input parameter file(s).

Type Documentation

type mom_get_input/directories

Container for paths and parameter file names.

Type fields
  • % restart_input_dir [character (len=240)] :: The directory to read restart and input files.

  • % restart_output_dir [character (len=240)] :: The directory into which to write restart files.

  • % output_directory [character (len=240)] :: The directory to use to write the model output.

  • % input_filename [character (len=2048)] :: A string that indicates the input files or how.

Function/Subroutine Documentation

subroutine mom_get_input/get_mom_input(param_file, dirs, check_params, default_input_filename, ensemble_num)

Get the names of the I/O directories and initialization file. Also calls the subroutine that opens run-time parameter files.

Parameters
  • param_file :: [out] A structure to parse for run-time parameters.

  • dirs :: [out] Container for paths and parameter file names.

  • check_params :: [in] If present and False will stop error checking for run-time parameters.

  • default_input_filename :: [in] If present, is the value assumed for input_filename if input_filename is not listed in the namelist MOM_input_nml.

  • ensemble_num :: [in] The ensemble id of the current member

Call to

mom_io::check_nml_error mom_error_handler::mom_error mom_io::open_namelist_file mom_file_parser::open_param_file

Called from

mom_tracer_flow_control::call_tracer_flux_init mom_oda_driver_mod::init_oda mom_ice_shelf::initialize_ice_shelf mom_main mom_surface_forcing_gfdl::surface_forcing_init mom_surface_forcing::surface_forcing_init