- added cmake option for third-party methods

Author: janbender

CMake/Common.cmake

@@ -32,6 +32,11 @@ if (USE_DEBUG_TOOLS)
 	add_definitions( -DUSE_DEBUG_TOOLS)	
 endif (USE_DEBUG_TOOLS)
 
+option(USE_THIRD_PARTY_METHODS "Use third-party methods" ON)
+if (USE_THIRD_PARTY_METHODS)
+	add_definitions( -DUSE_THIRD_PARTY_METHODS)	
+endif (USE_THIRD_PARTY_METHODS)
+
 cmake_dependent_option(USE_PYTHON_BINDINGS "Generate Python Bindings using PyBind11" ON "PYTHON_EXECUTABLE" OFF)
 if (USE_PYTHON_BINDINGS AND UNIX)
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")

Changelog.txt

@@ -1,3 +1,5 @@
+2.9.0 
+	- added new surface tension model (thanks to Fernando Zorilla and Marcel Ritter)
 	- added a test for reading and writing the state of a simulation
 	- updated to Eigen 3.3.8
 	- added a hotkey (m) to rescale the range of the current color map

README.md

@@ -123,10 +123,9 @@ and the implicit methods of the following publications:
 The SPlisHSPlasH library implements the surface tension methods of the following publications: 
 
 * Markus Becker and Matthias Teschner. Weakly compressible SPH for free surface flows. In Proceedings of ACM SIGGRAPH/Eurographics Symposium on Computer Animation, 2007. Eurographics Association.
-
 * Nadir Akinci, Gizem Akinci, and Matthias Teschner. Versatile surface tension and adhesion for SPH fluids. ACM Trans. Graph., 32(6):182:1–182:8, 2013. 
-
 * Xiaowei He, Huamin Wang, Fengjun Zhang, Hongan Wang, Guoping Wang, and Kun Zhou, "Robust simulation of sparsely sampled thin features in SPH-based free surface flows", ACM Transactions on Graphics, 34(1), 2014.
+* F. Zorilla, M. Ritter, J. Sappl, W. Rauch, M. Harders, "Accelerating  Surface Tension Calculation in SPH via Particle Classification and Monte Carlo Integration", Computers 9, 23, 2020.
 
 ## Vorticity
 
@@ -208,3 +207,4 @@ The following videos were generated using the SPlisHSPlasH library:
 * Tetsuya Takahashi, Yoshinori Dobashi, Issei Fujishiro, Tomoyuki Nishita, and Ming C. Lin. Implicit Formulation for SPH-based Viscous Fluids. Computer Graphics Forum, 34, 2015.
 * Marcel Weiler, Dan Koschier and Jan Bender. Projective Fluids. Proceedings of the 9th International Conference on Motion in Games, ACM, 2016, 79-84
 * Marcel Weiler, Dan Koschier, Magnus Brand and Jan Bender. A Physically Consistent Implicit Viscosity Solver for SPH Fluids. Computer Graphics Forum (Eurographics), 37(2), 2018
+* F. Zorilla, M. Ritter, J. Sappl, W. Rauch, M. Harders, "Accelerating  Surface Tension Calculation in SPH via Particle Classification and Monte Carlo Integration", Computers 9, 23, 2020.

SPlisHSPlasH/CMakeLists.txt

