PUBLIC INTERFACE ~ PUBLIC ROUTINES ~ NAMELIST

Module ocean_sponges_velocity_mod

Contact:  Paul Sandery
Reviewers: 
Change History: WebCVS Log

OVERVIEW

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

This module applies sponges to currents. 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. Sponge data and damping coefficients are generally 3 dimensional. The user is responsible for providing (and registering) the data on the model grid of values towards which the currents are being driven.

OTHER MODULES USED

        diag_manager_mod
                 fms_mod
                 mpp_mod
time_interp_external_mod
        time_manager_mod
       ocean_domains_mod
    ocean_parameters_mod
         ocean_types_mod
     ocean_workspace_mod

PUBLIC INTERFACE

ocean_sponges_velocity_init:
sponge_velocity_source:

PUBLIC ROUTINES

  1. ocean_sponges_velocity_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_velocity_source

    DESCRIPTION
    This subroutine calculates thickness weighted and density weighted time tendencies due to damping by sponges.


NAMELIST

&ocean_sponges_velocity_nml

use_this_module
For using this module. Default use_this_module=.false.
[logical]
damp_coeff_3d
For case when damping coefficients are full 3d field of values. Default damp_coeff_3d=.false., which means damping coeffs are 2d horizontal array.
[logical]

top