PUBLIC INTERFACE ~ PUBLIC ROUTINES ~ NAMELIST

Module ocean_lap_friction_mod

Contact:  Stephen M. Griffies
Reviewers: 
Change History: WebCVS Log

OVERVIEW

This module calls the appropriate lateral laplacian friction modules.

This module serves as an interface to the chosen lateral laplacian friction modules.

OTHER MODULES USED

           diag_manager_mod
                    fms_mod
                 fms_io_mod
            mpp_domains_mod
                    mpp_mod
          ocean_domains_mod
  ocean_lapcst_friction_mod
  ocean_lapgen_friction_mod
ocean_lapcgrid_friction_mod
        ocean_operators_mod
       ocean_parameters_mod
            ocean_types_mod
             ocean_util_mod

PUBLIC INTERFACE

ocean_lap_friction_init:
lap_friction:
lap_viscosity_check:
lap_reynolds_check:
lap_friction_barotropic:
ocean_lap_friction_restart:
ocean_lap_friction_end:

PUBLIC ROUTINES

  1. ocean_lap_friction_init

    DESCRIPTION
    Initialize the horizontal Laplacian friction module.


  2. lap_friction

    DESCRIPTION
    Compute the thickness weighted and density weighted accel due to lateral laplacian friction. Add this contribution to Velocity%accel.


  3. lap_viscosity_check

    DESCRIPTION
    To check that the viscosity is not too large.


  4. lap_reynolds_check

    DESCRIPTION
    To check that the Reynolds number is not too large.


  5. lap_friction_barotropic

    DESCRIPTION
    This routine computes the laplacian friction acting on a two-dim array. It uses the two-dimensional vertically averaged viscosity used in the laplacian friction module. The intent is to apply this 2d operator to the vertically integrated horizontal momentum. We ignore the spherical metric terms in this form of the operator, since we are aiming for a fast smoothing operator to be applied during each of the many barotropic time steps. We also apply just the isotropic portion of the more general anisotropic laplacian operator. This scheme is only meant for the B-grid version of MOM. It has not been generalized to the C-grid, since the C-grid has less noise in the barotropic gravity waves anyhow, so it is unlikely there will need to be extra friction applied to the C-grid barotropic equations.


  6. ocean_lap_friction_restart

    DESCRIPTION
    Write out restart files registered through register_restart_file


  7. ocean_lap_friction_end

    DESCRIPTION
    Write to restart of the vertically averaged viscosity.


NAMELIST

&ocean_lap_friction_nml

lap_friction_scheme
To determine the laplacian friction scheme: "const" or "general"
[character]
debug_this_module
For debugging.
[logical]
write_a_restart
Set true to write a restart. False setting only for rare cases where wish to benchmark model without measuring the cost of writing restarts and associated chksums. Default is write_a_restart=.true.
[logical]

NOTES

The model can generally run with both Laplacian and biharmonic friction enabled at the same time. Such has been found useful for some eddying ocean simulations.

top