namespace oil_tracer

Overview

A tracer package to mimic dissolved oil. More…

namespace oil_tracer {

// global functions

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

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

subroutine, public oil_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,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    );

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

subroutine, public oil_tracer_surface_state(state state, h h, G G, CS CS);
subroutine, public oil_tracer_end(CS CS);

} // namespace oil_tracer

Detailed Documentation

A tracer package to mimic dissolved oil.

By Alistair Adcroft and Robert Hallberg, 2010 *

In the midst of the Deepwater Horizon oil spill, it became evident that models were needed to predict the long-term fate of dissolved oil in the open ocean. This tracer packages mimics the transport, dilution and decay of dissolved oil plumes in the ocean.

This tracer package was central to the simulations used by Adcroft et al., GRL 2010, to prove that the Deepwater Horizon spill was an important regional event, with implications for dissolved oxygen levels in the Gulf of Mexico, but not one that would directly impact the East Coast of the U.S.

Global Functions

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

Register oil tracer fields and subroutines to be used with MOM.

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	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_oil_tracer(
    restart restart,
    day day,
    G G,
    GV GV,
    US US,
    h h,
    diag diag,
    OBC OBC,
    CS CS,
    sponge_CSp sponge_CSp
    )

Initialize the oil tracers and set up 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
us	A dimensional unit scaling type
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_oil_tracer.
sponge_csp	Pointer to the control structure for the sponges.

subroutine, public oil_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,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    )

Apply sources, sinks, diapycnal mixing and rising motions to the oil tracers.

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_oil_tracer.
tv	A structure pointing to various thermodynamic variables
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 oil_stock(
    h h,
    stocks stocks,
    G G,
    GV GV,
    CS CS,
    names names,
    units units,
    stock_index stock_index
    )

Calculate the mass-weighted integral of the oil 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_oil_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:

The number of stocks calculated here.

subroutine, public oil_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_oil_tracer.

subroutine, public oil_tracer_end(CS CS)

Deallocate memory associated with this tracer package.

Parameters:

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