Add changelog for v202404.0 (#523)

.github/pull_request_template.md

@@ -1,3 +1,8 @@
 <!-- Please submit your Pull Request to the `develop` branch.
 
 It may help to have a look at the file `CONTRIBUTING.md` for a few hints and guidelines. -->
+
+Checklist:
+
+- [ ] I added a summary of any user-facing changes (compared to the last release) in the `changelog-entries/<PRnumber>.md`.
+- [ ] I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

.pre-commit-config.yaml

@@ -8,9 +8,17 @@ repos:
   rev: v0.30.0
   hooks:
     - id: markdownlint
-      exclude: changelog-entries
+      exclude:  |
+            (?x)^(
+                changelog-entries|
+                .github/pull_request_template.md
+            )$
     - id: markdownlint-fix
-      exclude: changelog-entries
+      exclude:  |
+            (?x)^(
+                changelog-entries|
+                .github/pull_request_template.md
+            )$
 - repo: https://github.com/hhatto/autopep8
   rev: v2.0.4
   hooks:

CHANGELOG.md

@@ -6,6 +6,88 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 <!-- markdownlint-configure-file {"MD024": { "siblings_only": true } } -->
 
+## [v202404.0] 2024-04-16
+
+### Added
+
+New tutorials:
+
+- Added new multi-scale tutorial [two-scale heat conduction](https://precice.org/tutorials-two-scale-heat-conduction.html) with Nutils [#343](https://github.com/precice/tutorials/pull/343) and DuMuX [#376](https://github.com/precice/tutorials/pull/376), using the new [Micro Manager](https://precice.org/tooling-micro-manager-overview.html).
+- Added new [flow around controlled moving cylinder](https://precice.org/tutorials-flow-around-controlled-moving-cylinder.html) tutorial, using the new [FMI runner](https://precice.org/tooling-fmi-runner.html) [#474](https://github.com/precice/tutorials/pull/474).
+- Added new two-phase FSI tutorial [breaking dam with flexible pillar 2D](https://precice.org/tutorials-breaking-dam-2d.html) with OpenFOAM (interFoam) and CalculiX [#279](https://github.com/precice/tutorials/pull/279).
+- Added new flow coupling tutorials [#326](https://github.com/precice/tutorials/pull/326):
+  - [Partitioned flow over a backwards-facing step](https://precice.org/tutorials-partitioned-backwards-facing-step.html)
+  - [Partitioned flow over a heated plate](https://precice.org/tutorials-flow-over-heated-plate-partitioned-flow.html)
+  - [Partitioned pipe: two-phase](https://precice.org/tutorials-partitioned-pipe-two-phase.html) ([#418](https://github.com/precice/tutorials/pull/418))
+- Added new volume coupling cases/tutorials with OpenFOAM:
+  - Added an OpenFOAM case in the [channel transport](https://precice.org/tutorials-channel-transport.html) tutorial [#315](https://github.com/precice/tutorials/pull/315).
+  - Added a new tutorial [volume-coupled flow](https://precice.org/tutorials-volume-coupled-flow.html) [#350](https://github.com/precice/tutorials/pull/350).
+- Added overlapping Schwarz (Dirichlet-Dirichlet coupling) variants for the [oscillator](https://precice.org/tutorials-oscillator-overlap.html) [#391](https://github.com/precice/tutorials/pull/391) and for the [partitioned heat conduction](https://precice.org/tutorials-partitioned-heat-conduction-overlap.html) tutorials.
+
+New solver options in existing tutorials:
+
+- Added FMU participant options for the [oscillator](https://precice.org/tutorials-oscillator.html) tutorial [#466](https://github.com/precice/tutorials/pull/466).
+- Added an SU2 case in the [flow over a heated plate](https://precice.org/tutorials-flow-over-heated-plate.html) tutorial [da7a149](https://github.com/precice/tutorials/commit/da7a1494f5c36b4ef509daf2a43bfee42fb32d9d).
+- Added new solver options in the [perpendicular flap](https://precice.org/tutorials-perpendicular-flap.html) tutorial:
+  - `solid-nutils` [#433](https://github.com/precice/tutorials/pull/433)
+  - `fluid-fake` [#472](https://github.com/precice/tutorials/pull/472), only meant for debugging of solid participants
+- Added a Rust-based solver in the [elastic tube 1D](https://precice.org/tutorials-elastic-tube-1d.html) tutorial [#435](https://github.com/precice/tutorials/pull/435).
+
+General and documentation-related changes:
+
+- Added automatic logging in the run scripts [#479](https://github.com/precice/tutorials/pull/479).
+- Added a `.gitignore` and extended the clean-up scripts [#477](https://github.com/precice/tutorials/pull/477).
+- Added visualizations of the preCICE configuration file in every tutorial [#514](https://github.com/precice/tutorials/pull/514).
+- Added a list of exact Debian package links in the [quickstart](https://precice.org/quickstart.html) tutorial, to reduce cases of users installing the wrong package for their system. Now referring users to releases instead of the master branches of the Git repositories.
+
+Developer-facing changes:
+
+- Added on-demand system regression tests (multiple pull requests, starting from [#347](https://github.com/precice/tutorials/pull/347)).
+- Added reference results, in the context of the system regression tests, hosted in an external Git LFS server [#419](https://github.com/precice/tutorials/pull/419).
+- Added a pre-commit hook for preCICE configuration file formatting, and more [1d22c1](https://github.com/precice/tutorials/commit/1d22c1f61d7b13624973408c4bda7031b69adb5b), [#478](https://github.com/precice/tutorials/pull/478).
+
+### Changed
+
+General updates:
+
+- Updated all example codes and configuration files to preCICE v3 (see the [porting guide](https://precice.org/couple-your-code-porting-v2-3.html)). preCICE v2 is not supported anymore. This has happened in various pull requests.
+- Updated the SU2 configuration in the [perpendicular flap](https://precice.org/tutorials-perpendicular-flap.html) tutorial, for the updated SU2 adapter [da7a149](https://github.com/precice/tutorials/commit/da7a1494f5c36b4ef509daf2a43bfee42fb32d9d).
+- Updated the suggested OpenFOAM version in the [Quickstart](https://precice.org/quickstart.html) to OpenFOAM v2312.
+- Updated the documentation images for several tutorials, including [perpendicular flap](https://precice.org/tutorials-perpendicular-flap.html) ([#507](https://github.com/precice/tutorials/pull/507), now including reference watchpoint files), [heat exchanger: simplified](https://precice.org/tutorials-heat-exchanger-simplified.html) ([#327](https://github.com/precice/tutorials/pull/327) and [#513](https://github.com/precice/tutorials/pull/513)), [elastic tube 3d](https://precice.org/tutorials-elastic-tube-3d.html) ([#509](https://github.com/precice/tutorials/pull/509)), [multiple perpendicular flaps](https://precice.org/tutorials-multiple-perpendicular-flaps.html) ([#511](https://github.com/precice/tutorials/pull/511)), and more.
+
+Restructured:
+
+- Modified the following cases to fit the directory structure defined in the now extended [contributing guidelines](https://precice.org/community-contribute-to-precice.html#contributing-tutorials) ([#461](https://github.com/precice/tutorials/issues/461)):
+  - [Oscillator](https://precice.org/tutorials-oscillator.html)
+  - [Partitioned heat conduction](https://precice.org/tutorials-partitioned-heat-conduction.html)
+  - [Partitioned heat condiction: Complex](https://precice.org/tutorials-partitioned-heat-conduction-complex.html)
+  - [Partitioned heat condiction: Direct mesh access](https://precice.org/tutorials-partitioned-heat-conduction-direct.html)
+  - [Volume-coupled diffusion](https://precice.org/tutorials-volume-coupled-diffusion.html)
+
+Dependency and workflow updates:
+
+- Modified the [Turek-Hron FSI3](https://precice.org/tutorials-turek-hron-fsi3.html) and the [partitioned heat conduction](https://precice.org/tutorials-partitioned-heat-conduction.html) OpenFOAM cases to compute the parabolic inlet profiles using a coded boundary condition, dropping the dependency on groovyBC / swak4Foam [#428](https://github.com/precice/tutorials/pull/428) (added via [a688fa](https://github.com/precice/tutorials/commit/a688fa7db044efbb72ddab7dc0bece522a5ff1e5)).
+- Modified the run scripts so that Nutils is now installed automatically in a virtual environment in all related tutorials [#439](https://github.com/precice/tutorials/pull/439). Similarly for DUNE-FEM [#470](https://github.com/precice/tutorials/pull/470).
+- Modified the run scripts so that C++ solvers in the elastic-tube-1d tutorial are now built automatically [#330](https://github.com/precice/tutorials/pull/330).
+
+Improvements and bug fixes:
+
+- Modified all [partitioned heat conduction](https://precice.org/tutorials-partitioned-heat-conduction.html) tutorials (including the basic, complex, and direct mesh access variants):
+  - Modified the configuration file to use the waveform iteration (time interpolation) feature [#281](https://github.com/precice/tutorials/pull/281).
+  - Modified the preCICE configuration to use a (simpler) nearest-neighbor mapping [#382](https://github.com/precice/tutorials/pull/382).
+  - Modified all cases and solvers to use the same value of `beta` from 1.3 to 1.2 [#379](https://github.com/precice/tutorials/pull/379).
+  - Modified the FEniCS solvers to apply boundary conditions at the right time [#383](https://github.com/precice/tutorials/pull/383).
+  - Modified the FEniCS solver of the basic case to use higher-order implicit Runge-Kutta methods [#415](https://github.com/precice/tutorials/pull/415).
+  - Modified the OpenFOAM solver to output error estimations [#449](https://github.com/precice/tutorials/pull/449).
+- Modified the [partitioned pipe](https://precice.org/tutorials-partitioned-pipe.html) tutorial:
+  - Modified the OpenFOAM cases to use the new custom boundary conditions [#326](https://github.com/precice/tutorials/pull/326).
+  - Removed the unused `PressureGradient` and `VelocityGradient` coupling data [#384](https://github.com/precice/tutorials/pull/384).
+- Modified the [oscillator](https://precice.org/tutorials-oscillator.html) tutorial to use higher-order time stepping schemes.
+- Modified the [elastic tube 1d](https://precice.org/tutorials-elastic-tube-1d.html) tutorial to export and plot watchpoints [#438](https://github.com/precice/tutorials/pull/438).
+- Modified the configuration of the [flow over a heated plate: two meshes](https://precice.org/tutorials-flow-over-heated-plate-two-meshes.html) tutorial:
+  - The CalculiX domain now has the same thickness as the OpenFOAM domain [#487](https://github.com/precice/tutorials/pull/487).
+  - Removed an unused mesh [#390](https://github.com/precice/tutorials/pull/390).
+
 ## [v202211.0] 2022-11-21
 
 ### Added