PUBLIC INTERFACE ~ PUBLIC ROUTINES ~ NAMELIST

Module ocean_bih_friction_mod

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

OVERVIEW

This module calls the appropriate lateral biharmonic friction modules.

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

OTHER MODULES USED

              constants_mod
           diag_manager_mod
                    fms_mod
                 fms_io_mod
            mpp_domains_mod
                    mpp_mod
ocean_bihcgrid_friction_mod
  ocean_bihcst_friction_mod
  ocean_bihgen_friction_mod
          ocean_domains_mod
        ocean_operators_mod
       ocean_parameters_mod
            ocean_types_mod
             ocean_util_mod

PUBLIC INTERFACE

ocean_bih_friction_init:
bih_friction:
bih_viscosity_check:
bih_reynolds_check:
bih_friction_barotropic:
ocean_bih_friction_restart:
ocean_bih_friction_end:

PUBLIC ROUTINES

  1. ocean_bih_friction_init

    DESCRIPTION
    Initialize the horizontal biharmonic friction module.


  2. bih_friction

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


  3. bih_viscosity_check

    DESCRIPTION
    To check that the viscosity is not too large.


  4. bih_reynolds_check

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


  5. bih_friction_barotropic

    DESCRIPTION
    This routine computes the biharmonic friction acting on a two-dim array. It uses the two-dimensional vertically averaged viscosity used in the biharmonic 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 biharmonic operator. This method has only been implemented for Bgrid MOM. It is rarely used and remains only for legacy.


  6. ocean_bih_friction_restart

    DESCRIPTION
    Write out restart files registered through register_restart_file


  7. ocean_bih_friction_end

    DESCRIPTION
    Write to restart of the vertically averaged viscosity.


NAMELIST

&ocean_bih_friction_nml

bih_friction_scheme
To determine the biharmonic 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