mom_ice_shelf_dynamics mom_ice_shelf_dynamics::ice_shelf_dyn_cs mom_ice_shelf_dynamics::loop_bounds_type real function real function mom_ice_shelf_dynamics::slope_limiter (num, denom) slope_limiter num num denom denom used for flux limiting in advective subroutines Van Leer limiter (source: Wikipedia) The return value is between 0 and 2 [nondim]. num The numerator of the ratio used in the Van Leer slope limiter denom The denominator of the ratio used in the Van Leer slope limiter ice_shelf_advect_temp_x ice_shelf_advect_temp_y ice_shelf_advect_thickness_x ice_shelf_advect_thickness_y real function real function mom_ice_shelf_dynamics::quad_area (X, Y) quad_area X X Y Y Calculate area of quadrilateral. x The x-positions of the vertices of the quadrilateral [L ~> m]. y The y-positions of the vertices of the quadrilateral [L ~> m]. bilinear_shape_functions subroutine, public subroutine, public mom_ice_shelf_dynamics::register_ice_shelf_dyn_restarts (G, param_file, CS, restart_CS) register_ice_shelf_dyn_restarts G G param_file param_file CS CS restart_CS restart_CS This subroutine is used to register any fields related to the ice shelf dynamics that should be written to or read from the restart file. g The grid type describing the ice shelf grid. param_file A structure to parse for run-time parameters cs A pointer to the ice shelf dynamics control structure restart_cs A pointer to the restart control structure. mom_error_handler::mom_error subroutine, public subroutine, public mom_ice_shelf_dynamics::initialize_ice_shelf_dyn (param_file, Time, ISS, CS, G, US, diag, new_sim, solo_ice_sheet_in) initialize_ice_shelf_dyn param_file param_file Time Time ISS ISS CS CS G G US US diag diag new_sim new_sim 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 time The clock that that will indicate the model time iss A structure with elements that describe the ice-shelf state cs A pointer to the ice shelf dynamics control structure g The grid type describing the ice shelf grid. us A structure containing unit conversion factors diag A structure that is used to regulate the diagnostic output. new_sim If true this is a new simulation, otherwise has been started from a restart file. solo_ice_sheet_in If present, this indicates whether a solo ice-sheet driver. ice_shelf_solve_outer mom_error_handler::mom_error mom_error_handler::mom_mesg mom_domains::to_all update_od_ffrac_uncoupled update_velocity_masks subroutine subroutine mom_ice_shelf_dynamics::initialize_diagnostic_fields (CS, ISS, G, US, Time) initialize_diagnostic_fields CS CS ISS ISS G G US US Time Time cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors time The current model time ice_shelf_solve_outer real function, public real function, public mom_ice_shelf_dynamics::ice_time_step_cfl (CS, ISS, G) ice_time_step_cfl CS CS ISS ISS G G This function returns the global maximum advective timestep that can be taken based on the current ice velocities. Because it involves finding a global minimum, it can be surprisingly expensive. cs The ice shelf dynamics control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. The maximum permitted timestep based on the ice velocities [T ~> s]. mom_ice_shelf::solo_step_ice_shelf subroutine, public subroutine, public mom_ice_shelf_dynamics::update_ice_shelf (CS, ISS, G, US, time_step, Time, ocean_mass, coupled_grounding, must_update_vel) update_ice_shelf CS CS ISS ISS G G US US time_step time_step Time Time ocean_mass ocean_mass coupled_grounding coupled_grounding must_update_vel must_update_vel This subroutine updates the ice shelf velocities, mass, stresses and properties due to the ice shelf dynamics. cs The ice shelf dynamics control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors time_step time step [T ~> s] time The current model time ocean_mass If present this is the mass per unit area coupled_grounding If true, the grounding line is determined by coupled ice-ocean dynamics must_update_vel Always update the ice velocities if true. mom_diag_mediator::disable_averaging mom_diag_mediator::enable_averages ice_shelf_advect ice_shelf_solve_outer ice_shelf_temp update_od_ffrac update_od_ffrac_uncoupled subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_advect (CS, ISS, G, time_step, Time) ice_shelf_advect CS CS ISS ISS G G time_step time_step Time Time This subroutine takes the velocity (on the Bgrid) and timesteps h_t = - div (uh) once. Additionally, it will update the volume of ice in partially-filled cells, and update hmask accordingly. cs The ice shelf dynamics control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. time_step time step [T ~> s] time The current model time calve_to_mask ice_shelf_advect_thickness_x ice_shelf_advect_thickness_y ice_shelf_min_thickness_calve mom_error_handler::mom_error shelf_advance_front update_velocity_masks update_ice_shelf subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_solve_outer (CS, ISS, G, US, u_shlf, v_shlf, iters, time) ice_shelf_solve_outer CS CS ISS ISS G G US US u_shlf u_shlf v_shlf v_shlf iters iters time time cs The ice shelf dynamics control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors u_shlf The zonal ice shelf velocity at vertices [L T-1 ~> m s-1] v_shlf The meridional ice shelf velocity at vertices [L T-1 ~> m s-1] iters The number of iterations used in the solver. time The current model time apply_boundary_values bilinear_shape_fn_grid bilinear_shape_functions_subgrid calc_shelf_driving_stress calc_shelf_visc cg_action ice_shelf_solve_inner interpolate_h_to_b mom_error_handler::mom_mesg initialize_diagnostic_fields initialize_ice_shelf_dyn update_ice_shelf subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_solve_inner (CS, ISS, G, US, u_shlf, v_shlf, taudx, taudy, H_node, float_cond, hmask, conv_flag, iters, time, Phi, Phisub) ice_shelf_solve_inner CS CS ISS ISS G G US US u_shlf u_shlf v_shlf v_shlf taudx taudx taudy taudy H_node H_node float_cond float_cond hmask hmask conv_flag conv_flag iters iters time time Phi Phi Phisub Phisub cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors u_shlf The zonal ice shelf velocity at vertices [L T-1 ~> m s-1] v_shlf The meridional ice shelf velocity at vertices [L T-1 ~> m s-1] taudx The x-direction driving stress [R L3 Z T-2 ~> kg m s-2] taudy The y-direction driving stress [R L3 Z T-2 ~> kg m s-2] h_node The ice shelf thickness at nodal (corner) float_cond An array indicating where the ice hmask A mask indicating which tracer points are conv_flag A flag indicating whether (1) or not (0) the iterations have converged to the specified tolerance iters The number of iterations used in the solver. time The current model time phi The gradients of bilinear basis elements at Gaussian phisub Quadrature structure weights at subgridscale apply_boundary_values cg_action matrix_diagonal mom_domains::to_all ice_shelf_solve_outer subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_advect_thickness_x (CS, G, LB, time_step, hmask, h0, h_after_uflux, uh_ice) ice_shelf_advect_thickness_x CS CS G G LB LB time_step time_step hmask hmask h0 h0 h_after_uflux h_after_uflux uh_ice uh_ice cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. lb Loop bounds structure. time_step The time step for this update [T ~> s]. hmask A mask indicating which tracer points are h0 The initial ice shelf thicknesses [Z ~> m]. h_after_uflux The ice shelf thicknesses after uh_ice The accumulated zonal ice volume flux [Z L2 ~> m3] slope_limiter ice_shelf_advect subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_advect_thickness_y (CS, G, LB, time_step, hmask, h0, h_after_vflux, vh_ice) ice_shelf_advect_thickness_y CS CS G G LB LB time_step time_step hmask hmask h0 h0 h_after_vflux h_after_vflux vh_ice vh_ice cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. lb Loop bounds structure. time_step The time step for this update [T ~> s]. hmask A mask indicating which tracer points are h0 The initial ice shelf thicknesses [Z ~> m]. h_after_vflux The ice shelf thicknesses after vh_ice The accumulated meridional ice volume flux [Z L2 ~> m3] slope_limiter ice_shelf_advect subroutine, public subroutine, public mom_ice_shelf_dynamics::shelf_advance_front (CS, ISS, G, hmask, uh_ice, vh_ice) shelf_advance_front CS CS ISS ISS G G hmask hmask uh_ice uh_ice vh_ice vh_ice cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. hmask A mask indicating which tracer points are uh_ice The accumulated zonal ice volume flux [Z L2 ~> m3] vh_ice The accumulated meridional ice volume flux [Z L2 ~> m3] mom_error_handler::is_root_pe mom_error_handler::mom_mesg ice_shelf_advect subroutine, public subroutine, public mom_ice_shelf_dynamics::ice_shelf_min_thickness_calve (G, h_shelf, area_shelf_h, hmask, thickness_calve, halo) ice_shelf_min_thickness_calve G G h_shelf h_shelf area_shelf_h area_shelf_h hmask hmask thickness_calve thickness_calve halo halo Apply a very simple calving law using a minimum thickness rule. g The grid structure used by the ice shelf. h_shelf The ice shelf thickness [Z ~> m]. area_shelf_h The area per cell covered by the ice shelf [L2 ~> m2]. hmask A mask indicating which tracer points are partly or fully covered by an ice-shelf thickness_calve The thickness at which to trigger calving [Z ~> m]. halo The number of halo points to use. If not present, work on the entire data domain. ice_shelf_advect subroutine, public subroutine, public mom_ice_shelf_dynamics::calve_to_mask (G, h_shelf, area_shelf_h, hmask, calve_mask) calve_to_mask G G h_shelf h_shelf area_shelf_h area_shelf_h hmask hmask calve_mask calve_mask g The grid structure used by the ice shelf. h_shelf The ice shelf thickness [Z ~> m]. area_shelf_h The area per cell covered by the ice shelf [L2 ~> m2]. hmask A mask indicating which tracer points are partly or fully covered by an ice-shelf calve_mask A mask that indicates where the ice shelf can exist, and where it will calve. ice_shelf_advect subroutine subroutine mom_ice_shelf_dynamics::calc_shelf_driving_stress (CS, ISS, G, US, taudx, taudy, OD) calc_shelf_driving_stress CS CS ISS ISS G G US US taudx taudx taudy taudy OD OD cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors od ocean floor depth at tracer points [Z ~> m]. taudx X-direction driving stress at q-points [kg L s-2 ~> kg m s-2] taudy Y-direction driving stress at q-points [kg L s-2 ~> kg m s-2] ice_shelf_solve_outer subroutine subroutine mom_ice_shelf_dynamics::init_boundary_values (CS, G, time, hmask, input_flux, input_thick, new_sim) init_boundary_values CS CS G G time time hmask hmask input_flux input_flux input_thick input_thick new_sim new_sim cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. time The current model time hmask A mask indicating which tracer points are input_flux The integrated inward ice thickness flux per unit face length [Z L T-1 ~> m2 s-1] input_thick The ice thickness at boundaries [Z ~> m]. new_sim If present and false, this run is being restarted subroutine subroutine mom_ice_shelf_dynamics::cg_action (uret, vret, u_shlf, v_shlf, Phi, Phisub, umask, vmask, hmask, H_node, ice_visc, float_cond, bathyT, basal_trac, G, US, is, ie, js, je, dens_ratio) cg_action uret uret vret vret u_shlf u_shlf v_shlf v_shlf Phi Phi Phisub Phisub umask umask vmask vmask hmask hmask H_node H_node ice_visc ice_visc float_cond float_cond bathyT bathyT basal_trac basal_trac G G US US is is ie ie js js je je dens_ratio dens_ratio g The grid structure used by the ice shelf. uret The retarding stresses working at u-points [R L3 Z T-2 ~> kg m s-2]. vret The retarding stresses working at v-points [R L3 Z T-2 ~> kg m s-2]. phi The gradients of bilinear basis elements at Gaussian phisub Quadrature structure weights at subgridscale u_shlf The zonal ice shelf velocity at vertices [L T-1 ~> m s-1] v_shlf The meridional ice shelf velocity at vertices [L T-1 ~> m s-1] umask A coded mask indicating the nature of the vmask A coded mask indicating the nature of the h_node The ice shelf thickness at nodal (corner) hmask A mask indicating which tracer points are ice_visc A field related to the ice viscosity from Glen's float_cond An array indicating where the ice bathyt The depth of ocean bathymetry at tracer points [Z ~> m]. basal_trac A field related to the nonlinear part of the dens_ratio The density of ice divided by the density of seawater, nondimensional us A structure containing unit conversion factors is The starting i-index to work on ie The ending i-index to work on js The starting j-index to work on je The ending j-index to work on cg_action_subgrid_basal ice_shelf_solve_inner ice_shelf_solve_outer subroutine subroutine mom_ice_shelf_dynamics::cg_action_subgrid_basal (Phisub, H, U, V, bathyT, dens_ratio, Ucontr, Vcontr) cg_action_subgrid_basal Phisub Phisub H H U U V V bathyT bathyT dens_ratio dens_ratio Ucontr Ucontr Vcontr Vcontr phisub Quadrature structure weights at subgridscale h The ice shelf thickness at nodal (corner) points [Z ~> m]. u The zonal ice shelf velocity at vertices [L T-1 ~> m s-1] v The meridional ice shelf velocity at vertices [L T-1 ~> m s-1] bathyt The depth of ocean bathymetry at tracer points [Z ~> m]. dens_ratio The density of ice divided by the density of seawater [nondim] ucontr The areal average of u-velocities where the ice shelf is grounded, or 0 where it is floating [L T-1 ~> m s-1]. vcontr The areal average of v-velocities where the ice shelf is grounded, or 0 where it is floating [L T-1 ~> m s-1]. apply_boundary_values cg_action subroutine subroutine mom_ice_shelf_dynamics::matrix_diagonal (CS, G, US, float_cond, H_node, ice_visc, basal_trac, hmask, dens_ratio, Phisub, u_diagonal, v_diagonal) matrix_diagonal CS CS G G US US float_cond float_cond H_node H_node ice_visc ice_visc basal_trac basal_trac hmask hmask dens_ratio dens_ratio Phisub Phisub u_diagonal u_diagonal v_diagonal v_diagonal returns the diagonal entries of the matrix for a Jacobi preconditioning cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. us A structure containing unit conversion factors float_cond An array indicating where the ice h_node The ice shelf thickness at nodal ice_visc A field related to the ice viscosity from Glen's basal_trac A field related to the nonlinear part of the hmask A mask indicating which tracer points are dens_ratio The density of ice divided by the density of seawater [nondim] phisub Quadrature structure weights at subgridscale locations for finite element calculations [nondim] u_diagonal The diagonal elements of the u-velocity v_diagonal The diagonal elements of the v-velocity bilinear_shape_fn_grid cg_diagonal_subgrid_basal ice_shelf_solve_inner subroutine subroutine mom_ice_shelf_dynamics::cg_diagonal_subgrid_basal (Phisub, H_node, bathyT, dens_ratio, sub_grnd) cg_diagonal_subgrid_basal Phisub Phisub H_node H_node bathyT bathyT dens_ratio dens_ratio sub_grnd sub_grnd phisub Quadrature structure weights at subgridscale h_node The ice shelf thickness at nodal (corner) points [Z ~> m]. bathyt The depth of ocean bathymetry at tracer points [Z ~> m]. dens_ratio The density of ice divided by the density of seawater [nondim] sub_grnd The weighted fraction of the sub-cell where the ice shelf is grounded [nondim] matrix_diagonal subroutine subroutine mom_ice_shelf_dynamics::apply_boundary_values (CS, ISS, G, US, time, Phisub, H_node, ice_visc, basal_trac, float_cond, dens_ratio, u_bdry_contr, v_bdry_contr) apply_boundary_values CS CS ISS ISS G G US US time time Phisub Phisub H_node H_node ice_visc ice_visc basal_trac basal_trac float_cond float_cond dens_ratio dens_ratio u_bdry_contr u_bdry_contr v_bdry_contr v_bdry_contr cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors time The current model time phisub Quadrature structure weights at subgridscale h_node The ice shelf thickness at nodal ice_visc A field related to the ice viscosity from Glen's basal_trac A field related to the nonlinear part of the float_cond An array indicating where the ice dens_ratio The density of ice divided by the density of seawater, nondimensional u_bdry_contr Zonal force contributions due to the v_bdry_contr Meridional force contributions due to the bilinear_shape_fn_grid cg_action_subgrid_basal ice_shelf_solve_inner ice_shelf_solve_outer subroutine subroutine mom_ice_shelf_dynamics::calc_shelf_visc (CS, ISS, G, US, u_shlf, v_shlf) calc_shelf_visc CS CS ISS ISS G G US US u_shlf u_shlf v_shlf v_shlf Update depth integrated viscosity, based on horizontal strain rates, and also update the nonlinear part of the basal traction. cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors u_shlf The zonal ice shelf velocity [L T-1 ~> m s-1]. v_shlf The meridional ice shelf velocity [L T-1 ~> m s-1]. ice_shelf_solve_outer subroutine subroutine mom_ice_shelf_dynamics::update_od_ffrac (CS, G, US, ocean_mass, find_avg) update_od_ffrac CS CS G G US US ocean_mass ocean_mass find_avg find_avg cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. us A structure containing unit conversion factors ocean_mass The mass per unit area of the ocean [kg m-2]. find_avg If true, find the average of OD and ffrac, and reset the underlying running sums to 0. update_ice_shelf subroutine subroutine mom_ice_shelf_dynamics::update_od_ffrac_uncoupled (CS, G, h_shelf) update_od_ffrac_uncoupled CS CS G G h_shelf h_shelf cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. h_shelf the thickness of the ice shelf [Z ~> m]. initialize_ice_shelf_dyn update_ice_shelf subroutine subroutine mom_ice_shelf_dynamics::bilinear_shape_functions (X, Y, Phi, area) bilinear_shape_functions X X Y Y Phi Phi area area This subroutine calculates the gradients of bilinear basis elements that that are centered at the vertices of the cell. Values are calculated at points of gaussian quadrature. x The x-positions of the vertices of the quadrilateral [L ~> m]. y The y-positions of the vertices of the quadrilateral [L ~> m]. phi The gradients of bilinear basis elements at Gaussian quadrature points surrounding the cell vertices [L-1 ~> m-1]. area The quadrilateral cell area [L2 ~> m2]. quad_area subroutine subroutine mom_ice_shelf_dynamics::bilinear_shape_fn_grid (G, i, j, Phi) bilinear_shape_fn_grid G G i i j j Phi Phi This subroutine calculates the gradients of bilinear basis elements that are centered at the vertices of the cell using a locally orthogoal MOM6 grid. Values are calculated at points of gaussian quadrature. g The grid structure used by the ice shelf. i The i-index in the grid to work on. j The j-index in the grid to work on. phi The gradients of bilinear basis elements at Gaussian quadrature points surrounding the cell vertices [L-1 ~> m-1]. apply_boundary_values ice_shelf_solve_outer matrix_diagonal subroutine subroutine mom_ice_shelf_dynamics::bilinear_shape_functions_subgrid (Phisub, nsub) bilinear_shape_functions_subgrid Phisub Phisub nsub nsub phisub Quadrature structure weights at subgridscale nsub The number of subgridscale quadrature locations in each direction ice_shelf_solve_outer subroutine subroutine mom_ice_shelf_dynamics::update_velocity_masks (CS, G, hmask, umask, vmask, u_face_mask, v_face_mask) update_velocity_masks CS CS G G hmask hmask umask umask vmask vmask u_face_mask u_face_mask v_face_mask v_face_mask cs A pointer to the ice shelf dynamics control structure g The grid structure used by the ice shelf. hmask A mask indicating which tracer points are umask A coded mask indicating the nature of the vmask A coded mask indicating the nature of the u_face_mask A coded mask for velocities at the C-grid u-face v_face_mask A coded mask for velocities at the C-grid v-face mom_domains::to_all ice_shelf_advect initialize_ice_shelf_dyn subroutine subroutine mom_ice_shelf_dynamics::interpolate_h_to_b (G, h_shelf, hmask, H_node) interpolate_h_to_b G G h_shelf h_shelf hmask hmask H_node H_node Interpolate the ice shelf thickness from tracer point to nodal points, subject to a mask. g The grid structure used by the ice shelf. h_shelf The ice shelf thickness at tracer points [Z ~> m]. hmask A mask indicating which tracer points are h_node The ice shelf thickness at nodal (corner) ice_shelf_solve_outer subroutine, public subroutine, public mom_ice_shelf_dynamics::ice_shelf_dyn_end (CS) ice_shelf_dyn_end CS CS Deallocates all memory associated with the ice shelf dynamics module. cs A pointer to the ice shelf dynamics control structure mom_ice_shelf::ice_shelf_end subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_temp (CS, ISS, G, US, time_step, melt_rate, Time) ice_shelf_temp CS CS ISS ISS G G US US time_step time_step melt_rate melt_rate Time Time This subroutine updates the vertically averaged ice shelf temperature. cs A pointer to the ice shelf control structure iss A structure with elements that describe the ice-shelf state g The grid structure used by the ice shelf. us A structure containing unit conversion factors time_step The time step for this update [T ~> s]. melt_rate basal melt rate [R Z T-1 ~> kg m-2 s-1] time The current model time ice_shelf_advect_temp_x ice_shelf_advect_temp_y update_ice_shelf subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_advect_temp_x (CS, G, time_step, hmask, h0, h_after_uflux) ice_shelf_advect_temp_x CS CS G G time_step time_step hmask hmask h0 h0 h_after_uflux h_after_uflux cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. time_step The time step for this update [T ~> s]. hmask A mask indicating which tracer points are h0 The initial ice shelf thicknesses [Z ~> m]. h_after_uflux The ice shelf thicknesses after slope_limiter ice_shelf_temp subroutine subroutine mom_ice_shelf_dynamics::ice_shelf_advect_temp_y (CS, G, time_step, hmask, h_after_uflux, h_after_vflux) ice_shelf_advect_temp_y CS CS G G time_step time_step hmask hmask h_after_uflux h_after_uflux h_after_vflux h_after_vflux cs A pointer to the ice shelf control structure g The grid structure used by the ice shelf. time_step The time step for this update [T ~> s]. hmask A mask indicating which tracer points are h_after_uflux The ice shelf thicknesses after h_after_vflux The ice shelf thicknesses after slope_limiter ice_shelf_temp Implements a crude placeholder for a later implementation of full ice shelf dynamics.