Sedtrans05 User Manual revision 1.06 (February 2010) Authors Urs Neumeier, Christian Ferrarin & Georg Umgiesser Copyright (c) 2007-2010 Urs Neumeier, Christian Ferrarin & Georg Umgiesser Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. See Appendix C for the full text of the GNU Free Documentation License. 3 Contents Introduction......................................................................................................................... 4 Limitations of Sedtrans05 ................................................................................................... 6 Installation of Sedtrand05 GUI........................................................................................... 7 Description of Sedtrand05 GUI .......................................................................................... 8 Use of SED05 ................................................................................................................... 10 Use of sedtrans05m........................................................................................................... 13 Use SEDI1D...................................................................................................................... 16 Instruction for the Cohesive Sediment Algorithm ............................................................ 18 Compilation of the source code ........................................................................................ 19 Direct access to the computation routines from other programs ...................................... 21 Appendix A : example input files ..................................................................................... 23 Appendix B : Explanation of the output files ................................................................... 24 Appendix C: GNU Free Documentation License ............................................................. 27 Appendix D: GNU General public license ....................................................................... 31 4 Introduction Sedtrans05 is a sediment transport model for continental shelf and estuaries. It predicts the sediment transport at one location as function water depth, sediment type, current and waves (single point model). Sedtrans05 computes the boundary layer parameter for pure current, or pure waves or combined current-waves conditions. The threshold of movements is computed as function of grain size, sediment density, water salinity and temperature. Five different transport equations are available for non-cohesive sediments (sand). Type and dimension of bedform are also predicted and taken into account for the hydrodynamic calculations. The Cohesive Sediment Algorithm model can be used for cohesive sediment to model the full cycle of bed erosion, transport in suspension including flocculation and deposition. Sedtrans05 is described in following publication: Neumeier U., Ferrarin C., Amos C.L., Umgiesser G. & Li M.Z. (2008) Sedtrans05: An improved sediment-transport model for continental shelves and coastal waters with a new algorithm for cohesive sediments. Computer & Geosciences. doi:10.1016/j.cageo.2008.02.007 Sedtrans05 is composed by computation routines and that can be accessed through following user interfaces. The different components are - Sedtrans05 GUI, a graphic user interface for Microsoft Windows - SED05, a console program for interactive or batch calculations - SEDI1D, a 1D(vertical)-time model for cohesive sediment - Fortran77 routines that can be integrated in other programs - Sedtrans05.dll, a dynamic linked library compiled for Microsoft Windows that can be called from other programs - sedtrans05m, a compiled MEX-file to access Sedtrans05 from Matlab (only compiled for Microsoft Windows) Sedtrans05 GUI is recommended to make a few calculations, to examine how variations in some input parameters modify the results, or for teaching purpose. To process larger dataset or when the input data are already in a file, it is recommended to use SED05 (or the Matlab function sedtrans05m if the data are already in Matlab). The different components of http://labsedim.uqar.ca/sedtrans05. Sedtrans05 can be downloaded Sedtrans05 is be published under the GNU General public license (see Appendix D). from 5 History of Sedtrans Sedtrans05 is the latest version of Sedtrans, which history started in the early 1980s. The previous versions of Sedtrans were developed at the Geological Survey of Canada, Bedford Institute of Oceanography, Dartmouth, Nova Scotia. The first versions were known as "Atlantic Geoscience Centre (AGC) sediment transport model". The two versions previous to Sedtrans05 were published by Michael Z. Li and Carl L. Amos: Sedtrans92 – Li M.Z. & Amos C.L. (1995) SEDTRANS92: a sediment transport model for continental shelves. Computer and Geosciences, 21, 533-554. Sedtrans96 – Li M.Z. & Amos C.L. (2001) SEDTRANS96: the upgraded and better calibrated sediment-transport model for continental shelves. Computer and Geosciences, 27, 619-645. 6 Limitations of Sedtrans05 Software issues: • There is no check of the input values in the core Fortran77 routines of Sedtrans05. Some limited input checks are done in the two input interfaces, sed05.exe and Sedtrans95 GUI (Windows version), but they pick up only major problems (e.g., wave height larger than water depth). It is the responsibility of the user to assure that the input values are realistic AND within the range of validity of the different equations used. Otherwise the results will be meaningless and the program may crash. • For SED05.exe and SEDI1D.exe, the length of each filename (inclusive path) specified as command-line argument is limited to 200 characters. Physical limitations of Sedtrans05: • The model assume linear wave theory and not adapted for breaking wave and the swash zone of beaches Limitations of the Cohesive Sediment Algorithm (CSA) • The CSA does not model sand-mud mixture, biological processes (bioconsolidation or bioturbation), lateral movement of fluid mud (due to current or gravitational forces), resuspension of fluid mud by waves or instabilities of the water-sediment interfaces (internal / Holmboe waves). • The flocculation equations used in the CSA are valid for seawater and brackish water until salinity of about 10-15. Therefore the Cohesive Sediment Algorithm should not be used for fresh water or very low salinities. • The CSA may not predict correctly erosion rate when long (much longer than 5 min.) time-step TIMEDR are used. Mass conservation is always respected. • For cohesive sediment, a well-mixed water column is assumed. This is not adapted for deeper subtidal areas. Sedtrans can still be used in such situation if it is combined with a 3D hydrodynamic/sediment-transport model. 7 Installation of Sedtrand05 GUI Sedtrans05 GUI should run on any computer with Windows95 or later. It was tested on Windows 98 and Windows XP. Sedtrans05 requires 1 to 3.5 MB disc space, depending which standard run-time library files of VisualBasic 6 are already installed on the computer. In addition, 4 MB are needed for temporary files during the installation. Setrans05 GUI is programmed in VisualBasic. In order to work correctly, some standard VisualBasic files must be copied to the SYSTEM directory and several files must be registered. Therefore is not possible to simply copy the executable, but the Sedtrans05 GUI must be installed using the setup program. The installation files usually come as zipped file. It may be necessary to unzip them before starting the installation. After the installation, the installation files can be removed from the computer. The installation of Sedtrans05 is started with the file "setup.exe". The user must have ADMINISTRATOR RIGHTS for the installation. Any previous version of Sedtrans05 installed in the same destination directory will be automatically removed during the installation procedure. However, previous examples files for the batch version (INDATA.DAT, OUTDATA.LST INDATA.CST, which are not copied during the installation but created with the options -e), may not longer be correct after the upgrade to a newer version. They should be recreated with the commands "SED05 -e" and "SED05 -ec" before being used, because the format of input/output files may change from one version to the next.. The installations files consist of - setup.exe - setup.lst - sedtrans05.cab The installation will create a new directory (by default "C:\Program files\Sedtrans05\") and make a short cut "Menu Start" - "Programs" - "Sedtrans05". Following files are created in the Sedtrans05 directory: - sedtrans05.exe The Sedtrans05 GUI program - sedtrans05.dll Library file containing all the computation routines - sed05.exe Batch version (and interactive DOS version) Sedtrans05 GUI does not use it directly - sedtrans05.hlp Help file for the Sedtrans05 GUI - sedtrans05.cnt additional data for the Help file - sedtrans05.gid additional data for the Help file - readme.txt A short explanation file The use of the batch mode (sed05.exe) will create several other files (see "Use of SED05") It is possible to uninstall Sedtrans05 through "Control Panel" - "Add/Remove Programs". 8 Description of Sedtrand05 GUI Sedtrans05 GUI give the same results than SED05 for non cohesive sediments, including secondary results. However, cohesive sediments cannot be modelled with it. Compared to the console interface SED05, Sedtrans05 has the advantage to present all the input and output parameters in one widow. The results can be copied into the system clipboard for transfer in another program. The 50 last input values and results are kept in memory, and examination how variations in some input parameters modify the results is also favoured by following functionalities: Main window of Sedtrans05 Comparison between the different calculation methods 9 Graphic representation of how the variation of one input parameter influence any output parameter Profile of mean current velocity and suspended sediment concentration Detailed instructions for using Sedtrans05 GUI are found in the help file accessed directly from the program (Menu Help – Help Setrans05, or "F1" key). 10 Use of SED05 SED05 is a user-interface running in a console window. It computes the sediment transport for one set of conditions. Only the file "sed05.exe" is necessary to run the interactive/batch version. The program is capable to generate example and explanation files. The command-line option "-?" (i.e., type "sed05 -?") return a explanation of the command-line syntax of SED05, which is reproduced in the frame below. Command-line syntax for using the 1D version of Sedtrans05 (version 1.03) SED05 [-b [IN-FILE [OUT-FILE]]] [-o OUT-FILE] [-c PARAMFILE] [-f] [-h] [-v] -b Batch mode with optionally names of input and output files (default is interactive mode) -o Specify the name of the output files -c Modify defaults parameters according to the file PARAMFILE -f Only one tabular output file for non-cohesive sediments -h No header line in tabular output files -v Input water density/dyn.viscosity instead of salinity/temperature Special options: SED05 -? Show the present help text SED05 -L Show the licence SED05 -e Generate an example input-file "INDATA.DAT" for batch-mode runs, an example file "INDATA.CST" to modify the default parameters and write the list of abbreviations used in the output files to the file "OUTPUT.LST" IN-FILE must be with extension; default IN-FILE (batch mode) is "INDATA.DAT". OUT-FILE must be without extension; default OUT-FILE (batch and interactive modes) is "OUTPUT.*". Examples of usage: SED05 Interactive mode with default output files SED05 -b cases.csv Batch mode with input "cases.csv" and output "cases.*" For the interactive version, start "sed05.exe" without any command-line parameter. Due to the significant number of input parameters required by the cohesive algorithm, interactive model computation is not available for cohesive sediments. After the first run in the interactive mode, it is possible to keep the previous input value for any parameter by giving an empty input (simply pressing RETURN). For the batch mode (input values from a tabular text file), start with "sed05.exe" the command-line option "-b". Comment lines (lines with any text) and empty lines are ignored in the input file. This mode does not produce any screen output. The command-line option "-e" generates an example input-file (INDATA.DAT), an explanation file for the output files (OUTPUT.LST), and an example file to modify the default parameters with the optional command-line option "-c" (INDATA.CST). SED05 saves the results in several ASCII files, that have all the same name but different extensions (*.dat, *.da2, *.pro, *.txt, *.coh). See detailed output explanations in the file "OUTPUT.LST" (generate with "sed05 -e", also reproduced in Appendix B). 11 The default input file is "INDATA.DAT" and the default output files are "OUTDATA.*". It is possible to specify the filenames for input and output: for the interactive version with the command-line option "-o"; for the batch mode by specifying input and output names after the command-line option "-b". The output files are : - OUTDATA.txt a text file with input values, summary results and bedform predictions; the interactive mode writes the output of this file also to the screen - OUTDATA.dat the main results in tabular format - OUTDATA.da2 additional output parameters in tabular format - OUTDATA.pro profiles of current velocities and (for non-cohesive sediment) suspended sediment concentration (SSC), - OUTDATA.coh results of the cohesive sediment algorithm in tabular format (this file is only created if the cohesive sediment algorithm is used) If no output filename but only a input filename is specified for the batch mode, and its extension not one of the output files (dat, da2, txt, pro or coh), then the input filename is also used as output filename. This property of SED05 can be used under Microsoft Windows to process a input file (with extension different from dat, da2, txt, pro or coh) directly from the "Windows Explorer" (without a consol window) by creating in the SendTo folder a shortcut with target "...\sed05.exe -b" (where ... is the location of sed05.exe). With the command-line option "-f", all tabular output for non-cohesive sediments (normally files *.dat, *.da2 and *.pro) is written in only one file (*.dat) with 81 columns. This may be more convenient if all parameter have to be processed subsequently with another software. The tabular output-files are tab-separated with by default a header line. The header line can be suppressed with the command-line option "-h", which produces output-files that can easier read be Matlab, Fortran program, etc. With the command-line option "-v", the program does not calculate density and dynamic viscosity of water from salinity and temperature, but read them directly as input values. With this option the interactive version ask for density water and dynamic viscosity instead of salinity and temperature; and the batch version expects water density (kg m-3) in the column containing usually salinity, and dynamic viscosity (Pa s) in the column containing usually temperature. After the first run in the interactive mode, it is possible to keep the previous input value for any parameter by giving an empty input (simply pressing RETURN). All dimensional variables are in SI units. The grain-size is in metres, and not in mm as in the graphic user interface Sedtrans05 GUI. Some limited input checking is done. When a clearly impossible value is noticed, this input value is refused in the interactive mode, in the batch mode the calculations are aborted and an error code is written in the output files. All errors or warnings are reported in the text output file *.txt, but only the first error or warning is specified in the tabular output file *.dat. See also general limitations of Sedtrans05 below. 12 If the command-line option "-c" is used to modify some coefficients for the cohesive sediment algorithm, the modified value are written in an additional output file *.log. See also the section "Instructions for the Cohesive Sediment Algorithm" in this readme file. 13 Use of sedtrans05m sedtrans05m is a MEX-file function to call the Fortran77 subroutines directly from Matlab. It operates like SED05 or a direct call the calculation routines from another program. However, sedtrans05m has the advantage that it is not necessary to generate an input data file and then to read the output data files, if the input data are already in Matlab and the output is afterward processed in Matlab. When a compiled MEX-file is available for your operating system/processor type (sedtrans05m.dll for Windows, sedtrans05m.so for Linux), copy the compiled MEX-file and the file sedtrans05m.m in the current Matlab directory or in a directory that is on the Matlab path. To compile the MEX-file, copy the source files (including sedtrans05m.f and sedtrans05dll.f) to the current Matlab directory, and then type "mex sedtrans05m.f" at the Matlab prompt. It is possible that Matlab must be configured for your Fortran compiler, type "mex -help" at the Matlab prompt for information how to proceed. The syntax for using sedtrans05m is described in the file sedtrans05m.m, which can be shown by typing "help sedtrans05m" at the Matlab prompt, and which is reproduced below. OUT1 = SEDTRANS05M(IN1) ... = SEDTRANS05M(IN1,CONC,BEDCHA) ... = SEDTRANS05M(IN1,CONC,BEDCHA,IN2) [OUT1,OUT2,OUT3,PROFILE,BEDTXT,CONC,BEDCHA] = SEDTRANS05M(...) For non-cohesive sediments (1 <= IOPT <= 5) SEDTRANS05M takes 1 input argument. For cohesive sediments (IOPT = 7) SEDTRANS05M takes 3 or 4 input arguments. Between 1 and 7 output arguments can be requested. The input and output variables to Sedtrans05 are bundled into several arrays that follow the parameter order of the input/output files of the batch version SED05 (except the columns IRUN and ERR). IN1 can be an array of 15 (or 17) columns, if all IOPT1<=5 (non-cohesive) and only output arguments OUT1 and OUT2 are requested. Array IN1(17) 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: IOPT1 D UZ Z CDIR HT PER WDIR GD RHINP RLINP BETA RHOS SALIN TEMP TIMEDR AULVA Input variables to Sedtrans, for non-cohesive sediments IN1 can also be 15 or 16 elements long selection of sediment transport equation (1,2,3,4,5,7 or 10) water depth (m) current speed (m/s) height of current measurement (m) current direction (degrees north) wave height (m) wave period (seconds) wave direction (degrees north) grain size (m) ripple height (m) ripple length (m) bed slope (degree) grain density (default=2650, kg/m**3) salinity (default=35) temperature (degrees Celsius) deposition/erosion duration (seconds) * OPTIONAL fraction of bed area covered by Ulva (range 0-1) * OPTIONAL 14 Array IN2(30) 1: SWITCH 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: ! ! if if Default parameters for cohesive algorithm with the value -999. the default value is not modified =0, then IN2 is ignored <>0, then IN2 is processed CSULVA TMULVA TRULVA RKERO E0 CDISRUPT CLIM1 CLIM2 KFLOC MFLOC RHOCLAY CTAUDEP PRS RHOMUD DPROFA DPROFB DPROFC DPROFD DPROFE CONSOA TEROA TEROB TEROC TEROD CDRAGRED Z0COH FCWCOH WSCLAY DOCOMPACT CONC(21) ! Cohesive SSC BEDCHA(20,3) ! Description of cohesive bed column 1 : depth below surface (m) column 2 : critical erosion shear stress (Pa) column 3 : dry bulk density (kg/m3) Array OUT1(16) ! Results (similar to file *.dat) 1: UB maximum wave induced orbital velocity at the bottom (m/s) 2: FCW bottom (skin) friction factor 3: UA current speed to be used in bottom stress calc. (m/sec) 4: U100 current speed at 1 m. above seabed (m/sec) 5: USTCWS combined skin-friction shear velocity of GM (m/sec) 6: USTCW combined total shear velocity of GM (m/sec) 7: Z0 bed roughness length (m) 8: FALL settling velocity for non-cohesive sediment (m/sec) 9: RHEIGHT predicted ripple height (m) 10: RLENGTH predicted ripple length (m) 11: C0A depth averaged reference concentration at z0 (kg/m^3) 12: QS suspended sediment transport rate (kg/m/s) 13: QSDIR direction of suspended sediment transport (degree) 14: SEDM time-averaged net sediment transport as mass (kg/s/m) 15: SED time-averaged net sediment transport as volume (m**3/s/m) 16: SEDDIR direction of net sediment transport (azimuth,degrees) Array OUT2(26) ! Results (similar to file *.da2) 1: AB excursion length of bottom wave orbit (m) 2: WL wave length (m) 3: USTCRB critical shear vel for initi of bedload trans (m/sec) 4: USTCRS critical shear vel for initi of suspended load transport (m/sec) 5: USTUP critical shear vel for initn of sheet flow transport (m/sec) 6: Z0C apparent bed roughness length (m) 7: PHIB angle between wave and current directions (radians) 8: PHI100 angle between wave and current directions at 1 m. above seabed 15 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: DELTACW USTCS USTWS USTCWSE USTCWSB USTC USTW RPLCOEF TB1 TB2 TS1 TS2 PERBED PERSUSP C0 TAOCWS RHOW VISC height of the wave-current boundary layer current skin-friction shear velocity of GM wave skin-friction shear velocity of GM effective combined skin-friction shear velocity transport-related combined shear velocity total current shear velocity of GM total wave shear velocity of GM ripple coefficient for shear velocity conversion time at which bedload transport ceases (sec) time at which bedload transport recommences (sec) time at which suspended load transport ceases (sec) time at which suspended load transport recommences (sec) percentage of time spent in only bedload transport phase percentage of time spent in suspended load transport phase reference concentration at z0 (kg/m^3) averaged effective shear stress water density (kg/m3) dynamic viscosity of water (Pa s) Array OUT3(5) ! Results (similar to file *.coh) 1: TAUEFF effective To, includes drag reduction and TAOS (Pa) 2: TAOS solid transmitted stress due to Ulva (Pa) 3: ZS height change in bed surface (m) (positive: erosion, negative: deposition) 4: EDRATE mean erosion/deposition rate (kg/m**2/s) (positive: erosion, negative: deposition) 5: TCONC final total suspended sediment concentration (kg/m**3) Array PROFILE(12,3) ! SSC and velocity profile (non-cohesive) 1st column: Zi height above the bed (m) 2nd column: Ci suspended sediment concentration at height Zi (kg/m**3) 3rd column: Ui mean velocity at height Ui (m/s) With IOPT1=10, the COHESIVE subroutine is called directly, without passing through the main subroutine SEDTRANS05. In this case, CONC, BEDCHA and IN2 are processed normally, but only followings parameters contained in IN1 are considered: D, UZ (which then does not represent velocity but TAUCWS=RHOW*USTCWS**2), SALIN, TEMP,TIMEDR and AULVA. From the output arguments, only RHOW, VISC (in OUT2), EDRATE,ZS,SEDM,TCONC,TAOS (in OUT3), CONC and BEDCHA are assigned. All the other output arguments are undefined ! 16 Use SEDI1D SEDI1D is a particular interface to Sedtrans05 that simulate a 1D(vertical)-time model for cohesive sediment. It assumes an infinite, homogeneous, horizontal bed, which is subject to various current and wave conditions over time. This simple model is not designed to represent a natural environment, but it is perfectly adapted for modelling processes observed in an annular flume. It was specifically written for comparing the cohesive algorithm with experimental results in annular flumes. It is made available because it may be useful for other persons, but it was developed and tested to be a robust, user-friendly and versatile program. Therefore some adaptations in the code may be necessary for particular situations. The command-line option "-?" displays the explanations of the command-line syntax, which is reproduced in the frame below. Command-line syntax for using the 1D-time version of Sedtrans05 (version 1.02) SEDI1D -? SEDI1D Show the present help text By default the input file is "IN1D.DAT" and output files are "OUT1D.*", The files can also be specified as follow: SEDI1D inputfile SEDI1D inputfile outputfile SEDI1D inputfile outputfile -c paramfile Modify the defaults parameters according to the file "paramfile" "inputfile" must be with extension, "outputfile must be without extension. SEDI1D -L SEDI1D -e Show the licence Generate the example files "IN1D.DAT" (input data) and "INDATA.CST" (modification of default parameters), and write the list of abbreviations used in the output files to the file "OUT1D.LST" SEDI1D reads input parameters from a file containing: - on the first data line, the initial bed characteristics and the initial SSC; - on the other data lines, several successive hydrodynamic conditions, each with a specific duration. The hydrodynamic conditions can be defined with the same input parameters as for SED05. Alternatively, τ0 can be specified directly; in this case the subroutine with the cohesive sediment algorithm (COHESIVE) is called directly, without passing through the main subroutine SEDTRANS05. See the comments in the example input-file IN1D.DAT, which is generated with the command-line option "-e", for more details. The output is a tabular text file with SSC and bed characteristics for each minute or each calling interval (whichever is shorter). See the explanation file OUT1D.LST, which is generated with the command-line option "-e", for more details. If error or warning are generated, they are reported in the text output file *.txt, but only the first error or warning is specified in the tabular output file *.dat. 17 If the command-line option "-c" is used to modify some coefficients, the modified value are written in an additional output file *.log. 18 Instruction for the Cohesive Sediment Algorithm 19 Compilation of the source code The main elements of Sedtrans05 (the calculations routines and the interfaces SED05 and SEDI1D are written in FORTRAN77. They were developed with the compiler "g77", that is freely available at http://www.gnu.org/software/fortran/ The code follow the FORTRAN77 standard with following exception: - "IMPLICIT NONE" statements, - comments starting with "!" - names of variables and routines longer than 6 characters - "INCLUDE" statements - calls to 2 functions retrieving the command-line arguments, which are specific to the compiler g77 (IARGC and GETARG); however the code can easily be modified to skip this code section. The source files for SED05 (console program for interactive or batch calculations) consist of - sed05.f - sedtrans-core.f - cohesive.f - bedform.f - sed_param.h The main file is sed05.f, which contains "INDCLUDE" statements making reference to all the other code files. Therefore only sed05.f has to be specified to the compiler. The source files for SEDI1D (1D(vertical)-time model for cohesive sediment) consist of - sedi1d.f - sedtrans-core.f - cohesive.f - sed_param.h The main file is sedi1d.f, which contains "INCLUDE" statements making reference to all the other code files. Therefore only sedi1d.f has to be specified to the compiler. The source files for the computation routines (accessed through the subroutine SEDTRANS05) consist of - sedtrans-core.f - cohesive.f - sed_param.h contains the subroutine SEDTRANS05 referred from sedtrans-core.f with an INCLUDE statement. definition of the COMMON blocks. The source files for sedtrans05m (MEX-file for Matlab) consist of - sedtrans05m.f (the gateway routine) 20 - sedtrans05dll.f - sedtrans-core.f - cohesive.f - bedform.f - sed_param.h - sedtrans05m.m (the help file explaining the usage of the MEX-file) The main file is sedtrans05m.f, which contains "INDCLUDE" statements making reference to all the other code files. Therefore only sedtrans05m.f has to be specified when compiling the MEX-file from Matlab. Compilation was tested with Matlab 6.1 and g77 as Fortran77 compiler. sedtrans05m.m is the help file explaining the usage of the MEX-file. It is recommended to keep sedtrans05m.m together with the compiled MEX-file. The source files for DLL-executable (dynamic link library for Microsoft Windows) consist of - sedtrans05dll.f - sedtrans-core.f - cohesive.f - bedform.f - sed_param.h - sedtrans05dll.def The main file is sedtrans05dll.f, which contains "INDCLUDE" statements making reference to all the other code files. Therefore only sedtrans05dll.f has to be specified when creating the object file with the compiler. For producing the DLL, dllwrap requires also sedtrans05dll.def, which contains the list of subroutine to be exported. The source files for Sedtrans05 GUI (graphic user interface for Microsoft Windows) consist of - About_form.frm - About_form.frx - Batch_form.frm - Batch_form.frx - Fcomparison.frm - Fcomparison.frx - Fmain.frm - Fmain.frx - Fprofiles.frm - Fprofiles.frx - Fsensitivity.frm - Fsensitivity.frx - GraphFun.bas - Licence_form.frm - Licence_form.frx - Module1.bas - Module2.bas - SEDTRANS05.HLP - sedtrans05w.vbp - sedtrans05w.vbw - sedtrans05.dll - sed05.exe Sedtrans05GUI is programmed in Visual Basic 6. The project file is sedtrans05w.vbp. The call to sedtrans05.dll (included in the source files, but can also be compiled separately, see above) does not work when the program is executed within the Visual Basic programming environment. The program must be compiled, and then sedtrans05.dll be placed in the same directory than sedtrans05.exe. sed05.exe (compiled console program for batch calculations) is included in the source files. When placed in the same directory than sedtrans05.exe, it can be called directly from Sedtrans05GUI. 21 Direct access to the computation routines from other programs It is possible to access the single-point model Sedtrans05 from other program, either to develop another user interface, or to integrate Sedtrans05 in larger 2D/3D hydrodynamic/sedimentary models. All the computations in Sedtrans05 is accessed through the subroutine SEDTRANS05 (in the file "sedtrans-core.f"), with following two exceptions: - the text of the bedform predictions is generated in the subroutine BEDFORM (in the file "bedform.f"), and - density and viscosity of water is computed from salinity and temperature in the subroutine DENSVISC (in the file "cohesive.f"). Before the first call to SEDTRANS05, it is necessary to make one call to the subroutine INICONST. The input parameters of Sedtrans05 are transmitted as arguments to SEDTRANS05. The main results are returned as arguments from SEDTRANS05, additional results are returned in the common blocks OSCL, THRE, FRICF, TIMIN, PROF, PROFIL (definition of common blocks in file "sed_param.h"). For explanations of the input/output argument of SEDTRANS05, see the beginning of the SEDTRANS05 subroutine. For explanations of the additional results see the comments in the file "sed_param.h". NO input argument check is done in the subroutine SEDTRANS05 Specific for the non-cohesive methods (call to SEDTRANS05 with IOPT<>7): + If IOPT1.NE.7, then none of the input arguments for the Cohesive Sediment Algorithm will be accessed; the arguments BEDCHA and CONC do not have to be arrays in this case. Specific for the Cohesive Sediment Algorithm (call to SEDTRANS05 with IOPT=7): + Various constants and parameters of the Cohesive Sediment Algorithm are specified in the common block CCONST, which is initialized by the subroutine INICONST. Expert users can change these constants/parameters by declaring the common block CCONST (using "INCLUDE sed_param.h") in the calling program and modifying some values AFTER the call to INICONST. + The subroutine BEDINI (in file "cohesive.f") is NOT tested so far. + The subroutine COMPACT (in file "cohesive.f") is NOT tested so far. + The array variable BEDCHA (describing the variations of the cohesive bed with depth) must have at least 3 row and may have up to 50 rows. The function CHECKBEDCHA can be used to check that information in BEDCHA is valid. 22 + The dimension of the input/output argument CONC (concentration of each class of suspended sediment) is specified with the PARAMETER variable NBCONC in the file "sed_param.h". The settling velocity Ws of each element of CONC is specified in the common block WSCLASS, variable WSI. INICONST must have been called once before WSI is accessed. To use CONC, the best is include the 2 following lines: INCLUDE "sed_param.h" DOUBLE PRECISION CONC(NBCONC) + See also the section "Instruction for the Cohesive Sediment Algorithm" in this manual. RHOS 0.0 SALIN TEMP -2.0 2650. 35. 15. # # if a real number is given for these parameters, it will be rounded to the nearest integer Meaning of the abbreviations IRUN identifier for the run (integer value) # IOPT1 selection of sediment transport equation (1,2,3,4,5 or 7) D water depth (m) UZ current speed (m/s) Z height of current measurement (m) CDIR current direction (degrees north) HT wave height (m) PER wave period (seconds) WDIR wave direction (degrees north) GD grain size (m) RHINP ripple height (m) RLINP ripple length (m) BETA bed slope (degree) RHOS grain density (default=2650, kg/m**3) SALIN salinity (default=35) TEMP temperature (degrees Celsius) TIMEDR deposition/erosion duration (seconds) AULVA fraction of bed area covered by Ulva (range 0-1) c1-c21 suspended sediment concentration of each Ws class NBED number (N) of entries in BEDCHA # z1-zN depth (positive downward, m) rho1-rhoN dry bulk density (kg/m**3) Tero1-TeroN critical erosion stress (Pa) For cohesive sediment, the input format is IRUN IOPT1 D UZ Z CDIR HT PER WDIR GD RHINP RLINP BETA RHOS SALIN TEMP TIMEDR AULVA c1 c2 c3 c4 c5 c6 c7 c8 c9 c10 c11 c12 c13 c14 c15 c16 c17 c18 c19 c20 c21 NBED z1 z2 z3 z4 Tero1 Tero2 Tero3 Tero4 rho1 rho2 rho3 rho4 2 7 2.2 0.8 0.5 30.5 0.3 3.5 185. 0.0 0.0 0.0 0.0 2650. 35. 15. 300. 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 4 0.0 0.005 0.02 0.05 0.2 0.3 0.4 0.45 200 300 400 450 For the non-cohesive equations, the input format is IRUN IOPT1 D UZ Z CDIR HT PER WDIR GD RHINP RLINP BETA 1 2 2.2 0.8 0.5 30.5 0.3 3.5 185. 0.00035 0.0 Example of an input file for the batch mode of Sedtrans05 (version 1.02) Comment lines (any line containing non numerical characters) and empty lines are ignored. The numerical values in the file must be separated by spaces, commas, or tabulators. The input format is different for non-cohesive and cohesive sediment. Both input types can be mixed in the same file. 23 Appendix A : example input files Below is the example file "INDATA.DAT generated with version 1.02 of SED05 by using the command-line option "-e". 24 Appendix B : Explanation of the output files Below is the file "OUTDATA.LST" generated with version 1.02 of SED05 by using the command-line option "-e". The output parameters may vary in future versions of the program. Only the OUTDATA.LST file generated with each program version is certain to described correctly the output of that version. Abbreviations used in the output files of Sedtrans05 (interactive/batch version, version 1.02) In the output file *.dat (main results) IRUN ERR UB FCW UA U100 USTCWS USTCW Z0 FALL RHEIGHT RLENGTH C0A QS QSDIR SEDM SED SEDDIR identifier for the run (integer value) error/warning code (see below) maximum wave induced orbital velocity at the bottom (m/s) bottom (skin) friction factor current speed to be used in bottom stress calc. (m/sec) current speed at 1 m. above seabed (m/sec) combined skin-friction shear velocity of GM (m/sec) combined total shear velocity of GM (m/sec) bed roughness length (m) settling velocity for non-cohesive sediment (m/sec) predicted ripple height (m) predicted ripple length (m) depth averaged reference concentration at z0 (kg/m^3) suspended sediment transport rate (kg/m/s) direction of suspended sediment transport (degree) time-averaged net sediment transport as mass (kg/s/m) time-averaged net sediment transport as volume (m**3/s/m) direction of net sediment transport (azimuth,degrees) In the output file *.da2 (additional parameters) IRUN AB WL USTCRB USTCRS USTUP Z0C PHIB PHI100 DELTACW USTCS USTWS USTCWSE USTCWSB USTC USTW RPLCOEF TB1 TB2 TS1 TS2 PERBED PERSUSP C0 TAOCWS RHOW VISC identifier for the run (integer value) excursion length of bottom wave orbit (m) wave length (m) critical shear vel for initi of bedload trans (m/sec) critical shear vel for initi of suspended load transport (m/sec) critical shear vel for initn of sheet flow transport (m/sec) apparent bed roughness length (m) angle between wave and current directions (radians) angle between wave and current directions at 1 m. above seabed height of the wave-current boundary layer current skin-friction shear velocity of GM wave skin-friction shear velocity of GM effective combined skin-friction shear velocity transport-related combined shear velocity total current shear velocity of GM total wave shear velocity of GM ripple coefficient for shear velocity conversion time at which bedload transport ceases (sec) time at which bedload transport recommences (sec) time at which suspended load transport ceases (sec) time at which suspended load transport recommences (sec) percentage of time spent in only bedload transport phase percentage of time spent in suspended load transport phase reference concentration at z0 (kg/m^3) averaged effective shear stress water density (kg/m3) dynamic viscosity of water (Pa s) 25 In the output file *.pro (velocity and concentration profile for non-cohesive sediments) IRUN Zi Ci Ui identifier for the run (integer value) height above the bed (m) suspended sediment concentration at height Zi (kg/m**3) mean velocity at height Ui (m/s) In the output file *.coh (results for cohesive sediments) IRUN ERR TAU0EFF TAOS UNUSED identifier for the run (integer value) error/warning code (see below) effective To, includes drag reduction and TAOS (Pa) solid transmitted stress due to Ulva (Pa) height change in bed surface (m) (positive: erosion, negative: deposition) EDRATE mean erosion/deposition rate (kg/m**2/s) (positive: erosion, negative: deposition) TCONC final total suspended sediment concentration (kg/m**3) NBCONC number of classes of suspended sediment Ci suspended sediment concentration for each class (kg/m3) bed characteristics (BEDCHA): MAXBED number of elements in Z, Tero and rho Zi depth below surface (m) Tero_i critical erosion stress at depth Zi (Pa) rho_i dry bulk density at depth Zi (kg/m**3) Settling velocities (Ws) for each suspended sediment class of cohesive sediment Class Ws (m/s) 1 0.000010 2 0.000016 3 0.000025 4 0.000040 5 0.000063 6 0.000100 7 0.000158 8 0.000251 9 0.000398 10 0.000631 11 0.001000 12 0.001585 13 0.002512 14 0.003981 15 0.006310 16 0.010000 17 0.015849 18 0.025119 19 0.039811 20 0.063096 21 0.100000 Error and warning codes Only one error/warning code is specified in the file *.dat The full list of error/warning is given in the file *.txt 0 No error or warning Critical errors 1 2 3 4 5 Incorrect Incorrect Incorrect Incorrect Incorrect input input input input input argument argument argument argument argument D UZ Z CDIR HT 26 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 30 Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect Incorrect input input input input input input input input input value input input input input input input input input input input argument argument argument argument argument argument argument argument argument for NBED argument argument argument argument argument argument argument argument argument argument PER WDIR GD RHINP RLINP BETA SALIN RHOS AULVA TIMEDR BEDCHA CONC TEMP DT USTCWS ARG4 OBS2 ROT IOPT1 Warnings 101 ENGELUND-HANSEN formula not recommended for use with sediments finer than 0.15 mm 102 EINSTEIN-BROWN formula is based on laboratory experiments using sediments with grain sizes of 0.3 to 28.6 mm 103 BAGNOLD formula is based on laboratory tests with grain sizes between 0.18 and 0.45 mm 104 YALIN formula is not recommended for use with sediments smaller than 0.2mm, based on the results of sensitivity analyses 105 VAN RIJN formula is based on laboratory experiments using sediments with grain sizes of 0.2 to 2.0 mm 107 The cohesive algorithm is not intended for non-cohesive sediments 27 Appendix C: GNU Free Documentation License (under which this user manual is published) Version 1.2, November 2002 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque". Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, 28 SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text. A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computernetwork location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. 29 E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements." 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. 30 You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/. Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. 31 Appendix D: GNU General public license (under which Sedtrans05 is published) Sedtrans05 is licensed under the GNU General Public License, which is reproduced in full below. Copyright (C) 2005 Urs Neumeier, Christian Ferrarin, Carl Amos and Georg Umgiesser. Sedtrans05 was developed at the ISMAR-CNR in Venice and the University of Southampton. Previous versions of Sedtrans (1992 and 1996) were developed at the Geological Survey of Canada, Bedford Institute of Oceanography. Version 3, 29 June 2007 Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. 32 TERMS AND CONDITIONS 0. Definitions. “This License” refers to version 3 of the GNU General Public License. “Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. “The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. A “covered work” means either the unmodified Program or a work based on the Program. To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make 33 modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. 34 d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. “Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. “Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or 35 f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”. A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further 36 modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. 37 If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project