6. Physical Parameterization and Packages

Within this chapter, the MITgcm ``packages'' are described. Initially, ``packages'' were conceived to group source code files together based upon their functionality. Each package was assigned a separate subdirectory (within pkg) and, usually, contained source code for implimenting different physical parametizations. This was a convenient method for both segregating and rapidly including or excluding parameterizations during the software build process.

Over time, package use has increased. The number of packages has grown and they have evolved to contain much of the model functionality including momentum schemes, I/O utilities, diagnostics, ``exchange'' algorithms for domain decomposition, and numerous physical parameterizations. The following sections describe how to use the existing packages and how to modify them and create new ones.

• 6.1 Using MITgcm Packages
  • 6.1.1 Package Inclusion/Exclusion
  • 6.1.2 Package Activation
  
  
• 6.2 Package Coding Standards
  • 6.2.1 Packages are Not Libraries
  
  
• 6.3 Gent/McWiliams/Redi SGS Eddy parameterization
  • 6.3.1 Redi scheme: Isopycnal diffusion
  • 6.3.2 GM parameterization
  • 6.3.3 Griffies Skew Flux
  • 6.3.4 Variable
  • 6.3.5 Tapering and stability
  • 6.3.6 Tapering: Danabasoglu and McWilliams, J. Clim. 1995
  • 6.3.7 Tapering: Large, Danabasoglu and Doney, JPO 1997
  • 6.3.8 Package Reference
  
  
• 6.4 DIC Package
  • 6.4.1 Introduction
  • 6.4.2 Key subroutines and parameters
  • 6.4.3 Do's and Don'ts
  • 6.4.4 Reference Material
  
  
• 6.5 Ocean vertical mixing - the nonlocal K-profile parameterization scheme KPP
• 6.6 Thermodynamic Sea Ice Package: ``thsice''
• 6.7 Sea Ice Package: ``seaice''
• 6.8 Bulk Formula Package
• 6.9 Generic Advection/Diffusion
  • 6.9.1 Introduction
  • 6.9.2 Key subroutines, parameters and files
  
  
• 6.10 Atmospheric Intermediate Physics: AIM
  • 6.10.1 Key subroutines, parameters and files
  
  
• 6.11 Land package
• 6.12 Coupling interface for Atmospheric Intermediate code
  • 6.12.1 Key subroutines, parameters and files
  
  
• 6.13 Coupler for mapping between AIM and ocean
  • 6.13.1 Key subroutines, parameters and files
  
  
• 6.14 Toolkit for building couplers
  • 6.14.1 Key subroutines, parameters and files
  
  
• 6.15 NetCDF I/O Integration: MNC
  • 6.15.1 Using MNC
  • 6.15.2 MNC Internals
  
  
• 6.16 MDSIO
• 6.17 Simulation state monitoring toolkit
  • 6.17.1 Key subroutines, parameters and files
  
  
• 6.18 exch2: Extended Cubed Sphere Topology
  • 6.18.1 Introduction
  • 6.18.2 Invoking exch2
  • 6.18.3 Generating Topology Files for exch2
  • 6.18.4 exch2, SIZE.h, and Multiprocessing
  • 6.18.5 Key Variables
  • 6.18.6 Key Routines
  
  
• 6.19 RW Basic binary I/O utilities
  • 6.19.1 Introduction
  
  
• 6.20 FFT Filtering Code
  • 6.20.1 Key subroutines, parameters and files
  
  
• 6.21 GCHEM Package
  • 6.21.1 Introduction
  • 6.21.2 Key subroutines and parameters
  • 6.21.3 Do's and Don'ts
  • 6.21.4 Reference Material

Copyright © 2002 Massachusetts Institute of Technology