Skip to content

Commit 2a8efd8

Browse files
authored
Merge branch 'develop' into bump-versions
2 parents 3dcfb1d + 560fa91 commit 2a8efd8

File tree

8 files changed

+15
-6
lines changed

8 files changed

+15
-6
lines changed

elastic-tube-1d/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ preCICE configuration (image generated using the [precice-config-visualizer](htt
4040
Both fluid and solid participant are supported in:
4141

4242
- *C++*: example solvers using the intrinsic [C++ API of preCICE](https://precice.org/couple-your-code-api.html). The fluid solver also depends on LAPACK (e.g. on Ubuntu `sudo apt-get install liblapack-dev`)
43-
- *Python*: example solvers using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). Both solvers depend on `numpy`. The fluid solver additionally depends on the Python libraries `scipy matplotlib`. You can get these libraries from your system package manager or with `pip3 install --user <package>`.
43+
- *Python*: example solvers using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). The run script installs these automatically via pip in a virtual environment.
4444
- *Rust*: example solvers using the preCICE [Rust bindings](https://precice.org/installation-bindings-rust.html). They need `cargo` to be installed.
4545

4646
## Running the Simulation

flow-around-controlled-moving-cylinder/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ OpenFOAM is used for the `Fluid` participant. The spring-damper system is solved
2929

3030
- *OpenFOAM*: To run this case, you need the preCICE [OpenFOAM Adapter](https://precice.org/adapter-openfoam-get.html). OpenFOAM is used to simulate the laminar flow around the cylinder with the solver `pimpleFoam`.
3131
- *FMI*: A solver using the [preCICE-FMI Runner](https://github.com/precice/fmi-runner) (requires at least v0.2). The Runner executes the FMU model `PIDcontroller.fmu` for computation. The provided run script (see below) builds this model if not already there. If you want to change the model parameters or simulation setup, have a look inside `fmi-settings.json` and `precice-settings.json` (see folder `controller-fmi`).
32-
- *Python*: A python script solving the spring damper system. It uses the preCICE [Python bindings](https://precice.org/installation-bindings-python.html) and depends on the Python library `numpy`. You can install `numpy` from your system package manager or with `pip3 install --user <package>`.
32+
- *Python*: A python script solving the spring damper system, using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). The run script installs the dependencies automatically via pip in a virtual environment.
3333

3434
## Running the simulation
3535

heat-exchanger/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This is one of our first ever and most popular tutorials, yet definitely not the
1515

1616
This tutorial describes how to run a conjugate heat transfer simulation with two separate OpenFOAM solvers and CalculiX. The files for this tutorial are located in this repository (directory CHT/heat_exchanger).
1717

18-
This tutorial is based on [a case](https://www.simscale.com/projects/cheunglucia/heat_exchanger_-_cht_simulation/) prepared with [SimScale](https://www.simscale.com/) by [Lucia Cheung Yau](https://github.com/ludcila) for her [Master's Thesis](https://www5.in.tum.de/pub/Cheung2016_Thesis.pdf).
18+
This tutorial is based on [a case](https://www.simscale.com/projects/cheunglucia/heat_exchanger_-_cht_simulation/) prepared with [SimScale](https://www.simscale.com/) by [Lucia Cheung Yau](https://github.com/ludcila) for her [Master's Thesis](https://mediatum.ub.tum.de/1461907).
1919

2020
## Setup
2121

oscillator-overlap/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ preCICE configuration (image generated using the [precice-config-visualizer](htt
2727

2828
This tutorial is only available in Python. You need to have preCICE and the Python bindings installed on your system.
2929

30-
- *Python*: An example solver using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). This solver also depends on the Python libraries `numpy`, which you can get from your system package manager or with `pip3 install --user <package>`.
30+
- *Python*: An example solver using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). The run script installs the dependencies automatically via pip in a virtual environment.
3131

3232
## Running the Simulation
3333

oscillator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ preCICE configuration (image generated using the [precice-config-visualizer](htt
2727

2828
There are two different implementations:
2929

30-
- *Python*: A solver using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). This solver also depends on the Python libraries `numpy`, which you can get from your system package manager or with `pip3 install --user <package>`. Using the option `-ts` allows you to pick the time stepping scheme being used. Available choices are Newmark beta, generalized alpha, explicit Runge Kutta 4, and implicit RadauIIA. The solver uses subcycling: Each participant performs 4 time steps in each time window. The data of these 4 substeps is then used by preCICE to create a third order B-spline interpolation (`waveform-degree="3"` in `precice-config.xml`).
30+
- *Python*: A solver using the preCICE [Python bindings](https://precice.org/installation-bindings-python.html). The run script installs the dependencies automatically via pip in a virtual environment. Using the option `-ts` allows you to pick the time stepping scheme being used. Available choices are Newmark beta, generalized alpha, explicit Runge Kutta 4, and implicit RadauIIA. The solver uses subcycling: Each participant performs 4 time steps in each time window. The data of these 4 substeps is then used by preCICE to create a third order B-spline interpolation (`waveform-degree="3"` in `precice-config.xml`).
3131
- *FMI*: A solver using the [preCICE-FMI runner](https://github.com/precice/fmi-runner) (requires at least v0.2). The Runner executes the FMU model `Oscillator.fmu` for computation. The provided run scripts (see below) build this model if not already there. For more information, please refer to [2].
3232

3333
## Running the simulation

perpendicular-flap/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Solid participant:
4747

4848
* Nutils. The structural model is currently limited to linear elasticity. For more information, have a look at the [Nutils adapter documentation](https://precice.org/adapter-nutils.html). This Nutils solver requires at least Nutils v8.0.
4949

50-
* 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.
50+
* 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://www.solids4foam.com/tutorials/more-tutorials/fluid-solid-interaction/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.
5151

5252
* 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.
5353

@@ -122,6 +122,11 @@ In this case, the coupling between the fluid flow and the flap becomes stronger
122122

123123
With the default value of $$ \rho_s= 3.0·10^{3}kg/m^{3} $$, the simulation will also converge with an explicit coupling scheme. With $$ \rho_s= 1kg/m^{3} $$, the simulation will only converge with implicit coupling, with an acceleration method such as the IQN-ILS in the current configuration.
124124

125+
See [how this tutorial behaves with different coupling algorithms](https://makish.github.io/vki-training/#/17).
126+
This talk varies the [coupling scheme configuration](https://precice.org/configuration-coupling.html) and demonstrates explicit and implicit coupling schemes, the latter with constant, Aitken, and Anderson acceleration.
127+
Even though this is not a rigorous study, it demonstrates the effect that different coupling algorithms can have.
128+
Find more thorough studies in the [literature guide](https://precice.org/fundamentals-literature-guide.html#precice-features).
129+
125130
{% disclaimer %}
126131
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.
127132
{% enddisclaimer %}

quickstart/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ toc: false
1414

1515
This is the first step you may want to try if you are new to preCICE: install preCICE and some solvers, and run a simple coupled case.
1616

17+
[![asciicast](https://asciinema.org/a/RqGhiiS8jf2fKTaXgiNn73B1G.svg)](https://asciinema.org/a/RqGhiiS8jf2fKTaXgiNn73B1G)
18+
1719
To get a feeling what preCICE does, watch a [short presentation](https://www.youtube.com/watch?v=FCv2FNUvKA8) or a [longer talk on the fundamentals](https://www.youtube.com/watch?v=9EDFlgfpGBs).
1820

1921
## Installation

tools/tests/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The tutorials repository hosts cases that need multiple components from the preC
1010

1111
Read more about the system tests in the publication [System Regression Tests for the preCICE Coupling Ecosystem](https://doi.org/10.14279/eceasst.v83.2614).
1212

13+
[![ECEASST](https://img.shields.io/badge/DOI-10.14279%2Feceasst.v83.2614-green)](https://doi.org/10.14279/eceasst.v83.2614)
14+
1315
## Running the system tests
1416

1517
The main workflow for the user is executing the `systemtests.py` script. Depending on the options given to the script, it reads in the respective metadata files and generates `docker-compose.yaml` files that can start a fully-defined coupled simulation.

0 commit comments

Comments
 (0)