next up previous
Next: Use of patch files Up: Introduction Previous: Introduction

The material

The downloaded file swash-4.01.tar.gz contains the SWASH source code. You can unzip this file either with WinRAR (in case of Windows) or with the command tar xzf (in case of UNIX or Linux). The SWASH source code consists of the following files:

general modules : ocpmod.ftn  
     SwashModule1.ftn90  
     SwashModule2.ftn90  
modules for flow : SwashFlowdata.ftn90  
modules for solvers : SwashSolvedata.ftn90  
modules for support    
parallel MPI runs : m_parall.ftn  


main program : Swash.ftn90  
     SwashMain.ftn90  
pre-processing routines : SwashBackup.ftn90  
     SwashBCboundwave.ftn90  
     SwashBCshortwave.ftn90  
     SwashBCspecfile.ftn90  
     SwashBCspectrum.ftn90  
     SwashBounCond.ftn90  
     SwashCheckPrep.ftn90  
     SwashInit.ftn90  
     SwashInitBCtrans.ftn90  
     SwashInitCompGrid.ftn90  
     SwashInitCompUgrid.ftn90  
     SwashInitCond.ftn90  
     SwashInitSteady.ftn90  
     SwashInputField.ftn90  
     SwashInputGrid.ftn90  
     SwashReadBndval.ftn90  
     SwashReadInput.ftn90  
     SwashReadTestpnts.ftn90  
     SwashReqOutL.ftn90  
     SwashReqOutQ.ftn90  
computational routines : SwashAntiCreep1DH.ftn90  
     SwashAntiCreep2DH.ftn90  
     SwashBotFrict.ftn90  
     SwashComputFlow.ftn90  
     SwashComputStruc.ftn90  
     SwashComputTrans.ftn90  
     SwashComputTurb.ftn90  
     SwashDensity.ftn90  
     SwashDryWet.ftn90  
     SwashBreakPoint.ftn90  
     SwashExpDep1DHflow.ftn90  
     SwashExpDep1DHtrans.ftn90  
     SwashExpDep2DHflow.ftn90  
     SwashExpDep2DHtrans.ftn90  
     SwashExpLay1DHflow.ftn90  
     SwashExpLayP1DHflow.ftn90  
     SwashExpLay1DHtrans.ftn90  
     SwashExpLay2DHflow.ftn90  
     SwashExpLayP2DHflow.ftn90  
     SwashExpLay2DHtrans.ftn90  
     SwashFlowdata.ftn90  
     SwashFlowDP.ftn90  
     SwashGeometrics.ftn90  
     SwashHDiffZplane1DH.ftn90  
     SwashHDiffZplane2DH.ftn90  
     SwashHorzVisc.ftn90  
     SwashImpDep1DHflow.ftn90  
     SwashImpDep2DHflow.ftn90  
     SwashImpLay1DHflow.ftn90  
     SwashImpLayP1DHflow.ftn90  
     SwashImpLay2DHflow.ftn90  
     SwashImpLayP2DHflow.ftn90  
     SwashKepsMod1DH.ftn90  
     SwashKepsMod2DH.ftn90  
     SwashLayerIntfaces.ftn90  
     SwashLogLaw.ftn90  
     SwashPorousStruc.ftn90  
     SwashPorFricDep.ftn90  
     SwashPorFricLay.ftn90  
     SwashSolvers.ftn90  
     SwashSpongeLayer.ftn90  
     SwashUpdateData.ftn90  
     SwashUpdateDepths.ftn90  
     SwashUpdateFld.ftn90  
     SwashUpdFlowFlds.ftn90  
     SwashUpdPress.ftn90  
     SwashVeget.ftn90  
     SwashVertVisc.ftn90  
     SwashWindStress.ftn90  
post-processing routines : swashout2.ftn  
     SwashCoorOutp.ftn90  
     SwashDecOutL.ftn90  
     SwashDecOutQ.ftn90  
     SwashOutput.ftn90  
     SwashQuanOutp.ftn90  
     SwashAverOutp.ftn90  
service routines : SwashServices.ftn90  
     SwashCleanMem.ftn90  
     SwashPrintSettings.ftn90  
SWAN service routines : swanser.ftn  
routines for support    
parallel MPI runs : swanparll.ftn  
routines for installation : ocpids.ftn  
command reading routines : ocpcre.ftn  
miscellaneous routines : ocpmix.ftn  

The source code is written in Fortran 90. Most of the routines are written in free form and are indicated by extension f90. Some routines are written in fixed form and depending on your system, the extension may be for or f. The conversion from ftn or ftn90 to one of these extensions can be done automatically or manually; see Chapter 3.


You are allow to make changes in the source code of SWASH, but Delft University of Technology will not support modified versions of SWASH. If you ever want your modifications to be implemented in the authorized version of SWASH (the version on the SWASH website), you need to submit these changes to the SWASH team.


The source code is being attended with the following files:

installation procedures : INSTALL.README  
     Makefile  
     macros.inc  
     getcmpl  
     platform.pl  
     switch.pl  
run procedures : SWASHRUN.README  
     swashrun  
     swashrun.bat  
machinefile for parallel     
MPI runs : machinefile  
edit file : swash.edt  

On the SWASH website, you also find some test cases for making a configuration test of SWASH on your computer. You may compare your results with e.g. analytical or laboratory data.


next up previous
Next: Use of patch files Up: Introduction Previous: Introduction
The SWASH team 2017-04-06