Merge pull request #265 from ludwig-cf/develop

Release 0.20.0

.github/workflows/codecov.yml

@@ -0,0 +1,21 @@
+name: Codecov
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build and run the unit tests
+        run: |
+          cp config/coverage-gcc.mk config.mk
+          make serial
+          make
+          make unit
+          cd src
+          gcov -abcfu *.c
+      - name: Upload results
+        run: |
+          curl -Os https://uploader.codecov.io/latest/linux/codecov
+          chmod +x codecov
+          ./codecov -t ${CODECOV_TOKEN}

.github/workflows/regression.yml

@@ -0,0 +1,91 @@
+# Regression tests (serial)
+
+name: "Regression"
+
+on:
+  pull_request:
+    branches:
+    - master
+    - develop
+
+jobs:
+
+  d2q9:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Build
+      run: |
+        gcc --version
+        cp config/github-gcc.mk config.mk
+        sed -i "s/D3Q19/D2Q9/" config.mk
+        make serial
+        make -j 2
+
+    - name: Check
+      run: |
+        make unit
+        make -C tests d2q9
+
+  d3q15:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Build
+      run: |
+        gcc --version
+        cp config/github-gcc.mk config.mk
+        sed -i "s/D3Q19/D3Q15/" config.mk
+        make serial
+        make -j 2
+
+    - name: Check
+      run: |
+        make unit
+        make -C tests d3q15
+
+  make-d3q19-short:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Build
+      run: |
+        gcc --version
+        cp config/github-gcc.mk config.mk
+        make serial
+        make -j 2
+
+    # Some care may be required with threads
+    - name: Check
+      run: |
+        export OMP_NUM_THREADS=1
+        make test
+
+  d3q27:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Build
+      run: |
+        gcc --version
+        cp config/github-gcc.mk config.mk
+        sed -i "s/D3Q19/D3Q27/" config.mk
+        make serial
+        make -j 2
+
+    # No specific tests yet
+    - name: Check
+      run: |
+        make unit

.travis.yml

@@ -5,12 +5,7 @@ cache:
 before_install:
   - bash ./config/build-mpi.sh
 script:
-  - cp config/travis-gcc.mk ./config.mk
-  - make serial
-  - make
   - export OMP_NUM_THREADS=1
-  - make test
-  - make clean
   - export PATH=$(pwd)/mpi/bin:${PATH}
   - cp config/travis-mpicc.mk ./config.mk
   - make

CHANGES.md

@@ -1,6 +1,20 @@
 
 ### Changes
 
+version 0.20.0
+
+- IMPORTANT: The input file can no longer be specified as a command
+  line argument. It must be called "input" in the current directory.
+- The electrokinetics sector has been updated and information is
+  available at
+  https://ludwig.epcc.ed.ac.uk/tutorials/electrokinetics/electrokinetics.html
+- A D3Q27 model is available
+- Added coverage via https://about.codecov.io/
+- The free energy is now reported at t = 0 for the initial state.
+- An extra "first touch" option has been added. For details, see
+  https://ludwig.epcc.ed.ac.uk/inputs/parallel.html
+- Various minor changes and code quality improvements.
+
 version 0.19.1
 - Fix bug in io_subfile to prevent failure at iogrid > 1.
 

README.md

@@ -44,10 +44,11 @@ $ make test
 ```
 
 
-Full details of the build process are available at
+Full details of the build process, and tutorials on how to
+use the code are available at
 <a href = "https://ludwg.epcc.ed.ac.uk/">https://ludwig.epcc.ed.ac.uk/</a>.
 
-#### Background and Tutorial
+#### Background
 
 Background documentation on the LB model and various free energy choices
 is available in the `docs` directory.
@@ -57,14 +58,6 @@ $ make
 ```
 will produce a pdf version of the LaTeX source.
 
-A short tutorial, which includes some examples in which the
-results are visualised, is also provided:
-```
-$ cd docs/tutorial
-$ make
-```
-to produce a pdf of the tutorial instructions.
-
 #### Contributing
 
 If you would like to contribute, please consider a pull request.

config/coverage-gcc.mk

@@ -0,0 +1,26 @@
+##############################################################################
+#
+#  coverage-gcc.mk
+#
+#  One for coverage
+#
+##############################################################################
+
+BUILD   = serial
+MODEL   = -D_D3Q27_
+
+GCOV    = -ftest-coverage -fprofile-arcs
+
+CC      = gcc
+CFLAGS  = -fopenmp $(GCOV) -O2 -g -Wall
+
+AR      = ar
+ARFLAGS = -cru
+LDFLAGS = -fopenmp $(GCOV)
+
+MPI_INC_PATH      = ./mpi_s
+MPI_LIB_PATH      = ./mpi_s
+MPI_LIB           = -lmpi
+
+LAUNCH_SERIAL_CMD =
+LAUNCH_MPIRUN_CMD =

config/github-gcc.mk

@@ -0,0 +1,22 @@
+##############################################################################
+#
+#  github-gcc.mk
+#
+##############################################################################
+
+BUILD   = serial
+MODEL   = -D_D3Q19_
+
+CC      = gcc -fopenmp
+CFLAGS  = -g -Wall -O2
+
+AR      = ar
+ARFLAGS = -cru
+LDFLAGS =
+
+MPI_INC_PATH      = ./mpi_s
+MPI_LIB_PATH      = ./mpi_s
+MPI_LIB           = -lmpi
+
+LAUNCH_SERIAL_CMD =
+LAUNCH_MPIRUN_CMD =