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

Module coupler_types_mod

Contact:  Richard D. Slater
Reviewers:  John Dunne
Change History: WebCVS Log


OVERVIEW

This module contains type declarations for the coupler.

This module contains type declarations for the coupler.


OTHER MODULES USED

field_manager_mod
mpp_mod
fm_util_mod
time_manager_mod
diag_manager_mod

PUBLIC INTERFACE

coupler_types_init:
Initialize the coupler types
coupler_type_copy_1d_2d:
Copy fields from one coupler type to another.
coupler_type_copy_1d_3d:
Copy fields from one coupler type to another.


PUBLIC DATA

None.


PUBLIC ROUTINES

  1. coupler_types_init

    call coupler_types_init 
    
    DESCRIPTION
    Initialize the coupler types


  2. coupler_type_copy_1d_2d

    call coupler_type_copy_1d_2d 
    
    DESCRIPTION
    Copy fields from one coupler type to another. Specific version for generic coupler_type_copy.


    INPUT
    var_in    variable to copy information from
       [coupler_1d_bc_type]
    var_out    variable to copy information to
       [coupler_2d_bc_type]
    is    lower bound of first dimension
       [integer]
    ie    upper bound of first dimension
       [integer]
    js    lower bound of second dimension
       [integer]
    je    upper bound of second dimension
       [integer]
    diag_name    name for diagnostic file--if blank, then don't register the fields
       [character]
    axes    array of axes identifiers for diagnostic variable registration
       [integer]
    time    model time variable for registering diagnostic field
       [time_type]
    suffix    optional suffix to make the name identifier unique
       [character]

  3. coupler_type_copy_1d_3d

    call coupler_type_copy_1d_3d 
    
    DESCRIPTION
    Copy fields from one coupler type to another. Specific version for generic coupler_type_copy.


    INPUT
    var_in    variable to copy information from
       [coupler_1d_bc_type]
    var_out    variable to copy information to
       [coupler_3d_bc_type]
    is    lower bound of first dimension
       [integer]
    ie    upper bound of first dimension
       [integer]
    js    lower bound of second dimension
       [integer]
    je    upper bound of second dimension
       [integer]
    kd    third dimension
       [integer]
    diag_name    name for diagnostic file--if blank, then don't register the fields
       [character]
    axes    array of axes identifiers for diagnostic variable registration
       [integer]
    time    model time variable for registering diagnostic field
       [time_type]
    suffix    optional suffix to make the name identifier unique
       [character]


DATA SETS

None.


ERROR MESSAGES

None.


top