Added continuous integration to CN-Stream

.dockerignore

@@ -0,0 +1 @@
+**

.gitignore

@@ -16,3 +16,6 @@ example/fortran/Computation/libCNStream.so
 src/libFyMc/example/testDict/*.o
 # ignore output files
 MATLAB/waverf.cof
+# ide
+.vscode
+build*

.travis.yml

@@ -0,0 +1,140 @@
+language: cpp
+sudo: false
+dist: trusty
+
+matrix:
+  include:
+    - os: linux
+      compiler: gcc
+      addons: &gcc5
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-5
+            - gcc-5
+            - gfortran-5
+      env:
+        - CXX_COMPILER='g++-5'
+        - C_COMPILER='gcc-5'
+        - Fortran_COMPILER='gfortran-5'
+        - BUILD_TYPE='Release'
+        - CMAKE_GENERATOR='Unix Makefiles'
+    - os: linux
+      compiler: gcc
+      addons: &gcc6
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-6
+            - gcc-6
+            - gfortran-6
+      env:
+        - CXX_COMPILER='g++-6'
+        - C_COMPILER='gcc-6'
+        - Fortran_COMPILER='gfortran-6'
+        - BUILD_TYPE='Release'
+        - CMAKE_GENERATOR='Unix Makefiles'
+    - os: linux
+      compiler: gcc
+      addons: &gcc7
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+            - gcc-7
+            - gfortran-7
+      env:
+        - CXX_COMPILER='g++-7'
+        - C_COMPILER='gcc-7'
+        - Fortran_COMPILER='gfortran-7'
+        - BUILD_TYPE='Release'
+        - CMAKE_GENERATOR='Unix Makefiles'
+    - os: linux
+      compiler: gcc
+      addons: &gcc7
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+            - gcc-7
+            - gfortran-7
+      env:
+        - CXX_COMPILER='g++-7'
+        - C_COMPILER='gcc-7'
+        - Fortran_COMPILER='gfortran-7'
+        - BUILD_TYPE='Coverage'
+        - CMAKE_GENERATOR='Unix Makefiles'
+    - os: osx
+      compiler: gcc
+      env:
+        - CXX_COMPILER='g++-7'
+        - C_COMPILER='gcc-7'
+        - Fortran_COMPILER='gfortran-7'
+        - BUILD_TYPE='Release'
+        - CMAKE_GENERATOR='Unix Makefiles'
+#    - os: windows
+#      compiler: mingw
+#      env:
+#        - CXX_COMPILER='g++'
+#        - C_COMPILER='gcc'
+#        - Fortran_COMPILER='gfortran'
+#        - BUILD_TYPE='Release'
+#        - CMAKE_GENERATOR='MinGW Makefiles'
+
+before_install:
+  - test -n $CC && unset CC
+  - test -n $CXX && unset CXX
+  - test -n $FC && unset FC
+
+install:
+  - |
+    if [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then sudo softwareupdate -l > soft.txt; fi
+    if [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then cat soft.txt; fi
+    if [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then cat soft.txt | grep "Command Line Tools" | cut -f2 -d"*" | while read -r line ; do sudo softwareupdate -i "$line"; done ; fi
+    if [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then
+      brew update &> /dev/null
+      brew cask uninstall --force oclint
+      brew upgrade cmake
+      brew install gcc@7
+      brew info gcc
+    elif [[ "${TRAVIS_OS_NAME}" == "linux" ]]; then
+      echo "linux"
+    elif [[ "${TRAVIS_OS_NAME}" == "windows" ]]; then
+      echo "windows"
+      echo $PATH
+    fi
+
+before_script:
+  - mkdir cnstream-build && cd cnstream-build
+  # Configure
+  - >
+     cmake $TRAVIS_BUILD_DIR
+     -G"${CMAKE_GENERATOR}"
+     -DCMAKE_CXX_COMPILER=${CXX_COMPILER}
+     -DCMAKE_C_COMPILER=${C_COMPILER}
+     -DCMAKE_Fortran_COMPILER=${Fortran_COMPILER}
+     -DCMAKE_BUILD_TYPE=${BUILD_TYPE}
+     -DCMAKE_INSTALL_PREFIX=~/cnstream
+  # Build
+  - make
+
+script:
+  # Test the program
+  - make test ARGS="-V"
+  # Create package
+  - make package
+  # Make sure we can install with no issues.
+  - make install
+  # Create coverage report
+  - if [[ "$BUILD_TYPE" == "Coverage" ]];
+    then
+    echo "Coverage";
+    find $TRAVIS_BUILD_DIR -type f -name "*.gcno";
+    find $TRAVIS_BUILD_DIR -type f -name "*.gcna";
+    make coverage;
+    bash <(curl -s https://codecov.io/bash) -X gcov;
+    fi

CMakeLists.txt

@@ -1,39 +1,42 @@
 ###-------------------------------------------------------------------------###
 
-cmake_minimum_required(VERSION 2.7)  #... Specify the minimum version for CMake
+cmake_minimum_required(VERSION 2.8.8)  #... Specify the minimum version for CMake
 
 ###-------------------------------------------------------------------------###
 
 if(NOT WIN32)
-  string(ASCII 27 Esc)
-  set(ColourReset "${Esc}[m")
-  set(ColourBold  "${Esc}[1m")
-  set(Red         "${Esc}[31m")
-  set(Green       "${Esc}[32m")
-  set(Yellow      "${Esc}[33m")
-  set(Blue        "${Esc}[34m")
-  set(Magenta     "${Esc}[35m")
-  set(Cyan        "${Esc}[36m")
-  set(White       "${Esc}[37m")
-  set(BoldRed     "${Esc}[1;31m")
-  set(BoldGreen   "${Esc}[1;32m")
-  set(BoldYellow  "${Esc}[1;33m")
-  set(BoldBlue    "${Esc}[1;34m")
-  set(BoldMagenta "${Esc}[1;35m")
-  set(BoldCyan    "${Esc}[1;36m")
-  set(BoldWhite   "${Esc}[1;37m")
+    string(ASCII 27 Esc)
+    set(ColourReset "${Esc}[m")
+    set(ColourBold  "${Esc}[1m")
+    set(Red         "${Esc}[31m")
+    set(Green       "${Esc}[32m")
+    set(Yellow      "${Esc}[33m")
+    set(Blue        "${Esc}[34m")
+    set(Magenta     "${Esc}[35m")
+    set(Cyan        "${Esc}[36m")
+    set(White       "${Esc}[37m")
+    set(BoldRed     "${Esc}[1;31m")
+    set(BoldGreen   "${Esc}[1;32m")
+    set(BoldYellow  "${Esc}[1;33m")
+    set(BoldBlue    "${Esc}[1;34m")
+    set(BoldMagenta "${Esc}[1;35m")
+    set(BoldCyan    "${Esc}[1;36m")
+    set(BoldWhite   "${Esc}[1;37m")
 endif()
 
 ###-------------------------------------------------------------------------###
 
-set(COMPILE_LANGUAGE Fortran)                       #
-set(CMAKE_Fortran_COMPILER gfortran)       #... Fortran Compiler Path
-#set(CMAKE_Fortran_COMPILER ifort)       #... Fortran Compiler Path
+SET(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
+set(COMPILE_LANGUAGE Fortran CXX)
+if(NOT DEFINED CMAKE_Fortran_COMPILER)
+    set(CMAKE_Fortran_COMPILER gfortran)       #... Fortran Compiler Path
+    # set(CMAKE_Fortran_COMPILER ifort)        #... Fortran Compiler Path
+endif()
 
 ###-------------------------------------------------------------------------###
 
 set(PROJECT_NAME CNStream)                         #... Project Name
-set(PROJECT_COMPILE_PATH ${CMAKE_HOME_DIRECTORY})   #... COMPILE_PATH (RF Directory where CMakeLists.txt exists)
+set(PROJECT_COMPILE_PATH ${CMAKE_HOME_DIRECTORY})  #... COMPILE_PATH (RF Directory where CMakeLists.txt exists)
 
 project(${PROJECT_NAME} ${COMPILE_LANGUAGE})        # PROJECT NAME
 
@@ -48,28 +51,34 @@ set(CMAKE_Fortran_MODULE_DIRECTORY ${PROJECT_COMPILE_PATH}/lib)
 
 set(CNSTREAM_LIB_OUT ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
 
-if ("${CMAKE_Fortran_COMPILER_ID}" MATCHES "Intel")
-  set(CMAKE_Fortran_FLAGS "-fPIC -O3 -xHOST -ipo -ip -O0 -traceback -check all -CB -check uninit -g")
-  #set(CMAKE_Fortran_FLAGS "-O3 -xHOST -ipo -ip -O0 -traceback -check all -warn all")
-elseif("${CMAKE_Fortran_COMPILER_ID}" MATCHES "GNU")
-  set(CMAKE_Fortran_FLAGS "-fPIC -O3 -march=corei7 -msse2 -funroll-loops -fno-protect-parens -ffast-math -fcheck=bounds")
+message(STATUS "CMAKE_Fortran_FLAGS ${CMAKE_Fortran_FLAGS}")
+message(STATUS "CMAKE_Fortran_COMPILER_ID ${CMAKE_Fortran_COMPILER_ID}")
+
+if (DEFINED USER_DEFINED_COMPILATION_OPTION)
+    set(CMAKE_Fortran_FLAGS ${USER_DEFINED_COMPILATION_OPTION})
+else()
+    if ("${CMAKE_Fortran_COMPILER_ID}" MATCHES "Intel")
+        set(CMAKE_Fortran_FLAGS "-fPIC -O3 -xHOST -ipo -ip -O0 -traceback -check all -CB -check uninit -g")
+        #set(CMAKE_Fortran_FLAGS "-O3 -xHOST -ipo -ip -O0 -traceback -check all -warn all")
+    elseif("${CMAKE_Fortran_COMPILER_ID}" MATCHES "GNU")
+        set(CMAKE_Fortran_FLAGS "-fPIC -O3 -march=native -funroll-loops -fno-protect-parens -fcheck=bounds -ffast-math")
+    endif()
 endif()
 
 # In case you need to compile shared library in openFoam. Uncomment the belows.
 #   cmake -H. -Bbuild -DBUILD_OF_LIB=ON
 
- if (BUILD_OF_LIB)
-
-     if (NOT "$ENV{FOAM_USER_LIBBIN}" STREQUAL "")
-         set(CNSTREAM_LIB_OUT $ENV{FOAM_USER_LIBBIN})
-     else()
-         message("${BoldRed} ")
-         message("   [ERROR] Not in OpenFOAM Environment... ")
-         message("${ColourReset} ${Green}")
-         message("   Wrong $FOAM_USER_LIBBIN path")
-         message("")
-         message("       $FOAM_USER_LIBBIN : " $ENV{FOAM_USER_LIBBIN})
-         message("${ColourReset} ")
+if (BUILD_OF_LIB)
+    if (NOT "$ENV{FOAM_USER_LIBBIN}" STREQUAL "")
+        set(CNSTREAM_LIB_OUT $ENV{FOAM_USER_LIBBIN})
+    else()
+        message("${BoldRed} ")
+        message("   [ERROR] Not in OpenFOAM Environment... ")
+        message("${ColourReset} ${Green}")
+        message("   Wrong $FOAM_USER_LIBBIN path")
+        message("")
+        message("       $FOAM_USER_LIBBIN : " $ENV{FOAM_USER_LIBBIN})
+        message("${ColourReset} ")
         message( FATAL_ERROR )
     endif()
 endif()
@@ -84,5 +93,22 @@ message("${ColourReset}")
 #... -fPIC is needed to generate shared library
 #set(CMAKE_Fortran_FLAGS "-O3 -march=corei7 -msse2 -funroll-loops -fno-protect-parens -ffast-math -fPIC")
 
+IF((NOT DEFINED CMAKE_BUILD_TYPE) OR (CMAKE_BUILD_TYPE STREQUAL ""))
+    MESSAGE(STATUS "Setting CMAKE_BUILD_TYPE to Release")
+    SET(CMAKE_BUILD_TYPE Release)
+ENDIF()
+
+MESSAGE(STATUS "CMAKE_BUILD_TYPE = ${CMAKE_BUILD_TYPE}")
+STRING(TOUPPER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_UPPER)
+MESSAGE(STATUS "CMAKE_BUILD_TYPE_UPPER = ${CMAKE_BUILD_TYPE_UPPER}")
+
+IF(CMAKE_BUILD_TYPE_UPPER STREQUAL "COVERAGE")
+    MESSAGE(STATUS "Adding coverage")
+    FIND_PACKAGE(codecov)
+ENDIF()
+
+ENABLE_TESTING()
 add_subdirectory(src/libFyMc)
 add_subdirectory(src/libCNStream)
+add_subdirectory(example)
+INCLUDE(CMakePack)

Dockerfile

@@ -0,0 +1,11 @@
+FROM gcc:8.2.0
+RUN apt-get update -yq && \
+    apt-get install \
+        --yes \
+        --no-install-recommends \
+        cmake && \
+    apt-get autoclean && \
+    apt-get autoremove && \
+    apt-get clean && \
+    rm -rf /tmp/* /var/tmp/* && \
+    rm -rf /var/lib/apt/lists

Makefile

@@ -0,0 +1,63 @@
+# This Makefile allows to compile CN-stream with docker.
+# A single 'make' command will
+#
+#  - build the required docker image
+#  - configure project with CMake
+#  - compile project
+#  - run test
+#  - create an installation package
+
+all: docker
+
+docker_image: Dockerfile
+	@echo "Build docker image cnstream_build"
+	docker build . -t cnstream_build
+
+docker: docker_image
+	@echo "Compile, test and package CN-stream with docker image cnstream_build"
+	docker run --rm -u $(shell id -u ):$(shell id -g ) \
+	    -v $(shell pwd):/opt/share \
+	    -w /opt/share \
+	    cnstream_build /bin/bash -c \
+           "cd /opt/share && \
+            mkdir -p build_docker && \
+            cd build_docker && \
+            cmake .. && \
+            make && \
+            make test ARGS=\"-V\" && \
+            make package"
+
+docker_make: docker_image
+	@echo "Compile CN-stream with docker image cnstream_build"
+	docker run --rm -u $(shell id -u ):$(shell id -g ) \
+	    -v $(shell pwd):/opt/share \
+	    -w /opt/share \
+	    cnstream_build /bin/bash -c \
+           "cd /opt/share && \
+            mkdir -p build_docker && \
+            cd build_docker && \
+            cmake .. && \
+            make"
+
+docker_animate: docker_image
+	@echo "Create an animation"
+	docker run --rm -u $(shell id -u ):$(shell id -g ) \
+        -v $(shell pwd):/opt/share \
+        -w /opt/share \
+        cnstream_build /bin/bash -c \
+           "cd /opt/share && \
+            for timestep in 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0 1.1 1.2 1.3 1.4 1.5; \
+            do \
+            echo \$${timestep}; \
+            cp input/CN_Stream_input.dict input/CN_Stream_input.dict.ORI; \
+            sed -i \"s/time 2.5/time \$${timestep}/g\" /opt/share/input/CN_Stream_input.dict; \
+            cat /opt/share/input/CN_Stream_input.dict; \
+            ./mainCNS; \
+            mv input/CN_Stream_input.dict.ORI input/CN_Stream_input.dict; \
+            mv output/VP_card_fitted.dat output/VP_card_fitted_\$${timestep}.dat; \
+            done"
+
+clean:
+	rm -rf build build_docker lib main mainCNS prog
+
+.PHONY: docker docker_image clean