mom_diagnostics mom_diagnostics::diagnostics_cs mom_diagnostics::surface_diag_ids mom_diagnostics::transport_diag_ids subroutine, public subroutine, public mom_diagnostics::calculate_diagnostic_fields (u, v, h, uh, vh, tv, ADp, CDp, p_surf, dt, diag_pre_sync, G, GV, US, CS, eta_bt) calculate_diagnostic_fields u u v v h h uh uh vh vh tv tv ADp ADp CDp CDp p_surf p_surf dt dt diag_pre_sync diag_pre_sync G G GV GV US US CS CS eta_bt eta_bt Diagnostics not more naturally calculated elsewhere are computed here. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type u The zonal velocity [L T-1 ~> m s-1]. v The meridional velocity [L T-1 ~> m s-1]. h Layer thicknesses [H ~> m or kg m-2]. uh Transport through zonal faces = u*h*dy, vh Transport through meridional faces = v*h*dx, tv A structure pointing to various thermodynamic variables. adp structure with pointers to accelerations in momentum equation. cdp structure with pointers to terms in continuity equation. p_surf A pointer to the surface pressure [R L2 T-2 ~> Pa]. If p_surf is not associated, it is the same as setting the surface pressure to 0. dt The time difference since the last call to this subroutine [T ~> s]. diag_pre_sync Target grids from previous timestep cs Control structure returned by a previous call to diagnostics_init. eta_bt An optional barotropic calculate_derivs calculate_energy_diagnostics calculate_vertical_integrals mom_diag_mediator::diag_copy_storage_to_diag mom_diag_mediator::diag_restore_grids mom_diag_mediator::diag_save_grids find_weights mom_spatial_means::global_volume_mean mom_error_handler::mom_error mom_wave_speed::wave_speed subroutine subroutine mom_diagnostics::find_weights (Rlist, R_in, k, nz, wt, wt_p) find_weights Rlist Rlist R_in R_in k k nz nz wt wt wt_p wt_p This subroutine finds the location of R_in in an increasing ordered list, Rlist, returning as k the element such that Rlist(k) <= R_in < Rlist(k+1), and where wt and wt_p are the linear weights that should be assigned to elements k and k+1. rlist The list of target densities [R ~> kg m-3] r_in The density being inserted into Rlist [R ~> kg m-3] k The value of k such that Rlist(k) <= R_in < Rlist(k+1) The input value is a first guess nz The number of layers in Rlist wt The weight of layer k for interpolation, nondim wt_p The weight of layer k+1 for interpolation, nondim calculate_diagnostic_fields subroutine subroutine mom_diagnostics::calculate_vertical_integrals (h, tv, p_surf, G, GV, US, CS) calculate_vertical_integrals h h tv tv p_surf p_surf G G GV GV US US CS CS This subroutine calculates vertical integrals of several tracers, along with the mass-weight of these tracers, the total column mass, and the carefully calculated column height. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2]. tv A structure pointing to various thermodynamic variables. p_surf A pointer to the surface pressure [R L2 T-2 ~> Pa]. If p_surf is not associated, it is the same as setting the surface pressure to 0. cs Control structure returned by a previous call to diagnostics_init. mom_density_integrals::int_density_dz calculate_diagnostic_fields subroutine subroutine mom_diagnostics::calculate_energy_diagnostics (u, v, h, uh, vh, ADp, CDp, G, GV, US, CS) calculate_energy_diagnostics u u v v h h uh uh vh vh ADp ADp CDp CDp G G GV GV US US CS CS This subroutine calculates terms in the mechanical energy budget. g The ocean's grid structure. gv The ocean's vertical grid structure. u The zonal velocity [L T-1 ~> m s-1]. v The meridional velocity [L T-1 ~> m s-1]. h Layer thicknesses [H ~> m or kg m-2]. uh Transport through zonal faces=u*h*dy, vh Transport through merid faces=v*h*dx, adp Structure pointing to accelerations in momentum equation. cdp Structure pointing to terms in continuity equations. us A dimensional unit scaling type cs Control structure returned by a previous call to diagnostics_init. calculate_diagnostic_fields subroutine, public subroutine, public mom_diagnostics::register_time_deriv (lb, f_ptr, deriv_ptr, CS) register_time_deriv lb lb f_ptr f_ptr deriv_ptr deriv_ptr CS CS This subroutine registers fields to calculate a diagnostic time derivative. lb Lower index bound of f_ptr f_ptr Time derivative operand deriv_ptr Time derivative of f_ptr cs Control structure returned by previous call to diagnostics_init. mom_error_handler::mom_error mom_diagnostics_init set_dependent_diagnostics subroutine subroutine mom_diagnostics::calculate_derivs (dt, G, CS) calculate_derivs dt dt G G CS CS This subroutine calculates all registered time derivatives. dt The time interval over which differences occur [T ~> s]. g The ocean's grid structure. cs Control structure returned by previous call to diagnostics_init. calculate_diagnostic_fields subroutine, public subroutine, public mom_diagnostics::post_surface_dyn_diags (IDs, G, diag, sfc_state, ssh) post_surface_dyn_diags IDs IDs G G diag diag sfc_state sfc_state ssh ssh This routine posts diagnostics of various dynamic ocean surface quantities, including velocities, speed and sea surface height, at the time the ocean state is reported back to the caller. ids A structure with the diagnostic IDs. g ocean grid structure diag regulates diagnostic output sfc_state structure describing the ocean surface state ssh Time mean surface height without corrections for ice displacement [m] subroutine, public subroutine, public mom_diagnostics::post_surface_thermo_diags (IDs, G, GV, US, diag, dt_int, sfc_state, tv, ssh, ssh_ibc) post_surface_thermo_diags IDs IDs G G GV GV US US diag diag dt_int dt_int sfc_state sfc_state tv tv ssh ssh ssh_ibc ssh_ibc This routine posts diagnostics of various ocean surface and integrated quantities at the time the ocean state is reported back to the caller. ids A structure with the diagnostic IDs. g ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type diag regulates diagnostic output dt_int total time step associated with these diagnostics [T ~> s]. sfc_state structure describing the ocean surface state tv A structure pointing to various thermodynamic variables ssh Time mean surface height without corrections for ice displacement [m] ssh_ibc Time mean surface height with corrections for ice displacement and the inverse barometer [m] mom_spatial_means::global_area_integral subroutine, public subroutine, public mom_diagnostics::post_transport_diagnostics (G, GV, US, uhtr, vhtr, h, IDs, diag_pre_dyn, diag, dt_trans, Reg) post_transport_diagnostics G G GV GV US US uhtr uhtr vhtr vhtr h h IDs IDs diag_pre_dyn diag_pre_dyn diag diag dt_trans dt_trans Reg Reg This routine posts diagnostics of the transports, including the subgridscale contributions. g ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type uhtr Accumulated zonal thickness fluxes used to advect tracers [H L2 ~> m3 or kg] vhtr Accumulated meridional thickness fluxes used to advect tracers [H L2 ~> m3 or kg] h The updated layer thicknesses [H ~> m or kg m-2] ids A structure with the diagnostic IDs. diag_pre_dyn Stored grids from before dynamics diag regulates diagnostic output dt_trans total time step associated with the transports [T ~> s]. reg Pointer to the tracer registry mom_diag_mediator::diag_copy_storage_to_diag mom_diag_mediator::diag_restore_grids mom_diag_mediator::diag_save_grids mom_tracer_registry::post_tracer_transport_diagnostics subroutine, public subroutine, public mom_diagnostics::mom_diagnostics_init (MIS, ADp, CDp, Time, G, GV, US, param_file, diag, CS, tv) mom_diagnostics_init MIS MIS ADp ADp CDp CDp Time Time G G GV GV US US param_file param_file diag diag CS CS tv tv This subroutine registers various diagnostics and allocates space for fields that other diagnostis depend upon. mis For "MOM Internal State" a set of pointers to the fields and accelerations that make up the ocean's internal physical state. adp Structure with pointers to momentum equation terms. cdp Structure with pointers to continuity equation terms. time Current model time. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type param_file A structure to parse for run-time parameters. diag Structure to regulate diagnostic output. cs Pointer set to point to control structure for this module. tv A structure pointing to various thermodynamic variables. mom_error_handler::mom_error register_time_deriv set_dependent_diagnostics mom_wave_speed::wave_speed_init subroutine, public subroutine, public mom_diagnostics::register_surface_diags (Time, G, US, IDs, diag, tv) register_surface_diags Time Time G G US US IDs IDs diag diag tv tv Register diagnostics of the surface state and integrated quantities. time current model time g ocean grid structure us A dimensional unit scaling type ids A structure with the diagnostic IDs. diag regulates diagnostic output tv A structure pointing to various thermodynamic variables subroutine, public subroutine, public mom_diagnostics::register_transport_diags (Time, G, GV, US, IDs, diag) register_transport_diags Time Time G G GV GV US US IDs IDs diag diag Register certain diagnostics related to transports. time current model time g ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type ids A structure with the diagnostic IDs. diag regulates diagnostic output mom_verticalgrid::get_thickness_units subroutine, public subroutine, public mom_diagnostics::write_static_fields (G, GV, US, tv, diag) write_static_fields G G GV GV US US tv tv diag diag Offers the static fields in the ocean grid type for output via the diag_manager. g ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type tv A structure pointing to various thermodynamic variables diag regulates diagnostic output subroutine subroutine mom_diagnostics::set_dependent_diagnostics (MIS, ADp, CDp, G, CS) set_dependent_diagnostics MIS MIS ADp ADp CDp CDp G G CS CS This subroutine sets up diagnostics upon which other diagnostics depend. mis For "MOM Internal State" a set of pointers to the fields and accelerations making up ocean internal physical state. adp Structure pointing to accelerations in momentum equation. cdp Structure pointing to terms in continuity equation. g The ocean's grid structure. cs Pointer to the control structure for this module. register_time_deriv mom_diagnostics_init subroutine, public subroutine, public mom_diagnostics::mom_diagnostics_end (CS, ADp) mom_diagnostics_end CS CS ADp ADp Deallocate memory associated with the diagnostics module. cs Control structure returned by a previous call to diagnostics_init. adp structure with pointers to accelerations in momentum equation. Calculates any requested diagnostic quantities that are not calculated in the various subroutines. Diagnostic quantities are requested by allocating them memory.