mom_diabatic_driver mom_diabatic_driver::diabatic_cs integer integer mom_diabatic_driver::id_clock_entrain id_clock_entrain clock ids diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_mixedlayer id_clock_mixedlayer clock ids diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_set_diffusivity id_clock_set_diffusivity clock ids diabatic diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_tracers id_clock_tracers clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_tridiag id_clock_tridiag clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_pass id_clock_pass clock ids diabatic diabatic_ale diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_sponge id_clock_sponge clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_geothermal id_clock_geothermal clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_differential_diff id_clock_differential_diff clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_remap id_clock_remap clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic integer integer mom_diabatic_driver::id_clock_kpp id_clock_kpp clock ids diabatic_ale diabatic_ale_legacy diabatic_driver_init layered_diabatic subroutine, public subroutine, public mom_diabatic_driver::diabatic (u, v, h, tv, Hml, fluxes, visc, ADp, CDp, dt, Time_end, G, GV, US, CS, OBC, WAVES) diabatic u u v v h h tv tv Hml Hml fluxes fluxes visc visc ADp ADp CDp CDp dt dt Time_end Time_end G G GV GV US US CS CS OBC OBC WAVES WAVES This subroutine imposes the diapycnal mass fluxes and the accompanying diapycnal advection of momentum and tracers. g ocean grid structure gv ocean vertical grid structure u zonal velocity [L T-1 ~> m s-1] v meridional velocity [L T-1 ~> m s-1] h thickness [H ~> m or kg m-2] tv points to thermodynamic fields unused have NULL ptrs hml Active mixed layer depth [Z ~> m] fluxes points to forcing fields unused fields have NULL ptrs visc vertical viscosities, BBL properies, and adp related points to accelerations in momentum equations, to enable the later derived diagnostics, like energy budgets cdp points to terms in continuity equations dt time increment [T ~> s] time_end Time at the end of the interval us A dimensional unit scaling type cs module control structure obc Open boundaries control structure. waves Surface gravity waves mom_error_handler::calltree_waypoint diabatic_ale diabatic_ale_legacy diagnose_frazil_tendency mom_diapyc_energy_req::diapyc_energy_req_test id_clock_pass id_clock_set_diffusivity layered_diabatic mom_checksum_packages::mom_state_stats mom_time_manager::real_to_time mom_wave_speed::wave_speeds subroutine subroutine mom_diabatic_driver::diabatic_ale_legacy (u, v, h, tv, Hml, fluxes, visc, ADp, CDp, dt, Time_end, G, GV, US, CS, Waves) diabatic_ale_legacy u u v v h h tv tv Hml Hml fluxes fluxes visc visc ADp ADp CDp CDp dt dt Time_end Time_end G G GV GV US US CS CS Waves Waves Applies diabatic forcing and diapycnal mixing of temperature, salinity and other tracers for use with an ALE algorithm. This version uses an older set of algorithms compared with diabatic_ALE. 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 meridional velocity [L T-1 ~> m s-1] h thickness [H ~> m or kg m-2] tv points to thermodynamic fields unused have NULL ptrs hml Active mixed layer depth [Z ~> m] fluxes points to forcing fields unused fields have NULL ptrs visc vertical viscosities, BBL properies, and adp related points to accelerations in momentum equations, to enable the later derived diagnostics, like energy budgets cdp points to terms in continuity equations dt time increment [T ~> s] time_end Time at the end of the interval cs module control structure waves Surface gravity waves mom_ale_sponge::apply_ale_sponge mom_cvmix_conv::calculate_cvmix_conv mom_forcing_type::calculatebuoyancyflux2d mom_tracer_flow_control::call_tracer_column_fns mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint diagnose_boundary_forcing_tendency diagnose_diabatic_diff_tendency mom_energetic_pbl::energetic_pbl_get_mld id_clock_differential_diff id_clock_geothermal id_clock_kpp id_clock_remap id_clock_set_diffusivity id_clock_sponge id_clock_tracers id_clock_tridiag mom_cvmix_kpp::kpp_nonlocaltransport_saln mom_cvmix_kpp::kpp_nonlocaltransport_temp mom_checksum_packages::mom_state_stats mom_variables::mom_thermovar_chksum mom_opacity::optics_nbands mom_diabatic_aux::set_pen_shortwave mom_tracer_diabatic::tracer_vertdiff diabatic subroutine subroutine mom_diabatic_driver::diabatic_ale (u, v, h, tv, Hml, fluxes, visc, ADp, CDp, dt, Time_end, G, GV, US, CS, Waves) diabatic_ale u u v v h h tv tv Hml Hml fluxes fluxes visc visc ADp ADp CDp CDp dt dt Time_end Time_end G G GV GV US US CS CS Waves Waves This subroutine imposes the diapycnal mass fluxes and the accompanying diapycnal advection of momentum and tracers. 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 meridional velocity [L T-1 ~> m s-1] h thickness [H ~> m or kg m-2] tv points to thermodynamic fields unused have NULL ptrs hml Active mixed layer depth [Z ~> m] fluxes points to forcing fields unused fields have NULL ptrs visc vertical viscosities, BBL properies, and adp related points to accelerations in momentum equations, to enable the later derived diagnostics, like energy budgets cdp points to terms in continuity equations dt time increment [T ~> s] time_end Time at the end of the interval cs module control structure waves Surface gravity waves mom_ale_sponge::apply_ale_sponge mom_cvmix_conv::calculate_cvmix_conv mom_forcing_type::calculatebuoyancyflux2d mom_tracer_flow_control::call_tracer_column_fns mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint diagnose_boundary_forcing_tendency diagnose_diabatic_diff_tendency mom_domains::do_group_pass mom_energetic_pbl::energetic_pbl_get_mld id_clock_differential_diff id_clock_geothermal id_clock_kpp id_clock_pass id_clock_remap id_clock_set_diffusivity id_clock_sponge id_clock_tracers id_clock_tridiag mom_cvmix_kpp::kpp_nonlocaltransport_saln mom_cvmix_kpp::kpp_nonlocaltransport_temp mom_checksum_packages::mom_state_stats mom_variables::mom_thermovar_chksum mom_opacity::optics_nbands mom_diabatic_aux::set_pen_shortwave mom_tracer_diabatic::tracer_vertdiff diabatic subroutine subroutine mom_diabatic_driver::layered_diabatic (u, v, h, tv, Hml, fluxes, visc, ADp, CDp, dt, Time_end, G, GV, US, CS, WAVES) layered_diabatic u u v v h h tv tv Hml Hml fluxes fluxes visc visc ADp ADp CDp CDp dt dt Time_end Time_end G G GV GV US US CS CS WAVES WAVES Imposes the diapycnal mass fluxes and the accompanying diapycnal advection of momentum and tracers using the original MOM6 algorithms. 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 meridional velocity [L T-1 ~> m s-1] h thickness [H ~> m or kg m-2] tv points to thermodynamic fields unused have NULL ptrs hml Active mixed layer depth [Z ~> m] fluxes points to forcing fields unused fields have NULL ptrs visc vertical viscosities, BBL properies, and adp related points to accelerations in momentum equations, to enable the later derived diagnostics, like energy budgets cdp points to terms in continuity equations dt time increment [T ~> s] time_end Time at the end of the interval cs module control structure waves Surface gravity waves mom_sponge::apply_sponge mom_bulk_mixed_layer::bulkmixedlayer mom_cvmix_conv::calculate_cvmix_conv mom_forcing_type::calculatebuoyancyflux2d mom_tracer_flow_control::call_tracer_column_fns mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_error_handler::calltree_waypoint diagnose_diabatic_diff_tendency mom_domains::do_group_pass mom_eos::eos_domain id_clock_differential_diff id_clock_entrain id_clock_geothermal id_clock_kpp id_clock_mixedlayer id_clock_pass id_clock_remap id_clock_set_diffusivity id_clock_sponge id_clock_tracers id_clock_tridiag mom_cvmix_kpp::kpp_nonlocaltransport_saln mom_cvmix_kpp::kpp_nonlocaltransport_temp mom_checksum_packages::mom_state_stats mom_variables::mom_thermovar_chksum mom_regularize_layers::regularize_layers mom_diabatic_aux::set_pen_shortwave mom_tracer_diabatic::tracer_vertdiff diabatic subroutine, public subroutine, public mom_diabatic_driver::extract_diabatic_member (CS, opacity_CSp, optics_CSp, evap_CFL_limit, minimum_forcing_depth, KPP_CSp, energetic_PBL_CSp, diabatic_aux_CSp, diabatic_halo) extract_diabatic_member CS CS opacity_CSp opacity_CSp optics_CSp optics_CSp evap_CFL_limit evap_CFL_limit minimum_forcing_depth minimum_forcing_depth KPP_CSp KPP_CSp energetic_PBL_CSp energetic_PBL_CSp diabatic_aux_CSp diabatic_aux_CSp diabatic_halo diabatic_halo Returns pointers or values of members within the diabatic_CS type. For extensibility, each returned argument is an optional argument. cs module control structure opacity_csp A pointer to be set to the opacity control structure optics_csp A pointer to be set to the optics control structure kpp_csp A pointer to be set to the KPP CS energetic_pbl_csp A pointer to be set to the ePBL CS evap_cfl_limit The largest fraction of a layer that can be evaporated in one time-step [nondim]. minimum_forcing_depth The smallest depth over which heat and freshwater fluxes are applied [H ~> m or kg m-2]. diabatic_aux_csp A pointer to be set to the diabatic_aux control structure diabatic_halo The halo size where the diabatic algorithms assume thermodynamics properties are valid. mom_lateral_boundary_diffusion::lateral_boundary_diffusion_init mom_neutral_diffusion::neutral_diffusion_init mom_offline_main::offline_transport_init subroutine, public subroutine, public mom_diabatic_driver::adiabatic (h, tv, fluxes, dt, G, GV, US, CS) adiabatic h h tv tv fluxes fluxes dt dt G G GV GV US US CS CS Routine called for adiabatic physics. g ocean grid structure h thickness [H ~> m or kg m-2] tv points to thermodynamic fields fluxes boundary fluxes dt time step [T ~> s] gv ocean vertical grid structure us A dimensional unit scaling type cs module control structure mom_tracer_flow_control::call_tracer_column_fns subroutine subroutine mom_diabatic_driver::diagnose_diabatic_diff_tendency (tv, h, temp_old, saln_old, dt, G, GV, US, CS) diagnose_diabatic_diff_tendency tv tv h h temp_old temp_old saln_old saln_old dt dt G G GV GV US US CS CS This routine diagnoses tendencies from application of diabatic diffusion using ALE algorithm. Note that layer thickness is not altered by diabatic diffusion. g ocean grid structure gv ocean vertical grid structure tv points to updated thermodynamic fields h thickness [H ~> m or kg m-2] temp_old temperature prior to diabatic physics saln_old salinity prior to diabatic physics [ppt] dt time step [T ~> s] us A dimensional unit scaling type cs module control structure diabatic_ale diabatic_ale_legacy layered_diabatic subroutine subroutine mom_diabatic_driver::diagnose_boundary_forcing_tendency (tv, h, temp_old, saln_old, h_old, dt, G, GV, US, CS) diagnose_boundary_forcing_tendency tv tv h h temp_old temp_old saln_old saln_old h_old h_old dt dt G G GV GV US US CS CS This routine diagnoses tendencies from application of boundary fluxes. These impacts are generally 3d, in particular for penetrative shortwave. Other fluxes contribute 3d in cases when the layers vanish or are very thin, in which case we distribute the flux into k > 1 layers. g ocean grid structure gv ocean vertical grid structure tv points to updated thermodynamic fields h thickness after boundary flux application [H ~> m or kg m-2] temp_old temperature prior to boundary flux application [degC] saln_old salinity prior to boundary flux application [ppt] h_old thickness prior to boundary flux application [H ~> m or kg m-2] dt time step [T ~> s] us A dimensional unit scaling type cs module control structure diabatic_ale diabatic_ale_legacy subroutine subroutine mom_diabatic_driver::diagnose_frazil_tendency (tv, h, temp_old, dt, G, GV, US, CS) diagnose_frazil_tendency tv tv h h temp_old temp_old dt dt G G GV GV US US CS CS This routine diagnoses tendencies for temperature and heat from frazil formation. This routine is called twice from within subroutine diabatic; at start and at end of the diabatic processes. The impacts from frazil are generally a function of depth. Hence, when checking heat budget, be sure to remove HFSIFRAZIL from HFDS in k=1. g ocean grid structure gv ocean vertical grid structure tv points to updated thermodynamic fields h thickness [H ~> m or kg m-2] temp_old temperature prior to frazil formation [degC] dt time step [T ~> s] us A dimensional unit scaling type cs module control structure diabatic subroutine, public subroutine, public mom_diabatic_driver::adiabatic_driver_init (Time, G, param_file, diag, CS, tracer_flow_CSp) adiabatic_driver_init Time Time G G param_file param_file diag diag CS CS tracer_flow_CSp tracer_flow_CSp A simplified version of diabatic_driver_init that will allow tracer column functions to be called without allowing any of the diabatic processes to be used. time current model time g model grid structure param_file the file to parse for parameter values diag regulates diagnostic output cs module control structure tracer_flow_csp pointer to control structure of the tracer flow control module subroutine, public subroutine, public mom_diabatic_driver::diabatic_driver_init (Time, G, GV, US, param_file, useALEalgorithm, diag, ADp, CDp, CS, tracer_flow_CSp, sponge_CSp, ALE_sponge_CSp) diabatic_driver_init Time Time G G GV GV US US param_file param_file useALEalgorithm useALEalgorithm diag diag ADp ADp CDp CDp CS CS tracer_flow_CSp tracer_flow_CSp sponge_CSp sponge_CSp ALE_sponge_CSp ALE_sponge_CSp This routine initializes the diabatic driver module. time model time g model grid structure gv model vertical grid structure us A dimensional unit scaling type param_file file to parse for parameter values usealealgorithm logical for whether to use ALE remapping diag structure to regulate diagnostic output adp pointers to accelerations in momentum equations, to enable diagnostics, like energy budgets cdp pointers to terms in continuity equations cs module control structure tracer_flow_csp pointer to control structure of the tracer flow control module sponge_csp pointer to the sponge module control structure ale_sponge_csp pointer to the ALE sponge module control structure mom_bulk_mixed_layer::bulkmixedlayer_init mom_cvmix_ddiff::cvmix_ddiff_is_used mom_cvmix_shear::cvmix_shear_is_used mom_geothermal::geothermal_init mom_verticalgrid::get_thickness_units id_clock_differential_diff id_clock_entrain id_clock_geothermal id_clock_kpp id_clock_mixedlayer id_clock_pass id_clock_remap id_clock_set_diffusivity id_clock_sponge id_clock_tracers id_clock_tridiag mom_internal_tides::internal_tides_init mom_kappa_shear::kappa_shear_is_used mom_regularize_layers::regularize_layers_init subroutine, public subroutine, public mom_diabatic_driver::diabatic_driver_end (CS) diabatic_driver_end CS CS Routine to close the diabatic driver module. cs module control structure mom_cvmix_conv::cvmix_conv_end mom_entrain_diffusive::entrain_diffusive_end This routine drives the diabatic/dianeutral physics for MOM. By Robert Hallberg, Alistair Adcroft, and Stephen Griffies.This program contains the subroutine that, along with the subroutines that it calls, implements diapycnal mass and momentum fluxes and a bulk mixed layer. The diapycnal diffusion can be used without the bulk mixed layer. diabatic first determines the (diffusive) diapycnal mass fluxes based on the convergence of the buoyancy fluxes within each layer.The dual-stream entrainment scheme of MacDougall and Dewar (JPO, 1997) is used for combined diapycnal advection and diffusion, calculated implicitly and potentially with the Richardson number dependent mixing, as described by Hallberg (MWR, 2000).Diapycnal advection is the residual of diapycnal diffusion, so the fully implicit upwind differencing scheme that is used is entirely appropriate.The downward buoyancy flux in each layer is determined from an implicit calculation based on the previously calculated flux of the layer above and an estimated flux in the layer below. This flux is subject to the following conditions: (1) the flux in the top and bottom layers are set by the boundary conditions, and (2) no layer may be driven below an Angstrom thick- ness. If there is a bulk mixed layer, the buffer layer is treated as a fixed density layer with vanishingly small diffusivity.diabatic takes 5 arguments: the two velocities (u and v), the thicknesses (h), a structure containing the forcing fields, and the length of time over which to act (dt). The velocities and thickness are taken as inputs and modified within the subroutine. There is no limit on the time step.