ocean_model_mod ocean_model_mod::ocean_model_data_get ocean_model_mod::ocean_public_type ocean_model_mod::ocean_state_type subroutine, public subroutine, public ocean_model_mod::ocean_model_init (Ocean_sfc, OS, Time_init, Time_in, wind_stagger, gas_fields_ocn) ocean_model_init Ocean_sfc Ocean_sfc OS OS Time_init Time_init Time_in Time_in wind_stagger wind_stagger gas_fields_ocn gas_fields_ocn ocean_model_init initializes the ocean model, including registering fields for restarts and reading restart files if appropriate. This subroutine initializes both the ocean state and the ocean surface type. Because of the way that indicies and domains are handled, Ocean_sfc must have been used in a previous call to initialize_ocean_type. ocean_sfc A structure containing various publicly os A structure whose internal contents are private to ocean_model_mod that may be used to contain all information about the ocean's interior state. time_init The start time for the coupled model's calendar time_in The time at which to initialize the ocean model. wind_stagger If present, the staggering of the winds that are being provided in calls to update_ocean_model gas_fields_ocn If present, this type describes the mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_file_parser::close_param_file convert_state_to_ocean_type mom_diag_mediator::diag_mediator_close_registration initialize_ocean_public_type mom_marine_ice::marine_ice_init mom_wave_interface::mom_wave_interface_init_lite mom_string_functions::uppercase subroutine, public subroutine, public ocean_model_mod::update_ocean_model (Ice_ocean_boundary, OS, Ocean_sfc, time_start_update, Ocean_coupling_time_step, update_dyn, update_thermo, Ocn_fluxes_used, start_cycle, end_cycle, cycle_length) update_ocean_model Ice_ocean_boundary Ice_ocean_boundary OS OS Ocean_sfc Ocean_sfc time_start_update time_start_update Ocean_coupling_time_step Ocean_coupling_time_step update_dyn update_dyn update_thermo update_thermo Ocn_fluxes_used Ocn_fluxes_used start_cycle start_cycle end_cycle end_cycle cycle_length cycle_length update_ocean_model uses the forcing in Ice_ocean_boundary to advance the ocean model's state from the input value of Ocean_state (which must be for time time_start_update) for a time interval of Ocean_coupling_time_step, returning the publicly visible ocean surface properties in Ocean_sfc and storing the new ocean properties in Ocean_state. ice_ocean_boundary A structure containing the various os A pointer to a private structure containing the ocean_sfc A structure containing all the publicly visible time_start_update The time at the beginning of the update step. ocean_coupling_time_step The amount of time over which to advance the ocean. update_dyn If present and false, do not do updates due to the ocean dynamics. update_thermo If present and false, do not do updates due to the ocean thermodynamics or remapping. ocn_fluxes_used If present, this indicates whether the cumulative thermodynamic fluxes from the ocean, like frazil, have been used and should be reset. start_cycle This indicates whether this call is to be treated as the first call to step_MOM in a time-stepping cycle; missing is like true. end_cycle This indicates whether this call is to be treated as the last call to step_MOM in a time-stepping cycle; missing is like true. cycle_length The duration of a coupled time stepping cycle [s]. mom_ice_shelf::add_shelf_forces mom_error_handler::calltree_enter mom_error_handler::calltree_leave convert_state_to_ocean_type mom_forcing_type::forcing_diagnostics mom_marine_ice::iceberg_fluxes mom_marine_ice::iceberg_forces mom_forcing_type::mech_forcing_diags mom_generic_tracer::mom_generic_tracer_fluxes_accumulate mom_time_manager::real_to_time mom::step_offline mom_wave_interface::update_surface_waves subroutine, public subroutine, public ocean_model_mod::ocean_model_restart (OS, timestamp) ocean_model_restart OS OS timestamp timestamp This subroutine writes out the ocean model restart file. os A pointer to the structure containing the internal ocean state being saved to a restart file timestamp An optional timestamp string that should be prepended to the file name. (Currently this is unused.) mom_surface_forcing_gfdl::forcing_save_restart mom_ice_shelf::ice_shelf_save_restart mom_restart::save_restart subroutine, public subroutine, public ocean_model_mod::ocean_model_end (Ocean_sfc, Ocean_state, Time) ocean_model_end Ocean_sfc Ocean_sfc Ocean_state Ocean_state Time Time ocean_model_end terminates the model run, saving the ocean state in a restart and deallocating any data associated with the ocean. ocean_sfc An ocean_public_type structure that is to be deallocated upon termination. ocean_state A pointer to the structure containing the internal ocean state to be deallocated upon termination. time The model time, used for writing restarts. mom_diag_mediator::diag_mediator_end mom_ice_shelf::ice_shelf_end ocean_model_save_restart subroutine, public subroutine, public ocean_model_mod::ocean_model_save_restart (OS, Time, directory, filename_suffix) ocean_model_save_restart OS OS Time Time directory directory filename_suffix filename_suffix ocean_model_save_restart causes restart files associated with the ocean to be written out. os A pointer to the structure containing the internal ocean state (in). time The model time at this call, needed for mpp_write calls. directory An optional directory into which to write these restart files. filename_suffix An optional suffix (e.g., a time-stamp) to append to the restart file names. mom_surface_forcing_gfdl::forcing_save_restart mom_ice_shelf::ice_shelf_save_restart mom_restart::save_restart ocean_model_end subroutine subroutine ocean_model_mod::initialize_ocean_public_type (input_domain, Ocean_sfc, diag, maskmap, gas_fields_ocn) initialize_ocean_public_type input_domain input_domain Ocean_sfc Ocean_sfc diag diag maskmap maskmap gas_fields_ocn gas_fields_ocn Initialize the public ocean type. input_domain The ocean model domain description ocean_sfc A structure containing various publicly visible ocean surface properties after initialization, whose elements are allocated here. diag A structure that regulates diagnsotic output maskmap A mask indicating which virtual processors gas_fields_ocn If present, this type describes the ocean_model_init subroutine subroutine ocean_model_mod::convert_state_to_ocean_type (sfc_state, Ocean_sfc, G, US, patm, press_to_z) convert_state_to_ocean_type sfc_state sfc_state Ocean_sfc Ocean_sfc G G US US patm patm press_to_z press_to_z This subroutine translates the coupler's ocean_data_type into MOM's surface state variable. This may eventually be folded into the MOM code that calculates the surface state in the first place. Note the offset in the arrays because the ocean_data_type has no halo points in its arrays and always uses absolute indicies. sfc_state A structure containing fields that describe the surface state of the ocean. ocean_sfc A structure containing various publicly g The ocean's grid structure us A dimensional unit scaling type patm The pressure at the ocean surface [Pa]. press_to_z A conversion factor between pressure and ocean depth in m, usually 1/(rho_0*g) [m Pa-1]. mom_constants::celsius_kelvin_offset ocean_model_init ocean_model_init_sfc update_ocean_model subroutine, public subroutine, public ocean_model_mod::ocean_model_init_sfc (OS, Ocean_sfc) ocean_model_init_sfc OS OS Ocean_sfc Ocean_sfc This subroutine extracts the surface properties from the ocean's internal state and stores them in the ocean type returned to the calling ice model. It has to be separate from the ocean_initialization call because the coupler module allocates the space for some of these variables. os The structure with the complete ocean state ocean_sfc A structure containing various publicly visible ocean surface properties after initialization, whose elements have their data set here. convert_state_to_ocean_type subroutine, public subroutine, public ocean_model_mod::ocean_model_flux_init (OS, verbosity) ocean_model_flux_init OS OS verbosity verbosity ocean_model_flux_init is used to initialize properties of the air-sea fluxes as determined by various run-time parameters. It can be called from non-ocean PEs, or PEs that have not yet been initialzed, and it can safely be called multiple times. os An optional pointer to the ocean state, used to figure out if this is an ocean PE that has already been initialized. verbosity A 0-9 integer indicating a level of verbosity. mom_tracer_flow_control::call_tracer_flux_init subroutine, public subroutine, public ocean_model_mod::ocean_stock_pe (OS, index, value, time_index) ocean_stock_pe OS OS index index value value time_index time_index Ocean_stock_pe - returns the integrated stocks of heat, water, etc. for conservation checks. Because of the way FMS is coded, only the root PE has the integrated amount, while all other PEs get 0. os A structure containing the internal ocean state. The data in OS is intent in. index The stock index for the quantity of interest. value Sum returned for the conservation quantity of interest. time_index An unused optional argument, present only for interfacial compatibility with other models. mom::get_ocean_stocks subroutine subroutine ocean_model_mod::ocean_model_data2d_get (OS, Ocean, name, array2D, isc, jsc) ocean_model_data2d_get OS OS Ocean Ocean name name array2D array2D isc isc jsc jsc This subroutine extracts a named 2-D field from the ocean surface or public type. os A pointer to the structure containing the internal ocean state (intent in). ocean A structure containing various publicly visible ocean surface fields. name The name of the field to extract array2d The values of the named field, it must cover only the computational domain isc The starting i-index of array2D jsc The starting j-index of array2D mom_constants::celsius_kelvin_offset subroutine subroutine ocean_model_mod::ocean_model_data1d_get (OS, Ocean, name, value) ocean_model_data1d_get OS OS Ocean Ocean name name value value This subroutine extracts a named scalar field from the ocean surface or public type. os A pointer to the structure containing the internal ocean state (intent in). ocean A structure containing various publicly visible ocean surface fields. name The name of the field to extract value The value of the named field subroutine, public subroutine, public ocean_model_mod::ocean_public_type_chksum (id, timestep, ocn) ocean_public_type_chksum id id timestep timestep ocn ocn Write out FMS-format checsums on fields from the ocean surface state. id An identifying string for this call timestep The number of elapsed timesteps ocn A structure containing various publicly visible ocean surface fields. subroutine, public subroutine, public ocean_model_mod::get_ocean_grid (OS, Gridp) get_ocean_grid OS OS Gridp Gridp This subroutine gives a handle to the grid from ocean state. os A structure containing the internal ocean state gridp The ocean's grid structure subroutine, public subroutine, public ocean_model_mod::ocean_model_get_uv_surf (OS, Ocean, name, array2D, isc, jsc) ocean_model_get_uv_surf OS OS Ocean Ocean name name array2D array2D isc isc jsc jsc This subroutine extracts a named (u- or v-) 2-D surface current from ocean internal state. os A pointer to the structure containing the internal ocean state (intent in). ocean A structure containing various publicly visible ocean surface fields. name The name of the current (ua or va) to extract array2d The values of the named field, it must cover only the computational domain isc The starting i-index of array2D jsc The starting j-index of array2D Top-level module for the MOM6 ocean model in coupled mode.