PUBLIC INTERFACE ~ PUBLIC DATA ~ PUBLIC ROUTINES ~ NAMELIST ~ DIAGNOSTIC FIELDS ~ ERROR MESSAGES ~ REFERENCES ~ NOTES

Module ocean_sponge_mod

Contact:  Bonnie Samuels R.W. Hallberg M.J. Harrison P. S. Swathi R. C. Pacanowski
Reviewers: 
Change History: WebCVS Log


OVERVIEW

Thickness weighted tracer tendency [tracer*meter/sec] from sponges.

This module applies sponges to tracers. The sponges can occur at any location and with any distribution in the domain, and with any time step and damping rate. Sponges occur where positive inverse restore times occur in the field passed to sponge_init. An array of tracer tendencies due to the sponges is augmented through a call to sponge_tracer_source. The array of tracer tendencies must be reset to zero between calls.

Different damping rates can be specified for each field by making calls to register_sponge_rate - no sponges are applied to fields for which uniformly zero inverse damping rates are set with a call to register_sponge_rate. The value towards which a field is damped is set with calls to register_sponge_field; successive calls are used to set up linear interpolation of this restore rate.

The user is responsible for providing (and registering) the data on the model grid of values towards which the tracers are being driven.


OTHER MODULES USED

                 fms_mod
mpp_mod
time_interp_external_mod
time_manager_mod
ocean_domains_mod
ocean_types_mod
ocean_workspace_mod

PUBLIC INTERFACE

ocean_sponge_init:
sponge_tracer_source:


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. ocean_sponge_init

    DESCRIPTION
    This subroutine is intended to be used to initialize the sponges. Everything in this subroutine is a user prototype, and should be replacable.


  2. sponge_tracer_source

    DESCRIPTION
    This subroutine calculates thickness weighted time tendencies of the tracers due to the sponges.



DATA SETS

None.


ERROR MESSAGES

None.


top