mom_surface_forcing_gfdl mom_surface_forcing_gfdl::ice_ocean_boundary_type mom_surface_forcing_gfdl::surface_forcing_cs integer integer mom_surface_forcing_gfdl::id_clock_forcing id_clock_forcing A CPU time clock. convert_iob_to_fluxes convert_iob_to_forces surface_forcing_init subroutine, public subroutine, public mom_surface_forcing_gfdl::convert_iob_to_fluxes (IOB, fluxes, index_bounds, Time, valid_time, G, US, CS, sfc_state) convert_iob_to_fluxes IOB IOB fluxes fluxes index_bounds index_bounds Time Time valid_time valid_time G G US US CS CS sfc_state sfc_state This subroutine translates the Ice_ocean_boundary_type into a MOM thermodynamic forcing type, including changes of units, sign conventions, and putting the fields into arrays with MOM-standard halos. iob An ice-ocean boundary type with fluxes to drive fluxes A structure containing pointers to all possible mass, heat or salt flux forcing fields. Unused fields have NULL ptrs. index_bounds The i- and j- size of the arrays in IOB. time The time of the fluxes, used for interpolating the salinity to the right time, when it is being restored. valid_time The amount of time over which these fluxes should be applied [s]. g The ocean's grid structure us A dimensional unit scaling type cs A pointer to the control structure returned by a previous call to surface_forcing_init. sfc_state A structure containing fields that describe the surface state of the ocean. mom_spatial_means::adjust_area_mean_to_zero apply_flux_adjustments check_mask_val_consistency extract_iob_stresses id_clock_forcing subroutine, public subroutine, public mom_surface_forcing_gfdl::convert_iob_to_forces (IOB, forces, index_bounds, Time, G, US, CS, dt_forcing, reset_avg) convert_iob_to_forces IOB IOB forces forces index_bounds index_bounds Time Time G G US US CS CS dt_forcing dt_forcing reset_avg reset_avg This subroutine translates the Ice_ocean_boundary_type into a MOM mechanical forcing type, including changes of units, sign conventions, and putting the fields into arrays with MOM-standard halos. iob An ice-ocean boundary type with fluxes to drive forces A structure with the driving mechanical forces index_bounds The i- and j- size of the arrays in IOB. time The time of the fluxes, used for interpolating the salinity to the right time, when it is being restored. g The ocean's grid structure us A dimensional unit scaling type cs A pointer to the control structure returned by a previous call to surface_forcing_init. dt_forcing A time interval over which to apply the current value of ustar as a weighted running average [s], or if 0 do not average ustar. Missing is equivalent to 0. reset_avg If true, reset the time average. apply_force_adjustments extract_iob_stresses id_clock_forcing subroutine subroutine mom_surface_forcing_gfdl::extract_iob_stresses (IOB, index_bounds, Time, G, US, CS, taux, tauy, ustar, gustless_ustar, tau_halo) extract_iob_stresses IOB IOB index_bounds index_bounds Time Time G G US US CS CS taux taux tauy tauy ustar ustar gustless_ustar gustless_ustar tau_halo tau_halo This subroutine extracts the wind stresses and related fields like ustar from an Ice_ocean_boundary_type into optional argument arrays, including changes of units, sign conventions, and putting the fields into arrays with MOM-standard sized halos. iob An ice-ocean boundary type with fluxes to drive index_bounds The i- and j- size of the arrays in IOB. time The time of the fluxes, used for interpolating the salinity to the right time, when it is being restored. g The ocean's grid structure us A dimensional unit scaling type cs A pointer to the control structure returned by a previous call to surface_forcing_init. taux The zonal wind stresses on a C-grid [R Z L T-2 ~> Pa]. tauy The meridional wind stresses on a C-grid [R Z L T-2 ~> Pa]. ustar The surface friction velocity [Z T-1 ~> m s-1]. gustless_ustar The surface friction velocity without tau_halo The halo size of wind stresses to set, 0 by default. mom_error_handler::mom_error convert_iob_to_fluxes convert_iob_to_forces subroutine subroutine mom_surface_forcing_gfdl::apply_flux_adjustments (G, US, CS, Time, fluxes) apply_flux_adjustments G G US US CS CS Time Time fluxes fluxes Adds thermodynamic flux adjustments obtained via data_override Component name is 'OCN' Available adjustments are: hflx_adj (Heat flux into the ocean [W m-2])sflx_adj (Salt flux into the ocean [kg salt m-2 s-1])prcme_adj (Fresh water flux into the ocean [kg m-2 s-1]) g Ocean grid structure us A dimensional unit scaling type cs Surface forcing control structure time Model time structure fluxes Surface fluxes structure convert_iob_to_fluxes subroutine subroutine mom_surface_forcing_gfdl::apply_force_adjustments (G, US, CS, Time, forces) apply_force_adjustments G G US US CS CS Time Time forces forces Adds mechanical forcing adjustments obtained via data_override Component name is 'OCN' Available adjustments are: taux_adj (Zonal wind stress delta, positive to the east [Pa])tauy_adj (Meridional wind stress delta, positive to the north [Pa]) g Ocean grid structure us A dimensional unit scaling type cs Surface forcing control structure time Model time structure forces A structure with the driving mechanical forces mom_error_handler::mom_error convert_iob_to_forces subroutine, public subroutine, public mom_surface_forcing_gfdl::forcing_save_restart (CS, G, Time, directory, time_stamped, filename_suffix) forcing_save_restart CS CS G G Time Time directory directory time_stamped time_stamped filename_suffix filename_suffix Save any restart files associated with the surface forcing. cs A pointer to the control structure returned by a previous call to surface_forcing_init g The ocean's grid structure time The current model time directory The directory into which to write the restart files time_stamped If true, the restart file names include a unique time stamp. The default is false. filename_suffix An optional suffix (e.g., a time- stamp) to append to the restart file names. mom_restart::save_restart ocean_model_mod::ocean_model_restart ocean_model_mod::ocean_model_save_restart subroutine, public subroutine, public mom_surface_forcing_gfdl::surface_forcing_init (Time, G, US, param_file, diag, CS, wind_stagger) surface_forcing_init Time Time G G US US param_file param_file diag diag CS CS wind_stagger wind_stagger Initialize the surface forcing, including setting parameters and allocating permanent memory. time The current model time g The ocean's grid structure us A dimensional unit scaling type param_file A structure to parse for run-time parameters diag A structure that is used to regulate diagnostic output cs A pointer that is set to point to the control structure for this module wind_stagger If present, the staggering of the winds that are being provided in calls to update_ocean_model mom_get_input::get_mom_input id_clock_forcing mom_error_handler::mom_error mom_restart::restart_init_end mom_restart::restore_state mom_string_functions::uppercase subroutine subroutine mom_surface_forcing_gfdl::surface_forcing_end (CS, fluxes) surface_forcing_end CS CS fluxes fluxes Clean up and deallocate any memory associated with this module and its children. cs A pointer to the control structure returned by a previous call to surface_forcing_init, it will be deallocated here. fluxes A structure containing pointers to all possible mass, heat or salt flux forcing fields. If present, it will be deallocated here. subroutine, public subroutine, public mom_surface_forcing_gfdl::ice_ocn_bnd_type_chksum (id, timestep, iobt) ice_ocn_bnd_type_chksum id id timestep timestep iobt iobt Write out a set of messages with checksums of the fields in an ice_ocen_boundary type. id An identifying string for this call timestep The number of elapsed timesteps iobt An ice-ocean boundary type with fluxes to drive the subroutine subroutine mom_surface_forcing_gfdl::check_mask_val_consistency (val, mask, i, j, varname, G) check_mask_val_consistency val val mask mask i i j j varname varname G G Check the values passed by IOB over land are zero. val value of flux/variable passed by IOB mask value of ocean mask i model grid cell indices j model grid cell indices varname variable name g The ocean's grid structure mom_error_handler::mom_error convert_iob_to_fluxes