Welcome to MITgcm’s user manual

Contents:

• 1. Overview
  • 1.1. Introduction
  • 1.2. Illustrations of the model in action
    • 1.2.1. Convection and mixing over topography
    • 1.2.2. Boundary forced internal waves
• 2. Physical Parameterizations - Packages I
  • 2.1. Overview
    • 2.1.1. Using MITgcm Packages
  • 2.2. Packages Related to Hydrodynamical Kernel
    • 2.2.1. Generic Advection/Diffusion
    • 2.2.2. Shapiro Filter
    • 2.2.3. FFT Filtering Code
    • 2.2.4. exch2: Extended Cubed Sphere Topology
    • 2.2.5. Gridalt - Alternate Grid Package
  • 2.3. General purpose numerical infrastructure packages
    • 2.3.1. OBCS: Open boundary conditions for regional modeling
    • 2.3.2. RBCS Package
    • 2.3.3. PTRACERS Package
  • 2.4. Ocean Packages
    • 2.4.1. GMREDI: Gent-McWilliams/Redi SGS Eddy Parameterization
    • 2.4.2. KPP: Nonlocal K-Profile Parameterization for Vertical Mixing
    • 2.4.3. GGL90: a TKE vertical mixing scheme
    • 2.4.4. OPPS: Ocean Penetrative Plume Scheme
    • 2.4.5. KL10: Vertical Mixing Due to Breaking Internal Waves
    • 2.4.6. BULK_FORCE: Bulk Formula Package
    • 2.4.7. EXF: The external forcing package
    • 2.4.8. CAL: The calendar package
  • 2.5. Atmosphere Packages
    • 2.5.1. Atmospheric Intermediate Physics: AIM
    • 2.5.2. Land package
    • 2.5.3. Fizhi: High-end Atmospheric Physics
  • 2.6. Sea Ice Packages
    • 2.6.1. THSICE: The Thermodynamic Sea Ice Package
    • 2.6.2. SEAICE Package
• 3. Getting Started with MITgcm
  • 3.1. Where to find information
• 4. MITgcm Example Experiments
  • 4.1. Full list of model examples
  • 4.2. Barotropic Gyre MITgcm Example
    • 4.2.1. Equations Solved
    • 4.2.2. Discrete Numerical Configuration
    • 4.2.3. Code Configuration
  • 4.3. A Rotating Tank in Cylindrical Coordinates
    • 4.3.1. Overview
    • 4.3.2. Equations Solved
    • 4.3.3. Discrete Numerical Configuration
    • 4.3.4. Code Configuration
• 5. Contributing to the MITgcm
  • 5.1. Bugs and feature requests
  • 5.2. Contributing to the code
    • 5.2.1. Quickstart Guide
    • 5.2.2. Detailed guide
    • 5.2.3. Style guide
    • 5.2.4. Automatic testing with Travis-CI
  • 5.3. Contributing to the manual
    • 5.3.1. Section headings
    • 5.3.2. Cross referencing
    • 5.3.3. Maths
    • 5.3.4. Units
    • 5.3.5. Describing subroutine inputs and outputs
  • 5.4. Reviewing pull requests
• 6. References