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

Module ocean_nphysics_mod

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

OVERVIEW

Driver for ocean neutral physics.

Driver for ocean neutral physics.

OTHER MODULES USED

          constants_mod
       diag_manager_mod
                fms_mod
                mpp_mod
        mpp_domains_mod
      ocean_domains_mod
ocean_nphysics_util_mod
    ocean_nphysicsA_mod
    ocean_nphysicsB_mod
    ocean_nphysicsC_mod
   ocean_parameters_mod
        ocean_types_mod

PUBLIC INTERFACE

ocean_nphysics_init:
neutral_physics:
ocean_nphysics_restart:
ocean_nphysics_end:

PUBLIC DATA

None.

PUBLIC ROUTINES

  1. ocean_nphysics_init

    DESCRIPTION
    Initialize the neutral physics module.


  2. neutral_physics

    DESCRIPTION
    Call the relevant neutral physics scheme.



  3. ocean_nphysics_restart

    DESCRIPTION
    Write to restart.


  4. ocean_nphysics_end

    DESCRIPTION
    Write to restart.


NAMELIST

&ocean_nphysics_nml

use_this_module
Must be true to use this module. Default use_this_module=.false.
[logical]
debug_this_module
For printing starting and ending checksums for restarts Default debug_this_module=.false.
[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]
use_nphysicsA
For using the nphysicsA method of neutral physics, based on that developed in MOM4p0. This scheme is more robust and recommended for general use. Default use_nphysicsA=.true.
[logical]
use_nphysicsB
For using the nphysicsB method of neutral physics. This method is experimental, and is not recommended for general use. Default use_nphysicsB=.false.
[logical]
use_nphysicsC
For using the nphysicsC method of neutral physics. This method is experimental, and is not recommended for general use. Default use_nphysicsC=.false.
[logical]

DATA SETS

None.

ERROR MESSAGES

None.

top