@@ -65,16 +65,13 @@ set(SURFACETENSION_HEADER_FILES
 	SurfaceTension/SurfaceTension_Becker2007.h
 	SurfaceTension/SurfaceTension_Akinci2013.h
 	SurfaceTension/SurfaceTension_He2014.h
-	SurfaceTension/SurfaceTension_ZorillaRitter2020_haltonVec323.h
-	SurfaceTension/SurfaceTension_ZorillaRitter2020.h
 	)
 
 set(SURFACETENSION_SOURCE_FILES
 	SurfaceTension/SurfaceTensionBase.cpp
 	SurfaceTension/SurfaceTension_Becker2007.cpp
 	SurfaceTension/SurfaceTension_Akinci2013.cpp
 	SurfaceTension/SurfaceTension_He2014.cpp
-	SurfaceTension/SurfaceTension_ZorillaRitter2020.cpp
 	)	
 
 set(VISCOSITY_HEADER_FILES
@@ -166,6 +163,17 @@ set(UTILS_SOURCE_FILES
 	Utilities/WindingNumbers.cpp
 	)	
 
+if (USE_THIRD_PARTY_METHODS)
+	list(APPEND SURFACETENSION_HEADER_FILES 
+		SurfaceTension/SurfaceTension_ZorillaRitter2020_haltonVec323.h
+		SurfaceTension/SurfaceTension_ZorillaRitter2020.h
+	)
+	
+	list(APPEND SURFACETENSION_SOURCE_FILES
+		SurfaceTension/SurfaceTension_ZorillaRitter2020.cpp
+	)
+endif()
+	
 add_library(SPlisHSPlasH
 	Common.h
 

SPlisHSPlasH/FluidModel.cpp

@@ -14,7 +14,6 @@
 #include "SurfaceTension/SurfaceTension_Becker2007.h"
 #include "SurfaceTension/SurfaceTension_Akinci2013.h"
 #include "SurfaceTension/SurfaceTension_He2014.h"
-#include "SurfaceTension/SurfaceTension_ZorillaRitter2020.h"
 #include "Viscosity/Viscosity_XSPH.h"
 #include "Viscosity/Viscosity_Standard.h"
 #include "Viscosity/Viscosity_Bender2017.h"
@@ -30,6 +29,9 @@
 #include "Elasticity/Elasticity_Becker2009.h"
 #include "Elasticity/Elasticity_Peer2018.h"
 
+#ifdef USE_THIRD_PARTY_METHODS
+#include "SurfaceTension/SurfaceTension_ZorillaRitter2020.h"
+#endif
 
 using namespace SPH;
 using namespace GenParam;
@@ -49,7 +51,9 @@ int FluidModel::ENUM_SURFACETENSION_NONE = -1;
 int FluidModel::ENUM_SURFACETENSION_BECKER2007 = -1;
 int FluidModel::ENUM_SURFACETENSION_AKINCI2013 = -1;
 int FluidModel::ENUM_SURFACETENSION_HE2014 = -1;
+#ifdef USE_THIRD_PARTY_METHODS
 int FluidModel::ENUM_SURFACETENSION_ZORILLARITTER2020 = -1;
+#endif
 int FluidModel::ENUM_VISCOSITY_NONE = -1;
 int FluidModel::ENUM_VISCOSITY_STANDARD = -1;
 int FluidModel::ENUM_VISCOSITY_XSPH = -1;
@@ -170,8 +174,9 @@ void FluidModel::initParameters()
 	enumParam->addEnumValue("Becker & Teschner 2007", ENUM_SURFACETENSION_BECKER2007);
 	enumParam->addEnumValue("Akinci et al. 2013", ENUM_SURFACETENSION_AKINCI2013);
 	enumParam->addEnumValue("He et al. 2014", ENUM_SURFACETENSION_HE2014);
+#ifdef USE_THIRD_PARTY_METHODS
 	enumParam->addEnumValue("Zorilla, Ritter, et al. 2020", ENUM_SURFACETENSION_ZORILLARITTER2020);
-
+#endif
 
 	ParameterBase::GetFunc<int> getViscosityFct = std::bind(&FluidModel::getViscosityMethod, this);
 	ParameterBase::SetFunc<int> setViscosityFct = std::bind(&FluidModel::setViscosityMethod, this, std::placeholders::_1);
@@ -484,8 +489,10 @@ void FluidModel::setSurfaceTensionMethod(const int val)
 		m_surfaceTension = new SurfaceTension_Akinci2013(this);
 	else if (m_surfaceTensionMethod == SurfaceTensionMethods::He2014)
 		m_surfaceTension = new SurfaceTension_He2014(this);
+#ifdef USE_THIRD_PARTY_METHODS
 	else if (m_surfaceTensionMethod == SurfaceTensionMethods::ZorillaRitter2020)
 		m_surfaceTension = new SurfaceTension_ZorillaRitter2020(this);
+#endif
 
 	if (m_surfaceTension != nullptr)
 		m_surfaceTension->init();

SPlisHSPlasH/FluidModel.h

@@ -70,7 +70,11 @@ namespace SPH
 			name(n), type(t), getFct(fct), storeData(s) { }
 	};
 
-	enum class SurfaceTensionMethods { None = 0, Becker2007, Akinci2013, He2014, ZorillaRitter2020, NumSurfaceTensionMethods };
+	enum class SurfaceTensionMethods { None = 0, Becker2007, Akinci2013, He2014, 
+#ifdef USE_THIRD_PARTY_METHODS
+		ZorillaRitter2020, 
+#endif
+		NumSurfaceTensionMethods };
 	enum class ViscosityMethods { None = 0, Standard, XSPH, Bender2017, Peer2015, Peer2016, Takahashi2015, Weiler2018, NumViscosityMethods };
 	enum class VorticityMethods { None = 0, Micropolar, VorticityConfinement, NumVorticityMethods };
 	enum class DragMethods { None = 0, Macklin2014, Gissler2017, NumDragMethods };
@@ -101,7 +105,9 @@ namespace SPH
 			static int ENUM_SURFACETENSION_BECKER2007;
 			static int ENUM_SURFACETENSION_AKINCI2013;
 			static int ENUM_SURFACETENSION_HE2014;
+#ifdef USE_THIRD_PARTY_METHODS
 			static int ENUM_SURFACETENSION_ZORILLARITTER2020;
+#endif
 
 			static int ENUM_VISCOSITY_NONE;
 			static int ENUM_VISCOSITY_STANDARD;