From 94d3e79a8617f88dc0219cfdeedfa3147833719d Mon Sep 17 00:00:00 2001
From: Adrian Kummerlaender
Date: Mon, 24 Jun 2019 14:43:36 +0200
Subject: Initialize at openlb-1-3
---
examples/laminar/cavity2d/sequential/Makefile | 105 +++++++
examples/laminar/cavity2d/sequential/cavity2d.cpp | 230 ++++++++++++++
examples/laminar/cavity2d/sequential/cavity2d.xml | 44 +++
.../laminar/cavity2d/sequential/definitions.mk | 30 ++
.../cavity2d/sequential/description_cavity2d.xml | 345 +++++++++++++++++++++
examples/laminar/cavity2d/sequential/module.mk | 29 ++
6 files changed, 783 insertions(+)
create mode 100644 examples/laminar/cavity2d/sequential/Makefile
create mode 100644 examples/laminar/cavity2d/sequential/cavity2d.cpp
create mode 100644 examples/laminar/cavity2d/sequential/cavity2d.xml
create mode 100644 examples/laminar/cavity2d/sequential/definitions.mk
create mode 100644 examples/laminar/cavity2d/sequential/description_cavity2d.xml
create mode 100644 examples/laminar/cavity2d/sequential/module.mk
(limited to 'examples/laminar/cavity2d/sequential')
diff --git a/examples/laminar/cavity2d/sequential/Makefile b/examples/laminar/cavity2d/sequential/Makefile
new file mode 100644
index 0000000..a953954
--- /dev/null
+++ b/examples/laminar/cavity2d/sequential/Makefile
@@ -0,0 +1,105 @@
+# This file is part of the OpenLB library
+#
+# Copyright (C) 2007 Mathias Krause
+# E-mail contact: info@openlb.net
+# The most recent release of OpenLB can be downloaded at
+#
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this program; if not, write to the Free
+# Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA 02110-1301, USA.
+
+###########################################################################
+## definitions
+
+include definitions.mk
+
+include $(ROOT)/global.mk
+
+OBJECTS := $(foreach file, $(SRC), $(PWD)/$(file:.cpp=.o))
+DEPS := $(foreach file, $(SRC), $(PWD)/$(file:.cpp=.d))
+
+###########################################################################
+## all
+
+all : depend compile link
+
+
+###########################################################################
+## dependencies
+
+depend : $(DEPS)
+
+$(PWD)/%.d : %.cpp
+ @echo Create dependencies for $<
+ @$(SHELL) -ec '$(CXX) -M $(CXXFLAGS) $(IDIR) $< \
+ | sed -e "s!$*\.o!$(PWD)\/$*\.o!1" > .tmpfile; \
+ cp -f .tmpfile $@;'
+
+###########################################################################
+## compile
+
+compile : $(OBJECTS)
+
+$(PWD)/%.o: %.cpp
+ @echo Compile $<
+ $(CXX) $(CXXFLAGS) $(IDIR) -c $< -o $@
+
+###########################################################################
+## clean
+
+clean : cleanrub cleanobj cleandep
+
+cleanrub:
+ @echo Clean rubbish files
+ @rm -f *~ core .tmpfile tmp/*.* $(OUTPUT)
+ @rm -f tmp/vtkData/*.* tmp/vtkData/data/*.* tmp/imageData/*.* tmp/gnuplotData/*.* tmp/gnuplotData/data/*.*
+
+cleanobj:
+ @echo Clean object files
+ @rm -f $(OBJECTS)
+
+cleandep:
+ @echo Clean dependencies files
+ @rm -f $(DEPS)
+
+cleanbuild:
+ @cd $(ROOT); \
+ $(MAKE) cleanlib;
+
+###########################################################################
+## update lib
+
+$(ROOT)/$(LIBDIR)/lib$(LIB).a :
+ @cd $(ROOT); \
+ $(MAKE) all
+
+###########################################################################
+## link
+
+link: $(OUTPUT)
+
+$(OUTPUT): $(OBJECTS) $(ROOT)/$(LIBDIR)/lib$(LIB).a
+ @echo Link $@
+ $(CXX) $(foreach file, $(SRC), $(file:.cpp=.o)) $(LDFLAGS) -L$(ROOT)/$(LIBDIR) -l$(LIB) -lz -o $@
+
+###########################################################################
+## include dependencies
+
+ifneq "$(strip $(wildcard *.d))" ""
+ include $(foreach file,$(DEPS),$(file))
+endif
+
+###########################################################################
+###########################################################################
diff --git a/examples/laminar/cavity2d/sequential/cavity2d.cpp b/examples/laminar/cavity2d/sequential/cavity2d.cpp
new file mode 100644
index 0000000..c31433e
--- /dev/null
+++ b/examples/laminar/cavity2d/sequential/cavity2d.cpp
@@ -0,0 +1,230 @@
+/* Lattice Boltzmann sample, written in C++, using the OpenLB
+ * library
+ *
+ * Copyright (C) 2006 - 2012 Mathias J. Krause, Jonas Fietz,
+ * Jonas Latt, Jonas Kratzke
+ * E-mail contact: info@openlb.net
+ * The most recent release of OpenLB can be downloaded at
+ *
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+/* cavity2d.cpp:
+ * This example illustrates a flow in a cuboid, lid-driven cavity.
+ * It also shows how to use the XML parameter files and has an
+ * example description file for OpenGPI. This version is for sequential
+ * use. A version for parallel use is also available.
+ */
+
+
+#include "olb2D.h"
+#ifndef OLB_PRECOMPILED // Unless precompiled version is used,
+#include "olb2D.hh" // include full template code
+#endif
+#include
+#include
+
+using namespace olb;
+using namespace olb::descriptors;
+using namespace olb::graphics;
+using namespace olb::util;
+using namespace std;
+
+typedef double T;
+#define DESCRIPTOR D2Q9<>
+
+void prepareLattice( UnitConverter const& converter,
+ BlockLatticeStructure2D& lattice,
+ Dynamics& bulkDynamics,
+ OnLatticeBoundaryCondition2D& bc ) {
+
+ const int nx = lattice.getNx();
+ const int ny = lattice.getNy();
+ const T omega = converter.getLatticeRelaxationFrequency();
+
+ // link lattice with dynamics for collision step
+ lattice.defineDynamics( 0,nx-1, 0,ny-1, &bulkDynamics );
+
+ // left boundary
+ bc.addVelocityBoundary0N( 0, 0, 1,ny-2, omega );
+ // right boundary
+ bc.addVelocityBoundary0P( nx-1,nx-1, 1,ny-2, omega );
+ // bottom boundary
+ bc.addVelocityBoundary1N( 1,nx-2, 0, 0, omega );
+ // top boundary
+ bc.addVelocityBoundary1P( 1,nx-2,ny-1,ny-1, omega );
+
+ // corners
+ bc.addExternalVelocityCornerNN( 0, 0, omega );
+ bc.addExternalVelocityCornerNP( 0,ny-1, omega );
+ bc.addExternalVelocityCornerPN( nx-1, 0, omega );
+ bc.addExternalVelocityCornerPP( nx-1,ny-1, omega );
+}
+
+void setBoundaryValues( UnitConverter const& converter,
+ BlockLatticeStructure2D& lattice, int iT ) {
+
+ if ( iT==0 ) {
+
+ const int nx = lattice.getNx();
+ const int ny = lattice.getNy();
+
+ // set initial values: v = [0,0]
+ for ( int iX=0; iX& lattice,
+ UnitConverter const& converter, int iT, Timer* timer,
+ const T logT, const T imSave, const T vtkSave,
+ std::string filenameGif, std::string filenameVtk,
+ const int timerPrintMode, const int timerTimeSteps, bool converged ) {
+
+ // Get statistics
+ if ( iT%converter.getLatticeTime( logT )==0 || converged ) {
+ lattice.getStatistics().print( iT, converter.getPhysTime( iT ) );
+ }
+
+// if ( iT%timerTimeSteps==0 || converged ) {
+ if ( iT%timerTimeSteps==0 ) {
+ timer->print( iT,timerPrintMode );
+ }
+
+ BlockVTKwriter2D vtkWriter( filenameVtk );
+ BlockLatticePhysVelocity2D velocity( lattice,converter );
+ BlockLatticePhysPressure2D pressure( lattice,converter );
+ vtkWriter.addFunctor( velocity );
+ vtkWriter.addFunctor( pressure );
+
+ // Writes the Gif files
+ if ( ( iT%converter.getLatticeTime( imSave )==0 && iT>0 ) || converged ) {
+ BlockEuklidNorm2D normVel( velocity );
+ BlockGifWriter gifWriter;
+ gifWriter.write( normVel, 0, 3, iT, filenameVtk );
+// gifWriter.write(normVel, iT, "vel");
+ }
+
+ // Writes the VTK files
+ if ( ( iT%converter.getLatticeTime( vtkSave )==0 && iT>0 ) || converged ) {
+ vtkWriter.write( iT );
+ }
+}
+
+
+int main( int argc, char* argv[] ) {
+
+ // === 1st Step: Initialization ===
+ olbInit( &argc, &argv );
+ OstreamManager clout( std::cout,"main" );
+
+ string fName( "cavity2d.xml" );
+ XMLreader config( fName );
+
+ std::string olbdir = "../../"; //config["Application"]["OlbDir"].get();
+ std::string outputdir = "./tmp/"; //config["Output"]["OutputDir"].get();
+ singleton::directories().setOlbDir( olbdir );
+ singleton::directories().setOutputDir( outputdir );
+
+ // call creator functions using xml data
+ UnitConverter* converter = createUnitConverter( config );
+ // Prints the converter log as console output
+ converter->print();
+ // Writes the converter log in a file
+ converter->write("cavity2d");
+
+ int N = converter->getLatticeLength(1) + 1; // number of voxels in x,y,z direction
+ Timer* timer = createTimer( config, *converter, N*N );
+
+ // === 3rd Step: Prepare Lattice ===
+ T logT = 0.1; //config["Output"]["Log"]["SaveTime"].get();
+ T imSave = 1; //config["Output"]["VisualizationImages"]["SaveTime"].get();
+ T vtkSave = 1; //config["Output"]["VisualizationVTK"]["SaveTime"].get();
+ T maxPhysT = 100; //config["Application"]["PhysParam"]["MaxTime"].get();
+ int timerSkipType = 0; //config["Output"]["Timer"]["SkipType"].get();
+ int timerPrintMode = 0; //config["Output"]["Timer"]["PrintMode"].get();
+ int timerTimeSteps = 1;
+
+ if ( timerSkipType == 0 ) {
+ timerTimeSteps = converter->getLatticeTime( .1 );
+ }
+// else {
+// config["Output"]["Timer"]["TimeSteps"].read( timerTimeSteps );
+// }
+
+
+ std::string filenameGif = "cavity2dimage"; //config["Output"]["VisualizationImages"]["Filename"].get();
+ std::string filenameVtk = "cavity2dvtk"; //config["Output"]["VisualizationVTK"]["Filename"].get();
+
+ BlockLattice2D lattice( N, N );
+
+ ConstRhoBGKdynamics bulkDynamics (
+ converter->getLatticeRelaxationFrequency(),
+ instances::getBulkMomenta()
+ );
+
+ OnLatticeBoundaryCondition2D*
+ boundaryCondition = createInterpBoundaryCondition2D >( lattice );
+
+ prepareLattice( *converter, lattice, bulkDynamics, *boundaryCondition );
+
+ // === 4th Step: Main Loop with Timer ===
+
+ int interval = converter->getLatticeTime( 1 /*config["Application"]["ConvergenceCheck"]["interval"].get()*/ );
+ T epsilon = 1e-3; //config["Application"]["ConvergenceCheck"]["residuum"].get();
+ util::ValueTracer converge( interval, epsilon );
+
+ timer->start();
+ for ( int iT=0; iT <= converter->getLatticeTime( maxPhysT ); ++iT ) {
+ if ( converge.hasConverged() ) {
+ clout << "Simulation converged." << endl;
+ getResults( lattice, *converter, iT, timer, logT, imSave, vtkSave, filenameGif, filenameVtk, timerPrintMode, timerTimeSteps, converge.hasConverged() );
+
+ break;
+ }
+
+ // === 5th Step: Definition of Initial and Boundary Conditions ===
+ setBoundaryValues( *converter, lattice, iT );
+ // === 6th Step: Collide and Stream Execution ===
+ lattice.collideAndStream();
+ // === 7th Step: Computation and Output of the Results ===
+ getResults( lattice, *converter, iT, timer, logT, imSave, vtkSave, filenameGif, filenameVtk, timerPrintMode, timerTimeSteps, converge.hasConverged() );
+ converge.takeValue( lattice.getStatistics().getAverageEnergy(), true );
+ }
+
+ timer->stop();
+ timer->printSummary();
+ delete converter;
+ delete timer;
+ delete boundaryCondition;
+}
diff --git a/examples/laminar/cavity2d/sequential/cavity2d.xml b/examples/laminar/cavity2d/sequential/cavity2d.xml
new file mode 100644
index 0000000..54250f0
--- /dev/null
+++ b/examples/laminar/cavity2d/sequential/cavity2d.xml
@@ -0,0 +1,44 @@
+
+
+ cavity2d
+ 2
+ ../../
+
+ 128
+ 0.5384
+
+
+ 100
+ 1
+ 1
+ 0.001
+ 1
+
+
+ 1
+ 1e-3
+
+
+
+
diff --git a/examples/laminar/cavity2d/sequential/definitions.mk b/examples/laminar/cavity2d/sequential/definitions.mk
new file mode 100644
index 0000000..84ffdca
--- /dev/null
+++ b/examples/laminar/cavity2d/sequential/definitions.mk
@@ -0,0 +1,30 @@
+# This file is part of the OpenLB library
+#
+# Copyright (C) 2007 Mathias Krause
+# E-mail contact: info@openlb.net
+# The most recent release of OpenLB can be downloaded at
+#
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this program; if not, write to the Free
+# Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA 02110-1301, USA.
+
+
+###########################################################################
+###########################################################################
+## DEFINITIONS TO BE CHANGED
+
+ROOT := ../../../..
+SRC := cavity2d.cpp
+OUTPUT := cavity2d
diff --git a/examples/laminar/cavity2d/sequential/description_cavity2d.xml b/examples/laminar/cavity2d/sequential/description_cavity2d.xml
new file mode 100644
index 0000000..63874e1
--- /dev/null
+++ b/examples/laminar/cavity2d/sequential/description_cavity2d.xml
@@ -0,0 +1,345 @@
+
+
+ 0.1
+
+ Application
+ Application: Cavity 2D
+ true
+
+ Name
+ true
+ text
+ cavity2d
+ Name of the application
+
+
+ dim
+ Dimension
+ true
+ spinbox
+ 2
+ 2
+ 2
+ Dimension of the domain
+
+
+ OlbDir
+ true
+ file
+ ../../
+ Path to OpenLB directory
+
+
+ DiscParam
+ Discretization Parameters
+ true
+
+ latticeL
+ Lattice Length [Si]
+ true
+ decimal
+ 0.0078125
+
+ Length of a lattice cell in meter (proportional to Knudsen number)
+ (*obligatory)
+
+
+
+ latticeU
+ Lattice Velocity
+ true
+ decimal
+ 0.1
+
+ Dimensionless lattice velocity (proportional to Mach number)
+
+
+
+
+ PhysParam
+ Physical Parameters
+ true
+
+ MaxTime
+ MaxTime [Si]
+ true
+ decimal
+ 15
+
+ Maximal simulation time in seconds
+
+
+
+ charL
+ Characteristical Length [Si]
+ true
+ decimal
+ 1
+ Characteristical length in meter
+
+
+ charU
+ Characteristical Velocity [Si]
+ true
+ decimal
+ 1
+ Characteristical speed in m/s
+
+
+ viscosityType
+ Describe viscosity by
+ true
+ combobox
+
+ - Kinematic viscosity
+ - Reynolds-Number
+
+ Kinematic viscosity
+
+ Kinematic viscosity
+
+ Application
+ PhysParam
+ charNu
+
+ true
+
+
+
+ Application
+ PhysParam
+ Re
+
+ false
+
+
+
+
+ Reynolds-Number
+
+ Application
+ PhysParam
+ Re
+
+ true
+
+
+
+ Application
+ PhysParam
+ charNu
+
+ false
+
+
+
+ Choose, whether you want to specify either characteristical kinematic viscosity or Reynolds-Number.
+
+
+ charNu
+ Characteristical Viscosity [Si]
+ true
+ decimal
+ 0.001
+
+ Kinematic viscosity in m^2/s
+
+
+
+ Re
+ Reynolds-Number
+ false
+ decimal
+ 100
+
+ Reynolds number
+
+
+
+ charRho
+ Characteristical Density [Si]
+ true
+ decimal
+ 1
+
+ Density factor rho in kg/m^d. As average latticeRho is always around 1, specify the average physical density here.
+ At some point latticeRho can be multplied by this factor to get the local physical density.
+
+
+
+ charPressure
+ Characteristical Pressure [Si]
+ true
+ decimal
+ 0
+
+ This additive pressure constant in Pa is added to the relative pressure result of the computation
+ to get the absolute value.
+
+
+
+
+
+ Output
+ Output Settings
+ true
+
+ OutputDir
+ true
+ file
+ ./tmp/
+ Directory for output data
+
+
+ MultiOutput
+ Multi-Output Mode
+ true
+ checkbox
+ false
+ Chooses whether output will be activated per program (false) or per mpi process (true)
+
+
+ Log
+ Logging
+ true
+
+ Filename
+ true
+ file
+ cavity2d.log
+ Converter information will be stored in this file.
+
+
+ SaveTime
+ true
+ decimal
+ 0.1
+ Time intervall for console output
+
+
+
+ VisualizationVTK
+ true
+
+ Filename
+ true
+ file
+ cavity2dvtk
+ No info
+
+
+ SaveTime
+ true
+ decimal
+ 1
+ No info
+
+
+
+ VisualizationImages
+ true
+
+ Filename
+ true
+ file
+ cavity2dimage
+ No info
+
+
+ SaveTime
+ true
+ decimal
+ 1
+ No info
+
+
+
+ Timer
+ true
+
+ PrintMode
+ Mode of Output
+ true
+ combobox
+
+ - csv-style
+ - one-line
+ - two-line-layout
+
+ 0
+ Displays timer informations about current calculation with different output modes.
+
+
+ SkipType
+ Skip output by
+ true
+ combobox
+
+ - Physical time
+ - Time steps
+
+ 0
+
+ 0
+
+ Output
+ Timer
+ PhysTime
+
+ true
+
+
+
+ Output
+ Timer
+ TimeSteps
+
+ false
+
+
+
+
+ 1
+
+ Output
+ Timer
+ PhysTime
+
+ false
+
+
+
+ Output
+ Timer
+ TimeSteps
+
+ true
+
+
+
+ Choose, whether timer information should displayed either by physical or computational time steps.
+
+
+ PhysTime
+ true
+ decimal
+ .1
+ No info
+
+
+ TimeSteps
+ false
+ text
+ 128
+ 1 will print every step, 2 each second, etc.
+
+
+ PrintSummary
+ true
+ checkbox
+ true
+ Determines whether a summary after calculation should be displayed or not.
+
+
+
+
diff --git a/examples/laminar/cavity2d/sequential/module.mk b/examples/laminar/cavity2d/sequential/module.mk
new file mode 100644
index 0000000..1190482
--- /dev/null
+++ b/examples/laminar/cavity2d/sequential/module.mk
@@ -0,0 +1,29 @@
+# This file is part of the OpenLB library
+#
+# Copyright (C) 2017 Markus Mohrhard
+# E-mail contact: info@openlb.net
+# The most recent release of OpenLB can be downloaded at
+#
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this program; if not, write to the Free
+# Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+# Boston, MA 02110-1301, USA.
+
+current_dir := $(dir $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)))
+
+include global.mk
+include rules.mk
+include $(addsuffix definitions.mk, $(current_dir))
+
+$(eval $(call sample,$(current_dir)$(OUTPUT),$(addprefix $(current_dir), $(SRC))))
--
cgit v1.2.3