Add more watchpoint plots and source files (#507)

Author: MakisH

perpendicular-flap/README.md

@@ -23,10 +23,10 @@ Fluid participant:
 
 * OpenFOAM (pimpleFoam). In case you are using a very old OpenFOAM version, you will need to adjust the solver to `pimpleDyMFoam` in the `Fluid/system/controlDict` file. For more information, have a look at the [OpenFOAM adapter documentation](https://www.precice.org/adapter-openfoam-overview.html).
 
-* Nutils. For more information, have a look at the [Nutils adapter documentation](https://www.precice.org/adapter-nutils.html). This Nutils solver requires at least Nutils v6.0.
-
 * SU2. As opposed to the other two fluid codes, SU2 is in particular specialized for compressible flow. Therefore the default simulation parameters haven been adjusted in order to pull the setup into the compressible flow regime. For more information, have a look at the [SU2 adapter documentation](https://www.precice.org/adapter-su2-overview.html).
 
+* Nutils. For more information, have a look at the [Nutils adapter documentation](https://www.precice.org/adapter-nutils.html). This Nutils solver requires at least Nutils v6.0. This case currently takes orders of magnitude longer than the OpenFOAM and SU2 cases, see [related issue](https://github.com/precice/tutorials/issues/506).
+
 * Fake. A simple python script that acts as a fake solver and provides an arbitrary force, linearly-increasing per length of the flap. This solver can be used for debugging of the solid participant and its adapter. It also technically works with implicit coupling, thus no changes to the preCICE configuration are necessary. Note that [ASTE's replay mode](https://precice.org/tooling-aste.html#replay-mode) has a similar use case and could also feed artificial or previously recorded real data, replacing an actual solver.
 
 Solid participant:
@@ -41,10 +41,10 @@ Solid participant:
 
 * Nutils. The structural model is currently limited to linear elasticity. For more information, have a look at the [Nutils adapter documentation](https://www.precice.org/adapter-nutils.html). This Nutils solver requires at least Nutils v8.0.
 
-* OpenFOAM (solidDisplacementFoam). For more information, have a look at the [OpenFOAM plateHole tutorial](https://www.openfoam.com/documentation/tutorial-guide/5-stress-analysis/5.1-stress-analysis-of-a-plate-with-a-hole). The solidDisplacementFoam solver only supports linear geometry. For general solid mechanics procedures in OpenFOAM, see solids4foam.
-
 * solids4foam. Like for CalculiX, the geometrically non-linear solver is used by default. For more information, see the [solids4foam documentation](https://solids4foam.github.io/documentation/overview.html) and a [related tutorial](https://solids4foam.github.io/tutorials/more-tutorials/flexibleOversetCylinder.html). This case works with solids4foam v2.0, which is compatible with up to OpenFOAM v2012 and OpenFOAM 9 (as well as foam-extend, with which the OpenFOAM-preCICE adapter is not compatible), as well as the OpenFOAM-preCICE adapter v1.2.0 or later.
 
+* OpenFOAM (solidDisplacementFoam). For more information, have a look at the [OpenFOAM plateHole tutorial](https://www.openfoam.com/documentation/tutorial-guide/5-stress-analysis/5.1-stress-analysis-of-a-plate-with-a-hole). The solidDisplacementFoam solver only supports linear geometry and this case is only provided for quick testing purposes, leading to outlier results. For general solid mechanics procedures in OpenFOAM, see solids4foam.
+
 ## Running the Simulation
 
 All listed solvers can be used in order to run the simulation. OpenFOAM can be executed in parallel using `run.sh -parallel`. The default setting uses 4 MPI ranks. Open two separate terminals and start the desired fluid and solid participant by calling the respective run script `run.sh` located in the participant directory. For example:
@@ -73,17 +73,41 @@ As we defined a watchpoint on the 'Solid' participant at the flap tip (see `prec
 
 ![Flap watchpoint](images/tutorials-perpendicular-flap-displacement-watchpoint.png)
 
-There is moreover a script `plot-all-displacements.sh` to plot and compare all possible variants. This script expects all watchpoint logs to be available in a subfolder `watchpoints` in the format `openfoam-dealii.log` or similar. If you want to use this script, you need to copy the files over accordingly.
+There is moreover a script `plot-all-displacements.sh` to plot and compare all possible variants. This script expects all watchpoint logs to be available in a subfolder `watchpoints` in the format `openfoam-dealii-version.log` or similar. If you want to use this script, you need to edit it to exclude combinations you want to exclude and copy the files over accordingly.
 
 You should get results similar to this one:
 
-![All flap watchpoints](images/tutorials-perpendicular-flap-displacement-all-watchpoints.png)
+![Selected flap watchpoints](images/tutorials-perpendicular-flap-displacement-selected-watchpoints.png)
 
 Reasons for the differences:
 
 * The CalculiX adapter only supports linear finite elements (deal.II uses 4th order, FEniCS 2nd order).
 * SU2 models a compressible fluid, OpenFOAM and Nutils an incompressible one.  
 
+### Looking closer
+
+Excluding the `solid-openfoam` (outlier, provided mainly for technical testing), let's look at an overview of different combinations.
+
+Comparison of the different flow solvers (incompressible `fluid-openfoam` and `fluid-nutils`, compressible `fluid-su2`, dummy `fluid-fake`):
+
+![Flap watchpoints using solid-calculix](images/tutorials-perpendicular-flap-displacement-flow-comparison-watchpoints.png)
+
+Combinations using the incompressible `fluid-openfoam` case:
+
+![Flap watchpoints using fluid-openfoam](images/tutorials-perpendicular-flap-displacement-openfoam-watchpoints.png)
+
+Combinations (excerpt) using the incompressible `fluid-nutils` case:
+
+![Flap watchpoints using fluid-nutils](images/tutorials-perpendicular-flap-displacement-nutils-watchpoints.png)
+
+Combinations (excerpt) using the compressible `fluid-su2` case:
+
+![Flap watchpoints using fluid-su2](images/tutorials-perpendicular-flap-displacement-su2-watchpoints.png)
+
+Combinations (excerpt) using the dummy `fluid-fake` case:
+
+![Flap watchpoints using fluid-fake](images/tutorials-perpendicular-flap-displacement-fake-watchpoints.png)
+
 {% disclaimer %}
 This offering is not approved or endorsed by OpenCFD Limited, producer and distributor of the OpenFOAM software via www.openfoam.com, and owner of the OPENFOAM®  and OpenCFD®  trade marks.
 {% enddisclaimer %}

perpendicular-flap/images/tutorials-perpendicular-flap-displacement-all-watchpoints.png

@@ -16,32 +16,94 @@
 #
 # If you are only interested in a subset of combinations, remove the respective lines.
 
+WATCHPOINTS_DIR="./reference-results/watchpoints/"
+
+gnuplot -p << EOF
+    set grid
+    set title 'x-displacement of the flap tip (selected combinations)'
+    set xlabel 'time [s]'
+    set ylabel 'x-displacement [m]'
+    set term pngcairo enhanced size 900,654
+    set output "images/tutorials-perpendicular-flap-displacement-selected-watchpoints.png"
+    plot "${WATCHPOINTS_DIR}/openfoam-calculix-v2404.log" using 1:4 with lines title "OpenFOAM-CalculiX", \
+         "${WATCHPOINTS_DIR}/openfoam-dealii-v2404.log" using 1:4 with lines title "OpenFOAM-deal.II", \
+         "${WATCHPOINTS_DIR}/openfoam-fenics-v2404.log" using 1:4 with lines title "OpenFOAM-FEniCS", \
+         "${WATCHPOINTS_DIR}/su2-calculix-v2404.log" using 1:4 with lines title "SU2-CalculiX", \
+         "${WATCHPOINTS_DIR}/su2-dealii-v2404.log" using 1:4 with lines title "SU2-deal.II", \
+         "${WATCHPOINTS_DIR}/su2-fenics-v2404.log" using 1:4 with lines title "SU2-FEniCS", \
+         "${WATCHPOINTS_DIR}/nutils-calculix-v2404.log" using 1:4 with lines title "Nutils-CalculiX", \
+         "${WATCHPOINTS_DIR}/nutils-dealii-v2404.log" using 1:4 with lines title "Nutils-deal.II"
+EOF
+
+gnuplot -p << EOF
+    set grid
+    set title 'x-displacement of the flap tip (comparison of flow solvers)'
+    set xlabel 'time [s]'
+    set ylabel 'x-displacement [m]'
+    set term pngcairo enhanced size 900,654
+    set output "images/tutorials-perpendicular-flap-displacement-flow-comparison-watchpoints.png"
+    plot "${WATCHPOINTS_DIR}/openfoam-calculix-v2404.log" using 1:4 with lines title "OpenFOAM-CalculiX", \
+         "${WATCHPOINTS_DIR}/su2-calculix-v2404.log" using 1:4 with lines title "SU2-CalculiX", \
+         "${WATCHPOINTS_DIR}/nutils-calculix-v2404.log" using 1:4 with lines title "Nutils-CalculiX", \
+         "${WATCHPOINTS_DIR}/fake-calculix-v2404.log" using 1:4 with lines title "fake-CalculiX"
+EOF
+
+gnuplot -p << EOF
+    set grid
+    set title 'x-displacement of the flap tip (incompressible flow with OpenFOAM)'
+    set xlabel 'time [s]'
+    set ylabel 'x-displacement [m]'
+    set term pngcairo enhanced size 900,654
+    set output "images/tutorials-perpendicular-flap-displacement-openfoam-watchpoints.png"
+    plot "${WATCHPOINTS_DIR}/openfoam-calculix-v2404.log" using 1:4 with lines title "OpenFOAM-CalculiX", \
+         "${WATCHPOINTS_DIR}/openfoam-dealii-v2404.log" using 1:4 with lines title "OpenFOAM-deal.II", \
+         "${WATCHPOINTS_DIR}/openfoam-dune-v2404.log" using 1:4 with lines title "OpenFOAM-DUNE", \
+         "${WATCHPOINTS_DIR}/openfoam-fenics-v2404.log" using 1:4 with lines title "OpenFOAM-FEniCS", \
+         "${WATCHPOINTS_DIR}/openfoam-nutils-v2404.log" using 1:4 with lines title "OpenFOAM-Nutils", \
+         "${WATCHPOINTS_DIR}/openfoam-solids4foam-v2404.log" using 1:4 with lines title "OpenFOAM-solids4Foam"
+EOF
+
+gnuplot -p << EOF
+    set grid
+    set title 'x-displacement of the flap tip (compressible flow with SU2)'
+    set xlabel 'time [s]'
+    set ylabel 'x-displacement [m]'
+    set term pngcairo enhanced size 900,654
+    set output "images/tutorials-perpendicular-flap-displacement-su2-watchpoints.png"
+    plot "${WATCHPOINTS_DIR}/su2-calculix-v2404.log" using 1:4 with lines title "SU2-CalculiX", \
+         "${WATCHPOINTS_DIR}/su2-dealii-v2404.log" using 1:4 with lines title "SU2-deal.II", \
+         "${WATCHPOINTS_DIR}/su2-dune-v2404.log" using 1:4 with lines title "SU2-DUNE", \
+         "${WATCHPOINTS_DIR}/su2-fenics-v2404.log" using 1:4 with lines title "SU2-FEniCS", \
+         "${WATCHPOINTS_DIR}/su2-nutils-v2404.log" using 1:4 with lines title "SU2-nutils", \
+         "${WATCHPOINTS_DIR}/su2-solids4foam-v2404.log" using 1:4 with lines title "SU2-solids4Foam"
+EOF
+
+gnuplot -p << EOF
+    set grid
+    set title 'x-displacement of the flap tip (incompressible flow with Nutils)'
+    set xlabel 'time [s]'
+    set ylabel 'x-displacement [m]'
+    set term pngcairo enhanced size 900,654
+    set output "images/tutorials-perpendicular-flap-displacement-nutils-watchpoints.png"
+    plot "${WATCHPOINTS_DIR}/nutils-calculix-v2404.log" using 1:4 with lines title "Nutils-CalculiX", \
+         "${WATCHPOINTS_DIR}/nutils-dealii-v2404.log" using 1:4 with lines title "Nutils-deal.II", \
+         "${WATCHPOINTS_DIR}/nutils-dune-v2404.log" using 1:4 with lines title "Nutils-DUNE", \
+         "${WATCHPOINTS_DIR}/nutils-fenics-v2404.log" using 1:4 with lines title "Nutils-FEniCS", \
+         "${WATCHPOINTS_DIR}/nutils-nutils-v2404.log" using 1:4 with lines title "Nutils-Nutils", \
+         "${WATCHPOINTS_DIR}/nutils-solids4foam-v2404.log" using 1:4 with lines title "Nutils-solids4Foam"
+EOF
+
 gnuplot -p << EOF
     set grid
-    set title 'x-displacement of the flap tip'
+    set title 'x-displacement of the flap tip (dummy force data with fluid-fake)'
     set xlabel 'time [s]'
     set ylabel 'x-displacement [m]'
     set term pngcairo enhanced size 900,654
-    set output "images/tutorials-perpendicular-flap-displacement-all-watchpoints.png"
-    plot "watchpoints/openfoam-calculix.log" using 1:4 with lines title "OpenFOAM-CalculiX", \
-         "watchpoints/openfoam-dealii.log" using 1:4 with lines title "OpenFOAM-deal.II", \
-         "watchpoints/openfoam-fenics.log" using 1:4 with lines title "OpenFOAM-FEniCS", \
-         "watchpoints/openfoam-dune.log" using 1:4 with lines title "OpenFOAM-DUNE", \
-         "watchpoints/openfoam-openfoam.log" using 1:4 with lines title "OpenFOAM-OpenFOAM", \
-         "watchpoints/openfoam-solids4foam.log" using 1:4 with lines title "OpenFOAM-solids4Foam", \
-         "watchpoints/openfoam-nutils.log" using 1:4 with lines title "OpenFOAM-Nutils", \
-         "watchpoints/su2-calculix.log" using 1:4 with lines title "SU2-CalculiX", \
-         "watchpoints/su2-dealii.log" using 1:4 with lines title "SU2-deal.II", \
-         "watchpoints/su2-fenics.log" using 1:4 with lines title "SU2-FEniCS", \
-         "watchpoints/su2-dune.log" using 1:4 with lines title "SU2-DUNE", \
-         "watchpoints/su2-openfoam.log" using 1:4 with lines title "SU2-OpenFOAM", \
-         "watchpoints/su2-solids4foam.log" using 1:4 with lines title "SU2-solids4Foam", \
-         "watchpoints/su2-nutils.log" using 1:4 with lines title "SU2-nutils", \
-         "watchpoints/nutils-calculix.log" using 1:4 with lines title "Nutils-CalculiX", \
-         "watchpoints/nutils-dealii.log" using 1:4 with lines title "Nutils-deal.II", \
-         "watchpoints/nutils-fenics.log" using 1:4 with lines title "Nutils-FEniCS", \
-         "watchpoints/nutils-dune.log" using 1:4 with lines title "Nutils-DUNE", \
-         "watchpoints/nutils-openfoam.log" using 1:4 with lines title "Nutils-OpenFOAM", \
-         "watchpoints/nutils-solids4foam.log" using 1:4 with lines title "Nutils-solids4Foam", \
-         "watchpoints/nutils-nutils.log" using 1:4 with lines title "Nutils-Nutils"
+    set output "images/tutorials-perpendicular-flap-displacement-fake-watchpoints.png"
+    plot "${WATCHPOINTS_DIR}/fake-calculix-v2404.log" using 1:4 with lines title "fake-CalculiX", \
+         "${WATCHPOINTS_DIR}/fake-dealii-v2404.log" using 1:4 with lines title "fake-deal.II", \
+         "${WATCHPOINTS_DIR}/fake-dune-v2404.log" using 1:4 with lines title "fake-DUNE", \
+         "${WATCHPOINTS_DIR}/fake-fenics-v2404.log" using 1:4 with lines title "fake-FEniCS", \
+         "${WATCHPOINTS_DIR}/fake-nutils-v2404.log" using 1:4 with lines title "fake-Nutils", \
+         "${WATCHPOINTS_DIR}/fake-solids4foam-v2404.log" using 1:4 with lines title "fake-solids4Foam"
 EOF

perpendicular-flap/images/tutorials-perpendicular-flap-displacement-fake-watchpoints.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f117eb1c0c1dcaa921442550533db8dc5077c45eb6632ede2b341470814d193c
+size 337608