mom_tracer_registry module reference

This module contains subroutines that handle registration of tracers and related subroutines. The primary subroutine, register_tracer, is called to indicate the tracers advected and diffused. It also makes public the types defined in MOM_tracer_types.

More…

Functions/Subroutines

`register_tracer()`	This subroutine registers a tracer to be advected and laterally diffused.
`lock_tracer_registry()`	This subroutine locks the tracer registry to prevent the addition of more tracers.
`register_tracer_diagnostics()`	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.
`preale_tracer_diagnostics()`
`postale_tracer_diagnostics()`
`post_tracer_diagnostics_at_sync()`	Post tracer diganostics when that should only be posted when MOM's state is self-consistent (also referred to as 'synchronized')
`post_tracer_transport_diagnostics()`	Post the advective and diffusive tendencies.
`tracer_array_chksum()`	This subroutine writes out chksums for the first ntr registered tracers.
`tracer_reg_chksum()`	This subroutine writes out chksums for all the registered tracers.
`tracer_array_chkinv()`	Calculates and prints the global inventory of the first ntr tracers in the registry.
`tracer_reg_chkinv()`	Calculates and prints the global inventory of all tracers in the registry.
`tracer_name_lookup()`	Find a tracer in the tracer registry by name.
`tracer_registry_init()`	Initialize the tracer registry.
`tracer_registry_end()`	This routine closes the tracer registry module.

Detailed Description

This module contains subroutines that handle registration of tracers and related subroutines. The primary subroutine, register_tracer, is called to indicate the tracers advected and diffused. It also makes public the types defined in MOM_tracer_types.

Function/Subroutine Documentation

subroutine mom_tracer_registry/register_tracer(tr_ptr, Reg, param_file, HI, GV, name, longname, units, cmor_name, cmor_units, cmor_longname, net_surfflux_name, NLT_budget_name, net_surfflux_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, conc_scale, flux_nameroot, flux_longname, flux_units, flux_scale, convergence_units, convergence_scale, cmor_tendprefix, diag_form, restart_CS, mandatory, underflow_conc, Tr_out, advect_scheme)

This subroutine registers a tracer to be advected and laterally diffused.

Parameters:

hi :: [in] horizontal index type
gv :: [in] ocean vertical grid structure
reg :: pointer to the tracer registry
tr_ptr :: tr_ptr target or pointer to the tracer array [CU ~> conc]
param_file :: param_file [in] file to parse for model parameter values
name :: name [in] Short tracer name
longname :: longname [in] The long tracer name
units :: units [in] The units of this tracer
cmor_name :: cmor_name [in] CMOR name
cmor_units :: cmor_units [in] CMOR physical dimensions of variable
cmor_longname :: cmor_longname [in] CMOR long name
net_surfflux_name :: net_surfflux_name [in] Name for net_surfflux diag
nlt_budget_name :: [in] Name for NLT_budget diag
net_surfflux_longname :: net_surfflux_longname [in] Long name for net_surfflux diag
tr_desc :: tr_desc [in] A structure with metadata about the tracer
obc_inflow :: [in] the tracer for all inflows via OBC for which OBC_in_u or OBC_in_v are not specified [CU ~> conc]
obc_in_u :: tracer at inflows through u-faces of tracer cells [CU ~> conc]
obc_in_v :: tracer at inflows through v-faces of tracer cells [CU ~> conc]
ad_x :: ad_x diagnostic x-advective flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
ad_y :: ad_y diagnostic y-advective flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
df_x :: df_x diagnostic x-diffusive flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
df_y :: df_y diagnostic y-diffusive flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
ad_2d_x :: ad_2d_x vert sum of diagnostic x-advect flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
ad_2d_y :: ad_2d_y vert sum of diagnostic y-advect flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
df_2d_x :: df_2d_x vert sum of diagnostic x-diffuse flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
df_2d_y :: df_2d_y vert sum of diagnostic y-diffuse flux [CU H L2 T-1 ~> conc m3 s-1 or conc kg s-1]
advection_xy :: advection_xy convergence of lateral advective tracer fluxes [CU H T-1 ~> conc m s-1 or conc kg m-2 s-1]
registry_diags :: registry_diags [in] If present and true, use the registry for the diagnostics of this tracer.
conc_scale :: conc_scale [in] A scaling factor used to convert the concentration of this tracer to its desired units [conc CU-1 ~> 1]
flux_nameroot :: flux_nameroot [in] Short tracer name snippet used construct the names of flux diagnostics.
flux_longname :: flux_longname [in] A word or phrase used construct the long names of flux diagnostics.
flux_units :: flux_units [in] The units for the fluxes of this tracer.
flux_scale :: flux_scale [in] A scaling factor used to convert the fluxes of this tracer to its desired units [conc m CU-1 H-1 ~> 1] or [conc kg m-2 CU-1 H-1 ~> 1]
convergence_units :: convergence_units [in] The units for the flux convergence of this tracer.
convergence_scale :: convergence_scale [in] A scaling factor used to convert the flux convergence of this tracer to its desired units. [conc m CU-1 H-1 ~> 1] or [conc kg m-2 CU-1 H-1 ~> 1]
cmor_tendprefix :: cmor_tendprefix [in] The CMOR name for the layer-integrated tendencies of this tracer.
diag_form :: diag_form [in] An integer (1 or 2, 1 by default) indicating the character string template to use in labeling diagnostics
restart_cs :: [inout] MOM restart control struct
mandatory :: mandatory [in] If true, this tracer must be read from a restart file.
underflow_conc :: underflow_conc [in] A tiny concentration, below which the tracer concentration underflows to 0 [CU ~> conc].
tr_out :: If present, returns pointer into registry
advect_scheme :: advect_scheme [in] Advection scheme for this tracer, the default is -1 indicating to use the scheme from MOM_tracer_advect

