mod_sediment.F

Go to the documentation of this file.

#include "cppdefs.h"
 
/*
** git $id$
*************************************************** hernan g. arango ***
** copyright(c) 2002-2025 the roms group                             **
**   licensed under a mit/x style license                             **
**   see license_roms.md                                              **
************************************************************************
**                                                                    **
** this module declares  sediment model internal parameters.  some    **
** of these parameters are usually read from the appropriate input    **
** script.                                                            **
**                                                                    **
** the current design allows the user to have a lot of latitude for   **
** customizing or expanding the sediment model.                       **
**                                                                    **
** the sediment model is composed of several files:                   **
**                                                                    **
**   *  model source and sink discretized equations:                  **
**                                                                    **
**        sediment.f           sediment model driver                  **
**        sed_bed.f            bed layer stratigraphy                 **
**        sed_bedload.f        bedload transport                      **
**        sed_fluxes.f         deposition, resuspension, erosion      **
**        sed_settling.f       vertical settling                      **
**        sed_surface.f        sediment-water interface properties    **
**                                                                    **
**   *  internal model parameters declarations:                       **
**                                                                    **
**        sediment_mod.h                                              **
**                                                                    **
**   *  model parameters standard input script:                       **
**                                                                    **
**        sediment.in                                                 **
**                                                                    **
**   *  code to read input model parameters:                          **
**                                                                    **
**        sediment_inp.h                                              **
**                                                                    **
**   *  code to assign indices to model variables during the          **
**      reading of metadata information from "varinfo.yaml":          **
**                                                                    **
**        sediment_var.h                                              **
**                                                                    **
**   *  code to define input model parameters in all output           **
**      netcdf files:                                                 **
**                                                                    **
**        sediment_def.h                                              **
**                                                                    **
**   *  code to write out input model parameters in all output        **
**      netcdf files:                                                 **
**                                                                    **
**        sediment_wrt.h                                              **
**                                                                    **
** note that all the files are located in roms/nonlinear/sediment     **
** and the *.h files are included within  <...> to allow the user     **
** customize any of them in the project directory, while  keeping     **
** the distributed code intact(check build scripts for details).     **
**                                                                    **
************************************************************************
*/
 
#if defined SEDIMENT || defined BBL_MODEL
# include <sediment_mod.h>
#else
      MODULE mod_sediment
      END MODULE mod_sediment
#endif