Submission: ROBERT ZHOU

.gitignore

@@ -1,8 +1,9 @@
-Thanda.xcodeproj
-Thanda.build
+MFluidSolver.xcodeproj
+MFluidSolver.build
 DerivedData
 CMakeScripts
 CMakeFiles
 CMakeCache.txt
 cmake_install.cmake
 CMakeLists.txt.user
+build

CMakeLists.txt

@@ -1,23 +1,43 @@
-##################
-#     Thanda     #
-##################
+########################
+#     MFluidSolver     #
+########################
 
-# credit - base CMake config : Yining Karl Li , edited CMake config: Akshay Shah & Debanshu Singh
+# Credit - base CMake config: Yining Karl Li, edited CMake config: Akshay Shah & Debanshu Singh
 
-#name your project
-project(Thanda)
+# Name your project
+project(MFluidSolver)
 cmake_minimum_required(VERSION 2.8)
 
-# set creates a variable
-set (NUPARU "nuparu")
-# add include and src directories to path
+# Versioning - https://cmake.org/cmake-tutorial/
+set(MFluidSolver_VERSION_MAJOR 1)
+set(MFluidSolver_VERSION_MINOR 0)
+configure_file(
+    "${PROJECT_SOURCE_DIR}/src/MFluidSolverConfig.hpp.in"
+    "${PROJECT_BINARY_DIR}/MFluidSolverConfig.hpp"
+)
+include_directories("${PROJECT_BINARY_DIR}")
+
+# Copy GLSL, JSON, and Texture files
+file(GLOB CONFIG_FILE "${PROJECT_SOURCE_DIR}/config/*")
+file(COPY ${CONFIG_FILE} DESTINATION "${PROJECT_BINARY_DIR}/")
+file(GLOB GLSL_SRC "${PROJECT_SOURCE_DIR}/glsl/*.glsl")
+file(COPY ${GLSL_SRC} DESTINATION "${PROJECT_BINARY_DIR}/glsl/")
+file(GLOB JSON_SRC "${PROJECT_SOURCE_DIR}/scene/*.json")
+file(COPY ${JSON_SRC} DESTINATION "${PROJECT_BINARY_DIR}/scene/")
+file(GLOB TEXTURE_SRC "${PROJECT_SOURCE_DIR}/texture/*")
+file(COPY ${TEXTURE_SRC} DESTINATION "${PROJECT_BINARY_DIR}/texture/")
+
+# Set creates a variable
+set(NUPARU "nuparu")
+# Add include and src directories to path
 include_directories(
+        ${PROJECT_SOURCE_DIR}/src
         ${NUPARU}/include
         ${NUPARU}/src
 )
 
 # Add path for pre-compiled libraries here (we will later link them with our compiled source)
-# Add Nuparu library to path for OSX, linux and windows
+# Add Nuparu library to path for OSX, Linux and Windows
 if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
     set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} ${NUPARU}/lib/osx)
 elseif(${CMAKE_SYSTEM_NAME} MATCHES "Linux")
@@ -26,27 +46,38 @@ elseif(WIN32)
     set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} ${NUPARU}/lib/win)
 endif()
 
-#set include variables
-set(GLFW_INCLUDE_DIR ${NUPARU}/include )
-set(GLEW_INCLUDE_DIR ${NUPARU}/include )
+# Set include variables
 set(GLFW_LIBRARY_DIR ${CMAKE_LIBRARY_PATH})
 set(GLEW_LIBRARY_DIR ${CMAKE_LIBRARY_PATH})
+set(GLFW_INCLUDE_DIR ${NUPARU}/include)
+set(GLEW_INCLUDE_DIR ${NUPARU}/include)
 
 # Use find_package & find_library to link with
-find_package(OPENGL REQUIRED)
+find_package(Boost COMPONENTS filesystem system REQUIRED)
+find_package(OpenGL REQUIRED)
 find_package(GLEW)
 find_library(GLFW_LIBRARY "glfw3" HINTS ${GLFW_LIBRARY_DIR})
 find_library(JSONCPP "jsoncpp")
+find_library(LIBZ "z")
+find_library(OPENVDB "openvdb")
+find_library(OPENEXR_HALF NAMES Half PATHS ${CMAKE_LIBRARY_PATH})
+find_library(PARTIO "partio")
+find_library(TBB "tbb")
+
+include_directories(${Boost_INCLUDE_DIRS})
 
 add_definitions(
         -DTW_STATIC
         -DTW_NO_LIB_PRAGMA
         -DTW_NO_DIRECT3D
         -DGLEW_STATIC
         -D_CRT_SECURE_NO_WARNINGS
+        -DBOOST_TEST_DYN_LINK
 )
 
-set(CORE_LIBS ${GLFW_LIBRARY} ${GLUT_LIBRARY} ${GLEW_LIBRARY} ${JSONCPP} ${OPENGL_LIBRARY} )
+set(CORE_LIBS ${GLFW_LIBRARY} ${GLUT_LIBRARY} ${GLEW_LIBRARY} ${OPENGL_LIBRARY}
+    ${Boost_FILESYSTEM_LIBRARY} ${Boost_SYSTEM_LIBRARY}
+    ${JSONCPP} ${LIBZ} ${OPENVDB} ${OPENEXR_HALF} ${PARTIO} ${TBB})
 
 # OSX-specific hacks/fixes
 if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
@@ -62,33 +93,92 @@ if(${CMAKE_SYSTEM_NAME} MATCHES "Linux")
     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lX11 -lXxf86vm -lXrandr -lpthread -lXi")
 endif()
 
-# set compiler flags for c++11
+# Set compiler flags for c++11
 if(${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -O3 -m64 -msse2 -w")
 elseif(WIN32)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
 endif()
 
+# Add -O0 to remove optimizations when using gcc
+IF(CMAKE_COMPILER_IS_GNUCC)
+    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -O0")
+    set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O0")
+ENDIF(CMAKE_COMPILER_IS_GNUCC)
+
 if(MSVC)
-    set(COMPILER_FLAGS 
+    set(COMPILER_FLAGS
             CMAKE_CXX_FLAGS
             CMAKE_CXX_FLAGS_DEBUG
             CMAKE_CXX_FLAGS_RELEASE
-            CMAKE_C_FLAGS 
+            CMAKE_C_FLAGS
             CMAKE_C_FLAGS_DEBUG
             CMAKE_C_FLAGS_RELEASE
         )
 endif()
 
 # Add source files you want to compile (.cpp)
 set(CORE_SRC
-        src/main.cpp
-        src/camera/camera.cpp
-        src/viewer/viewer.cpp
+        nuparu/src/stb_image/stb_image_write.c
+        src/fluidSolver/sphSolver/iiSphSolver.cpp
+        src/fluidSolver/sphSolver/kernelFunctions.cpp
+        src/fluidSolver/sphSolver/neighborSearch.cpp
+        src/fluidSolver/sphSolver/sphGrid.cpp
+        src/fluidSolver/sphSolver/sphIndexSortedUniformGrid.cpp
+        src/fluidSolver/sphSolver/sphParticle.cpp
+        src/fluidSolver/sphSolver/sphSolver.cpp
+        src/fluidSolver/sphSolver/sphUniformGrid.cpp
+        src/fluidSolver/sphSolver/sphZIndexSortedUniformGrid.cpp
         src/fluidSolver/fluidSolver.cpp
-        src/scene/scene.cpp
+        src/fluidSolver/particle.cpp
+        src/fluidSolver/zCurve.cpp
+        src/geom/cube.cpp
+        src/geom/drawable.cpp
         src/geom/geom.cpp
+        src/geom/transform.cpp
+        src/scene/camera.cpp
+        src/scene/scene.cpp
+        src/viewer/input.cpp
+        src/viewer/particleShaderProgram.cpp
+        src/viewer/shaderProgram.cpp
+        src/viewer/viewer.cpp
+        src/main.cpp
+        src/utils.cpp
+)
+
+add_executable(MFluidSolver ${CORE_SRC})
+target_link_libraries(MFluidSolver ${CORE_LIBS})
+
+##### Testing #####
+add_subdirectory(unittest)
+
+# KernelFunctions Library
+set(MKERNELFUNCTIONS_LIB
+        src/fluidSolver/sphSolver/kernelFunctions.cpp
+)
+add_library(MKernelFunctions ${MKERNELFUNCTIONS_LIB})
+
+# NeighborSearch Library
+set(MNEIGHBORSEARCH_LIB
+        src/fluidSolver/sphSolver/neighborSearch.cpp
+        src/fluidSolver/sphSolver/sphGrid.cpp
+        src/fluidSolver/sphSolver/sphIndexSortedUniformGrid.cpp
+        src/fluidSolver/sphSolver/sphParticle.cpp
+        src/fluidSolver/sphSolver/sphUniformGrid.cpp
+        src/fluidSolver/sphSolver/sphZIndexSortedUniformGrid.cpp
+        src/fluidSolver/particle.cpp
+        src/fluidSolver/zCurve.cpp
+        src/utils.cpp
+)
+add_library(MNeighborSearch ${MNEIGHBORSEARCH_LIB})
+target_link_libraries(MNeighborSearch ${CORE_LIBS})
+
+# ZCurve Library
+set(MZCURVE_LIB
+        src/fluidSolver/zCurve.cpp
 )
+add_library(MZCurve ${MZCURVE_LIB})
 
-add_executable(Thanda ${CORE_SRC})
-target_link_libraries(Thanda ${CORE_LIBS})
+# Tests
+enable_testing()
+add_test(NAME MTest COMMAND MTest)

README.md

@@ -1,16 +1,151 @@
-# CIS563-FluidSolver
-(Credit : CIS565 README)
+# MFluidSolver #
 
-Fluid Solver Submission guidelines:
+IISPH Demo: [Vimeo](https://vimeo.com/groups/cis563/videos/164437486)
 
+![IISPH Cube in Cube Snapshot](images/cube-iisph-sprint1_0.png?raw=true "IISPH Cube in Cube snapshot.")
 
-- If you have modified any of the CMakeLists.txt files at all (aside from the list of CORE_SRC), you must test that your project can build. Beware of any build issues.
+### How Does It Work ###
+This fluid solver uses GLFW, GLM, and GLEW. It reads a JSON configuration file
+and a JSON scene file, creating a fluid container and a scene container. The
+fluid generates particles once, then all the particles are subject to fluid
+forces (currently none). The scene is initially paused. The camera is controlled
+by a standard arcball interface described below. The solver currently set to
+display the neighbor particles of the first particle, which can be changed
+randomly. The solver can also export the backend grid for the fluid particles to
+the VDB format. The solver runs both SESPH and IISPH.
 
-- Open a GitHub pull request so that we can see that you have finished. The title should be "Submission: YOUR NAME".
+### Dependencies ###
 
-- In the body of the pull request, include a link to your repository.
+- Boost (Filesytem, System, Unit Test Framework)
+- OpenVDB 2.3.0
 
-- Submit on canvas with a direct link to your pull request on GitHub
+### Build Instructions (*nix) ###
+By default, the program is set to default debugging mode as set in
+`src/MFluidSolverConfig.hpp.in`. There are many other options there including
+logging settings and defaults, but note that defaults will be overwritten by
+the configuration file `config/config.json`.
 
+    mkdir build
+    cd build
+    cmake ..
+    make
+    ./MFluidSolver
 
-And you're done!
+### Unit Test Instructions (*nix) ###
+This will run all tests in the unittest folder. Test results will be printed
+to stdout, and details are found in `build/Testing/Temporary/LastTest.log`.
+This does include a brief performance test on neighbor search.
+
+    make test
+
+### How To Use ###
+Press P to toggle pausing. Press Press N to randomly pick a particle to show
+its neighbors. Press E to export a VDB file of the graph to `export.vdb` (if
+OpenVDB is enabled in `MFluidSolverConfig`). Press R to reseed the scene
+using the fluid source. Press right to step frame by frame (0.001 seconds).
+Press S to write out a screenshot to `screenshot_%05d.tga`.
+
+All SPH parameters, as well as several general program parameters, can be found
+in `config/config.json`. The scene file, which contains dimensions, particle
+parameters, camera settings, and particle spawn information, can be edited from
+`scene/scene.json`. Parameter names are case sensitive, but options are not. If
+you change parameters outside of the build folder, you will need to rerun
+`cmake ..`. You can avoid this issue by editing the files in the build folder.
+Note the following case-insensitive string options available for several
+parameters:
+
+neighborSearchType
+- naive
+- uniform
+- indexSortedUniform
+- indexSortedUniformInsertionSort
+- zIndexSortedUniform
+- zIndexSortedUniformInsertionSort
+
+spawnMethod
+- jittered
+- poissonDisk
+- uniform
+
+visualization
+- type
+    - density (set maxDensityDifference)
+    - index
+    - neighbors
+    - none
+    - particle (set particleId)
+    - pressure (set maxPressure)
+    - velocity (set maxVelocity)
+    - velocityDir
+- maxDensityDifference
+- maxPressure
+- maxVelocity
+- particleId
+- velocityColor (8-bit rgb array)
+
+The `numUpdates` parameter can be used to set the number of frames to simulate
+in order to get accurate and comparable performance ratings.
+
+#### Arcball ####
+The camera uses the arcball interface and can be controlled with the left and
+right mouse buttons and the scroll wheel.
+
+The left mouse button is handled by an arcball interface. Clicking and dragging
+across the center of the GL widget rotates the camera around its focus point in
+the X and Y directions. Clicking and dragging in a circular motion around the
+outer edges of the GL widget rotates the camera around its focus point in the Z
+direction. The movements of the camera should follow the movements of the mouse
+intuitively.
+
+The scroll wheel zooms the camera. Scrolling up zooms out and scrolling down
+zooms in.
+
+The right mouse button pans the camera. This changes both the camera's and its
+focus point's position. Right-click and drag to move the camera in the opposite
+direction of the mouse. It will look like you're dragging the scene with you.
+
+### IISPH Simulation Performance ###
+CPU: Intel i7-4800MQ limited to 2.7GHz<br />
+GPU: NVIDIA GeForce GTX 765M<br />
+Compiler: GCC 5.3.0<br />
+Measured in seconds per frame. Note that this includes time spent updating the
+viewer and logging input events.
+
+![Graph of the simulation performance for different neighbor search types](images/nsPerfGraph2.png?raw=true "Index sorting improves performance without forced insertion sort.")
+
+- The performance gain from index sorting is a signficant improvement over a
+standard uniform grid, especially when insertion sort is not forced.
+- The fact that the uniform grid uses the Y axis last (i.e.: change in the
+Y-coordinate causes the greatest index change) may play a role in making uniform
+grids comparable to Z-indexed grids, as fluids tend to stay within the XZ-plane.
+It would be interesting to explore this further.
+- Z-indexing may be more beneficial in cases where the XZ-plane is large (i.e.:
+when there are larger index changes in the uniform grid), as it is in the Cube
+in Cube scene.
+- Index sorted grids sort every frame with std::sort, which is a hybrid of
+introsort and insertion sort in [GCC](https://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/a01027.html).
+This likely explains the deficiencies of using insertion sort only.
+- Insertion sort may also be less effective in IISPH where timesteps can be
+larger than in traditional SESPH, so particles travel much farther and therefore
+change indices much more frequently.
+
+### Missing Required Features ###
+
+- Test Partio point export
+- OpenVDB level set export
+- Optional: Update derivatives
+- Optional: Ihmsen boundary conditions
+- Optional: Cache neighbor distances
+- Optional: Better seeding (poisson distribution)
+- Optional: Test bicubic spline kernel
+- Optional: Solid body coupling
+- Optional: Headless mode
+- Optional: Refactor IISPH because update() is way too hard to read
+- Optional: Flyaway prevention
+
+### Extra Features ###
+None
+
+### Credits ###
+- [Nuparu Dependency and Foundation Libraries](https://github.com/betajippity/Nuparu)
+- DDS File Loader adapted from [opengl-tutorial.org](http://www.opengl-tutorial.org/beginners-tutorials/tutorial-5-a-textured-cube/) [(WTF Public License)](http://www.wtfpl.net/).