mom::mom_control_struct real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::h h layer thickness [H ~> m or kg m-2] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::t t potential temperature [degC] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::s s salinity [ppt] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::u u zonal velocity component [L T-1 ~> m s-1] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::uh uh uh = u * h * dy at u grid points [H L2 T-1 ~> m3 s-1 or kg s-1] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::uhtr uhtr accumulated zonal thickness fluxes to advect tracers [H L2 ~> m3 or kg] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::v v meridional velocity [L T-1 ~> m s-1] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::vh vh vh = v * h * dx at v grid points [H L2 T-1 ~> m3 s-1 or kg s-1] real, dimension(:, :, :), allocatable real, dimension( : , : , : ), allocatable mom::mom_control_struct::vhtr vhtr accumulated meridional thickness fluxes to advect tracers [H L2 ~> m3 or kg] real, dimension(:, :), allocatable real, dimension( : , : ), allocatable mom::mom_control_struct::ssh_rint ssh_rint A running time integral of the sea surface height [T m ~> s m]. real, dimension(:, :), allocatable real, dimension( : , : ), allocatable mom::mom_control_struct::ave_ssh_ibc ave_ssh_ibc time-averaged (over a forcing time step) sea surface height with a correction for the inverse barometer [m] real, dimension(:, :), allocatable real, dimension( : , : ), allocatable mom::mom_control_struct::eta_av_bc eta_av_bc free surface height or column mass time averaged over the last baroclinic dynamics time step [H ~> m or kg m-2] real, dimension(:,:), pointer real, dimension(:,:), pointer mom::mom_control_struct::hml hml => NULL() active mixed layer depth [Z ~> m] real real mom::mom_control_struct::time_in_cycle time_in_cycle The running time of the current time-stepping cycle in calls that step the dynamics, and also the length of the time integral of ssh_rint [T ~> s]. real real mom::mom_control_struct::time_in_thermo_cycle time_in_thermo_cycle The running time of the current time-stepping cycle in calls that step the thermodynamics [T ~> s]. type(ocean_grid_type) type(ocean_grid_type) mom::mom_control_struct::g_in g_in Input grid metric. type(ocean_grid_type), pointer type(ocean_grid_type), pointer mom::mom_control_struct::g g => NULL() Model grid metric. logical logical mom::mom_control_struct::rotate_index rotate_index = .false. True if index map is rotated. type(verticalgrid_type), pointer type(verticalgrid_type), pointer mom::mom_control_struct::gv gv => NULL() structure containing vertical grid info type(unit_scale_type), pointer type(unit_scale_type), pointer mom::mom_control_struct::us us => NULL() structure containing various unit conversion factors type(thermo_var_ptrs) type(thermo_var_ptrs) mom::mom_control_struct::tv tv structure containing pointers to available thermodynamic fields real real mom::mom_control_struct::t_dyn_rel_adv t_dyn_rel_adv The time of the dynamics relative to tracer advection and lateral mixing [T ~> s], or equivalently the elapsed time since advectively updating the tracers. t_dyn_rel_adv is invariably positive and may span multiple coupling timesteps. real real mom::mom_control_struct::t_dyn_rel_thermo t_dyn_rel_thermo The time of the dynamics relative to diabatic processes and remapping [T ~> s]. t_dyn_rel_thermo can be negative or positive depending on whether the diabatic processes are applied before or after the dynamics and may span multiple coupling timesteps. real real mom::mom_control_struct::t_dyn_rel_diag t_dyn_rel_diag The time of the diagnostics relative to diabatic processes and remapping [T ~> s]. t_dyn_rel_diag is always positive, since the diagnostics must lag. logical logical mom::mom_control_struct::preadv_h_stored preadv_h_stored = .false. If true, the thicknesses from before the advective cycle have been stored for use in diagnostics. type(diag_ctrl) type(diag_ctrl) mom::mom_control_struct::diag diag structure to regulate diagnostic output timing type(vertvisc_type) type(vertvisc_type) mom::mom_control_struct::visc visc structure containing vertical viscosities, bottom drag viscosities, and related fields type(meke_type), pointer type(meke_type), pointer mom::mom_control_struct::meke meke => NULL() structure containing fields related to the Mesoscale Eddy Kinetic Energy logical logical mom::mom_control_struct::adiabatic adiabatic If true, there are no diapycnal mass fluxes, and no calls to routines to calculate or apply diapycnal fluxes. logical logical mom::mom_control_struct::diabatic_first diabatic_first If true, apply diabatic and thermodynamic processes before time stepping the dynamics. logical logical mom::mom_control_struct::use_ale_algorithm use_ale_algorithm If true, use the ALE algorithm rather than layered isopycnal/stacked shallow water mode. This logical is set by calling the function useRegridding() from the MOM_regridding module. logical logical mom::mom_control_struct::offline_tracer_mode offline_tracer_mode = .false. If true, step_offline() is called instead of step_MOM(). This is intended for running MOM6 in offline tracer mode. type(time_type), pointer type(time_type), pointer mom::mom_control_struct::time time pointer to the ocean clock real real mom::mom_control_struct::dt dt (baroclinic) dynamics time step [T ~> s] real real mom::mom_control_struct::dt_therm dt_therm thermodynamics time step [T ~> s] logical logical mom::mom_control_struct::thermo_spans_coupling thermo_spans_coupling If true, thermodynamic and tracer time steps can span multiple coupled time steps. integer integer mom::mom_control_struct::nstep_tot nstep_tot = 0 The total number of dynamic timesteps tcaaken so far in this run segment. logical logical mom::mom_control_struct::count_calls count_calls = .false. If true, count the calls to step_MOM, rather than the number of dynamics steps in nstep_tot. logical logical mom::mom_control_struct::debug debug If true, write verbose checksums for debugging purposes. integer integer mom::mom_control_struct::ntrunc ntrunc number u,v truncations since last call to write_energy integer integer mom::mom_control_struct::cont_stencil cont_stencil The stencil for thickness from the continuity solver. logical logical mom::mom_control_struct::do_dynamics do_dynamics If false, does not call step_MOM_dyn_*. This is an undocumented run-time flag that is fragile. logical logical mom::mom_control_struct::split split If true, use the split time stepping scheme. logical logical mom::mom_control_struct::use_rk2 use_rk2 If true, use RK2 instead of RK3 in unsplit mode (i.e., no split between barotropic and baroclinic). logical logical mom::mom_control_struct::thickness_diffuse thickness_diffuse If true, diffuse interface height w/ a diffusivity KHTH. logical logical mom::mom_control_struct::thickness_diffuse_first thickness_diffuse_first If true, diffuse thickness before dynamics. logical logical mom::mom_control_struct::mixedlayer_restrat mixedlayer_restrat If true, use submesoscale mixed layer restratifying scheme. logical logical mom::mom_control_struct::usemeke usemeke If true, call the MEKE parameterization. logical logical mom::mom_control_struct::usewaves usewaves If true, update Stokes drift. logical logical mom::mom_control_struct::use_p_surf_in_eos use_p_surf_in_eos If true, always include the surface pressure contributions in equation of state calculations. real real mom::mom_control_struct::dtbt_reset_period dtbt_reset_period The time interval between dynamic recalculation of the barotropic time step [s]. If this is negative dtbt is never calculated, and if it is 0, dtbt is calculated every step. type(time_type) type(time_type) mom::mom_control_struct::dtbt_reset_interval dtbt_reset_interval A time_time representation of dtbt_reset_period. type(time_type) type(time_type) mom::mom_control_struct::dtbt_reset_time dtbt_reset_time The next time DTBT should be calculated. real, dimension(:,:,:), pointer real, dimension(:,:,:), pointer mom::mom_control_struct::h_pre_dyn h_pre_dyn => NULL() The thickness before the transports [H ~> m or kg m-2]. real, dimension(:,:,:), pointer real, dimension(:,:,:), pointer mom::mom_control_struct::t_pre_dyn t_pre_dyn => NULL() Temperature before the transports [degC]. real, dimension(:,:,:), pointer real, dimension(:,:,:), pointer mom::mom_control_struct::s_pre_dyn s_pre_dyn => NULL() Salinity before the transports [ppt]. type(accel_diag_ptrs) type(accel_diag_ptrs) mom::mom_control_struct::adp adp structure containing pointers to accelerations, for derived diagnostics (e.g., energy budgets) type(cont_diag_ptrs) type(cont_diag_ptrs) mom::mom_control_struct::cdp cdp structure containing pointers to continuity equation terms, for derived diagnostics (e.g., energy budgets) real, dimension(:,:,:), pointer real, dimension(:,:,:), pointer mom::mom_control_struct::u_prev u_prev => NULL() previous value of u stored for diagnostics [L T-1 ~> m s-1] real, dimension(:,:,:), pointer real, dimension(:,:,:), pointer mom::mom_control_struct::v_prev v_prev => NULL() previous value of v stored for diagnostics [L T-1 ~> m s-1] logical logical mom::mom_control_struct::interp_p_surf interp_p_surf If true, linearly interpolate surface pressure over the coupling time step, using specified value at the end of the coupling step. False by default. logical logical mom::mom_control_struct::p_surf_prev_set p_surf_prev_set If true, p_surf_prev has been properly set from a previous time-step or the ocean restart file. This is only valid when interp_p_surf is true. real, dimension(:,:), pointer real, dimension(:,:), pointer mom::mom_control_struct::p_surf_prev p_surf_prev => NULL() surface pressure [R L2 T-2 ~> Pa] at end previous call to step_MOM real, dimension(:,:), pointer real, dimension(:,:), pointer mom::mom_control_struct::p_surf_begin p_surf_begin => NULL() surface pressure [R L2 T-2 ~> Pa] at start of step_MOM_dyn_... real, dimension(:,:), pointer real, dimension(:,:), pointer mom::mom_control_struct::p_surf_end p_surf_end => NULL() surface pressure [R L2 T-2 ~> Pa] at end of step_MOM_dyn_... logical logical mom::mom_control_struct::write_ic write_ic If true, then the initial conditions will be written to file. character(len=120) character(len=120) mom::mom_control_struct::ic_file ic_file A file into which the initial conditions are written in a new run if SAVE_INITIAL_CONDS is true. logical logical mom::mom_control_struct::calc_rho_for_sea_lev calc_rho_for_sea_lev If true, calculate rho to convert pressure to sea level. real real mom::mom_control_struct::hmix hmix Diagnostic mixed layer thickness over which to average surface tracer properties when a bulk mixed layer is not used [Z ~> m], or a negative value if a bulk mixed layer is being used. real real mom::mom_control_struct::hfrz hfrz If HFrz > 0, the nominal depth over which melt potential is computed [Z ~> m]. The actual depth over which melt potential is computed is min(HFrz, OBLD), where OBLD is the boundary layer depth. If HFrz <= 0 (default), melt potential will not be computed. real real mom::mom_control_struct::hmix_uv hmix_uv Depth scale over which to average surface flow to feedback to the coupler/driver [Z ~> m] when bulk mixed layer is not used, or a negative value if a bulk mixed layer is being used. logical logical mom::mom_control_struct::check_bad_sfc_vals check_bad_sfc_vals If true, scan surface state for ridiculous values. real real mom::mom_control_struct::bad_val_ssh_max bad_val_ssh_max Maximum SSH before triggering bad value message [Z ~> m]. real real mom::mom_control_struct::bad_val_sst_max bad_val_sst_max Maximum SST before triggering bad value message [degC]. real real mom::mom_control_struct::bad_val_sst_min bad_val_sst_min Minimum SST before triggering bad value message [degC]. real real mom::mom_control_struct::bad_val_sss_max bad_val_sss_max Maximum SSS before triggering bad value message [ppt]. real real mom::mom_control_struct::bad_val_col_thick bad_val_col_thick Minimum column thickness before triggering bad value message [Z ~> m]. logical logical mom::mom_control_struct::answers_2018 answers_2018 If true, use expressions for the surface properties that recover the answers from the end of 2018. Otherwise, use more appropriate expressions that differ at roundoff for non-Boussinsq cases. type(mom_diag_ids) type(mom_diag_ids) mom::mom_control_struct::ids ids Handles used for diagnostics. type(transport_diag_ids) type(transport_diag_ids) mom::mom_control_struct::transport_ids transport_ids Handles used for transport diagnostics. type(surface_diag_ids) type(surface_diag_ids) mom::mom_control_struct::sfc_ids sfc_ids Handles used for surface diagnostics. type(diag_grid_storage) type(diag_grid_storage) mom::mom_control_struct::diag_pre_sync diag_pre_sync The grid (thicknesses) before remapping. type(diag_grid_storage) type(diag_grid_storage) mom::mom_control_struct::diag_pre_dyn diag_pre_dyn The grid (thicknesses) before dynamics. type(mom_dyn_unsplit_cs), pointer type(mom_dyn_unsplit_cs), pointer mom::mom_control_struct::dyn_unsplit_csp dyn_unsplit_csp => NULL() Pointer to the control structure used for the unsplit dynamics. type(mom_dyn_unsplit_rk2_cs), pointer type(mom_dyn_unsplit_rk2_cs), pointer mom::mom_control_struct::dyn_unsplit_rk2_csp dyn_unsplit_rk2_csp => NULL() Pointer to the control structure used for the unsplit RK2 dynamics. type(mom_dyn_split_rk2_cs), pointer type(mom_dyn_split_rk2_cs), pointer mom::mom_control_struct::dyn_split_rk2_csp dyn_split_rk2_csp => NULL() Pointer to the control structure used for the mode-split RK2 dynamics. type(thickness_diffuse_cs), pointer type(thickness_diffuse_cs), pointer mom::mom_control_struct::thickness_diffuse_csp thickness_diffuse_csp => NULL() Pointer to the control structure used for the isopycnal height diffusive transport. This is also common referred to as Gent-McWilliams diffusion. type(mixedlayer_restrat_cs), pointer type(mixedlayer_restrat_cs), pointer mom::mom_control_struct::mixedlayer_restrat_csp mixedlayer_restrat_csp => NULL() Pointer to the control structure used for the mixed layer restratification. type(set_visc_cs), pointer type(set_visc_cs), pointer mom::mom_control_struct::set_visc_csp set_visc_csp => NULL() Pointer to the control structure used to set viscosities. type(diabatic_cs), pointer type(diabatic_cs), pointer mom::mom_control_struct::diabatic_csp diabatic_csp => NULL() Pointer to the control structure for the diabatic driver. type(meke_cs), pointer type(meke_cs), pointer mom::mom_control_struct::meke_csp meke_csp => NULL() Pointer to the control structure for the MEKE updates. type(varmix_cs), pointer type(varmix_cs), pointer mom::mom_control_struct::varmix varmix => NULL() Pointer to the control structure for the variable mixing module. type(barotropic_cs), pointer type(barotropic_cs), pointer mom::mom_control_struct::barotropic_csp barotropic_csp => NULL() Pointer to the control structure for the barotropic module. type(tracer_registry_type), pointer type(tracer_registry_type), pointer mom::mom_control_struct::tracer_reg tracer_reg => NULL() Pointer to the MOM tracer registry. type(tracer_advect_cs), pointer type(tracer_advect_cs), pointer mom::mom_control_struct::tracer_adv_csp tracer_adv_csp => NULL() Pointer to the MOM tracer advection control structure. type(tracer_hor_diff_cs), pointer type(tracer_hor_diff_cs), pointer mom::mom_control_struct::tracer_diff_csp tracer_diff_csp => NULL() Pointer to the MOM along-isopycnal tracer diffusion control structure. type(tracer_flow_control_cs), pointer type(tracer_flow_control_cs), pointer mom::mom_control_struct::tracer_flow_csp tracer_flow_csp => NULL() Pointer to the control structure that orchestrates the calling of tracer packages. type(update_obc_cs), pointer type(update_obc_cs), pointer mom::mom_control_struct::update_obc_csp update_obc_csp => NULL() Pointer to the control structure for updating open boundary condition properties. type(ocean_obc_type), pointer type(ocean_obc_type), pointer mom::mom_control_struct::obc obc => NULL() Pointer to the MOM open boundary condition type. type(sponge_cs), pointer type(sponge_cs), pointer mom::mom_control_struct::sponge_csp sponge_csp => NULL() Pointer to the layered-mode sponge control structure. type(ale_sponge_cs), pointer type(ale_sponge_cs), pointer mom::mom_control_struct::ale_sponge_csp ale_sponge_csp => NULL() Pointer to the ALE-mode sponge control structure. type(ale_cs), pointer type(ale_cs), pointer mom::mom_control_struct::ale_csp ale_csp => NULL() Pointer to the Arbitrary Lagrangian Eulerian (ALE) vertical coordinate control structure. type(sum_output_cs), pointer type(sum_output_cs), pointer mom::mom_control_struct::sum_output_csp sum_output_csp => NULL() Pointer to the globally summed output control structure. type(diagnostics_cs), pointer type(diagnostics_cs), pointer mom::mom_control_struct::diagnostics_csp diagnostics_csp => NULL() Pointer to the MOM diagnostics control structure. type(offline_transport_cs), pointer type(offline_transport_cs), pointer mom::mom_control_struct::offline_csp offline_csp => NULL() Pointer to the offline tracer transport control structure. logical logical mom::mom_control_struct::ensemble_ocean ensemble_ocean if true, this run is part of a larger ensemble for the purpose of data assimilation or statistical analysis. type(oda_cs), pointer type(oda_cs), pointer mom::mom_control_struct::odacs odacs => NULL() a pointer to the control structure for handling ensemble model state vectors and data assimilation increments and priors Control structure for the MOM module, including the variables that describe the state of the ocean. type(diabatic_cs), pointer type(update_obc_cs), pointer real unit_scale_type type(transport_diag_ids) ocean_grid_type character(len=120) type(tracer_hor_diff_cs), pointer type(sponge_cs), pointer type(mom_dyn_unsplit_rk2_cs), pointer cont_diag_ptrs type(verticalgrid_type), pointer type(oda_cs), pointer type(offline_transport_cs), pointer type(meke_type), pointer type(tracer_flow_control_cs), pointer type(diagnostics_cs), pointer logical type(ale_cs), pointer mom::mom_diag_ids id_u id_v id_h id_ssh_inst type(tracer_advect_cs), pointer time_type type(set_visc_cs), pointer ocean_obc_type diag_grid_storage vertvisc_type type(mom_dyn_split_rk2_cs), pointer thermo_var_ptrs type(sum_output_cs), pointer type(surface_diag_ids) diag_ctrl type(mixedlayer_restrat_cs), pointer type(varmix_cs), pointer integer mom::mom_control_struct diagnostics_csp ale_csp tracer_diff_csp thickness_diffuse_csp sfc_ids thickness_diffuse use_ale_algorithm rotate_index answers_2018 split count_calls usemeke thermo_spans_coupling check_bad_sfc_vals use_rk2 ... odacs obc diabatic_csp dyn_split_rk2_csp us barotropic_csp dtbt_reset_time dtbt_reset_interval time tracer_flow_csp ic_file tracer_reg set_visc_csp cdp mixedlayer_restrat_csp tv update_obc_csp offline_csp ale_sponge_csp varmix dyn_unsplit_rk2_csp ids dyn_unsplit_csp meke tracer_adv_csp sum_output_csp diag diag_pre_dyn diag_pre_sync transport_ids visc sponge_csp meke_csp nstep_tot cont_stencil ntrunc gv g g_in h_pre_dyn p_surf_end hml vhtr p_surf_prev ave_ssh_ibc uhtr h hmix dt_therm ... adp type(ale_sponge_cs), pointer type(meke_cs), pointer type(barotropic_cs), pointer tracer_registry_type type(mom_dyn_unsplit_cs), pointer accel_diag_ptrs type(thickness_diffuse_cs), pointer mom::mom_control_structadiabatic mom::mom_control_structadp mom::mom_control_structale_csp mom::mom_control_structale_sponge_csp mom::mom_control_structanswers_2018 mom::mom_control_structave_ssh_ibc mom::mom_control_structbad_val_col_thick mom::mom_control_structbad_val_ssh_max mom::mom_control_structbad_val_sss_max mom::mom_control_structbad_val_sst_max mom::mom_control_structbad_val_sst_min mom::mom_control_structbarotropic_csp mom::mom_control_structcalc_rho_for_sea_lev mom::mom_control_structcdp mom::mom_control_structcheck_bad_sfc_vals mom::mom_control_structcont_stencil mom::mom_control_structcount_calls mom::mom_control_structdebug mom::mom_control_structdiabatic_csp mom::mom_control_structdiabatic_first mom::mom_control_structdiag mom::mom_control_structdiag_pre_dyn mom::mom_control_structdiag_pre_sync mom::mom_control_structdiagnostics_csp mom::mom_control_structdo_dynamics mom::mom_control_structdt mom::mom_control_structdt_therm mom::mom_control_structdtbt_reset_interval mom::mom_control_structdtbt_reset_period mom::mom_control_structdtbt_reset_time mom::mom_control_structdyn_split_rk2_csp mom::mom_control_structdyn_unsplit_csp mom::mom_control_structdyn_unsplit_rk2_csp mom::mom_control_structensemble_ocean mom::mom_control_structeta_av_bc mom::mom_control_structg mom::mom_control_structg_in mom::mom_control_structgv mom::mom_control_structh mom::mom_control_structh_pre_dyn mom::mom_control_structhfrz mom::mom_control_structhmix mom::mom_control_structhmix_uv mom::mom_control_structhml mom::mom_control_structic_file mom::mom_control_structids mom::mom_control_structinterp_p_surf mom::mom_control_structmeke mom::mom_control_structmeke_csp mom::mom_control_structmixedlayer_restrat mom::mom_control_structmixedlayer_restrat_csp mom::mom_control_structnstep_tot mom::mom_control_structntrunc mom::mom_control_structobc mom::mom_control_structodacs mom::mom_control_structoffline_csp mom::mom_control_structoffline_tracer_mode mom::mom_control_structp_surf_begin mom::mom_control_structp_surf_end mom::mom_control_structp_surf_prev mom::mom_control_structp_surf_prev_set mom::mom_control_structpreadv_h_stored mom::mom_control_structrotate_index mom::mom_control_structs mom::mom_control_structs_pre_dyn mom::mom_control_structset_visc_csp mom::mom_control_structsfc_ids mom::mom_control_structsplit mom::mom_control_structsponge_csp mom::mom_control_structssh_rint mom::mom_control_structsum_output_csp mom::mom_control_structt mom::mom_control_structt_dyn_rel_adv mom::mom_control_structt_dyn_rel_diag mom::mom_control_structt_dyn_rel_thermo mom::mom_control_structt_pre_dyn mom::mom_control_structthermo_spans_coupling mom::mom_control_structthickness_diffuse mom::mom_control_structthickness_diffuse_csp mom::mom_control_structthickness_diffuse_first mom::mom_control_structtime mom::mom_control_structtime_in_cycle mom::mom_control_structtime_in_thermo_cycle mom::mom_control_structtracer_adv_csp mom::mom_control_structtracer_diff_csp mom::mom_control_structtracer_flow_csp mom::mom_control_structtracer_reg mom::mom_control_structtransport_ids mom::mom_control_structtv mom::mom_control_structu mom::mom_control_structu_prev mom::mom_control_structuh mom::mom_control_structuhtr mom::mom_control_structupdate_obc_csp mom::mom_control_structus mom::mom_control_structuse_ale_algorithm mom::mom_control_structuse_p_surf_in_eos mom::mom_control_structuse_rk2 mom::mom_control_structusemeke mom::mom_control_structusewaves mom::mom_control_structv mom::mom_control_structv_prev mom::mom_control_structvarmix mom::mom_control_structvh mom::mom_control_structvhtr mom::mom_control_structvisc mom::mom_control_structwrite_ic