CROCO’S Documentation

CROCO is an oceanic modeling system built upon ROMS_AGRIF and maintained by IRD, INRIA, CNRS, IFREMER and SHOM, French institutes working on environmental sciences and applied mathematics. An important objective for CROCO is to resolve very fine scales (especially in the coastal area), and their interactions with larger scales. It includes new capabilities such as a non-hydrostatic solver, ocean-wave-atmosphere coupling, evolving sediment dynamics and marine biogeochemistry, new high-order numerical schemes for advection and mixing, and a dedicated I/O server (XIOS). A toolbox for pre- and post-processing, CROCO_TOOLS, accompanies the source code. CROCO will keep evolving and integrating new capabilities in the following years.

• Model Documentation
  • 1. Governing Equations
    • 1.1. Primitive Equations
    • 1.2. Quasi-Hydrostatic Equations
    • 1.3. Wave-averaged Equations
    • 1.4. Non-Hydrostatic, Non-Boussinesq Equations
  • 2. Model variables
    • 2.1. Domain variables (grid.h)
    • 2.2. Barotropic variables (ocean2d.h)
    • 2.3. Tri-dimensionnal variables (ocean3d.h)
    • 2.4. Surface forcing (forces.h)
  • 3. Grid and Coordinates
    • 3.1. Vertical Grid parameters
    • 3.2. Grid staggering
    • 3.3. Wetting-Drying
  • 4. Numerics
    • 4.1. Overview
    • 4.2. Time Stepping
    • 4.3. Advection Schemes
    • 4.4. Pressure gradient
    • 4.5. Equation of State
    • 4.6. Wetting and Drying
    • 4.7. Non-Boussinesq Solver
  • 5. Parametrizations
    • 5.1. Vertical mixing parametrizations
    • 5.2. Horizontal diffusion
    • 5.3. Bottom friction
  • 6. Parallelisation
    • 6.1. Parallel strategy overview
    • 6.2. Variable placement for staggered grids
    • 6.3. Loops and indexes for staggered grids
    • 6.4. Halo layer exchanges
    • 6.5. Dealing with outputs
    • 6.6. Run with GPU
  • 7. Atmospheric Surface Boundary Layer
  • 8. Open boundaries conditions
    • 8.1. OBC
    • 8.2. Sponge Layer
    • 8.3. Nudging layers
    • 8.4. Lateral forcing
  • 9. Rivers
  • 10. Tides
  • 11. Wavemaker
    • 11.1. Formulation
    • 11.2. Input parameters
    • 11.3. JONSWAP spectrum
  • 12. Nesting Capabilities
  • 13. Other modules : sediment models, flow-obstruction models, biology models
    • 13.1. Bottom Boundary Layer model
    • 13.2. Sediment models
    • 13.3. OBSTRUCTIONS module : flow in presence of various obstructions
    • 13.4. Biogeochemical models
    • 13.5. Lagrangian floats
  • 14. Coupling CROCO with other models
    • 14.1. OASIS philosophy
    • 14.2. Detailed OASIS implementation
    • 14.3. Coupled variables
    • 14.4. Grids
  • 15. I/O and Online Diagnostics
    • 15.1. General ouptut options
    • 15.2. Advanced diagnostics options
  • 16. Testing CROCO
    • 16.1. Test Script
    • 16.2. Review of test cases
  • 17. Appendices
    • 17.1. cppdefs.h
    • 17.2. croco.in
    • 17.3. Comparison of ROMS and CROCO versions

• Tutorials
  • 1. System requirements
    • 1.1. Disk space
    • 1.2. Compilers and Libraries
    • 1.3. Environment variables
  • 2. Download
    • 2.1. Downloading CROCO
    • 2.2. Getting other codes (coupling)
  • 3. Contents & Architecture
    • 3.1. Architecture
    • 3.2. Contents
  • 4. Summary of essential steps
  • 5. Test Cases
    • 5.1. BASIN
    • 5.2. Set up you own test case
  • 6. Regional: Preparing your configuration
  • 7. Regional: Preprocessing (Matlab)
    • 7.1. Contents of the croco_tools
    • 7.2. Philosophy of the croco_tools
    • 7.3. Climatological pre-processing
    • 7.4. Interannual pre-processing
  • 8. Compiling
    • 8.1. cppdefs.h
    • 8.2. param.h
    • 8.3. Compilation using jobcomp
    • 8.4. Compilation options
    • 8.5. Tips in case of errors during compilation
  • 9. Running the model
    • 9.1. Edit croco.in
    • 9.2. Run the model
    • 9.3. Tips in case of BLOW UP or ERROR
  • 10. Increasing the resolution: BENGUELA_VHR
  • 11. Running with interannual forcing
    • 11.1. Run after classical interannual pre-processing
    • 11.2. Alternative method: online interpolation of atmospheric bulk forcing
  • 12. Running forecasts
    • 12.1. Strategy of Forecast_tools
    • 12.2. Set forecast parameters
    • 12.3. Compiling
    • 12.4. Running the script
  • 13. Nesting Tutorial
  • 14. Adding Rivers
    • 14.1. Constant flow and concentration
    • 14.2. Variable flow read in a netCDF file and constant concentration
    • 14.3. Variable flow and variable concentration from a netCDF file
    • 14.4. Using a nest
  • 15. Adding tides
    • 15.1. Pre-processing (Matlab)
    • 15.2. Compiling
    • 15.3. Running
  • 16. Visualization (Matlab)
  • 17. Python tools for CROCO
  • 18. NBQ Tutorial
    • 18.1. Some important points about Large-Eddy Simulations (LES)
    • 18.2. KH_INST Test Case
    • 18.3. Set up your own NBQ configuration
    • 18.4. NBQ OPTIONS
    • 18.5. Appendix : some words on CROCO-NBQ kernel
  • 19. Coupling tutorial
    • 19.1. Summary of steps for coupling
    • 19.2. Compiling in coupled mode
    • 19.3. Simple CROCO-TOY coupled example
    • 19.4. Advanced coupling tutorial
  • 20. Littoral tutorial
  • 21. Realistic coastal configuration
  • 22. XIOS
  • 23. Tips
    • 23.1. Tips in case of errors during compilation
    • 23.2. TIPS for errors at runtime
    • 23.3. Analytical forcing
    • 23.4. MUSTANG tips

• References