mom_tracer_registry mom_tracer_registry::tracer_registry_type mom_tracer_registry::tracer_type subroutine, public subroutine, public mom_tracer_registry::register_tracer (tr_ptr, Reg, param_file, HI, GV, name, longname, units, cmor_name, cmor_units, cmor_longname, tr_desc, OBC_inflow, OBC_in_u, OBC_in_v, ad_x, ad_y, df_x, df_y, ad_2d_x, ad_2d_y, df_2d_x, df_2d_y, advection_xy, registry_diags, flux_nameroot, flux_longname, flux_units, flux_scale, convergence_units, convergence_scale, cmor_tendprefix, diag_form, restart_CS, mandatory) register_tracer tr_ptr tr_ptr Reg Reg param_file param_file HI HI GV GV name name longname longname units units cmor_name cmor_name cmor_units cmor_units cmor_longname cmor_longname tr_desc tr_desc OBC_inflow OBC_inflow OBC_in_u OBC_in_u OBC_in_v OBC_in_v ad_x ad_x ad_y ad_y df_x df_x df_y df_y ad_2d_x ad_2d_x ad_2d_y ad_2d_y df_2d_x df_2d_x df_2d_y df_2d_y advection_xy advection_xy registry_diags registry_diags flux_nameroot flux_nameroot flux_longname flux_longname flux_units flux_units flux_scale flux_scale convergence_units convergence_units convergence_scale convergence_scale cmor_tendprefix cmor_tendprefix diag_form diag_form restart_CS restart_CS mandatory mandatory This subroutine registers a tracer to be advected and laterally diffused. hi horizontal index type gv ocean vertical grid structure reg pointer to the tracer registry tr_ptr target or pointer to the tracer array param_file file to parse for model parameter values name Short tracer name longname The long tracer name units The units of this tracer cmor_name CMOR name cmor_units CMOR physical dimensions of variable cmor_longname CMOR long name tr_desc A structure with metadata about the tracer obc_inflow the tracer for all inflows via OBC for which OBC_in_u or OBC_in_v are not specified (units of tracer CONC) obc_in_u tracer at inflows through u-faces of tracer cells (units of tracer CONC) obc_in_v tracer at inflows through v-faces of tracer cells (units of tracer CONC) ad_x diagnostic x-advective flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] ad_y diagnostic y-advective flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] df_x diagnostic x-diffusive flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] df_y diagnostic y-diffusive flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] ad_2d_x vert sum of diagnostic x-advect flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] ad_2d_y vert sum of diagnostic y-advect flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] df_2d_x vert sum of diagnostic x-diffuse flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] df_2d_y vert sum of diagnostic y-diffuse flux [conc H L2 T-1 ~> CONC m3 s-1 or CONC kg s-1] advection_xy convergence of lateral advective tracer fluxes registry_diags If present and true, use the registry for the diagnostics of this tracer. flux_nameroot Short tracer name snippet used construct the names of flux diagnostics. flux_longname A word or phrase used construct the long names of flux diagnostics. flux_units The units for the fluxes of this tracer. flux_scale A scaling factor used to convert the fluxes of this tracer to its desired units. convergence_units The units for the flux convergence of this tracer. convergence_scale A scaling factor used to convert the flux convergence of this tracer to its desired units. cmor_tendprefix The CMOR name for the layer-integrated tendencies of this tracer. diag_form An integer (1 or 2, 1 by default) indicating the character string template to use in labeling diagnostics restart_cs A pointer to the restart control structure this tracer will be registered for restarts if this argument is present mandatory If true, this tracer must be read from a restart file. mom_error_handler::mom_error mom_io::query_vardesc tracer_registry_init advection_test_tracer::register_advection_test_tracer boundary_impulse_tracer::register_boundary_impulse_tracer dome_tracer::register_dome_tracer regional_dyes::register_dye_tracer dyed_obc_tracer::register_dyed_obc_tracer ideal_age_example::register_ideal_age_tracer isomip_tracer::register_isomip_tracer mom_generic_tracer::register_mom_generic_tracer mom_ocmip2_cfc::register_ocmip2_cfc oil_tracer::register_oil_tracer pseudo_salt_tracer::register_pseudo_salt_tracer rgc_tracer::register_rgc_tracer user_tracer_example::user_register_tracer_example subroutine, public subroutine, public mom_tracer_registry::lock_tracer_registry (Reg) lock_tracer_registry Reg Reg This subroutine locks the tracer registry to prevent the addition of more tracers. After locked=.true., can then register common diagnostics. reg pointer to the tracer registry mom_error_handler::mom_error mom::initialize_mom subroutine, public subroutine, public mom_tracer_registry::register_tracer_diagnostics (Reg, h, Time, diag, G, GV, US, use_ALE) register_tracer_diagnostics Reg Reg h h Time Time diag diag G G GV GV US US use_ALE use_ALE register_tracer_diagnostics does a set of register_diag_field calls for any previously registered in a tracer registry with a value of registry_diags set to .true. g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type reg pointer to the tracer registry h Layer thicknesses time current model time diag structure to regulate diagnostic output use_ale If true active diagnostics that only apply to ALE configurations mom_io::cmor_long_std mom_string_functions::lowercase mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_registry::preale_tracer_diagnostics (Reg, G, GV) preale_tracer_diagnostics Reg Reg G G GV GV reg pointer to the tracer registry g The ocean's grid structure gv ocean vertical grid structure subroutine, public subroutine, public mom_tracer_registry::postale_tracer_diagnostics (Reg, G, GV, diag, dt) postale_tracer_diagnostics Reg Reg G G GV GV diag diag dt dt reg pointer to the tracer registry g The ocean's grid structure gv ocean vertical grid structure diag regulates diagnostic output dt total time interval for these diagnostics [T ~> s] mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_registry::post_tracer_diagnostics_at_sync (Reg, h, diag_prev, diag, G, GV, dt) post_tracer_diagnostics_at_sync Reg Reg h h diag_prev diag_prev diag diag G G GV GV dt dt Post tracer diganostics when that should only be posted when MOM's state is self-consistent (also referred to as 'synchronized') g The ocean's grid structure gv The ocean's vertical grid structure reg pointer to the tracer registry h Layer thicknesses diag_prev Contains diagnostic grids from previous timestep diag structure to regulate diagnostic output dt total time step for tracer updates [T ~> s] mom_diag_mediator::diag_copy_storage_to_diag mom_diag_mediator::diag_restore_grids mom_diag_mediator::diag_save_grids subroutine, public subroutine, public mom_tracer_registry::post_tracer_transport_diagnostics (G, GV, Reg, h_diag, diag) post_tracer_transport_diagnostics G G GV GV Reg Reg h_diag h_diag diag diag Post the advective and diffusive tendencies. g The ocean's grid structure gv The ocean's vertical grid structure reg pointer to the tracer registry h_diag Layer thicknesses on which to post fields diag structure to regulate diagnostic output mom_diagnostics::post_transport_diagnostics subroutine, public subroutine, public mom_tracer_registry::mom_tracer_chksum (mesg, Tr, ntr, G) mom_tracer_chksum mesg mesg Tr Tr ntr ntr G G This subroutine writes out chksums for tracers. mesg message that appears on the chksum lines tr array of all of registered tracers ntr number of registered tracers g ocean grid structure mom_offline_main::offline_redistribute_residual mom_tracer_hor_diff::tracer_hordiff subroutine, public subroutine, public mom_tracer_registry::mom_tracer_chkinv (mesg, G, h, Tr, ntr) mom_tracer_chkinv mesg mesg G G h h Tr Tr ntr ntr Calculates and prints the global inventory of all tracers in the registry. mesg message that appears on the chksum lines g ocean grid structure tr array of all of registered tracers h Layer thicknesses ntr number of registered tracers mom_error_handler::is_root_pe mom_ale::ale_offline_inputs mom_offline_main::offline_advection_ale mom_offline_main::offline_diabatic_ale mom_offline_main::offline_fw_fluxes_into_ocean mom_offline_main::offline_fw_fluxes_out_ocean mom_offline_main::offline_redistribute_residual subroutine, public subroutine, public mom_tracer_registry::tracer_name_lookup (Reg, tr_ptr, name) tracer_name_lookup Reg Reg tr_ptr tr_ptr name name Find a tracer in the tracer registry by name. reg pointer to tracer registry tr_ptr target or pointer to the tracer array name tracer name mom_string_functions::lowercase dome_initialization::dome_set_obc_data subroutine, public subroutine, public mom_tracer_registry::tracer_registry_init (param_file, Reg) tracer_registry_init param_file param_file Reg Reg Initialize the tracer registry. param_file open file to parse for model parameters reg pointer to tracer registry mom_error_handler::is_root_pe mom_error_handler::mom_error register_tracer subroutine, public subroutine, public mom_tracer_registry::tracer_registry_end (Reg) tracer_registry_end Reg Reg This routine closes the tracer registry module. reg The tracer registry that will be deallocated mom::mom_end This module contains the tracer_registry_type and the subroutines that handle registration of tracers and related subroutines. The primary subroutine, register_tracer, is called to indicate the tracers advected and diffused.