namespace regional_dyes

Overview

A tracer package for using dyes to diagnose regional flows. More…

namespace regional_dyes {

// global functions

logical function, public register_dye_tracer(
    HI HI,
    GV GV,
    US US,
    param_file param_file,
    CS CS,
    tr_Reg tr_Reg,
    restart_CS restart_CS
    );

subroutine, public initialize_dye_tracer(
    restart restart,
    day day,
    G G,
    GV GV,
    h h,
    diag diag,
    OBC OBC,
    CS CS,
    sponge_CSp sponge_CSp
    );

subroutine, public dye_tracer_column_physics(
    h_old h_old,
    h_new h_new,
    ea ea,
    eb eb,
    fluxes fluxes,
    dt dt,
    G G,
    GV GV,
    CS CS,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    );

integer function, public dye_stock(
    h h,
    stocks stocks,
    G G,
    GV GV,
    CS CS,
    names names,
    units units,
    stock_index stock_index
    );

subroutine, public dye_tracer_surface_state(state state, h h, G G, CS CS);
subroutine, public regional_dyes_end(CS CS);

} // namespace regional_dyes

Detailed Documentation

A tracer package for using dyes to diagnose regional flows.

This file contains an example of the code that is needed to set up and use a set (in this case two) of dynamically passive tracers for diagnostic purposes. The tracers here are dye tracers which are set to 1 within the geographical region specified. The depth which a tracer is set is determined by calculating the depth from the seafloor upwards through the column.

Global Functions

logical function, public register_dye_tracer(
    HI HI,
    GV GV,
    US US,
    param_file param_file,
    CS CS,
    tr_Reg tr_Reg,
    restart_CS restart_CS
    )

This subroutine is used to register tracer fields and subroutines to be used with MOM.

Parameters:

hi	A horizontal index type structure.
gv	The ocean’s vertical grid structure
us	A dimensional unit scaling type
param_file	A structure to parse for run-time parameters
cs	A pointer that is set to point to the control structure for this module
tr_reg	A pointer that is set to point to the control structure for the tracer advection and diffusion module.
restart_cs	A pointer to the restart control structure.

subroutine, public initialize_dye_tracer(
    restart restart,
    day day,
    G G,
    GV GV,
    h h,
    diag diag,
    OBC OBC,
    CS CS,
    sponge_CSp sponge_CSp
    )

This subroutine initializes the CSntr tracer fields in tr(:,:,:,:) and it sets up the tracer output.

Parameters:

restart	.true. if the fields have already been read from a restart file.
day	Time of the start of the run.
g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
h	Layer thicknesses [H ~> m or kg m-2]
diag	Structure used to regulate diagnostic output.
obc	This open boundary condition type specifies whether, where, and what open boundary conditions are used.
cs	The control structure returned by a previous call to register_dye_tracer.
sponge_csp	A pointer to the control structure for the sponges, if they are in use.

subroutine, public dye_tracer_column_physics(
    h_old h_old,
    h_new h_new,
    ea ea,
    eb eb,
    fluxes fluxes,
    dt dt,
    G G,
    GV GV,
    CS CS,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    )

This subroutine applies diapycnal diffusion and any other column tracer physics or chemistry to the tracers from this file. This is a simple example of a set of advected passive tracers. The arguments to this subroutine are redundant in that h_new(k) = h_old(k) + ea(k) - eb(k-1) + eb(k) - ea(k+1)

Parameters:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
h_old	Layer thickness before entrainment [H ~> m or kg m-2].
h_new	Layer thickness after entrainment [H ~> m or kg m-2].
ea	an array to which the amount of fluid entrained
eb	an array to which the amount of fluid entrained
fluxes	A structure containing pointers to thermodynamic and tracer forcing fields. Unused fields have NULL ptrs.
dt	The amount of time covered by this call [s]
cs	The control structure returned by a previous call to register_dye_tracer.
evap_cfl_limit	Limit on the fraction of the water that can be fluxed out of the top layer in a timestep [nondim]
minimum_forcing_depth	The smallest depth over which fluxes can be applied [m]

integer function, public dye_stock(
    h h,
    stocks stocks,
    G G,
    GV GV,
    CS CS,
    names names,
    units units,
    stock_index stock_index
    )

This function calculates the mass-weighted integral of all tracer stocks, returning the number of stocks it has calculated. If the stock_index is present, only the stock corresponding to that coded index is returned.

Parameters:

h	Layer thicknesses [H ~> m or kg m-2]
stocks	the mass-weighted integrated amount of each tracer, in kg times concentration units [kg conc].
g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
cs	The control structure returned by a previous call to register_dye_tracer.
names	the names of the stocks calculated.
units	the units of the stocks calculated.
stock_index	the coded index of a specific stock being sought.

Returns:

Return value: the number of stocks calculated here.

subroutine, public dye_tracer_surface_state(state state, h h, G G, CS CS)

This subroutine extracts the surface fields from this tracer package that are to be shared with the atmosphere in coupled configurations. This particular tracer package does not report anything back to the coupler.

Parameters:

g	The ocean’s grid structure.
state	A structure containing fields that describe the surface state of the ocean.
h	Layer thickness [H ~> m or kg m-2].
cs	The control structure returned by a previous call to register_dye_tracer.

subroutine, public regional_dyes_end(CS CS)

Clean up any allocated memory after the run.

Parameters:

cs	The control structure returned by a previous call to register_dye_tracer.