Compilation is independent of ISCD Commons

.github/workflows/Build.yml

@@ -0,0 +1,36 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+jobs:
+  Matrix:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-18.04, ubuntu-20.04, macos-10.15, macos-11]
+        compiler: [gcc-8, clang-7]
+        build_type: ['Release', 'Debug']
+      fail-fast: false
+    env:
+      MAKEFLAGS: "-j2"
+    steps:
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Configure CMake
+        run: >
+          cmake
+          -B ${{github.workspace}}/build
+          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build
+
+
+

.gitignore

@@ -1,5 +1,153 @@
-CMakeFiles/*
+# ---> macOS
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# ---> Linux
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# ---> C
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# ---> C++
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# ---> CMake
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
 Makefile
 cmake_install.cmake
-CMakeCache.txt
-build/*
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
+build
+
+# ----> ccls
+.ccls-cache
+
+docs
+
+*.vim
+

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "third-party/ISCD/Commons"]
+	path = third-party/ISCD/Commons
+	url = https://github.com/ISCDtoolbox/Commons

CMakeLists.txt

@@ -1,28 +1,40 @@
-cmake_minimum_required(VERSION 2.8)
-set(CMAKE_BUILD_TYPE  "Release")
-INCLUDE_DIRECTORIES(  "$ENV{HOME}/include")
-LINK_DIRECTORIES(     "$ENV{HOME}/lib")
-SET(CMAKE_CXX_FLAGS   "-w -g -O3")
-set(CMAKE_MACOSX_RPATH 1)
-set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
+cmake_minimum_required(VERSION 3.12)
 
-#Advection library
-project(Advection)
-file(                  GLOB_RECURSE source_files sources/*)
-file(                  GLOB_RECURSE header_files sources/*.h)
-ADD_LIBRARY(           Advection SHARED ${source_files})
-find_library(          Commons NAMES Commons HINTS "$ENV{HOME}/lib")
-target_link_libraries( Advection ${Commons})
-INSTALL(               TARGETS Advection LIBRARY  DESTINATION "$ENV{HOME}/lib")
-INSTALL(               FILES ${header_files} DESTINATION "$ENV{HOME}/include")
+project(Advection C)
 
-#Executable
-project(main)
-add_executable(        advect sources/advect.c)
-target_link_libraries( advect Commons Advection)
-INSTALL(               TARGETS advect RUNTIME DESTINATION "$ENV{HOME}/bin")
+# ---- Configure compiler ----------------------------------------------------
+add_compile_options(
+  -g
+  -O0
+  -Wall
+  -Wextra
+  -Wpedantic
+  -Wno-newline-eof
+  -Wno-missing-braces
+  -Wno-char-subscripts
+  -Wno-unused-variable
+  -Wno-unused-function
+  -Wno-unused-parameter
+  -Wno-sign-compare
+  -Wno-incompatible-function-pointer-types)
 
-
+# ---- ISCD::Commons ---------------------------------------------------------
+add_subdirectory(
+  ${PROJECT_SOURCE_DIR}/third-party/ISCD/Commons
+  ${PROJECT_BINARY_DIR}/third-party/ISCD/Commons)
+target_include_directories(Commons
+  INTERFACE
+  ${PROJECT_SOURCE_DIR}/third-party/ISCD/Commons/sources)
+add_library(ISCD::Commons ALIAS Commons)
 
+# ---- Executable ------------------------------------------------------------
+file(GLOB_RECURSE Advection_SRCS sources/*.c)
+file(GLOB_RECURSE Advection_HEADERS sources/*.h)
 
+add_executable(Advection ${Advection_SRCS} ${Advection_HEADERS})
 
+target_link_libraries(Advection
+  PRIVATE
+  m
+  pthread
+  ISCD::Commons)

README.md

@@ -1,88 +1,26 @@
-# advect [![Build Status](https://travis-ci.org/ISCDtoolbox/Advection.svg?branch=master)](https://travis-ci.org/ISCDtoolbox/Advection)
-Advect is a program for solving linear advection problems in two and three dimensions.
+# Advection
 
-#### Installation
+| Branch      |  Matrix  |
+|:-----------:|:--------:|
+| master      | [![Build](https://github.com/cbritopacheco/Advection/actions/workflows/Build.yml/badge.svg?branch=master)](https://github.com/cbritopacheco/Advection/actions/workflows/Build.yml) |
+| develop     | [![Build](https://github.com/cbritopacheco/Advection/actions/workflows/Build.yml/badge.svg?branch=develop)](https://github.com/cbritopacheco/Advection/actions/workflows/Build.yml) |
 
-1. install the [ISCD Commons Library](https://github.com/ISCDtoolbox/Commons) on your system. 
-Please refer to the instructions provided on the ISCD Commons Library page in order to install this library.
+## About
+Advection is a program for solving linear advection problems in two and three dimensions.
 
-2. download the zip archive of Advection or clone this repository:
+This repo is a fork of the [original
+Advection](https://github.com/ISCDtoolbox/Advection) to be used as a dependency in
+[Rodin](https://github.com/cbritopacheco/rodin).
 
-   ` git clone https://github.com/ISCDtoolbox/Advection.git `
+## Building
 
-   navigate to the downloaded directory: 
-
-   ` cd Advection `
-
-   create a build directory and compile with cmake
-   ```
-   mkdir build
-   cd build
-   cmake ..
-   make
-   make install
-   ```
-
-#### Usage
-After compiling advect as described above, you should have an executable file in your $HOME/bin directory. If your PATH variable is correctly set to this directory, advect can be called with the following syntax:
-
-    usage: advect [+/-v | -h] [-dt step] source[.mesh] [-c function[.sol]] [-s data[.sol]] [-o output[.sol]]
-
-The square braces indicate optional arguments. Some commands have flags, some others do not.
-
-The options and flags are:
+```bash
+git clone --recursive https://github.com/cbritopacheco/Advection
+cd Advection
+mkdir build && cd build
+cmake ..
+make -j4
 ```
-  --help       show the syntax and exit.
-  --version    show the version and date of release and exit.
-
-  -dt step     time step (time units)
-  -nocfl       avoid truncation of the time period for advection due to cfl condition.
-  -noex        deactivates the default feature whereby characteristic lines are extrapolated outside the domain when the input velocity field causes them to do so.  
-  -v           suppress any message (for use with function call).
-  +v           increase the verbosity level for output.
-
-  source.mesh    name of the mesh file
-  function.sol   name of file containing the (scalar) values to be advected
-  data.sol       name of file containing the velocity field
-  output.sol     name of the output file containing the function values
-```
-
-A full description of all parameters and options that can be specified in the command line or in a parameter file [file.advect] can be found in the project [wiki](https://github.com/ISCDtoolbox/Advection/wiki) (Coming soon...).
-
-#### Quickstart (Coming soon...)
-You can test the installation and look at examples by entering the [demos](demos) directory and running the program:
-
-    cd demos
-    advect test.mesh -dt 0.01 -s test.sol -c test.chi.sol -o test.chi.sol
-
-that will produce an output that will look like:
-```
-user:~/code/Advection/demos/2d$ advect test.mesh -dt 0.01 -s test.sol -c test.chi.sol -o test.chi.sol
- - ADVECT, Release 3.0a, Feb. 19, 2016
-   (C) Copyright 2007- , ICS-SU
-
- - LOADING DATA
-    test.mesh: 2225 vertices, 4222 triangles
-    test.sol : 2225 data vectors
-    test.chi.sol : 2225 data scalar
-    Adjacency table:  12666 updated
- - COMPLETED: 0.013s
-
- ** MODULE ADVECT: 3.0a
-    Time stepping: 0.001
-    Solving: 2225 characteristics
- ** COMPLETED: 0.009s
-
- - WRITING DATA
-    test.chi.sol: 2225 data vectors
- - COMPLETED: 0.010s
-
- ** Cumulative time: 0.032s.
-```
-
-#### Authors & contributors
-* advect has been initiated by Thi Thu Cuc Bui, Charles Dapogny and Pascal Frey (Université Pierre et Marie Curie).
-* Contributors to this project are warmly welcomed. 
 
-#### License
-advect is given under the [terms of the GNU Lesser General Public License] (LICENSE.md).
+## License
+Advection is given under the [terms of the GNU Lesser General Public License](LICENSE.md).