mom_dynamics_split_rk2 mom_dynamics_split_rk2::mom_dyn_split_rk2_cs integer integer mom_dynamics_split_rk2::id_clock_cor id_clock_cor CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_pres id_clock_pres CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_vertvisc id_clock_vertvisc CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_horvisc id_clock_horvisc CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_mom_update id_clock_mom_update CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_continuity id_clock_continuity CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_thick_diff id_clock_thick_diff CPU time clock IDs. integer integer mom_dynamics_split_rk2::id_clock_btstep id_clock_btstep CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_btcalc id_clock_btcalc CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_btforce id_clock_btforce CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_pass id_clock_pass CPU time clock IDs. initialize_dyn_split_rk2 step_mom_dyn_split_rk2 integer integer mom_dynamics_split_rk2::id_clock_pass_init id_clock_pass_init CPU time clock IDs. initialize_dyn_split_rk2 subroutine, public subroutine, public mom_dynamics_split_rk2::step_mom_dyn_split_rk2 (u, v, h, tv, visc, Time_local, dt, forces, p_surf_begin, p_surf_end, uh, vh, uhtr, vhtr, eta_av, G, GV, US, CS, calc_dtbt, VarMix, MEKE, thickness_diffuse_CSp, Waves) step_mom_dyn_split_rk2 u u v v h h tv tv visc visc Time_local Time_local dt dt forces forces p_surf_begin p_surf_begin p_surf_end p_surf_end uh uh vh vh uhtr uhtr vhtr vhtr eta_av eta_av G G GV GV US US CS CS calc_dtbt calc_dtbt VarMix VarMix MEKE MEKE thickness_diffuse_CSp thickness_diffuse_CSp Waves Waves RK2 splitting for time stepping MOM adiabatic dynamics. g ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type u zonal velocity [L T-1 ~> m s-1] v merid velocity [L T-1 ~> m s-1] h layer thickness [H ~> m or kg m-2] tv thermodynamic type visc vertical visc, bottom drag, and related time_local model time at end of time step dt time step [T ~> s] forces A structure with the driving mechanical forces p_surf_begin surf pressure at the start of this dynamic time step [R L2 T-2 ~> Pa] p_surf_end surf pressure at the end of this dynamic time step [R L2 T-2 ~> Pa] uh zonal volume/mass transport vh merid volume/mass transport uhtr accumulatated zonal volume/mass transport vhtr accumulatated merid volume/mass transport eta_av free surface height or column mass time averaged over time step [H ~> m or kg m-2] cs module control structure calc_dtbt if true, recalculate barotropic time step varmix specify the spatially varying viscosities meke related to mesoscale eddy kinetic energy param thickness_diffuse_csp Pointer to a structure containing interface height diffusivities waves A pointer to a structure containing fields related to the surface wave conditions mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint mom_domains::complete_group_pass mom_continuity::continuity_stencil mom_coriolisadv::coradcalc mom_diag_mediator::diag_update_remap_grids mom_hor_visc::horizontal_viscosity id_clock_btcalc id_clock_btforce id_clock_btstep id_clock_continuity id_clock_cor id_clock_horvisc id_clock_mom_update id_clock_pass id_clock_pres id_clock_vertvisc mom_checksum_packages::mom_accel_chksum mom_open_boundary::open_boundary_test_extern_h mom_pressureforce::pressureforce mom_barotropic::set_dtbt mom_set_visc::set_viscous_ml mom_domains::start_group_pass mom_boundary_update::update_obc_data mom_open_boundary::update_obc_ramp mom_vert_friction::updatecfltruncationvalue subroutine, public subroutine, public mom_dynamics_split_rk2::register_restarts_dyn_split_rk2 (HI, GV, param_file, CS, restart_CS, uh, vh) register_restarts_dyn_split_rk2 HI HI GV GV param_file param_file CS CS restart_CS restart_CS uh uh vh vh This subroutine sets up any auxiliary restart variables that are specific to the unsplit time stepping scheme. All variables registered here should have the ability to be recreated if they are not present in a restart file. hi Horizontal index structure gv ocean vertical grid structure param_file parameter file cs module control structure restart_cs restart control structure uh zonal volume/mass transport [H L2 T-1 ~> m3 s-1 or kg s-1] vh merid volume/mass transport [H L2 T-1 ~> m3 s-1 or kg s-1] mom_verticalgrid::get_flux_units mom_barotropic::register_barotropic_restarts mom_io::var_desc subroutine, public subroutine, public mom_dynamics_split_rk2::initialize_dyn_split_rk2 (u, v, h, uh, vh, eta, Time, G, GV, US, param_file, diag, CS, restart_CS, dt, Accel_diag, Cont_diag, MIS, VarMix, MEKE, thickness_diffuse_CSp, OBC, update_OBC_CSp, ALE_CSp, setVisc_CSp, visc, dirs, ntrunc, calc_dtbt, cont_stencil) initialize_dyn_split_rk2 u u v v h h uh uh vh vh eta eta Time Time G G GV GV US US param_file param_file diag diag CS CS restart_CS restart_CS dt dt Accel_diag Accel_diag Cont_diag Cont_diag MIS MIS VarMix VarMix MEKE MEKE thickness_diffuse_CSp thickness_diffuse_CSp OBC OBC update_OBC_CSp update_OBC_CSp ALE_CSp ALE_CSp setVisc_CSp setVisc_CSp visc visc dirs dirs ntrunc ntrunc calc_dtbt calc_dtbt cont_stencil cont_stencil This subroutine initializes all of the variables that are used by this dynamic core, including diagnostics and the cpu clocks. g ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type u zonal velocity [L T-1 ~> m s-1] v merid velocity [L T-1 ~> m s-1] h layer thickness [H ~> m or kg m-2] uh zonal volume/mass transport [H L2 T-1 ~> m3 s-1 or kg s-1] vh merid volume/mass transport [H L2 T-1 ~> m3 s-1 or kg s-1] eta free surface height or column mass [H ~> m or kg m-2] time current model time param_file parameter file for parsing diag to control diagnostics cs module control structure restart_cs restart control structure dt time step [T ~> s] accel_diag points to momentum equation terms for budget analysis cont_diag points to terms in continuity equation mis "MOM6 internal state" used to pass diagnostic pointers varmix points to spatially variable viscosities meke points to mesoscale eddy kinetic energy fields thickness_diffuse_csp Pointer to the control structure used for the isopycnal height diffusive transport. obc points to OBC related fields update_obc_csp points to OBC update related fields ale_csp points to ALE control structure setvisc_csp points to the set_visc control structure. visc vertical viscosities, bottom drag, and related dirs contains directory paths ntrunc A target for the variable that records the number of times the velocity is truncated (this should be 0). calc_dtbt If true, recalculate the barotropic time step cont_stencil The stencil for thickness from the continuity solver. mom_continuity::continuity_stencil mom_coriolisadv::coriolisadv_init mom_verticalgrid::get_flux_units mom_hor_visc::hor_visc_init mom_hor_visc::horizontal_viscosity id_clock_btcalc id_clock_btforce id_clock_btstep id_clock_continuity id_clock_cor id_clock_horvisc id_clock_mom_update id_clock_pass id_clock_pass_init id_clock_pres id_clock_vertvisc mom_restart::is_new_run mom_pressureforce::pressureforce_init mom_tidal_forcing::tidal_forcing_init mom_open_boundary::update_obc_ramp mom_vert_friction::updatecfltruncationvalue subroutine, public subroutine, public mom_dynamics_split_rk2::end_dyn_split_rk2 (CS) end_dyn_split_rk2 CS CS Close the dyn_split_RK2 module. cs module control structure Time step the adiabatic dynamic core of MOM using RK2 method. This file time steps the adiabatic dynamic core by splitting between baroclinic and barotropic modes. It uses a pseudo-second order Runge-Kutta time stepping scheme for the baroclinic momentum equation and a forward-backward coupling between the baroclinic momentum and continuity equations. This split time-stepping scheme is described in detail in Hallberg (JCP, 1997). Additional issues related to exact tracer conservation and how to ensure consistency between the barotropic and layered estimates of the free surface height are described in Hallberg and Adcroft (Ocean Modelling, 2009). This was the time stepping code that is used for most GOLD applications, including GFDL's ESM2G Earth system model, and all of the examples provided with the MOM code (although several of these solutions are routinely verified by comparison with the slower unsplit schemes). The subroutine step_MOM_dyn_split_RK2 actually does the time stepping, while register_restarts_dyn_split_RK2 sets the fields that are found in a full restart file with this scheme, and initialize_dyn_split_RK2 initializes the cpu clocks that are used in this module. For largely historical reasons, this module does not have its own control structure, but shares the same control structure with MOM.F90 and the other MOM_dynamics_... modules.