Skip to content

A new structure for the tutorials
Compare
Choose a tag to compare
@MakisH MakisH released this 23 Apr 16:36
· 369 commits to master since this release
v202104.1.0
15e5240
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Over the past months, we redesigned the tutorials of preCICE. Previously, cases often had inconsistent names (e.g. flap_perp), were offered only for specific combinations of solvers (e.g. OpenFOAM-CalculiX) and had quite some duplication in the related run & clean scripts.

This is the first versioned release, which you can rely upon and refer to for the next months. We will be following the scheme <year-month>.<minor>.<patch>, following the system used in the preCICE VM (Vagrant box).

Highlights of this release:

  • No more scattering of documentation: Find everything directly in our redesigned preCICE website (rendered from the README.md files here, so you can also check the basic information without internet connection).
  • No more scattering of case files: We know, keeping the OpenFOAM-only cases in the OpenFOAM adapter repository did not really help.
  • New directory structure. Read more in the contributing guidelines.
  • Self-contained cases: The files for each case are inside its own directory, e.g. fluid-openfoam. The exchange directory is set to .., next to precice-config.xml.
  • Arbitrary combinations of solvers: Run OpenFOAM-CalculiX, OpenFOAM-deal.II, SU2-deal.II, ... you name it!
  • A standard way to run each case: Get into the case folder you want to run and execute ./run.sh. We kept these scripts as short as possible, so that you can easily copy from them.
  • A standard way to clean: A clean<what>.sh script in each directory cleans up everything from this level and deeper.
  • An easy-to-run first tutorial: We created a quickstart tutorial to get everything you need and run a simple case on your laptop.
  • Better 2D cases: Two-dimensional cases such as the (now rotated) perpendicular flap are using the 2D interface of preCICE and every involved adapter supports a 2D mode.
  • A validated Turek-Hron FSI3: No more "cylinder-flap is almost like FSI3, but not exactly". You can now validate your cases starting from this case, validated with OpenFOAM and non-linear deal.II.
  • Formatting & linting: Our Python scripts, shell scripts, and Markdown files are now a little bit more robust and pretty!

Update your adapters to their latest state and enjoy! 🤗

With love,
the preCICE team

Assets 2
Loading