namespace pseudo_salt_tracer

Overview

A tracer package that mimics salinity. More…

namespace pseudo_salt_tracer {

// global functions

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

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

subroutine, public pseudo_salt_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,
    tv tv,
    debug debug,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    );

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

subroutine, public pseudo_salt_tracer_surface_state(state state, h h, G G, CS CS);
subroutine, public pseudo_salt_tracer_end(CS CS);

} // namespace pseudo_salt_tracer

Detailed Documentation

A tracer package that mimics salinity.

By Andrew Shao, 2016

This file contains the routines necessary to model a passive tracer that uses the same boundary fluxes as salinity. At the beginning of the run, salt is set to the same as tvS. Any deviations between this salt-like tracer and tvS signifies a difference between how active and passive tracers are treated.

Global Functions

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

Register the pseudo-salt tracer with MOM6.

Parameters:

hi	A horizontal index type structure
gv	The ocean’s vertical grid structure
param_file	A structure to parse for run-time parameters
cs	The control structure returned by a previous call to register_pseudo_salt_tracer.
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_pseudo_salt_tracer(
    restart restart,
    day day,
    G G,
    GV GV,
    h h,
    diag diag,
    OBC OBC,
    CS CS,
    sponge_CSp sponge_CSp,
    tv tv
    )

Initialize the pseudo-salt tracer.

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	A structure that is 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_pseudo_salt_tracer.
sponge_csp	Pointer to the control structure for the sponges.
tv	A structure pointing to various thermodynamic variables

subroutine, public pseudo_salt_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,
    tv tv,
    debug debug,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    )

Apply sources, sinks and diapycnal diffusion to the tracers in this package.

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_pseudo_salt_tracer.
tv	A structure pointing to various thermodynamic variables
debug	If true calculate checksums
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 pseudo_salt_stock(
    h h,
    stocks stocks,
    G G,
    GV GV,
    CS CS,
    names names,
    units units,
    stock_index stock_index
    )

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:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
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].
cs	The control structure returned by a previous call to register_pseudo_salt_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 pseudo_salt_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_pseudo_salt_tracer.

subroutine, public pseudo_salt_tracer_end(CS CS)

Deallocate memory associated with this tracer package.

Parameters:

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