How hycom/hycom-src works
HYCOM-src is the source for a layered ocean general-circulation model. The documented scientific workflow is primitive-equation horizontal dynamics with layered continuity, using an ALE vertical-coordinate approach; the tree also identifies initialization, time integration, physics, and restart/archive code. Parallel tiled communication and array I/O are substantial internal layers, and coupling interfaces are present as separate branches. The excerpts establish behavior for selected communication and I/O helpers, but not their callers or most model-module interactions, so those connections are omitted or marked unverified.
Main entry points: hycom.F90 HYCOM driver · mod_za.F90 Array I/O interface · mod_momtum.F90 Momentum dynamics · mod_tsadvc.F90 Tracer advection
Components 25
Ocean Model
- HYCOM driver
hycom.F90 - Model initialization
inicon.F90 - Layer continuity
cnuity.F90 - ALE layers
hybgen.F90 - Momentum dynamics
mod_momtum.F90 - Tracer advection
mod_tsadvc.F90
Ocean Physics
- Equation of state
stmt_fns.h - Convection
convec.F90 - KPP mixing
inikpp.F90 - Tidal forcing
mod_tides.F90 - Stokes forcing
mod_stokes.F90
Parallel Runtime
- Grid dimensions
dimensions.h - MPI communication
mod_xc_mp.h - Shared-memory communication
mod_xc_sm.h
Model I/O
- Array I/O interface
mod_za.F90 - MPI array I/O
mod_za_mp.h - Message-passing I/O
mod_za_mp1.h - Single-process I/O
mod_za_sm.h - Per-tile I/O
mod_za_zt.h - Restart state
mod_restart.F90 - Model archive
mod_archiv.F90
Coupling Interfaces
- NUOPC coupling
CESMBETA/ocn_comp_nuopc_mod.F90 - MCT coupling
CESMBETA/ocn_comp_mct.F90 - NAVYESPC coupling
NAVYESPC/HYCOM_OceanComp.F90
Other components
- Model operator
Connections 25
- Model operator → HYCOM driver: runs model
- HYCOM driver → Model initialization: initializes
- HYCOM driver → Layer continuity: advances layers
- HYCOM driver → ALE layers: updates coordinates
- HYCOM driver → Momentum dynamics: computes dynamics
- HYCOM driver → Tracer advection: advances tracers
- HYCOM driver → Convection: applies mixing
- HYCOM driver → KPP mixing: uses mixing
- HYCOM driver → Tidal forcing: applies forcing
- HYCOM driver → Stokes forcing: applies forcing
- Momentum dynamics → Equation of state: uses constants
- Tracer advection → Equation of state: uses constants
- HYCOM driver → MPI communication: uses communication
- HYCOM driver → Shared-memory communication: uses communication
- HYCOM driver → Grid dimensions: uses dimensions
- HYCOM driver → Array I/O interface: uses array I/O
- Array I/O interface → MPI array I/O: selects backend
- Array I/O interface → Message-passing I/O: selects backend
- Array I/O interface → Single-process I/O: selects backend
- Array I/O interface → Per-tile I/O: selects backend
- HYCOM driver → Restart state: saves state
- HYCOM driver → Model archive: archives fields
- HYCOM driver → NUOPC coupling: couples through
- HYCOM driver → MCT coupling: couples through
- HYCOM driver → NAVYESPC coupling: couples through