SNL-SWAN Version 1.0 Release

INSTALL.README

@@ -0,0 +1,12 @@
+Instructions for quick installation of SWAN
+-------------------------------------------
+
+1) Ensure that the Perl package is available on your computer.
+   In most cases, it is available for Linux and a Unix operating
+   system. Check it by typing 'perl -v'. Otherwise, you may
+   download a free distribution for Linux, Solaris and Windows
+   called ActivePerl (www.activestate.com/activeperl/downloads).
+   The Perl version should be at least 5.0.0 or higher!
+
+2) From the 'build' directory, type 'mk.pl ser' for a serial compilation.
+   Type 'mk.pl omp' for an openMP compilation

NOTICE

@@ -0,0 +1,10 @@
+SNL-SWAN (Sandia National Laboratories - Simulating WAves Nearshore)
+Copyright 2014 Sandia Corporation
+
+Principal Developers:
+Chris Chartrand (Sandia National Laboratories)
+Ari J Posner (DOE EERE)
+
+Contributors:
+Kelley Ruehl (Sandia National Laboratories)
+

build/Makefile

@@ -0,0 +1,205 @@
+# ------------------------------------------------------------------------------
+#                      Makefile for building SWAN program and documentation
+# ------------------------------------------------------------------------------
+#
+# Before compilation, type "make config" first!
+#
+# To compile the serial executable type "make ser"
+# To compile the OpenMP executable type "make omp"
+# To compile the MPI executable type "make mpi"
+#
+# To remove compiled objects and modules: type "make clean"
+#
+# To remove compiled objects, modules and executable: type "make clobber"
+#
+# To compile the SWAN documentation type "make doc"
+#
+# To remove the PDF and HTML documents type "make cleandoc"
+#
+# Please do not change anything below, unless you're very sure what you're doing
+# ------------------------------------------------------------------------------
+
+include macros.inc
+
+SWAN_EXE = swan.exe
+
+SRCDIR=..\src
+BINDIR=..\bin
+
+#$(OBSDIR)\$(NCF_OBJS)
+SWAN_OBJS = \
+$(OBSDIR)\swmod1.$(EXTO) \
+$(OBSDIR)\swmod2.$(EXTO) \
+$(OBSDIR)\m_constants.$(EXTO) \
+$(OBSDIR)\m_fileio.$(EXTO) \
+$(OBSDIR)\serv_xnl4v5.$(EXTO) \
+$(OBSDIR)\mod_xnl4v5.$(EXTO) \
+$(OBSDIR)\SwanGriddata.$(EXTO) \
+$(OBSDIR)\SwanGridobjects.$(EXTO) \
+$(OBSDIR)\SwanCompdata.$(EXTO) \
+$(OBSDIR)\swanmain.$(EXTO) \
+$(OBSDIR)\swanpre1.$(EXTO) \
+$(OBSDIR)\swanpre2.$(EXTO) \
+$(OBSDIR)\swancom1.$(EXTO) \
+$(OBSDIR)\swancom2.$(EXTO) \
+$(OBSDIR)\swancom3.$(EXTO) \
+$(OBSDIR)\swancom4.$(EXTO) \
+$(OBSDIR)\swancom5.$(EXTO) \
+$(OBSDIR)\swanout1.$(EXTO) \
+$(OBSDIR)\swanout2.$(EXTO) \
+$(OBSDIR)\swanser.$(EXTO) \
+$(OBSDIR)\swanparll.$(EXTO) \
+$(OBSDIR)\SwanReadGrid.$(EXTO) \
+$(OBSDIR)\SwanReadADCGrid.$(EXTO) \
+$(OBSDIR)\SwanReadTriangleGrid.$(EXTO) \
+$(OBSDIR)\SwanReadEasymeshGrid.$(EXTO) \
+$(OBSDIR)\SwanInitCompGrid.$(EXTO) \
+$(OBSDIR)\SwanCheckGrid.$(EXTO) \
+$(OBSDIR)\SwanCreateEdges.$(EXTO) \
+$(OBSDIR)\SwanGridTopology.$(EXTO) \
+$(OBSDIR)\SwanGridVert.$(EXTO) \
+$(OBSDIR)\SwanGridCell.$(EXTO) \
+$(OBSDIR)\SwanGridFace.$(EXTO) \
+$(OBSDIR)\SwanPrintGridInfo.$(EXTO) \
+$(OBSDIR)\SwanFindPoint.$(EXTO) \
+$(OBSDIR)\SwanPointinMesh.$(EXTO) \
+$(OBSDIR)\SwanBpntlist.$(EXTO) \
+$(OBSDIR)\SwanPrepComp.$(EXTO) \
+$(OBSDIR)\SwanVertlist.$(EXTO) \
+$(OBSDIR)\SwanCompUnstruc.$(EXTO) \
+$(OBSDIR)\SwanDispParm.$(EXTO) \
+$(OBSDIR)\SwanPropvelX.$(EXTO) \
+$(OBSDIR)\SwanSweepSel.$(EXTO) \
+$(OBSDIR)\SwanPropvelS.$(EXTO) \
+$(OBSDIR)\SwanTranspAc.$(EXTO) \
+$(OBSDIR)\SwanTranspX.$(EXTO) \
+$(OBSDIR)\SwanDiffPar.$(EXTO) \
+$(OBSDIR)\SwanGSECorr.$(EXTO) \
+$(OBSDIR)\SwanInterpolatePoint.$(EXTO) \
+$(OBSDIR)\SwanInterpolateAc.$(EXTO) \
+$(OBSDIR)\SwanInterpolateOutput.$(EXTO) \
+$(OBSDIR)\SwanConvAccur.$(EXTO) \
+$(OBSDIR)\SwanConvStopc.$(EXTO) \
+$(OBSDIR)\SwanThreadBounds.$(EXTO) \
+$(OBSDIR)\SwanFindObstacles.$(EXTO) \
+$(OBSDIR)\SwanCrossObstacle.$(EXTO) \
+$(OBSDIR)\SwanComputeForce.$(EXTO) \
+$(OBSDIR)\SwanIntgratSpc.$(EXTO) \
+$(OBSDIR)\SwanBndStruc.$(EXTO) \
+$(OBSDIR)\SwanReadfort18.$(EXTO) \
+$(OBSDIR)\SwanPunCollect.$(EXTO) \
+$(OBSDIR)\SwanSumOverNodes.$(EXTO) \
+$(OBSDIR)\SwanMinOverNodes.$(EXTO) \
+$(OBSDIR)\SwanMaxOverNodes.$(EXTO) \
+$(OBSDIR)\ocpids.$(EXTO) \
+$(OBSDIR)\ocpcre.$(EXTO) \
+$(OBSDIR)\ocpmix.$(EXTO) \
+$(OBSDIR)\Pincident.$(EXTO) \
+$(OBSDIR)\Bivariate_1.$(EXTO) \
+
+HCAT_EXE = hcat.exe
+HCAT_OBJS = swanhcat.$(EXTO)
+
+.SUFFIXES: .o .f .for .f90
+
+.PHONEY: help clean clobber
+
+help:
+	@echo "This Makefile supports the following:"
+	@echo "make config    -- makes machine-dependent macros include file"
+	@echo "make ser       -- makes the serial $(SWAN_EXE) executable"
+	@echo "make omp       -- makes the OpenMP $(SWAN_EXE) executable"
+	@echo "make mpi       -- makes the    MPI $(SWAN_EXE) executable"
+	@echo "make doc       -- makes the SWAN documentation (PDF)"
+	@echo "make clean     -- removes compiled objects and modules"
+	@echo "make clobber   -- removes compiled objects, modules and executables"
+	@echo "make cleandoc  -- removes all SWAN documents"
+
+config:
+	@perl platform.pl
+
+install:
+	@perl platform.pl
+
+ser:
+	@perl switch.pl $(swch) $(SRCDIR)\*.ftn $(SRCDIR)\*.ftn90
+	$(MAKE) FOR=$(F90_SER) FFLAGS="$(FLAGS_OPT) $(FLAGS_MSC) $(FLAGS_SER)" \
+	        FFLAGS90="$(FLAGS_OPT) $(FLAGS90_MSC) $(FLAGS_SER)" \
+                INCS="$(INCS_SER)" LIBS="$(LIBS_SER)" OBSDIR=obs-$(F90_SER)-$(arch)-ser \
+<<<<<<< HEAD
+		EXENAME="snl-swan-$(arch)-ser-$(F90_SER).exe" $(SWAN_EXE)
+=======
+		EXENAME="swan-$(arch)-ser-$(F90_SER).exe" $(SWAN_EXE)
+>>>>>>> 8beb893a314f9c3a686c0dfb11ad866da9ee3855
+#	$(MAKE) hcat
+
+omp:
+	@perl switch.pl $(swch) $(SRCDIR)\*.ftn $(SRCDIR)\*.ftn90
+	@$(MAKE) FOR=$(F90_OMP) FFLAGS="$(FLAGS_OPT) $(FLAGS_MSC) $(FLAGS_OMP)" \
+	        FFLAGS90="$(FLAGS_OPT) $(FLAGS90_MSC) $(FLAGS_OMP)" \
+                INCS="$(INCS_OMP)" LIBS="$(LIBS_OMP)" OBSDIR=obs-$(F90_OMP)-$(arch)-omp \
+<<<<<<< HEAD
+		EXENAME="snl-swan-$(arch)-omp-$(F90_OMP).exe" $(SWAN_EXE)
+=======
+		EXENAME="swan-$(arch)-omp-$(F90_OMP).exe" $(SWAN_EXE)
+>>>>>>> 8beb893a314f9c3a686c0dfb11ad866da9ee3855
+#	$(MAKE) hcat
+
+mpi:
+	@perl switch.pl $(swch) -mpi $(SRCDIR)\*.ftn $(SRCDIR)\*.ftn90
+	$(MAKE) FOR=$(F90_MPI) FFLAGS="$(FLAGS_OPT) $(FLAGS_MSC) $(FLAGS_MPI)" \
+	        FFLAGS90="$(FLAGS_OPT) $(FLAGS90_MSC) $(FLAGS_MPI)" \
+                INCS="$(INCS_MPI)" LIBS="$(LIBS_MPI)" OBSDIR=obs-$(F90_MPI)-$(arch)-mpi \
+<<<<<<< HEAD
+		EXENAME="snl-swan-$(arch)-mpi-$(F90_MPI).exe" $(SWAN_EXE)
+=======
+		EXENAME="swan-$(arch)-mpi-$(F90_MPI).exe" $(SWAN_EXE)
+>>>>>>> 8beb893a314f9c3a686c0dfb11ad866da9ee3855
+#	$(MAKE) hcat
+
+hcat:
+	@perl switch.pl $(swch) $(SRCDIR)\swanhcat.ftn
+	$(MAKE) FOR=$(F90_SER) FFLAGS="$(FLAGS_OPT) $(FLAGS_MSC) $(FLAGS_SER)" \
+	        FFLAGS90="$(FLAGS_OPT) $(FLAGS90_MSC) $(FLAGS_SER)" $(HCAT_EXE)
+
+doc:
+	$(MAKE) -f Makefile.latex TARGET=swanuse doc
+	$(MAKE) -f Makefile.latex TARGET=swantech doc
+	$(MAKE) -f Makefile.latex TARGET=swanimp doc
+	$(MAKE) -f Makefile.latex TARGET=swanpgr doc
+	$(MAKE) -f Makefile.latex TARGET=latexfordummies doc
+
+$(HCAT_EXE): $(HCAT_OBJS)
+	$(FOR) $(HCAT_OBJS) $(FFLAGS) $(OUT)$(HCAT_EXE)
+
+
+$(SWAN_EXE): dircheck $(SWAN_OBJS)
+	@echo "Making" $(SWAN_EXE) " from " $(SWAN_OBJS)
+	@$(FOR) $(SWAN_OBJS) $(FFLAGS) $(OUT)$(OBSDIR)\$(SWAN_EXE) $(INCS) $(LIBS)
+	$(CP) $(OBSDIR)\$(SWAN_EXE) $(BINDIR)\$(EXENAME)
+
+dircheck:
+	@echo $(OBSDIR)$(arch)$(swch)
+	-@mkdir $(OBSDIR)
+
+.for{$(OBSDIR)}.obj:
+	$(FOR) $< -c $(FFLAGS) $(INCS) $(MOD)$(OBSDIR) -o $@
+
+.f90{$(OBSDIR)}.obj:
+	$(FOR) $< -c $(FFLAGS90) $(INCS) $(MOD)$(OBSDIR) -o $@
+
+clean:
+	$(RM) *.$(EXTO) *.mod
+
+clobber:
+	$(RM) *.$(EXTO) *.mod *.f *.for *.f90 $(SWAN_EXE) $(HCAT_EXE)
+
+allclean:
+	$(RM) *.$(EXTO) *.mod *.f *.for *.f90 $(SWAN_EXE) $(HCAT_EXE)
+
+cleandoc:
+	$(MAKE) -f Makefile.latex TARGET=swanuse cleandoc
+	$(MAKE) -f Makefile.latex TARGET=swantech cleandoc
+	$(MAKE) -f Makefile.latex TARGET=swanimp cleandoc
+	$(MAKE) -f Makefile.latex TARGET=swanpgr cleandoc
+	$(MAKE) -f Makefile.latex TARGET=latexfordummies cleandoc