mom_ice_shelf mom_ice_shelf::ice_shelf_cs integer integer mom_ice_shelf::id_clock_shelf id_clock_shelf CPU Clock for the ice shelf code. initialize_ice_shelf shelf_calc_flux integer integer mom_ice_shelf::id_clock_pass id_clock_pass CPU Clock for group pass calls. initialize_ice_shelf shelf_calc_flux subroutine, public subroutine, public mom_ice_shelf::shelf_calc_flux (sfc_state, fluxes, Time, time_step, CS, forces) shelf_calc_flux sfc_state sfc_state fluxes fluxes Time Time time_step time_step CS CS forces forces Calculates fluxes between the ocean and ice-shelf using the three-equations formulation (optional to use just two equations). See ICE_SHELF equations. sfc_state A structure containing fields that describe the surface state of the ocean. The intent is only inout to allow for halo updates. fluxes structure containing pointers to any possible thermodynamic or mass-flux forcing fields. time Start time of the fluxes. time_step Length of time over which these fluxes will be applied [s]. cs A pointer to the control structure returned by a previous call to initialize_ice_shelf. forces A structure with the driving mechanical forces add_shelf_flux add_shelf_forces change_thickness_using_melt mom_diag_mediator::disable_averaging mom_diag_mediator::enable_averaging id_clock_pass id_clock_shelf mom_error_handler::mom_error mom_domains::to_all update_shelf_mass mom_main subroutine subroutine mom_ice_shelf::change_thickness_using_melt (ISS, G, US, time_step, fluxes, density_ice, debug) change_thickness_using_melt ISS ISS G G US US time_step time_step fluxes fluxes density_ice density_ice debug debug Changes the thickness (mass) of the ice shelf based on sub-ice-shelf melting. g The ocean's grid structure. iss A structure with elements that describe the ice-shelf state us A dimensional unit scaling type time_step The time step for this update [T ~> s]. fluxes structure containing pointers to any possible thermodynamic or mass-flux forcing fields. density_ice The density of ice-shelf ice [R ~> kg m-3]. debug If present and true, write chksums shelf_calc_flux subroutine, public subroutine, public mom_ice_shelf::add_shelf_forces (G, US, CS, forces, do_shelf_area) add_shelf_forces G G US US CS CS forces forces do_shelf_area do_shelf_area This subroutine adds the mechanical forcing fields and perhaps shelf areas, based on the ice state in ice_shelf_CS. g The ocean's grid structure. us A dimensional unit scaling type cs This module's control structure. forces A structure with the driving mechanical forces do_shelf_area If true find the shelf-covered areas. mom_error_handler::mom_error mom_domains::to_all initialize_ice_shelf mom_main shelf_calc_flux ocean_model_mod::update_ocean_model subroutine subroutine mom_ice_shelf::add_shelf_pressure (G, US, CS, fluxes) add_shelf_pressure G G US US CS CS fluxes fluxes This subroutine adds the ice shelf pressure to the fluxes type. g The ocean's grid structure. us A dimensional unit scaling type cs This module's control structure. fluxes A structure of surface fluxes that may be updated. mom_error_handler::mom_error add_shelf_flux initialize_ice_shelf subroutine, public subroutine, public mom_ice_shelf::add_shelf_flux (G, US, CS, sfc_state, fluxes) add_shelf_flux G G US US CS CS sfc_state sfc_state fluxes fluxes Updates surface fluxes that are influenced by sub-ice-shelf melting. g The ocean's grid structure. us A dimensional unit scaling type cs This module's control structure. sfc_state Surface ocean state fluxes A structure of surface fluxes that may be used/updated. add_shelf_pressure mom_spatial_means::global_area_integral mom_error_handler::mom_error mom_error_handler::mom_mesg mom_time_manager::real_to_time shelf_calc_flux subroutine, public subroutine, public mom_ice_shelf::initialize_ice_shelf (param_file, ocn_grid, Time, CS, diag, forces, fluxes, Time_in, solo_ice_sheet_in) initialize_ice_shelf param_file param_file ocn_grid ocn_grid Time Time CS CS diag diag forces forces fluxes fluxes Time_in Time_in solo_ice_sheet_in solo_ice_sheet_in Initializes shelf model data, parameters and diagnostics. param_file A structure to parse for run-time parameters ocn_grid The calling ocean model's horizontal grid structure time The clock that that will indicate the model time cs A pointer to the ice shelf control structure diag A structure that is used to regulate the diagnostic output. fluxes A structure containing pointers to any possible thermodynamic or mass-flux forcing fields. forces A structure with the driving mechanical forces time_in The time at initialization. solo_ice_sheet_in If present, this indicates whether a solo ice-sheet driver. add_shelf_forces add_shelf_pressure mom_transcribe_grid::copy_dyngrid_to_mom_grid mom_eos::eos_init mom_unit_scaling::fix_restart_unit_scaling mom_get_input::get_mom_input mom_ice_shelf_state::ice_shelf_state_init id_clock_pass id_clock_shelf mom_ice_shelf_initialize::initialize_ice_thickness initialize_shelf_mass mom_error_handler::is_root_pe mom_error_handler::mom_error mom_grid::mom_grid_init mom_error_handler::mom_mesg mom_dyn_horgrid::rescale_dyn_horgrid_bathymetry mom_restart::restart_init mom_restart::restore_state mom_grid_initialize::set_grid_metrics mom_unit_scaling::unit_scaling_init mom_main subroutine subroutine mom_ice_shelf::initialize_shelf_mass (G, param_file, CS, ISS, new_sim) initialize_shelf_mass G G param_file param_file CS CS ISS ISS new_sim new_sim Initializes shelf mass based on three options (file, zero and user) g The ocean's grid structure. param_file A structure to parse for run-time parameters cs A pointer to the ice shelf control structure iss The ice shelf state type that is being updated new_sim If present and false, this run is being restarted mom_error_handler::mom_error initialize_ice_shelf subroutine subroutine mom_ice_shelf::update_shelf_mass (G, US, CS, ISS, Time) update_shelf_mass G G US US CS CS ISS ISS Time Time Updates the ice shelf mass using data from a file. g The ocean's grid structure. us A dimensional unit scaling type cs A pointer to the ice shelf control structure iss The ice shelf state type that is being updated time The current model time shelf_calc_flux subroutine, public subroutine, public mom_ice_shelf::ice_shelf_save_restart (CS, Time, directory, time_stamped, filename_suffix) ice_shelf_save_restart CS CS Time Time directory directory time_stamped time_stamped filename_suffix filename_suffix Save the ice shelf restart file. cs ice shelf control structure time model time at this call directory An optional directory into which to write these restart files. time_stamped f 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_main ocean_model_mod::ocean_model_restart ocean_model_mod::ocean_model_save_restart subroutine, public subroutine, public mom_ice_shelf::ice_shelf_end (CS) ice_shelf_end CS CS Deallocates all memory associated with this module. cs A pointer to the ice shelf control structure mom_ice_shelf_dynamics::ice_shelf_dyn_end mom_ice_shelf_state::ice_shelf_state_end mom_main ocean_model_mod::ocean_model_end subroutine, public subroutine, public mom_ice_shelf::solo_step_ice_shelf (CS, time_interval, nsteps, Time, min_time_step_in) solo_step_ice_shelf CS CS time_interval time_interval nsteps nsteps Time Time min_time_step_in min_time_step_in This routine is for stepping a stand-alone ice shelf model without an ocean. cs A pointer to the ice shelf control structure time_interval The time interval for this update [s]. nsteps The running number of ice shelf steps. time The current model time min_time_step_in The minimum permitted time step [T ~> s]. mom_diag_mediator::disable_averaging mom_diag_mediator::enable_averages mom_ice_shelf_dynamics::ice_time_step_cfl mom_error_handler::mom_error mom_error_handler::mom_mesg Implements the thermodynamic aspects of ocean / ice-shelf interactions, along with a crude placeholder for a later implementation of full ice shelf dynamics, all using the MOM framework and coding style. This module implements the thermodynamic aspects of ocean/ice-shelf inter-actions using the MOM framework and coding style. Derived from code by Chris Little, early 2010. The ice-sheet dynamics subroutines do the following: initialize_shelf_mass - Initializes the ice shelf mass distribution. Initializes h_shelf, h_mask, area_shelf_h CURRENTLY: initializes mass_shelf as well, but this is unnecessary, as mass_shelf is initialized based on h_shelf and density_ice immediately afterwards. Possibly subroutine should be renamed update_shelf_mass - updates ice shelf mass via netCDF file USER_update_shelf_mass (TODO). solo_step_ice_shelf - called only in ice-only mode. shelf_calc_flux - after melt rate & fluxes are calculated, ice dynamics are done. currently mass_shelf is updated immediately after ice_shelf_advect in fully dynamic mode. NOTES: be aware that hmask(:,:) has a number of functions; it is used for front advancement, for subroutines in the velocity solve, and for thickness boundary conditions (this last one may be removed). in other words, interfering with its updates will have implications you might not expect. Overall issues: Many variables need better documentation and units and the subgrid on which they are discretized. The three fundamental equations are: Heat flux \[ \qquad \rho_w C_{pw} \gamma_T (T_w - T_b) = \rho_i \dot{m} L_f \] Salt flux \[ \qquad \rho_w \gamma_s (S_w - S_b) = \rho_i \dot{m} S_b \] Freezing temperature \[ \qquad T_b = a S_b + b + c P \] where .... Asay-Davis, Xylar S., Stephen L. Cornford, Benjamin K. Galton-Fenzi, Rupert M. Gladstone, G. Hilmar Gudmundsson, David M. Holland, Paul R. Holland, and Daniel F. Martin. Experimental design for three interrelated marine ice sheet and ocean model intercomparison projects: MISMIP v. 3 (MISMIP+), ISOMIP v. 2 (ISOMIP+) and MISOMIP v. 1 (MISOMIP1). Geoscientific Model Development 9, no. 7 (2016): 2471. Goldberg, D. N., et al. Investigation of land ice-ocean interaction with a fully coupled ice-ocean model: 1. Model description and behavior. Journal of Geophysical Research: Earth Surface 117.F2 (2012). Goldberg, D. N., et al. Investigation of land ice-ocean interaction with a fully coupled ice-ocean model: 2. Sensitivity to external forcings. Journal of Geophysical Research: Earth Surface 117.F2 (2012). Holland, David M., and Adrian Jenkins. Modeling thermodynamic ice-ocean interactions at the base of an ice shelf. Journal of Physical Oceanography 29.8 (1999): 1787-1800.