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

Module ocean_adv_vel_diag_mod

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


OVERVIEW

Numerical diagnostics for advection velocity related quantities.

Numerical diagnostics for advection velocity related quantities.


OTHER MODULES USED

      constants_mod
diag_manager_mod
fms_mod
mpp_mod
time_manager_mod
ocean_domains_mod
ocean_operators_mod
ocean_types_mod
ocean_util_mod
ocean_workspace_mod

PUBLIC INTERFACE

ocean_adv_vel_diag_init:
ocean_adv_vel_diagnostics:
remapping_check:
cfl_check1:
cfl_check2:
maximum_bottom_w:
max_continuity_error:
transport_on_z:
transport_on_rho:
transport_on_theta:
vertical_reynolds_check:


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. ocean_adv_vel_diag_init

    DESCRIPTION
    Initialize the ocean_adv_vel_diag module containing subroutines diagnosing advection velocity related properties of the simulation.


  2. ocean_adv_vel_diagnostics

    DESCRIPTION
    Call diagnostics related to the velocity.


  3. remapping_check

    DESCRIPTION
    Compute remapping error. This error will be roundoff only for model grids where the tracer and velocity grid cell distances are linearly related. The spherical version of mom4 satisfies the appropriate relation, and so should maintain roundoff for the remapping error. The tripolar version of mom4 does not have tracer and velocity grids related linearly, and so the "remapping error" is nontrivial. The significance of this error is unclear. No adverse effects have been identified.


  4. cfl_check1

    DESCRIPTION
    Perform the first of two CFL checks.


  5. cfl_check2

    DESCRIPTION
    Perform the second of two CFL checks.


  6. maximum_bottom_w

    DESCRIPTION
    Compute maximum vertical velocity on the bottom of tracer and velocity cells. The vertical velocity at bottom of a column of tracer cells should be roundoff. For flat bottom simulations, the vertical velocity on the bottom of the velocity cell column should also be roundoff. For simulations with topography, the vertical velocity on the bottom of a velocity cell column will not vanish due to the effects of topography.


  7. max_continuity_error

    DESCRIPTION
    Compute continuity error. Should be roundoff if all is working well.


  8. transport_on_z

    DESCRIPTION
    Compute volume transports on z-levels and send to diag_manager.


  9. transport_on_rho

    DESCRIPTION
    Classify horizontal transport of volume according to potential density classes.

    Diagnostic makes sense when potrho is monotonically increasing with depth, although the algorithm does not explicitly make this assumption.

    Stephen.Griffies@noaa.gov Zhi.Liang@noaa.gov



  10. transport_on_theta

    DESCRIPTION
    Classify horizontal transport of volume according to potential temperature classes. This diagnostic is useful to deduce the heat that is transported between potential temperature classes.

    Diagnostic makes sense when theta is monotonically decreasing with depth, although the algorithm does not explicitly make this assumption.

    Stephen.Griffies@noaa.gov Zhi.Liang@noaa.gov



  11. vertical_reynolds_check

    DESCRIPTION
    This subroutine computes the Reynolds number associated with vertical friction visc_cbu and vertical velocity w_bu.



NAMELIST

&ocean_adv_vel_diag_nml

cflcrt
Critical CFL number for CFL check.
[real, units: dimensionless]
max_cfl_violations
Maximum number of CFL violations allowed before model is brought down.
[integer, units: dimensionless]
diag_freq
Number of time steps between which compute the diagnostics.
[integer, units: dimensionless]


DATA SETS

None.


ERROR MESSAGES

None.


top