mom_tracer_advect module reference

This module contains the subroutines that advect tracers along coordinate surfaces.

Data Types

tracer_advect_cs

Control structure for this module.

Functions/Subroutines

`advect_tracer()`	This routine time steps the tracer concentration using a monotonic, conservative, weakly diffusive scheme.
`advect_x()`	This subroutine does 1-d flux-form advection in the zonal direction using a monotonic piecewise linear scheme.
`advect_y()`	This subroutine does 1-d flux-form advection using a monotonic piecewise linear scheme.
`tracer_advect_init()`	Initialize lateral tracer advection module.
`tracer_advect_end()`	Close the tracer advection module.

Detailed Description

This program contains the subroutines that advect tracers horizontally (i.e. along layers).

section_mom_advect_intro

advect_tracer advects tracer concentrations using a combination of the modified flux advection scheme from Easter (Mon. Wea. Rev., 1993) with tracer distributions given by the monotonic piecewise parabolic method, as described in Carpenter et al. (MWR, 1990). This scheme conserves the total amount of tracer while avoiding spurious maxima and minima of the tracer concentration.
advect_tracer subroutine determines the volume of a layer in a grid cell at the previous instance when the tracer concentration was changed, so it is essential that the volume fluxes should be correct. It is also important that the tracer advection occurs before each calculation of the diabatic forcing.

The advection scheme of some tracers can be set to be different to that used by active tracers.

Type Documentation

type mom_tracer_advect/tracer_advect_cs

Control structure for this module.

Type fields:

% dt :: real The baroclinic dynamics time step [T ~> s].
% diag :: type(diag_ctrl), pointer A structure that is used to regulate the timing of diagnostic output.
% debug :: logical If true, write verbose checksums for debugging purposes.
% usehuynhstencilbug :: logical If true, use the incorrect stencil width. This is provided for compatibility with legacy simuations.
% pass_uhr_vhr_t_hprev :: type(group_pass_type) A structure used for group passes.
% default_advect_scheme :: integer Determines which reconstruction to use.

[source]

Function/Subroutine Documentation

subroutine mom_tracer_advect/advect_tracer(h_end, uhtr, vhtr, OBC, dt, G, GV, US, CS, Reg, x_first_in, vol_prev, max_iter_in, update_vol_prev, uhr_out, vhr_out)

This routine time steps the tracer concentration using a monotonic, conservative, weakly diffusive scheme.

Parameters:

g :: [inout] ocean grid structure
gv :: [in] ocean vertical grid structure
h_end :: h_end [in] Layer thickness after advection [H ~> m or kg m-2]
uhtr :: uhtr [in] Accumulated volume or mass flux through the
vhtr :: vhtr [in] Accumulated volume or mass flux through the
obc :: specifies whether, where, and what OBCs are used
dt :: dt [in] time increment [T ~> s]
us :: [in] A dimensional unit scaling type
cs :: control structure for module
reg :: pointer to tracer registry
x_first_in :: x_first_in [in] If present, indicate whether to update first in the x- or y-direction.
vol_prev :: vol_prev [inout] Cell volume before advection [H L2 ~> m3 or kg].
max_iter_in :: max_iter_in [in] The maximum number of iterations
update_vol_prev :: update_vol_prev [in] If present and true, update vol_prev to return its value after the tracer have been updated.
uhr_out :: uhr_out [out] Remaining accumulated volume or mass fluxes
vhr_out :: vhr_out [out] Remaining accumulated volume or mass fluxes

Call to:

advect_x advect_y id_clock_advect id_clock_pass id_clock_sync mom_error_handler::mom_error

Called from:

mom_offline_main::offline_advection_ale mom_offline_main::offline_advection_layer mom_offline_main::offline_redistribute_residual

[source]

subroutine mom_tracer_advect/advect_x(Tr, hprev, uhr, uh_neglect, OBC, domore_u, ntr, Idt, is, ie, js, je, k, G, GV, US, advect_schemes)

This subroutine does 1-d flux-form advection in the zonal direction using a monotonic piecewise linear scheme.

Parameters:

g :: [inout] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
ntr :: ntr [in] The number of tracers
tr :: [inout] The array of registered tracers to work on
hprev :: hprev [inout] cell volume at the end of previous tracer change [H L2 ~> m3 or kg]
uhr :: uhr [inout] accumulated volume/mass flux through the zonal face [H L2 ~> m3 or kg]
uh_neglect :: uh_neglect [in] A tiny zonal mass flux that can be neglected [H L2 ~> m3 or kg]
obc :: specifies whether, where, and what OBCs are used
domore_u :: domore_u [inout] If true, there is more advection to be done in this u-row
idt :: [in] The inverse of dt [T-1 ~> s-1]
is :: is [in] The starting tracer i-index to work on
ie :: ie [in] The ending tracer i-index to work on
js :: js [in] The starting tracer j-index to work on
je :: je [in] The ending tracer j-index to work on
k :: k [in] The k-level to work on
us :: [in] A dimensional unit scaling type
advect_schemes :: advect_schemes [in] list of advection schemes to use

Called from:

advect_tracer

[source]

subroutine mom_tracer_advect/advect_y(Tr, hprev, vhr, vh_neglect, OBC, domore_v, ntr, Idt, is, ie, js, je, k, G, GV, US, advect_schemes)

This subroutine does 1-d flux-form advection using a monotonic piecewise linear scheme.

Parameters:

g :: [inout] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
ntr :: ntr [in] The number of tracers
tr :: [inout] The array of registered tracers to work on
hprev :: hprev [inout] cell volume at the end of previous tracer change [H L2 ~> m3 or kg]
vhr :: vhr [inout] accumulated volume/mass flux through the meridional face [H L2 ~> m3 or kg]
vh_neglect :: vh_neglect [inout] A tiny meridional mass flux that can be neglected [H L2 ~> m3 or kg]
obc :: specifies whether, where, and what OBCs are used
domore_v :: domore_v [inout] If true, there is more advection to be done in this v-row
idt :: [in] The inverse of dt [T-1 ~> s-1]
is :: is [in] The starting tracer i-index to work on
ie :: ie [in] The ending tracer i-index to work on
js :: js [in] The starting tracer j-index to work on
je :: je [in] The ending tracer j-index to work on
k :: k [in] The k-level to work on
us :: [in] A dimensional unit scaling type
advect_schemes :: advect_schemes [in] list of advection schemes to use

Called from:

advect_tracer

[source]

subroutine mom_tracer_advect/tracer_advect_init(Time, G, US, param_file, diag, CS)

Initialize lateral tracer advection module.

Parameters:

time :: [in] current model time
g :: [in] ocean grid structure
us :: [in] A dimensional unit scaling type
param_file :: param_file [in] open file to parse for model parameters
diag :: diag [inout] regulates diagnostic output
cs :: module control structure

Call to:

id_clock_advect id_clock_pass id_clock_sync mom_error_handler::mom_error mom_tracer_advect_schemes::set_tracer_advect_scheme mom_tracer_advect_schemes::traceradvectionschemedoc

[source]

subroutine mom_tracer_advect/tracer_advect_end(CS)

Close the tracer advection module.

Parameters:: cs :: module control structure
Called from:: mom::mom_end

[source]