#TOC Entry REPLACE PATTERN
#The following are used to preformat the table of contents
Installation _INSTALL_ ^
3. Getting started and using the MITgcm
Download _DOWNLOAD_ ^3.* Obtaining the code
Compilation _COMPILATION_ ^3.* Building the code
Running the model _RUNNING_ ^3.* Running the model
Customization _CUSTOMIZATION_ ^3.* Doing it yourself: customizing the code
Tutorials _TUTORIALS_ ^3.* Tutorials
Barotropic Gyre _BAROTROPIC_ ^3.* Barotropic Ocean Gyre In Cartesian Coordinates
Baroclinic Gyre _BAROCLINIC_ ^3.* Four Layer Baroclinic Ocean Gyre In Spherical Coordinates
Global Ocean _GLOBAL_ ^3.* Global Ocean Simulation at 4
Held Suarez Atmosphe _HELD_ ^3.* Held-Suarez Atmospheric Simulation at 2.8
Open Ocean Convectio _OPEN_ ^3.* Surface Driven Convection
Shelf Convection _SHELF_ ^3.* Gravity Plume
Tracer injection _TRACERINJ_ ^3.* Centennial Time Scale
# Parallel Global Ocea _PARALLEL_ ^5. Tutorial II - Parallelism
Tracer Sensitivity _TRACER_ ^5.* Sensitivity of Air-Sea Exchange to Tracer Injection Site
Documentation _DOCUMENTATION_ ^1. Overview of MITgcm
MITgcm in Action _MITGCM_ ^1.* Introduction
Continuous formulati _CONTINUOUS_ ^1.* Continuous
Numerical Algorithm _NUMERICAL_ ^2. Discretization and Algorithm
Software Architectur _SOFTWARE_ ^4. Software Architecture
Automatic Differenti _AUTOMATIC_ ^5. Automatic Differentiation
Optional Packages _OPTIONAL_ ^6. Physical
Diagnostics _DIAGNOSTICS_ ^7. Diagnostics and tools
Interface to ECCO _INTERFACE_ ^8. Interface with ECCO
#The following are used to preformat the front_page
Atmosphere _ATMOSPHERE_ ^1.* Global atmosphere: `Held-Suarez' benchmark
Oceanic _OCEANIC_ ^1.* Global ocean circulation
Non-Hydrostatic _NONHYDROSTATIC_ ^1.* Convection and mixing over topography
Horizontal Orthogonal _HORIZONTAL_ ^2.* Vector invariant momentum equations
Finite Volume _FINITE_ fig:finite-volumes
Physical Parameteriz _PHYSICAL_ ^6. Physical
Tangent Linear _TANGENT_ ^1.* Parameter sensitivity using the adjoint of MITgcm
Domain Decomposition _DOMAIN_ The three level domain decomposition
#Documentation - see above
#Download - see above
#Tutorials see above
#Browse Code - see above
#The following are used to preformat the Quicklinks menu
AD _AD_ ^5. Automatic Differentiation
Adjoint _ADJOINT_ ^5.1.2 Reverse or adjoint sensitivity
Atmospheric _ATMOSPHERIC_ ^1.4.1 Hydrostatic
CVS _CVS_ ^3.2 Obtaining the code
Flux-form _FLUX_ ^2.13 Flux-form momentum equations
GM/Redi _GM_ ^6.1 Gent/McWiliams/Redi SGS Eddy parameterization
KPP _KPP_ ^6.2 Ocean vertical mixing
Linear Advection _LINEAR_ ^2.16 Linear advection schemes
MATLAB _MATLAB_ ^7.1.2 utils/matlab
Nonlinear Advection _NONLINEAR_ ^2.17 Non-linear advection schemes
Ocean Equations _OCEANEQ_ ^1.5.1 Equations of motion for the ocean
Operators _OPERATORS_ ^1.6 Appendix:OPERATORS
#Runtime Diagnostics _DIAGNOSTICS ^7. Diagnostics and tools
Starting/Restarting _STARTING_ ^3.6 Running the model
Tangent-linear _TANGENT_ ^5.1.1 Forward or direct
Time-stepping _TIMESTEP_ ^2.1 Time-stepping
MPI _MPI_ ^4.2.7 Distributed memory
Threads _THREADS_ ^4.2.6 Shared memory
Vector Invariant _VECTOR_ ^2.14 Vector invariant momentum equations
WRAPPER _WRAPPER_ ^4.2 WRAPPER