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

Module ocean_domains_mod

Contact:  Matthew Harrison
Reviewers: 
Change History: WebCVS Log

OVERVIEW

Set the ocean domain parameters.

The module computes the horizontal domain parameters needed to run mom4 in a parallel computational environment.

OTHER MODULES USED

        fms_mod
mpp_domains_mod
        mpp_mod
ocean_types_mod

PUBLIC INTERFACE

set_ocean_domain:
get_local_indices:
get_domain_offsets:
get_active_indices:
get_global_indices:
reduce_active_domain:
get_halo_sizes:

PUBLIC DATA

None.

PUBLIC ROUTINES

  1. set_ocean_domain

    DESCRIPTION
    For setting the ocean domain layout and associated parameters.


  2. get_local_indices

    DESCRIPTION
    For getting local indices from domain derived type.


  3. get_domain_offsets

    DESCRIPTION
    For getting domain offsets from domain derived type.


  4. get_active_indices

    DESCRIPTION
    For getting active domain indices from domain derived type.


  5. get_global_indices

    DESCRIPTION
    For getting global indices from domain derived type.


  6. reduce_active_domain

    DESCRIPTION
    For getting reducing the active domain


  7. get_halo_sizes

    DESCRIPTION
    For getting halo sizes from domain derived type.


NAMELIST

&ocean_domains_nml

halo
For specifying the halo size by hand.
[integer, units: dimensionless]
max_tracers
temporary - need to call domains_init before tracer_init Used for computing mpp_stack_size.
[integer, units: dimensionless]
x_cyclic_offset
offset to be applied on x-direction boundary condition. Its value could be positive or negative and the default value is 0. When the y-direction boundary condition is folded-north(tripolar grid), x_cyclic_offset must be 0. For torus (cyclic in x and y-direction), at least one of x_cyclic_offset and y_cyclic_offset must be 0.
[integer, units: dimensionless]
y_cyclic_offset
offset to be applied on y-direction boundary condition. Its value could be positive or negative and the default value is 0. For torus (cyclic in x and y-direction), at least one of x_cyclic_offset and y_cyclic_offset must be 0.
[integer, units: dimensionless]

DATA SETS

None.

ERROR MESSAGES

None.

REFERENCES

  1. S.M. Griffies, M.J. Harrison, R.C. Pacanowski, and A. Rosati A Technical Guide to MOM4 (2003)

COMPILER SPECIFICS

None.

PRECOMPILER OPTIONS

None.

LOADER OPTIONS

None.

TEST PROGRAM

None.

KNOWN BUGS

None.

NOTES

None.

FUTURE PLANS

None.

top