Call to:

mom_string_functions::lowercase mom_error_handler::mom_error mom_io::query_vardesc tracer_registry_init

Called from:

advection_test_tracer::register_advection_test_tracer boundary_impulse_tracer::register_boundary_impulse_tracer mom_cfc_cap::register_cfc_cap dome_tracer::register_dome_tracer regional_dyes::register_dye_tracer ideal_age_example::register_ideal_age_tracer isomip_tracer::register_isomip_tracer marbl_tracers::register_marbl_tracers nw2_tracers::register_nw2_tracers 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

[source]

subroutine mom_tracer_registry/lock_tracer_registry(Reg)

This subroutine locks the tracer registry to prevent the addition of more tracers. After locked=.true., can then register common diagnostics.

Parameters:: reg :: pointer to the tracer registry
Call to:: mom_error_handler::mom_error
Called from:: mom::initialize_mom

[source]

subroutine mom_tracer_registry/register_tracer_diagnostics(Reg, h, Time, diag, G, GV, US, use_ALE, use_KPP)

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.

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
us :: [in] A dimensional unit scaling type
reg :: pointer to the tracer registry
h :: h [in] Layer thicknesses [H ~> m or kg m-2]
time :: [in] current model time
diag :: diag [in] structure to regulate diagnostic output
use_ale :: [in] If true active diagnostics that only apply to ALE configurations
use_kpp :: [in] If true active diagnostics that only apply to CVMix KPP mixings

Call to:

mom_io::cmor_long_std mom_string_functions::lowercase mom_error_handler::mom_error

[source]

subroutine mom_tracer_registry/preale_tracer_diagnostics(Reg, G, GV)

Parameters:

reg :: pointer to the tracer registry
g :: [in] The ocean’s grid structure
gv :: [in] ocean vertical grid structure

[source]

subroutine mom_tracer_registry/postale_tracer_diagnostics(Reg, G, GV, diag, dt)

Parameters:

reg :: pointer to the tracer registry
g :: [in] The ocean’s grid structure
gv :: [in] ocean vertical grid structure
diag :: diag [in] regulates diagnostic output
dt :: dt [in] total time interval for these diagnostics [T ~> s]

Call to:

mom_error_handler::mom_error

[source]

subroutine mom_tracer_registry/post_tracer_diagnostics_at_sync(Reg, h, diag_prev, diag, G, GV, dt)

Post tracer diganostics when that should only be posted when MOM’s state is self-consistent (also referred to as ‘synchronized’)

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
reg :: pointer to the tracer registry
h :: h [in] Layer thicknesses [H ~> m or kg m-2]
diag_prev :: diag_prev [in] Contains diagnostic grids from previous timestep
diag :: diag [inout] structure to regulate diagnostic output
dt :: dt [in] total time step for tracer updates [T ~> s]

Call to:

mom_diag_mediator::diag_copy_storage_to_diag mom_diag_mediator::diag_restore_grids mom_diag_mediator::diag_save_grids

[source]

subroutine mom_tracer_registry/post_tracer_transport_diagnostics(G, GV, Reg, h_diag, diag)

Post the advective and diffusive tendencies.

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
reg :: pointer to the tracer registry
h_diag :: h_diag [in] Layer thicknesses on which to post fields [H ~> m or kg m-2]
diag :: diag [in] structure to regulate diagnostic output

Called from: