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

Module ocean_velocity_diag_mod

Contact:  Ron Pacanowski ,  S.M. Griffies
Reviewers: 
Change History: WebCVS Log

OVERVIEW

Numerical diagnostics for velocity related quantities.

Numerical diagnostics for velocity related quantities.

OTHER MODULES USED

         constants_mod
      diag_manager_mod
               fms_mod
       mpp_domains_mod
               mpp_mod
      time_manager_mod
ocean_bih_friction_mod
     ocean_domains_mod
ocean_lap_friction_mod
   ocean_operators_mod
       ocean_types_mod
        ocean_util_mod

PUBLIC INTERFACE

ocean_velocity_diag_init:
ocean_velocity_diagnostics:
potential_energy:
kinetic_energy:
velocity_land_cell_check:
velocity_change:

PUBLIC DATA

None.

PUBLIC ROUTINES

  1. ocean_velocity_diag_init

    DESCRIPTION
    Initialize the ocean_velocity_diag module containing subroutines diagnosing velocity related properties of the simulation. These are not terms in the equations, but rather they are diagnosed from terms.


  2. ocean_velocity_diagnostics

    DESCRIPTION
    Call diagnostics related to the velocity.


  3. potential_energy

    DESCRIPTION
    Compute potential energy (Joules) relative to initial time step.


  4. kinetic_energy

    DESCRIPTION
    Compute global integrated horizontal kinetic energy.


  5. velocity_land_cell_check

    DESCRIPTION
    See if there are any points over land with nonzero ocean velocity


  6. velocity_change

    DESCRIPTION
    Determine the number of points that have large single-time step changes in the abs of the velocity.


NAMELIST

&ocean_velocity_diag_nml

diag_freq
Number of time steps between which compute the diagnostics.
[integer, units: dimensionless]
do_bitwise_exact_sum
Set true to do bitwise exact global sum. When it is false, the global sum will be non-bitwise_exact, but will significantly increase efficiency. The default value is false.
[logical]

DATA SETS

None.

ERROR MESSAGES

None.

top