Access to the full COHERENS manual
The manual describes the code in a complete and organized manner and has two parts: a reference manual (634 p.) and a user manual (920 p.). Though Chapter 1 of the official manual provides info on its structure and a recommendation of which parts are important for a starting user, it remains a huge chunk of information. The COHERENS manual is quite unique in its completeness and structured set up among the reference books of hydrodynamic manuals. Because the manual is a vademecum, its first concern was providing all the information needed to understand the code. The manual explains the code structure, provides the theoretical background of the features included and contains all the switches and code options.
The Central Input File in COHERENS is a functionality used to setup models. The purpose of this functionality is to provide an alternative to users who are not familiar with the Fortran 90 programming language. Hence, the CIF consist mainly of a text file (i.e. ASCII format) that can be edited by any text editor whenever is necessary. The CIF file can be created on request of the user, being based on the setup data defined in the Usrdef files.
Guidelines for COHERENS developers
The full and detailled guidelines are available here.
Basic rules
The basic rules for programming can be summarised by a few key words
- Portability
- FORTRAN 90 ANSI standard to make the code compiler-independent.
- Ensure maximum independency of computing platform.
- COHERENS is intended for implementation on UNIX/LINUX systems (WINDOWS, although not excluded a priori , is not supported)
- Use bash mode for shell scripts.
- Generic Makefile independent on type of compiler and computing platform.
- System dependent parameters, such as path names for the location of libraries should be provided from a user-defined configuration file.
- Error-free
- Optimisation
- Optimise (minimise) computing time
- Optimise (minimise) internal memory use (provided this is not in conflict with CPU optimisation)
- Efficiency
- Use generic formats (i.e. for parallel communications, I/O, array interpolation, routines used by different model compartments,...).
- When a new development is added to the code, make a clear distinction to what is new and should be implemented by creating new routines and files, and what can be integrated within the already existing routines and files.
- Further recommendations are listed here.
- Transparancy
- The code should be written in a transparant user-friendly readable format so that it is understandable by other developers even if this implies a (slightly) less optimum code.
- Use standard "COHERENS" coding guide lines.
- Compliance with the User Documentation.
- Standard (consistent) formats for internal documentation.
COHERENS manual
The documentation is organised in sections and chapters. Expand individual sections, then expand chapters by clicking on the arrows.
Getting started
- 1. General overview
- 2. Getting started
- 2.1 Introduction
- 2.1.1 General requirements
- 2.1.2 Short Linux introduction
- 2.1.2.1 getting help
- 2.1.2.2 working with files
- 2.2 Running a test case
- 2.2.1 Installing a COHERENS test case
- 2.2.2 Compiling COHERENS
- 2.2.3 Running COHERENS
- 2.3 Post-processing the results
- 2.3.1 Visualising with Ncview
- 2.3.2 visualising with Ferret
- 2.3.3 visualising with Octave and Matlab
- 2.4 Modifying model setup
- 2.4.1 Modifying model setup via CIF
- 2.4.1.1 short CIF introduction
- 2.4.1.2 tutorial river test case
- 2.4.1.3 changing model setup through the CIF
- 2.4.2 Adapting model set up via the Usrdef files
- 2.4.2.1 installing and running the example test
- 2.4.2.2 changing model setup through the Usrdef files
- 2.5 Format and specific syntax of a CIF
- 3. Compilation and installation
- 3.1 Installation
- 3.2 Compilation
- 3.2.1 C-preprocessing
- 3.2.2 Testing compilation
- 3.3 Installing and running a test case
- 3.4 Installing a user application
- 3.5 Running an application with external libraries
- 3.5.1 Parallel application
- 3.5.2 Using netCDF output format
- 3.6 Setting up a user application
- 3.7 Files for compilation and installation
- 3.7.1 compilers.cmp
- 3.7.2 The file coherens flags.cmp
- 3.7.3 The script install test
Physical model description
- 4. Physical model
- 4.1 Model coordinates
- 4.1.1 Coordinate systems
- 4.1.2 Coordinate transforms in the horizontal
- 4.1.3 Coordinate transforms in the vertical
- 4.1.3.1 σ-coordinates
- 4.1.3.2 generalised σ-coordinates
- 4.1.3.3 normalised vertical coordinate
- 4.2 Basic model equations
- 4.2.1 3-D mode equations
- 4.2.1.1 Cartesian coordinates
- 4.2.1.2 transformed coordinates
- 4.2.2 2-D mode equations
- 4.2.3 Equation of state
- 4.3 Model equations on reduced grids
- 4.3.1 Water column (1-D) mode
- 4.3.2 Depth-averaged (2-D) mode
- 4.4 Turbulence schemes
- 4.4.1 Introduction
- 4.4.2 Algebraic schemes
- 4.4.2.1 Richardson number dependent formulations
- 4.4.2.2 flow-dependent formulations
- 4.4.3 RANS models
- 4.4.3.1 general form of the RANS equations
- 4.4.3.2 parameterisation of the RANS equations
- 4.4.3.3 stability functions
- 4.4.3.4 solution methods
- 4.4.3.5 mixing length formulations
- 4.4.3.6 background mixing
- 4.5 Astronomical tidal force
- 4.6 Solar radiation
- 4.7 Surface boundary conditions
- 4.7.1 General form
- 4.7.2 Currents
- 4.7.3 Temperature
- 4.7.4 Salinity
- 4.7.5 Turbulence
- 4.7.6 Water column mode
- 4.8 Surface drag and exchange coefficients
- 4.8.1 Neutral formulations
- 4.8.2 Kondo’s stratified formulation
- 4.8.3 Stratified case from Monin-Obukhov theory
- 4.9 Bottom boundary conditions
- 4.9.1 General form
- 4.9.2 Currents
- 4.9.3 Temperature and salinity
- 4.9.4 Turbulence
- 4.10 Lateral boundary conditions
- 4.10.1 Open boundary conditions for the 2-D mode
- 4.10.2 Open boundary conditions for the 3-D mode
- 4.10.2.1 baroclinic currents
- 4.10.2.2 3-D scalars
- 4.10.2.3 turbulence variables
- 4.10.3 Relaxation conditions
- 4.10.4 Coastal boundaries
- 4.11 Initial conditions
- 4.12 Harmonic analysis
- 4.12.1 Residuals, amplitudes and phases
- 4.12.2 Tidal ellipses
- 5. Numerical methods
- 5.1 Introduction
- 5.2 Model grid and discretisations
- 5.2.1 Grid nodes and indexing system
- 5.2.2 Open boundaries
- 5.2.3 Conventions
- 5.2.4 Space discretisation
- 5.2.5 Time discretisation
- 5.3 Momentum equations
- 5.3.1 General procedure for the explicit case
- 5.3.1.1 predictor step
- 5.3.1.2 depth-integrated equations
- 5.3.1.3 corrector step
- 5.3.1.4 vertical current
- 5.3.2 General procedure for the implicit case
- 5.3.3 Advection schemes and time discretisation
- 5.3.3.1 introduction
- 5.3.3.2 mode splitting scheme for the 3-D momentum equations
- 5.3.3.3 mode splitting scheme for the 2-D momentum equations
- 5.3.4 Discretisation of 3-D horizontal advection
- 5.3.4.1 alongstream advection of u
- 5.3.4.2 cross-stream advection of u
- 5.3.4.3 cross-stream advection of v
- 5.3.4.4 alongstream advection of v
- 5.3.5 Discretisation of 2-D horizontal advection
- 5.3.5.1 alongstream advection of U
- 5.3.5.2 cross-stream advection of U
- 5.3.5.3 cross-stream advection of V
- 5.3.5.4 alongstream advection of V
- 5.3.6 Integrals of the baroclinic advection terms
- 5.3.7 Discretisation of vertical advection
- 5.3.7.1 vertical advection of u
- 5.3.7.2 vertical advection of v
- 5.3.8 Discretisation of 3-D horizontal diffusion
- 5.3.9 Discretisation of 2-D horizontal diffusion
- 5.3.10 Integrals of the baroclinic diffusion terms
- 5.3.11 Discretisation of vertical diffusion
- 5.3.12 Diffusion coefficients for momentum
- 5.3.12.1 horizontal diffusion coefficients
- 5.3.12.2 vertical diffusion coefficient
- 5.3.13 Discretisation of the baroclinic pressure gradient
- 5.3.13.1 second-order method
- 5.3.13.2 z-level method
- 5.3.13.3 cube-H method
- 5.3.14 Tidal force
- 5.3.15 Surface and bottom boundary conditions
- 5.3.15.1 surface boundary conditions
- 5.3.15.2 bottom boundary conditions
- 5.3.16 Lateral boundary conditions for the 2-D mode
- 5.3.16.1 open boundary conditions for transports
- 5.3.16.2 open boundary conditions for 2-D advective and diffusive fluxes
- 5.3.16.3 boundary conditions at closed lateral boundaries
- 5.3.17 Lateral boundary conditions for the 3-D currents
- 5.3.17.1 open boundary conditions for horizontal 3-D currents
- 5.3.17.2 open boundary conditions for the advective and diffusive fluxes of the 3-D currents
- 5.3.17.3 boundary conditions for the 3-D mode at closed lateral boundaries
- 5.3.18 Solution of the discretised equations for momentum
- 5.3.18.1 composition of the tridiagonal matrix
- 5.3.18.2 solution of tridiagonal systems
- 5.3.19 Elliptic equation for the free surface correction
- 5.3.19.1 interior terms
- 5.3.19.2 open boundary terms
- 5.4 Drying/wetting and inundation schemes
- 5.4.1 Drying and wetting algorithm
- 5.4.2 Inundation schemes
- 5.5 Scalar transport equations
- 5.5.1 General aspects of discretisation
- 5.5.2 Alternative formulation of the transport equation
- 5.5.3 Time discretisation
- 5.5.3.1 integration without advection
- 5.5.3.2 integration with advection but without operator splitting
- 5.5.3.3 integration with operator splitting
- 5.5.4 Discretisation of advection
- 5.5.4.1 advection in the X-direction
- 5.5.4.2 advection in the Y-direction
- 5.5.4.3 advection in the vertical direction
- 5.5.4.4 corrector terms
- 5.5.5 Discretisation of diffusion
- 5.5.5.1 diffusion in the X-direction
- 5.5.5.2 diffusion in the Y-direction
- 5.5.5.3 diffusion in the vertical direction
- 5.5.6 Diffusion coefficients for scalars
- 5.5.6.1 horizontal diffusion coefficients
- 5.5.6.2 vertical diffusion coefficient
- 5.5.7 Boundary conditions
- 5.5.7.1 surface boundary conditions
- 5.5.7.2 bottom boundary conditions
- 5.5.7.3 lateral boundary conditions
- 5.5.8 Solution of the discretised equations for scalars
- 5.6 Turbulence transport equations
- 5.6.1 Time discretisation
- 5.6.1.1 integration without advection
- 5.6.1.2 integration with advection but without operator splitting
- 5.6.1.3 integration with operator splitting
- 5.6.2 Discretisation of advection
- 5.6.2.1 advection in the X-direction
- 5.6.2.2 advection in the Y-direction
- 5.6.2.3 advection in the vertical direction
- 5.6.2.4 corrector terms
- 5.6.3 Discretisation of diffusion
- 5.6.3.1 diffusion in the X-direction
- 5.6.3.2 diffusion in the Y-direction
- 5.6.3.3 diffusion in the vertical direction
- 5.6.4 Diffusion coefficients for turbulence variables
- 5.6.4.1 horizontal diffusion coefficients
- 5.6.4.2 vertical diffusion coefficients
- 5.6.5 Production and sink terms
- 5.6.6 Boundary conditions
- 5.6.6.1 surface boundary conditions
- 5.6.6.2 bottom boundary conditions
- 5.6.6.3 lateral boundary conditions
- 5.6.7 Solution of the discretised equations for turbulent transport variables
- 5.7 Discretisations on reduced grids
- 5.7.1 Discretised 1-D mode equations
- 5.7.2 Discretised depth-integrated equations
- 5.8 Solution procedure
- 6. Structures and discharges model
- 7. Sediment transport model
- 7.1 Introduction
- 7.2 Physical aspects
- 7.2.1 Bed shear stresses
- 7.2.2 Wave effects
- 7.2.3 Density effects
- 7.2.3.1 Equation of state
- 7.2.3.2 Density stratification
- 7.2.4 Kinematic viscosity
- 7.3 Sediment properties
- 7.3.1 Introduction
- 7.3.2 Critical shear stress
- 7.3.2.1 Hiding and exposure
- 7.3.2.2 Bed level gradient
- 7.3.3 Settling velocity
- 7.3.3.1 Single particle settling
- 7.3.3.2 Hindered settling
- 7.3.3.3 Influence of flocculation
- 7.4 Bed load
- 7.4.1 Introduction
- 7.4.1.1 Transport of different sediment size classes
- 7.4.1.2 Applicability of transport models
- 7.4.2 Meyer-Peter and Mueller -1948
- 7.4.3 Engelund and Fredsøe -1976
- 7.4.4 Van Rijn (1984b)
- 7.4.5.Wu.et.al -2000
- 7.4.6 Soulsby -1997
- 7.4.7 Van Rijn (2007a)
- 7.4.8 Van Rijn -2003
- 7.4.9 Bed slope effects and coordinate transforms
- 7.5 Total Load
- 7.5.1 Engelund and Hansen -1967
- 7.5.2 Ackers and White -1973
- 7.5.3 Madsen and Grant -1976
- 7.5.4.Wu.et.al -2000
- 7.5.5 Van Rijn -2003
- 7.5.5.1 Current-related part
- 7.5.5.2 Wave-related part
- 7.5.6 Van Rijn (2007a)
- 7.6 Suspended sediment transport
- 7.6.1 Three-dimensional sediment transport
- 7.6.2 Two-dimensional sediment transport
- 7.6.3 Erosion and deposition
- 7.6.3.1 Erosion and deposition of sand.in 3-D
- 7.6.3.2 Erosion of cohesive sediment.in 3-D
- 7.6.3.3 Erosion-deposition of sand.in 2-D
- 7.6.3.4 Erosion-deposition of cohesive sediment.in 2-D
- 7.6.4 Sediment diffusivity
- 7.6.4.1 Without wave effects
- 7.6.4.2 With waves effects
- 7.6.5 Boundary conditions
- 7.7 Numerical methods
- 7.7.1 Erosion-deposition
- 7.7.1.1 Three-dimensional sediment transport
- 7.7.1.2 Time integration of sediment transport
- 7.7.2 Bed slope factors
- 7.7.3 Gaussian-Legendre quadrature
- 7.7.4 Bartnicki filter
- 8. Program conventions and techniques
- 8.1 Implementation of FORTRAN.90
- 8.1.1 COHERENS programming conventions
- 8.1.2 Data types
- 8.1.3 Allocatable arrays
- 8.1.4 Derived types
- 8.1.5 Modules
- 8.1.6 Generic procedures
- 8.1.7 Internal documentation and structured layout of
- code
- 8.2 Specific program features
- 8.2.1 Key ids
- 8.2.2 Date and time formats
- 8.2.3 Data flags
- 8.2.4 Variable units
Model code description
- 9. Model input and output
- 9.1 Classification of model files
- 9.2 Default file names
- 9.2.1 title
- 9.2.2 pid
- 9.2.3 form
- 9.2.4 filedesc
- 9.2.5 filenum
- 9.2.6 freqnum
- 9.2.7 dim
- 9.3 Formats of monitoring files
- 9.3.1 Log files
- 9.3.2 Error files
- 9.3.3 Warning file
- 9.3.4 Timer report file
- 9.4 Central input file
- 9.4.1 Syntax of.a CIF
- 9.4.2 CIF blocks
- 9.4.3 Order of definitions
- 9.5 Forcing files
- 9.5.1 General aspects
- 9.5.2 Data contents of forcing files
- 9.5.3 Standard format of forcing files
- 9.5.3.1 ASCII files
- 9.5.3.2 unformatted binary files
- 9.5.3.3 netCDF files
- 9.6 User output files
- 9.6.1 General aspects
- 9.6.2 Structure of user output files
- 9.6.3 Format of files with user-defined output
- 9.6.3.1 ASCII files
- 9.6.3.2 unformatted binary files
- 9.6.3.3 netcdf files
- 10. Model grid and spatial interpolation
- 10.1 Model grid arrays
- 10.1.1 Array shapes
- 10.1.2 Parameters and arrays related.to the model grid
- 10.1.2.1 definition of the model grid
- 10.1.2.2 definition of the open boundaries
- 10.1.2.3 grid spacings
- 10.1.2.4 pointer arrays
- 10.2 Interpolation of model arrays.at.a different node
- 10.2.1 Interpolation without land flags
- 10.2.2 Interpolation with land flags
- 10.3 Curvilinear, index and relative coordinates
- 10.4 Interpolation of a 2-D external data grid at the model grid
- 10.4.1 General description of the procedure
- 10.4.2 Implementation
- 10.5 Interpolation of model data.at external locations
- 10.5.1 General description of the procedure
- 10.5.2 Implementation
- 11. Aspects of parallellisation
- 11.1 Basic principles
- 11.1.1 Implementation of MPI
- 11.1.2 Principles of the parallel code
- 11.2 Domain decomposition
- 11.2.1 Definition
- 11.2.2 Local grid indexing system
- 11.3 Halos
- 11.4 Communications
- 11.4.1 Send and receive in MPI
- 11.4.2 Sort of communications
- 11.4.3 Implementation
- 11.4.3.1 all-to-all operations
- 11.4.3.2 exchange operations
- 11.4.3.3 program routines for communications
- 11.5 Local versus global array indexing
- 12. Structure of the model code
User manual
- 13. User manual introduction
- 14. Control parameters
- 14.1 File defruns
- 14.2 Parameters for monitoring
- 14.2.1 Cold start
- 14.2.2 Log files
- 14.2.3 Error files
- 14.2.4 Warning file
- 14.2.5 Timer file
- 14.3 Dimensions of the process domain grid
- 14.4 Model switches
- 14.4.1 Model grid
- 14.4.2 Interpolation
- 14.4.3 Hydrodynamics
- 14.4.4 Density
- 14.4.5 External modules
- 14.4.6 Bottom boundary conditions
- 14.4.7 Advection
- 14.4.8 Diffusion coefficients
- 14.4.9 Turbulence schemes
- 14.4.10 Drying/wetting scheme
- 14.4.11 Structures
- 14.4.12 Time integration
- 14.4.13 Open boundary conditions
- 14.4.14 Tides
- 14.4.15 1-D applications
- 14.4.16 Surface forcing
- 14.4.17 Surface boundary conditions
- 14.4.18 Nesting
- 14.4.19 MPI mode
- 14.4.20 PETSc
- 14.4.21 User output
- 14.4.22 NetCDF
- 14.5 Model parameters
- 14.5.1 Date and time parameters
- 14.5.2 Grid parameters
- 14.5.3 Other integer model parameters
- 14.5.4 Physical model parameters
- 14.5.5 Turbulence model parameters
- 14.6 Parameters for surface data grids
- 14.6.1 Grid descriptors
- 14.6.2 Grid parameters
- 14.7 Attributes of forcing files
- 14.7.1 File descriptors
- 14.7.2 File parameters for input forcing (iotype=1)
- 14.7.3 File parameters for output forcing (iotype=2)
- 14.7.4 Other forcing attributes
- 14.8 Parameters for user-defined output
- 14.9 Domain decomposition
- 15. Model grid and initial conditions
- 16. Open boundary conditions
- 16.1 2-D mode
- 16.1.1 Open boundary specifiers for the 2-D mode
- 16.1.1.1 general specifiers
- 16.1.1.2 specifiers for the data files
- 16.1.1.3 amplitudes and phases
- 16.1.2 Open boundary data for the 2-D mode
- 16.2 3-D mode
- 16.2.1 Open boundary specifiers for the 3-D mode
- 16.2.1.1 general specifiers
- 16.2.1.2 specifiers for the data files
- 16.2.2 Open boundary data for the 3-D mode
- 16.3 Specifiers for relaxation open boundary conditions
- 17. Surface forcing and nesting
- 17.1 Water column surface forcing
- 17.1.1 Surface forcing specifiers for the 1-D mode
- 17.1.2 Surface forcing data for the 1-D mode
- 17.2 2-D surface forcing
- 17.2.1 Surface grid in absolute coordinates
- 17.2.2 Surface grid in relative coordinates
- 17.2.3 Surface forcing data
- 17.3 Nesting
- 17.3.1 Sub-grid specifications
- 17.3.2 Sub-grid locations in absolute coordinates
- 17.3.3 Sub-grid locations in relative coordinates
- 18. Structure and discharge module
- 19. Sediment transport module
- 20. User output
- 20.1 Time series output
- 20.1.1 Specifiers for time series output
- 20.1.1.1 variable attributes
- 20.1.1.2 file attributes
- 20.1.1.3 output data grid
- 20.1.1.4 station attributes
- 20.1.2 Time series output data
- 20.1.2.1 values of 0-D time series data
- 20.1.2.2 values of 2-D time series data
- 20.1.2.3 values of 3-D time series data
- 20.2 Time averaged output
- 20.2.1 Specifiers for time averaged output
- 20.2.1.1 variable attributes
- 20.2.1.2 file attributes
- 20.2.1.3 output data grid
- 20.2.1.4 station attributes
- 20.2.2 Time averaged output data
- 20.2.2.1 values of 0-D time averaged data
- 20.2.2.2 values of 2-D time averaged data
- 20.2.2.3 values of 3-D time averaged data
- 20.3 Harmonic analysis
- 20.3.1 Harmonic frequencies
- 20.3.2 Specifiers for harmonic output
- 20.3.2.1 variable attributes
- 20.3.2.2 file attributes
- 20.3.2.3 output data grid
- 20.3.2.4 station attributes
- 20.3.3 Harmonic output data
- 20.3.3.1 values of 0-D harmonic data
- 20.3.3.2 values of 2-D harmonic data
- 20.3.3.3 values of 3-D harmonic data
- 20.4 User-defined output
- 20.5 Output grid coordinates
- 21. Recommendations for programming
Test cases
- 22. Introduction to test cases
- 23. Advection schemes
- 23.1 Test case cones
- 23.1.1 Description of the problem and model setup
- 23.1.2 Experiments and output parameters
- 23.1.3 Results
- 23.2 Test case front
- 23.2.1 Description of the problem and model setup
- 23.2.2 Experiments and output parameters
- 23.2.3 Results
- 23.3 Test case seich
- 23.3.1 Description of the problem and model setup
- 23.3.2 Analytical solution
- 23.3.3 Experiments and output parameters
- 23.3.4 Results
- 23.4 Test case fredy
- 23.4.1 Description of the problem and model setup
- 23.4.2 Experiments and output parameters
- 23.4.3 Results
- 24. Turbulence and heat flux formulations
- 25. Density fronts and river plumes
- 25.1 Test case river
- 25.1.1 Description of the problem and model setup
- 25.1.2 Experiments and output parameters
- 25.1.3 Results
- 25.2 Test case plume
- 25.2.1 Description of the problem and model setup
- 25.2.2 Experiments and output parameters
- 25.2.3 Results
- 25.3 Test case rhone
- 25.3.1 Description of the problem and model setup
- 25.3.2 Experiments and output parameters
- 25.3.3 Results
- 26. Inundation schemes
- 27. Shelf sea modelling
- 28. Structure and discharge test cases
- 28.1 Introduction
- 28.2 Test case drythin
- 28.2.1 Model setup
- 28.2.2 Experiments and output parameters
- 28.2.3 Results
- 28.3 Test case weirbar
- 28.3.1 Model setup
- 28.3.2 Experiments and output parameters
- 28.3.3 Results
- 28.4 Test case discharges
- 28.4.1 Model setup
- 28.4.2 Experiments and output parameters
- 28.4.3 Results
- 29. Sediment transport
- 29.1 Introduction
- 29.2 Test case bedload
- 29.2.1 Model setup
- 29.2.2 Experiments and output parameters
- 29.2.3 Results
- 29.2.4 Conclusion
- 29.3 Test case totload
- 29.3.1 Model setup
- 29.3.2 Experiments and output parameters
- 29.3.3 Results
- 29.3.4 Conclusion
- 29.4 Test case wavload
- 29.4.1 Model setup
- 29.4.2 Experiments and output parameters
- 29.4.3 Results
- 29.5 Test case sedvprof
- 29.5.1 Introduction
- 29.5.2 Model setup
- 29.5.3 Results
- 29.5.4 Conclusions
- 29.5.5 Experiments and output parameters
- 29.6 Test case sedhprof
- 29.6.1 Introduction
- 29.6.2 Model setup
- 29.6.3 Experiments and output parameters
- 29.6.4 Results
- 29.6.5 Conclusion
- 29.7 Test case seddens
- 29.7.1 Introduction
- 29.7.2 Model setup
- 29.7.3 Experiments and output parameters
- 29.7.4 Results
- 29.7.5 Conclusion
- 29.8 Test case thacker
- 29.8.1 Introduction
- 29.8.2 Model setup
- 29.8.3 Experiments and output parameters
- 29.8.4 Results
- 29.8.4.1 2-D simulations
- 29.8.5 3-D simulations
- 29.8.6 Conclusion
Reference manual and appendices
- 30. Description of external routines
- 31. Description of modules routines
- 32. Description of user defined routines
- 33. Description of program variables
- 34. Sediment reference manual
- Appendix A. Transformed model equations
- Appendix B. Solutions of the RANS equations
- Appendix C. Discretisation of the Coriolis force
- Appendix D. Energy balance equation
- Appendix E. List of standard output variables
- Bibliography
CIF manual
The CIF manual will be made available in the near future.
The CIF file is composed of two main components, the parameters defined in the CIF file and the callings to external files where forcing data is defined. These forcing data is still provided in a standard COHERENS format. These formats can be read by the program without the need to change the model setup code (and recompile the program) in the Usrdef files.
This file is composed of different data blocks, which are identified by a keyword to facilitate the input of data:
| Keyword | Description |
|---|---|
| INIT | Monitoring parameters |
| PHYSICS | General model setup parameters |
| SEDIMENTS | Parameters for sediment transport |
| TIMESERIES | Parameters for the setup of time series output |
| TIMEAVERAGE | Parameters for the setup of time averages output |
| FREQS | Parameters for the setup of harmonic analysis |
| HARMONIC | Parameters for the setup of harmonic analysis |