Commit de0115cc authored by hb's avatar hb
Browse files

Small LaTeX corrections to source code documentation

parent dca69fd9
!$Id: internal_pressure.F90,v 1.12 2006-01-28 20:07:54 hb Exp $
!$Id: internal_pressure.F90,v 1.13 2006-01-29 20:32:33 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -9,11 +9,14 @@
module internal_pressure
!
! !DESCRIPTION:
!
! \begin{verbatim}
! ip_method=1 ! old GETM version of Blumberg-Mellor, very stable
! ip_method=2 ! new GETM version of 1, zero for linear profiles
! ip_method=3 ! z-coordinates, linear interpolation
! ip_method=4 ! Song and Wright 1998 version
! ip_method=5 ! CHU and FAN 2003 version
! \end{verbatim}
!
! !USES:
use exceptions
......@@ -52,6 +55,9 @@
! Original author(s): Hans Burchard & Karsten Bolding
!
! $Log: internal_pressure.F90,v $
! Revision 1.13 2006-01-29 20:32:33 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.12 2006-01-28 20:07:54 hb
! Extensions to compiler option SLICE_MODEL for better representation of zero gradients in y-direction
!
......
!$Id: m3d.F90,v 1.26 2006-01-27 16:07:56 kbk Exp $
!$Id: m3d.F90,v 1.27 2006-01-29 20:32:33 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -58,6 +58,9 @@
! Original author(s): Karsten Bolding & Hans Burchard
!
! $Log: m3d.F90,v $
! Revision 1.27 2006-01-29 20:32:33 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.26 2006-01-27 16:07:56 kbk
! now works with -DNO_BAROCLINIC
!
......@@ -443,9 +446,10 @@
!
! !DESCRIPTION:
! A wrapper to call all 3D related subroutines in one subroutine.
! if #MUDFLAT is defined, then the sequence of velocity equations
! if the compiler option {\tt MUDFLAT} is defined, then the sequence of
! velocity equations
! and coordinate construction is made such that drying and flooding
! is stable. If #MUDFLAT is not defined, then adaptive grids with
! is stable. If {\tt MUDFLAT} is not defined, then adaptive grids with
! Lagrangian component are supported. Both, drying and flooding and
! Lagrangian coordinates does not go together.
!
......
!$Id: rivers.F90,v 1.7 2005-09-23 11:27:43 kbk Exp $
!$Id: rivers.F90,v 1.8 2006-01-29 20:32:33 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -79,6 +79,9 @@
! Original author(s): Karsten Bolding & Hans Burchard
!
! $Log: rivers.F90,v $
! Revision 1.8 2006-01-29 20:32:33 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.7 2005-09-23 11:27:43 kbk
! support fo nutrient loading in rivers
!
......@@ -308,7 +311,7 @@
!
! !DESCRIPTION:
! Allocates memory for storing the biological loads from rivers.
! The variable - river_bio - is initialised to - bio_missing.
! The variable - {\tt river\_bio} - is initialised to - {\tt bio\_missing}.
!
! !USES:
IMPLICIT NONE
......
!$Id: spm.F90,v 1.5 2004-06-15 08:25:57 kbk Exp $
!$Id: spm.F90,v 1.6 2006-01-29 20:32:33 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -34,7 +34,7 @@
! \end{array}
! \right.
! \end{equation}
! with $c_e erosion constant with units kg\,s\,m$^{-4}$
! with $c_e$ erosion constant with units kg\,s\,m$^{-4}$
! and the fluff layer SPM content $B$ (see below).
! The sedimentation flux is only non-zero for
! bottom shear stresses smaller than a critical shear stress $\tau_{cs}$.
......@@ -63,10 +63,10 @@
! after the advection step, although these negative values should be small.
!
! It is possible to take into account the impact of sediments on density by
! setting spm_dens to .true. The modified density is computed as:
! setting {\tt spm\_dens} to {\tt .true}. The modified density is computed as:
! \begin{equation}\label{SPM_density}
! \begin{array}{l}
! \{rho}={rho}_{T,S,p}+(1-\frac {{\rho}_{T,S,p} {\rho}_{spm}} C
! {rho}={rho}_{T,S,p}+(1-\frac {{\rho}_{T,S,p} {\rho}_{spm}} C
! \end{array}
! \end{equation}
!
......@@ -115,6 +115,9 @@
! Original author(s): Manuel Ruiz Villarreal, Karsten Bolding and Hans Burchard
!
! $Log: spm.F90,v $
! Revision 1.6 2006-01-29 20:32:33 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.5 2004-06-15 08:25:57 kbk
! added supoort for spm - Ruiz
!
......
!$Id: uu_momentum_3d.F90,v 1.6 2006-01-28 20:07:54 hb Exp $
!$Id: uu_momentum_3d.F90,v 1.7 2006-01-29 20:32:33 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -11,7 +11,8 @@
! !DESCRIPTION:
!
! Three-dimensional velocity equation in eastern direction.
! If #MUDFLAT is defined, fitting of profiles is made with
! If the compiler option {\tt MUDFLAT} is defined, fitting of profiles
! is made with
! respect to the new surface elevation, otherwise to the
! old surface elevation.
!
......@@ -50,6 +51,9 @@
! Original author(s): Hans Burchard & Karsten Bolding
!
! $Log: uu_momentum_3d.F90,v $
! Revision 1.7 2006-01-29 20:32:33 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.6 2006-01-28 20:07:54 hb
! Extensions to compiler option SLICE_MODEL for better representation of zero gradients in y-direction
!
......
!$Id: vv_momentum_3d.F90,v 1.9 2005-10-06 09:58:25 hb Exp $
!$Id: vv_momentum_3d.F90,v 1.10 2006-01-29 20:32:33 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -11,7 +11,8 @@
! !DESCRIPTION:
!
! Three-dimensional velocity equation in northern direction.
! If #MUDFLAT is defined, fitting of profiles is made with
! If the compiler option {\tt MUDFLAT} is defined, fitting of profiles is
! made with
! respect to the new surface elevation, otherwise to the
! old surface elevation.
!
......@@ -53,6 +54,9 @@
! Original author(s): Hans Burchard & Karsten Bolding
!
! $Log: vv_momentum_3d.F90,v $
! Revision 1.10 2006-01-29 20:32:33 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.9 2005-10-06 09:58:25 hb
! added itest case for SLICE_MODEL - XZ_PLUME_TEST
!
......
!$Id: check_grid.F90,v 1.1 2005-04-25 09:32:34 kbk Exp $
!$Id: check_grid.F90,v 1.2 2006-01-29 20:32:34 hb Exp $
#include"cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -10,11 +10,11 @@
! !DESCRIPTION:
! This is a wrapper routine to check whether the bathymetry file
! {\tt filename} contains everything needed for the desired
! {\tt grid_type}. For {\tt STATIC} allocation, it checks whether
! {\tt grid\_type}. For {\tt STATIC} allocation, it checks whether
! {\tt iextr} and {\tt jextr} are in agreement with the size of the
! read grid. For dynamic allocation, it derives {\tt iextr} and
! {\tt jextr} from the dimensions of the grid.
! The only thing {\tt check_grid} actually does is calling specialised
! The only thing {\tt check\_grid} actually does is calling specialised
! routines according to the {\tt filetype} of the file {\tt filename}.
!
! !USES:
......@@ -37,6 +37,9 @@
! Original author(s): Lars Umlauf
!
! $Log: check_grid.F90,v $
! Revision 1.2 2006-01-29 20:32:34 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.1 2005-04-25 09:32:34 kbk
! added NetCDF IO rewrite + de-stag of velocities - Umlauf
!
......
!$Id: get_grid.F90,v 1.1 2005-04-25 09:32:34 kbk Exp $
!$Id: get_grid.F90,v 1.2 2006-01-29 20:32:34 hb Exp $
#include"cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -9,8 +9,8 @@
!
! !DESCRIPTION:
! This is a wrapper routine to read the bathymetry file
! {\tt filename} containing the grid and the bathymetery. {\tt get_grid}
! assumes that {\tt check_grid} has been called before.
! {\tt filename} containing the grid and the bathymetery. {\tt get\_grid}
! assumes that {\tt check\_grid} has been called before.
! The only thing it actually does is calling the specialised routines
! according to the {\tt filetype}.
!
......@@ -34,6 +34,9 @@
! Original author(s): Lars Umlauf
!
! $Log: get_grid.F90,v $
! Revision 1.2 2006-01-29 20:32:34 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.1 2005-04-25 09:32:34 kbk
! added NetCDF IO rewrite + de-stag of velocities - Umlauf
!
......
!$Id: ncdf_topo.F90,v 1.11 2005-11-17 13:50:22 kbk Exp $
!$Id: ncdf_topo.F90,v 1.12 2006-01-29 20:32:34 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -12,18 +12,18 @@
! This module is responsible for checking and reading all grid-related quantities
! contained in a netCDF file. The grid types available so far are:
! \begin{itemize}
! \item {grid_type=1}. Cartesian grid with constant grid spacing {\tt dx} and {\tt dy}.
! \item {grid\_type=1}. Cartesian grid with constant grid spacing {\tt dx} and {\tt dy}.
!% The first $X$-point of the grid may start at {\tt x0} and {\tt y0}.
!% If these two offsets are not given, they are set to zero.
! \item {grid_type=2}. Spherical grid with constant grid spacing {\tt dlon} and {\tt dlat}.
! \item {grid\_type=2}. Spherical grid with constant grid spacing {\tt dlon} and {\tt dlat}.
!% The first grid point may start at {\tt lon0} and {\tt lat0}. If these two offsets
!% are not given they are set to zero.
! Earth's radius, {\tt rearth}, necessary to construct a spherical grid, may
! also be given in the input file.
! Otherwise it is set to a default value.
! \item {grid_type=3}. Plane curvilinear grid where the $x$ and $y$ positions of the $X$-points
! \item {grid\_type=3}. Plane curvilinear grid where the $x$ and $y$ positions of the $X$-points
! have to be specified in the bathymetry file.
! \item {grid_type=4}. Spherical curvilinear grid where the latitudes and longitudes
! \item {grid\_type=4}. Spherical curvilinear grid where the latitudes and longitudes
! of the $X$-points have to be specified in the bathymetry file.
! \end{itemize}
!
......@@ -49,8 +49,8 @@
! and will be written to the output files used for plotting.
! GETM checks the bathymetery file for corresponding variables called
! {\tt (latx,lonx)} {\tt ($xx$,$xy$)}. If it is known, also the type of the projection,
! {\tt proj_type}, and its specifications like the projection center and rotation (
! {\tt proj_lon, proj_lat, proj_rot}) can be given in the input file. The definition
! {\tt proj\_type}, and its specifications like the projection center and rotation (
! {\tt proj\_lon, proj\_lat, proj\_rot}) can be given in the input file. The definition
! follows that by the Seagrid grid-generation tool. MATLAB scripts to generate
! simple grids and bathymeteries can be found it the {\tt matlab} subdirectory.
! Ready-to-run bathymetries for some simple basins can be found among the test cases.
......@@ -89,6 +89,9 @@
! Karsten Bolding and Hans Burchard)
!
! $Log: ncdf_topo.F90,v $
! Revision 1.12 2006-01-29 20:32:34 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.11 2005-11-17 13:50:22 kbk
! fixes to compile with gfortran
!
......@@ -650,7 +653,7 @@ contains
!
! !DESCRIPTION:
! This subroutine reads grid-related quantities and the bathymetry from the
! netCDF file. It relies on a previous call to {\tt ncdf_check_grid} setting
! netCDF file. It relies on a previous call to {\tt ncdf\_check\_grid} setting
! all netCDF variable ID's and doing some consistency checks.
!
! !INPUT PARAMETERS:
......
!$Id: diagnostic_variables.F90,v 1.1 2004-03-29 15:35:52 kbk Exp $
!$Id: diagnostic_variables.F90,v 1.2 2006-01-29 20:32:34 hb Exp $
#include "cppdefs.h"
!-----------------------------------------------------------------------
!BOP
......@@ -11,7 +11,7 @@
! !DESCRIPTION:
! This modules serves as a container for diagnostic variables. It is the
! responsibillity of the subroutine(s) using these variables to properly
! allocate memory. Have a look at .../src/output/calc_mean_fields.F90.
! allocate memory. Have a look at {\tt .../src/output/calc\_mean\_fields.F90}.
!
! !USES:
IMPLICIT NONE
......@@ -33,6 +33,9 @@
! Original author(s): Karsten Bolding & Hans Burchard
!
! $Log: diagnostic_variables.F90,v $
! Revision 1.2 2006-01-29 20:32:34 hb
! Small LaTeX corrections to source code documentation
!
! Revision 1.1 2004-03-29 15:35:52 kbk
! possible to store calculated mean fields
!
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment