Refactoring

.circleci/config.yml

@@ -10,6 +10,7 @@ jobs:
       - run:
           name: GCC-8 build
           command: |
+            source /opt/intel/compilers_and_libraries/linux/bin/compilervars.sh -arch intel64 -platform linux
             mkdir -p build
             [ "$(ls -A build)" ] && rm -rf build/*
             cd build
@@ -20,6 +21,7 @@ jobs:
       - run:
           name: Clang-6.0 build
           command: |
+            source /opt/intel/compilers_and_libraries/linux/bin/compilervars.sh -arch intel64 -platform linux
             mkdir -p build
             [ "$(ls -A build)" ] && rm -rf build/*
             cd build
@@ -32,10 +34,16 @@ jobs:
           command: |
             cppcheck --version
             cppcheck --enable=warning --inconclusive --force --language=c++ --std=c++11 src/*.cc include/*.h include/*.tcc --error-exitcode=1
+      # clang-format
+      - run:
+          name: clang-format
+          command: |
+            python3 ./clang-tools/run-clang-format.py -r include/* src/* tests/*
       # codecoverage
       - run:
           name: codecov.io
           command: |
+            source /opt/intel/compilers_and_libraries/linux/bin/compilervars.sh -arch intel64 -platform linux
             mkdir -p build
             [ "$(ls -A build)" ] && rm -rf build/*
             cd build

.gitignore

@@ -58,4 +58,3 @@ configure.scan
 *install-sh
 *missing
 *stamp-h1
-benchmarks/

CMakeLists.txt

@@ -1,7 +1,7 @@
 project(pipe_network LANGUAGES CXX)
 
-# Require C++14-compliant compiler; only available for CMake v. 3.1 and up
-set(CMAKE_CXX_STANDARD 14)
+# Require C++17-compliant compiler; only available for CMake v. 3.1 and up
+set(CMAKE_CXX_STANDARD 17)
 
 cmake_minimum_required(VERSION 3.1)
 
@@ -11,7 +11,7 @@ SET(CMAKE_VERBOSE_MAKEFILE OFF)
 # General compile settings
 IF (NOT CMAKE_BUILD_TYPE)
  SET(CMAKE_BUILD_TYPE "Debug")
- #SET(CMAKE_BUILD_TYPE "Release")
+# SET(CMAKE_BUILD_TYPE "Release")
 ENDIF (NOT CMAKE_BUILD_TYPE)
 
 # GNU Specific settings
@@ -24,72 +24,110 @@ if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
   SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fpermissive -pthread")
 endif()
 
+# CMake seems to have no way to enable/disable testing per subproject,
+# so we provide an option similar to BUILD_TESTING, but just for CITYSCAPE.
+option(PIPE_NETWORK_TEST_BUILD_TESTING "enable testing for cityscape" ON)
+
 # CMake Modules
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 
-# Boost Archive
-#find_package(Boost REQUIRED COMPONENTS system serialization)
-#include_directories(${BOOST_INCLUDE_DIRS})
-#link_libraries(${Boost_SERIALIZATION_LIBRARY} ${Boost_SYSTEM_LIBRARY})
-
+# pipe_network executable
+SET(pipe_network_src
+        src/index_manager.cc
+        src/mesh_components.cc
+        src/mesh.cc
+        src/matrix_assembler_components.cc
+        src/matrix_assembler.cc
+        src/curves.cc
+        src/mkl_unsym.cc
+        src/LU_solver.cc
+        src/hydralic_sim.cc
+        src/io.cc
+        src/io_utils.cc
+        src/valve_graph.cc
+        src/valve_graph_components.cc
+        )
+
+# Find dependencies for the library
 # Eigen
 find_package(Eigen3 REQUIRED)
-include_directories(${EIGEN3_INCLUDE_DIR})
+
 
 # Pthreads
 set(THREADS_PREFER_PTHREAD_FLAG ON)
-find_package(Threads REQUIRED)
-
-# Include directories
-include_directories(
-  ${pipe_network_SOURCE_DIR}/include/
-  ${pipe_network_SOURCE_DIR}/external/
-)
+find_package (Threads)
+
+# OpenMP
+find_package(OpenMP)
+if (OPENMP_FOUND)
+  if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
+    set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${OpenMP_C_FLAGS}")
+    set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
+  endif()
+endif()
 
-# pipe_network executable
-SET(pipe_network_src
-  src/main.cc
-  src/eigen_gmres.cc
-  src/matrix_assembler.cc
-  src/mesh.cc
-  src/pipe.cc
-        src/node.cc
-  src/io.cc
-)
-add_executable(pipe_network
-  ${pipe_network_src}
-)
-
-target_link_libraries(pipe_network Threads::Threads)
-
-# Unit test
-SET(test_src
-   src/eigen_gmres.cc
-   src/matrix_assembler.cc
-   src/mesh.cc
-   src/pipe.cc
-   src/io.cc
-   src/node.cc
-   tests/eigen_gmres_test.cc
-#   tests/matrix_assembler_test.cc
-   tests/matrix_assembler_test_full.cc
-   tests/mesh_test.cc
-   tests/node_test.cc
-   tests/pipe_test.cc
-   tests/io_test.cc
-   tests/todini_example_test.cc
-   tests/test.cc
-)
-add_executable(pipe_network_test
-  ${test_src}
-)
-
-target_link_libraries(pipe_network_test Threads::Threads)
-
-add_test(NAME pipe_network_test COMMAND $<TARGET_FILE:pipe_network_test>)
-enable_testing()
+# MKL
+find_package(MKL REQUIRED)
+
+# BLAS Math Libraries
+find_package(BLAS REQUIRED)
+
+# LAPACK
+find_package(LAPACK REQUIRED)
+
+
+add_library(lpipe_network SHARED ${pipe_network_src})
+# include directories
+target_include_directories(lpipe_network
+        PUBLIC
+        ${pipe_network_SOURCE_DIR}/include/
+        ${pipe_network_SOURCE_DIR}/external/
+        ${EIGEN3_INCLUDE_DIR}
+        ${MKL_INCLUDE_DIR}
+        ${BOOST_INCLUDE_DIRS}
+
+        )
+
+# link libs
+target_link_libraries(lpipe_network
+        PUBLIC
+        ${CMAKE_THREAD_LIBS_INIT}
+        ${BLAS_LIBRARIES}
+        ${LAPACK_LIBRARIES}
+        ${Boost_LIBRARIES}
+        ${MKL_LIBRARIES}
+        )
+
+add_executable(pipe_network ${pipe_network_SOURCE_DIR}/src/main.cc)
+target_link_libraries(pipe_network
+        PUBLIC
+        lpipe_network)
+
+# Testing
+if(PIPE_NETWORK_TEST_BUILD_TESTING)
+  # Unit test
+  SET(pipe_network_test_src
+          tests/node_test.cc
+          tests/link_test.cc
+          tests/mesh_test.cc
+          tests/matrix_assembler_test.cc
+          tests/solver_test.cc
+          tests/hydraulic_sim_test.cc
+          tests/input_test.cc
+          tests/curve_test.cc
+          tests/valve_graph_test.cc
+          )
+
+  add_executable(pipe_network_test tests/main_test.cc ${pipe_network_test_src})
+  target_link_libraries(pipe_network_test lpipe_network)
+  add_test(NAME pipe_network_test COMMAND $<TARGET_FILE:pipe_network_test>)
+  enable_testing()
+endif()
 
 # Coverage
 find_package(codecov)
-add_coverage(pipe_network)
-add_coverage(pipe_network_test)
+if(ENABLE_COVERAGE)
+  add_executable(pipe_network_test_coverage tests/main_test.cc ${pipe_network_src} ${pipe_network_test_src})
+  target_link_libraries(pipe_network_test_coverage lpipe_network)
+  add_coverage(pipe_network_test_coverage)
+endif()

README.md

@@ -18,8 +18,8 @@
 ### Prerequisite packages
 > The following prerequisite packages can be found in the docker image:
 
-* [Boost](http://www.boost.org/)
 * [Eigen](http://eigen.tuxfamily.org/)
+* [Intel MKL](https://software.intel.com/content/www/us/en/develop/tools/math-kernel-library.html)
 
 ## Compile and Run
 > See https://pipe-network-doc.cb-cities.com/ for more detailed instructions. 
@@ -31,3 +31,21 @@
 ### Run tests
 
 0. Run `./pipe-network-test -s` (for a verbose output) or `ctest -VV`.
+
+### Run hydraulic simulation 
+Run ./pipe-network with the following flags 
+
+-f <filename>,  --file <filename>
+     .inp file path for the WDN system
+
+-t <save path>,  --to <save path>
+     folder to save the simulation results
+
+-d,  --debug
+     debug mode: output intermediate results (residuals)
+
+-n <meshname>,  --name <meshname>
+     Name for the WDN
+
+-h,  --help
+     Displays usage information and exits.