mom_sum_output mom_sum_output::depth_list mom_sum_output::sum_output_cs integer, parameter integer, parameter mom_sum_output::num_fields num_fields = 17 Number of diagnostic fields. character(*), parameter character (*), parameter mom_sum_output::depth_chksum_attr depth_chksum_attr = "bathyT_checksum" Checksum attribute name of GbathyT over the compute domain. read_depth_list write_depth_list character(*), parameter character (*), parameter mom_sum_output::area_chksum_attr area_chksum_attr = "mask2dT_areaT_checksum" Checksum attribute of name of Gmask2dT * GareaT over the compute domain. read_depth_list write_depth_list subroutine, public subroutine, public mom_sum_output::mom_sum_output_init (G, US, param_file, directory, ntrnc, Input_start_time, CS) mom_sum_output_init G G US US param_file param_file directory directory ntrnc ntrnc Input_start_time Input_start_time CS CS MOM_sum_output_init initializes the parameters and settings for the MOM_sum_output module. g The ocean's grid structure. us A dimensional unit scaling type param_file A structure to parse for run-time parameters. directory The directory where the energy file goes. ntrnc The integer that stores the number of times the velocity has been truncated since the last call to write_energy. input_start_time The start time of the simulation. cs A pointer that is set to point to the control structure for this module. depth_list_setup mom_error_handler::mom_error mom::initialize_mom subroutine subroutine mom_sum_output::mom_sum_output_end (CS) mom_sum_output_end CS CS MOM_sum_output_end deallocates memory used by the MOM_sum_output module. cs The control structure returned by a previous call to MOM_sum_output_init. subroutine, public subroutine, public mom_sum_output::write_energy (u, v, h, tv, day, n, G, GV, US, CS, tracer_CSp, OBC, dt_forcing) write_energy u u v v h h tv tv day day n n G G GV GV US US CS CS tracer_CSp tracer_CSp OBC OBC dt_forcing dt_forcing This subroutine calculates and writes the total model energy, the energy and mass of each layer, and other globally integrated physical quantities. 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]. tv A structure pointing to various thermodynamic variables. day The current model time. n The time step number of the current execution. cs The control structure returned by a previous call to MOM_sum_output_init. tracer_csp tracer control structure. obc Open boundaries control structure. dt_forcing The forcing time step mom_tracer_flow_control::call_tracer_stocks mom_error_handler::is_root_pe mom_error_handler::mom_error mom_open_boundary::obc_direction_e mom_open_boundary::obc_direction_n mom_open_boundary::obc_direction_s mom_open_boundary::obc_direction_w subroutine, public subroutine, public mom_sum_output::accumulate_net_input (fluxes, sfc_state, tv, dt, G, US, CS) accumulate_net_input fluxes fluxes sfc_state sfc_state tv tv dt dt G G US US CS CS This subroutine accumates the net input of volume, salt and heat, through the ocean surface for use in diagnosing conservation. fluxes A structure containing pointers to any possible forcing fields. Unused fields are unallocated. sfc_state A structure containing fields that describe the surface state of the ocean. tv A structure pointing to various thermodynamic variables. dt The amount of time over which to average [T ~> s]. g The ocean's grid structure. us A dimensional unit scaling type cs The control structure returned by a previous call to MOM_sum_output_init. mom_error_handler::mom_error subroutine subroutine mom_sum_output::depth_list_setup (G, US, CS) depth_list_setup G G US US CS CS This subroutine sets up an ordered list of depths, along with the cross sectional areas at each depth and the volume of fluid deeper than each depth. This might be read from a previously created file or it might be created anew. (For now only new creation occurs. g The ocean's grid structure us A dimensional unit scaling type cs The control structure returned by a previous call to MOM_sum_output_init. create_depth_list mom_error_handler::is_root_pe mom_error_handler::mom_error read_depth_list write_depth_list mom_sum_output_init subroutine subroutine mom_sum_output::create_depth_list (G, CS) create_depth_list G G CS CS create_depth_list makes an ordered list of depths, along with the cross sectional areas at each depth and the volume of fluid deeper than each depth. g The ocean's grid structure. cs The control structure set up in MOM_sum_output_init, in which the ordered depth list is stored. depth_list_setup read_depth_list subroutine subroutine mom_sum_output::write_depth_list (G, US, CS, filename, list_size) write_depth_list G G US US CS CS filename filename list_size list_size This subroutine writes out the depth list to the specified file. g The ocean's grid structure. us A dimensional unit scaling type cs The control structure returned by a previous call to MOM_sum_output_init. filename The path to the depth list file to write. list_size The size of the depth list. area_chksum_attr depth_chksum_attr get_depth_list_checksums mom_error_handler::is_root_pe mom_error_handler::mom_error depth_list_setup read_depth_list subroutine subroutine mom_sum_output::read_depth_list (G, US, CS, filename) read_depth_list G G US US CS CS filename filename This subroutine reads in the depth list to the specified file and allocates and sets up CSDL and CSlist_size . g The ocean's grid structure us A dimensional unit scaling type cs The control structure returned by a previous call to MOM_sum_output_init. filename The path to the depth list file to read. area_chksum_attr create_depth_list depth_chksum_attr get_depth_list_checksums mom_error_handler::mom_error write_depth_list depth_list_setup subroutine subroutine mom_sum_output::get_depth_list_checksums (G, depth_chksum, area_chksum) get_depth_list_checksums G G depth_chksum depth_chksum area_chksum area_chksum Return the checksums required to verify DEPTH_LIST_FILE contents. This function computes checksums for the bathymetry (GbathyT) and masked area (mask2dT * areaT) fields of the model grid G, which are used to compute the depth list. A difference in checksum indicates that a different method was used to compute the grid data, and that any results using the depth list, such as APE, will not be reproducible. Checksums are saved as hexadecimal strings, in order to avoid potential datatype issues with netCDF attributes. g Ocean grid structure depth_chksum Depth checksum hexstring area_chksum Area checksum hexstring read_depth_list write_depth_list Reports integrated quantities for monitoring the model state. By Robert Hallberg, April 1994 - June 2002 This file contains the subroutine (write_energy) that writes horizontally integrated quantities, such as energies and layer volumes, and other summary information to an output file. Some of these quantities (APE or resting interface height) are defined relative to the global histogram of topography. The subroutine that compiles that histogram (depth_list_setup) is also included in this file. In addition, if the number of velocity truncations since the previous call to write_energy exceeds maxtrunc or the total energy exceeds a very large threshold, a fatal termination is triggered.