How gotm-model/code works
Main Components
a. Core Simulation Components:
• Mean Flow Module (/src/meanflow)
• Turbulence Module (/src/turbulence)
• Air-Sea Interface (/src/airsea)
• Observations Module (/src/observations)
b. Supporting Components:
• Input/Output System (/src/input)
• Utilities (/src/util)
• Configuration System (/src/config)
• External Dependencies (extern/)
• CVMix
• FABM (Framework for Aquatic Biogeochemical Models)
• GSW (Gibbs SeaWater)
• Flexout
┌─────────────────────────────────────────────┐
• Input Layer │
• (NetCDF, Configuration, Observations) │
• ┤
• Core GOTM Engine │
• ┬───────────────┬────────────┤
• Mean Flow │ Turbulence │ Air-Sea │
• Processing │ Modeling │ Interface │
• ┴───────────────┴────────────┘
┌─────────────────────────────────────────────┐
• External Libraries │
• (CVMix, FABM, GSW, Flexout) │
• ┘
Specific Implementation Details
a. Physics Modules:
• Temperature equations
• Salinity calculations
• Pressure computations
• Coriolis effects
• Stokes drift
b. Turbulence Models:
• Various equation solvers (k-ε, k-ω, etc.)
• Algebraic length scales
• Dissipation equations
c. Integration Points:
• How external libraries integrate
• Data flow between components
• Configuration management
Implementation Notes
• Maintain consistent styling
• Clear labels
• Brief descriptions for each major component
• Both compile-time and runtime dependencies