From 3a32b5ca728700d63aa5d1f182822de371a9fc8e Mon Sep 17 00:00:00 2001
From: Soeren Peters <peters@irmb.tu-bs.de>
Date: Fri, 13 Jan 2023 10:27:53 +0000
Subject: [PATCH] Add uniform regression test.
---
apps/gpu/LBM/DrivenCavity/DrivenCavity.cpp | 4 +-
.../LBM/DrivenCavityUniform/CMakeLists.txt | 9 +
.../LBM/DrivenCavityUniform/DrivenCavity.cpp | 231 ++++++++++++++++++
.../configDrivenCavity.txt | 34 +++
regression-tests/driven_cavity_test.sh | 2 +-
.../driven_cavity_uniform_test.sh | 24 ++
regression-tests/regression-tests.sh | 5 +-
7 files changed, 303 insertions(+), 6 deletions(-)
create mode 100644 apps/gpu/LBM/DrivenCavityUniform/CMakeLists.txt
create mode 100644 apps/gpu/LBM/DrivenCavityUniform/DrivenCavity.cpp
create mode 100644 apps/gpu/LBM/DrivenCavityUniform/configDrivenCavity.txt
create mode 100755 regression-tests/driven_cavity_uniform_test.sh
diff --git a/apps/gpu/LBM/DrivenCavity/DrivenCavity.cpp b/apps/gpu/LBM/DrivenCavity/DrivenCavity.cpp
index 4ef9786cd..958ef4714 100644
--- a/apps/gpu/LBM/DrivenCavity/DrivenCavity.cpp
+++ b/apps/gpu/LBM/DrivenCavity/DrivenCavity.cpp
@@ -79,7 +79,7 @@ int main()
//////////////////////////////////////////////////////////////////////////
// Simulation parameters
//////////////////////////////////////////////////////////////////////////
- std::string path("./output/DrivenCavity");
+ std::string path("./output/DrivenCavity_uniform");
std::string simulationName("LidDrivenCavity");
const real L = 1.0;
@@ -116,7 +116,7 @@ int main()
gridBuilder->addCoarseGrid(-0.5 * L, -0.5 * L, -0.5 * L, 0.5 * L, 0.5 * L, 0.5 * L, dx);
- gridBuilder->addGrid(new Cuboid(-0.25, -0.25, -0.25, 0.25, 0.25, 0.25), 1); // add fine grid
+ // gridBuilder->addGrid(new Cuboid(-0.25, -0.25, -0.25, 0.25, 0.25, 0.25), 1); // add fine grid
GridScalingFactory scalingFactory = GridScalingFactory();
scalingFactory.setScalingFactory(GridScalingFactory::GridScaling::ScaleCompressible);
diff --git a/apps/gpu/LBM/DrivenCavityUniform/CMakeLists.txt b/apps/gpu/LBM/DrivenCavityUniform/CMakeLists.txt
new file mode 100644
index 000000000..8384e1bc6
--- /dev/null
+++ b/apps/gpu/LBM/DrivenCavityUniform/CMakeLists.txt
@@ -0,0 +1,9 @@
+PROJECT(DrivenCavity LANGUAGES CUDA CXX)
+
+#LIST(APPEND CS_COMPILER_FLAGS_CXX "-DOMPI_SKIP_MPICXX" )
+
+vf_add_library(BUILDTYPE binary PRIVATE_LINK basics VirtualFluids_GPU GridGenerator MPI::MPI_CXX FILES DrivenCavity.cpp)
+
+set_source_files_properties(DrivenCavity.cpp PROPERTIES LANGUAGE CUDA)
+
+set_target_properties(DrivenCavity PROPERTIES CUDA_SEPARABLE_COMPILATION ON)
diff --git a/apps/gpu/LBM/DrivenCavityUniform/DrivenCavity.cpp b/apps/gpu/LBM/DrivenCavityUniform/DrivenCavity.cpp
new file mode 100644
index 000000000..958ef4714
--- /dev/null
+++ b/apps/gpu/LBM/DrivenCavityUniform/DrivenCavity.cpp
@@ -0,0 +1,231 @@
+//=======================================================================================
+// ____ ____ __ ______ __________ __ __ __ __
+// \ \ | | | | | _ \ |___ ___| | | | | / \ | |
+// \ \ | | | | | |_) | | | | | | | / \ | |
+// \ \ | | | | | _ / | | | | | | / /\ \ | |
+// \ \ | | | | | | \ \ | | | \__/ | / ____ \ | |____
+// \ \ | | |__| |__| \__\ |__| \________/ /__/ \__\ |_______|
+// \ \ | | ________________________________________________________________
+// \ \ | | | ______________________________________________________________|
+// \ \| | | | __ __ __ __ ______ _______
+// \ | | |_____ | | | | | | | | | _ \ / _____)
+// \ | | _____| | | | | | | | | | | \ \ \_______
+// \ | | | | |_____ | \_/ | | | | |_/ / _____ |
+// \ _____| |__| |________| \_______/ |__| |______/ (_______/
+//
+// This file is part of VirtualFluids. VirtualFluids 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 3 of
+// the License, or (at your option) any later version.
+//
+// VirtualFluids 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 VirtualFluids (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
+//
+//! \file LidDrivenCavity.cpp
+//! \ingroup Applications
+//! \author Martin Schoenherr, Stephan Lenz
+//=======================================================================================
+#define _USE_MATH_DEFINES
+#include <exception>
+#include <fstream>
+#include <iostream>
+#include <memory>
+#include <sstream>
+#include <stdexcept>
+#include <string>
+
+//////////////////////////////////////////////////////////////////////////
+
+#include "Core/DataTypes.h"
+#include "Core/LbmOrGks.h"
+#include "Core/Logger/Logger.h"
+#include "Core/VectorTypes.h"
+#include "PointerDefinitions.h"
+
+#include <logger/Logger.h>
+
+//////////////////////////////////////////////////////////////////////////
+
+#include "GridGenerator/grid/BoundaryConditions/Side.h"
+#include "GridGenerator/grid/GridBuilder/LevelGridBuilder.h"
+#include "GridGenerator/grid/GridBuilder/MultipleGridBuilder.h"
+#include "GridGenerator/grid/GridFactory.h"
+#include "GridGenerator/geometries/Cuboid/Cuboid.h"
+
+//////////////////////////////////////////////////////////////////////////
+
+#include "VirtualFluids_GPU/Factories/BoundaryConditionFactory.h"
+#include "VirtualFluids_GPU/Factories/GridScalingFactory.h"
+#include "VirtualFluids_GPU/Communication/Communicator.h"
+#include "VirtualFluids_GPU/DataStructureInitializer/GridProvider.h"
+#include "VirtualFluids_GPU/DataStructureInitializer/GridReaderGenerator/GridGenerator.h"
+#include "VirtualFluids_GPU/GPU/CudaMemoryManager.h"
+#include "VirtualFluids_GPU/LBM/Simulation.h"
+#include "VirtualFluids_GPU/Output/FileWriter.h"
+#include "VirtualFluids_GPU/Parameter/Parameter.h"
+#include "VirtualFluids_GPU/Factories/GridScalingFactory.h"
+
+//////////////////////////////////////////////////////////////////////////
+
+int main()
+{
+ try {
+ vf::logging::Logger::initalizeLogger();
+ //////////////////////////////////////////////////////////////////////////
+ // Simulation parameters
+ //////////////////////////////////////////////////////////////////////////
+ std::string path("./output/DrivenCavity_uniform");
+ std::string simulationName("LidDrivenCavity");
+
+ const real L = 1.0;
+ const real Re = 1000.0;
+ const real velocity = 1.0;
+ const real dt = (real)0.5e-3;
+ const uint nx = 64;
+
+ const uint timeStepOut = 1000;
+ const uint timeStepEnd = 10000;
+
+ //////////////////////////////////////////////////////////////////////////
+ // setup logger
+ //////////////////////////////////////////////////////////////////////////
+
+ logging::Logger::addStream(&std::cout);
+ logging::Logger::setDebugLevel(logging::Logger::Level::INFO_LOW);
+ logging::Logger::timeStamp(logging::Logger::ENABLE);
+ logging::Logger::enablePrintedRankNumbers(logging::Logger::ENABLE);
+
+ //////////////////////////////////////////////////////////////////////////
+ // setup gridGenerator
+ //////////////////////////////////////////////////////////////////////////
+
+ auto gridFactory = GridFactory::make();
+ gridFactory->setTriangularMeshDiscretizationMethod(TriangularMeshDiscretizationMethod::POINT_IN_OBJECT);
+ auto gridBuilder = MultipleGridBuilder::makeShared(gridFactory);
+
+ //////////////////////////////////////////////////////////////////////////
+ // create grid
+ //////////////////////////////////////////////////////////////////////////
+
+ real dx = L / real(nx);
+
+ gridBuilder->addCoarseGrid(-0.5 * L, -0.5 * L, -0.5 * L, 0.5 * L, 0.5 * L, 0.5 * L, dx);
+
+ // gridBuilder->addGrid(new Cuboid(-0.25, -0.25, -0.25, 0.25, 0.25, 0.25), 1); // add fine grid
+ GridScalingFactory scalingFactory = GridScalingFactory();
+ scalingFactory.setScalingFactory(GridScalingFactory::GridScaling::ScaleCompressible);
+
+ gridBuilder->setPeriodicBoundaryCondition(false, false, false);
+
+ gridBuilder->buildGrids(LbmOrGks::LBM, false);
+
+ //////////////////////////////////////////////////////////////////////////
+ // compute parameters in lattice units
+ //////////////////////////////////////////////////////////////////////////
+
+ const real velocityLB = velocity * dt / dx; // LB units
+
+ const real vxLB = velocityLB / sqrt(2.0); // LB units
+ const real vyLB = velocityLB / sqrt(2.0); // LB units
+
+ const real viscosityLB = nx * velocityLB / Re; // LB units
+
+ //////////////////////////////////////////////////////////////////////////
+ // set parameters
+ //////////////////////////////////////////////////////////////////////////
+ SPtr<Parameter> para = std::make_shared<Parameter>();
+
+ para->setOutputPath(path);
+ para->setOutputPrefix(simulationName);
+
+ para->setPrintFiles(true);
+
+ para->setVelocityLB(velocityLB);
+ para->setViscosityLB(viscosityLB);
+
+ para->setVelocityRatio(velocity / velocityLB);
+ para->setDensityRatio(1.0);
+
+ para->setTimestepOut(timeStepOut);
+ para->setTimestepEnd(timeStepEnd);
+
+ para->setMainKernel("CumulantK17");
+
+ //////////////////////////////////////////////////////////////////////////
+ // set boundary conditions
+ //////////////////////////////////////////////////////////////////////////
+
+ gridBuilder->setNoSlipBoundaryCondition(SideType::PX);
+ gridBuilder->setNoSlipBoundaryCondition(SideType::MX);
+ gridBuilder->setNoSlipBoundaryCondition(SideType::PY);
+ gridBuilder->setNoSlipBoundaryCondition(SideType::MY);
+ gridBuilder->setVelocityBoundaryCondition(SideType::PZ, vxLB, vyLB, 0.0);
+ gridBuilder->setNoSlipBoundaryCondition(SideType::MZ);
+
+ BoundaryConditionFactory bcFactory;
+
+ bcFactory.setNoSlipBoundaryCondition(BoundaryConditionFactory::NoSlipBC::NoSlipBounceBack);
+ bcFactory.setVelocityBoundaryCondition(BoundaryConditionFactory::VelocityBC::VelocitySimpleBounceBackCompressible);
+
+ //////////////////////////////////////////////////////////////////////////
+ // set copy mesh to simulation
+ //////////////////////////////////////////////////////////////////////////
+
+ vf::gpu::Communicator &communicator = vf::gpu::Communicator::getInstance();
+
+ auto cudaMemoryManager = std::make_shared<CudaMemoryManager>(para);
+ SPtr<GridProvider> gridGenerator =
+ GridProvider::makeGridGenerator(gridBuilder, para, cudaMemoryManager, communicator);
+
+
+ //////////////////////////////////////////////////////////////////////////
+ // run simulation
+ //////////////////////////////////////////////////////////////////////////
+
+ VF_LOG_INFO("Start Running DrivenCavity Showcase...");
+ printf("\n");
+ VF_LOG_INFO("world parameter:");
+ VF_LOG_INFO("--------------");
+ VF_LOG_INFO("dt [s] = {}", dt);
+ VF_LOG_INFO("world_length [m] = {}", L);
+ VF_LOG_INFO("world_velocity [m/s] = {}", velocity);
+ VF_LOG_INFO("dx [m] = {}", dx);
+ printf("\n");
+ VF_LOG_INFO("LB parameter:");
+ VF_LOG_INFO("--------------");
+ VF_LOG_INFO("Re = {}", Re);
+ VF_LOG_INFO("lb_velocity [dx/dt] = {}", velocityLB);
+ VF_LOG_INFO("lb_viscosity [dx^2/dt] = {}", viscosityLB);
+ VF_LOG_INFO("lb_vx [dx/dt] (lb_velocity/sqrt(2)) = {}", vxLB);
+ VF_LOG_INFO("lb_vy [dx/dt] (lb_velocity/sqrt(2)) = {}", vyLB);
+ printf("\n");
+ VF_LOG_INFO("simulation parameter:");
+ VF_LOG_INFO("--------------");
+ VF_LOG_INFO("nx = {}", nx);
+ VF_LOG_INFO("ny = {}", nx);
+ VF_LOG_INFO("nz = {}", nx);
+ VF_LOG_INFO("number of nodes = {}", nx * nx * nx);
+ VF_LOG_INFO("n timesteps = {}", timeStepOut);
+ VF_LOG_INFO("write_nth_timestep = {}", timeStepEnd);
+ VF_LOG_INFO("output_path = {}", path);
+
+ Simulation sim(para, cudaMemoryManager, communicator, *gridGenerator, &bcFactory, &scalingFactory);
+ sim.run();
+
+ } catch (const spdlog::spdlog_ex &ex) {
+ std::cout << "Log initialization failed: " << ex.what() << std::endl;
+ } catch (const std::bad_alloc &e) {
+ VF_LOG_CRITICAL("Bad Alloc: {}", e.what());
+ } catch (const std::exception &e) {
+ VF_LOG_CRITICAL("exception: {}", e.what());
+ } catch (...) {
+ VF_LOG_CRITICAL("Unknown exception!");
+ }
+
+ return 0;
+}
diff --git a/apps/gpu/LBM/DrivenCavityUniform/configDrivenCavity.txt b/apps/gpu/LBM/DrivenCavityUniform/configDrivenCavity.txt
new file mode 100644
index 000000000..458346a67
--- /dev/null
+++ b/apps/gpu/LBM/DrivenCavityUniform/configDrivenCavity.txt
@@ -0,0 +1,34 @@
+##################################################
+#GPU Mapping
+##################################################
+#Devices="0 1 2 3"
+#NumberOfDevices=4
+
+##################################################
+#informations for Writing
+##################################################
+#Path = "output/"
+#Prefix="DrivenCavity"
+#WriteGrid=true
+##################################################
+#informations for reading
+##################################################
+#GridPath="grid/"
+
+##################################################
+#number of grid levels
+##################################################
+#NOGL=1
+
+##################################################
+#LBM Version
+##################################################
+#D3Qxx=27
+#MainKernelName=CumulantAA2016CompSP27
+
+##################################################
+#simulation parameter
+##################################################
+#TimeEnd=100000
+#TimeOut=1000
+#TimeStartOut=0
\ No newline at end of file
diff --git a/regression-tests/driven_cavity_test.sh b/regression-tests/driven_cavity_test.sh
index 96490eb3e..a00e550f0 100755
--- a/regression-tests/driven_cavity_test.sh
+++ b/regression-tests/driven_cavity_test.sh
@@ -8,7 +8,7 @@
# in this case adding -DUSER_APPS="apps/gpu/LBM/DrivenCavity to the cmake command is not necessary, because the DrivenCavity is added to VirtualFluids by default.
mkdir -p build
cmake -B build --preset=release_make_gpu -DCMAKE_CUDA_ARCHITECTURES=75 #-DUSER_APPS="apps/gpu/LBM/DrivenCavity"
-cd build && make -j 8 && cd ..
+cmake --build build --parallel 8
# execute VirtualFluids
./build/bin/DrivenCavity
diff --git a/regression-tests/driven_cavity_uniform_test.sh b/regression-tests/driven_cavity_uniform_test.sh
new file mode 100755
index 000000000..9337eb7f9
--- /dev/null
+++ b/regression-tests/driven_cavity_uniform_test.sh
@@ -0,0 +1,24 @@
+#!/bin/bash
+
+#################################
+# Driven Cavity Regression Test
+#################################
+
+# build VirtualFluids accordingly to our specific test scenario.
+# in this case adding -DUSER_APPS="apps/gpu/LBM/DrivenCavity to the cmake command is not necessary, because the DrivenCavity is added to VirtualFluids by default.
+mkdir -p build
+cmake -B build --preset=release_make_gpu -DCMAKE_CUDA_ARCHITECTURES=75 -DUSER_APPS="apps/gpu/LBM/DrivenCavityUniform"
+cmake --build build --parallel 8
+
+# execute VirtualFluids
+./build/bin/DrivenCavity
+
+# set the path to the produced data
+PATH_TO_DIR=output/DrivenCavity_uniform
+
+# set the path to the reference data.
+# `regression-tests/reference_data` is fix `regression_tests/gpu/DrivenCavity_uniform_2022_12_16` must match the structure in https://github.com/irmb/test_data:
+PATH_TO_REFERENCE_DIR=regression-tests/reference_data/regression_tests/gpu/DrivenCavity_uniform_2022_12_16
+
+# execute fieldcompare (A more comprehensive manual can be found here https://gitlab.com/dglaeser/fieldcompare)
+fieldcompare dir $PATH_TO_DIR $PATH_TO_REFERENCE_DIR --include-files "*.vtu"
diff --git a/regression-tests/regression-tests.sh b/regression-tests/regression-tests.sh
index 5b7d22790..9f5dc8cf7 100755
--- a/regression-tests/regression-tests.sh
+++ b/regression-tests/regression-tests.sh
@@ -13,11 +13,10 @@ git clone https://github.com/irmb/test_data regression-tests/reference_data
# by cloning our meshio patch and fieldcompare into a venv
python3 -m venv .venv
source .venv/bin/activate
-pip install rich
-pip install git+https://github.com/soerenPeters/meshio@update-pyproject-version
-pip install git+https://gitlab.com/dglaeser/fieldcompare
+pip install fieldcompare
# 3. Running the specific tests
+./regression-tests/driven_cavity_uniform_test.sh
./regression-tests/driven_cavity_test.sh
--
GitLab