You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-28
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,14 @@ This repository contains ready-to-run tutorial cases for the coupling library [p
4
4
5
5
You may find step-by-step instructions for each case in the [preCICE wiki](https://github.com./precice/precice/wiki). *More tutorials come with each adapter* and you can also find them in the wiki.
6
6
7
-
The files in this repository are organized in the form `problem_type/geometry/solvers`. The following cases are currently provided:
8
7
9
-
*`CHT`: Conjugate Heat Transfer
10
-
*`heat_exchanger`: A shell-and-tube heat exchanger
11
-
*`buoyantSimpleFoam-CalculiX`
12
-
*`flow-over-plate`: A channel flow over a hot plate
13
-
*`buoyantPimpleFoam-fenics`: for running see `README.md`
14
-
*`buoyantPimpleFoam-nutils`: for running see `README.md`
15
-
*`buoyantSimpleFoam-Aster` : for running see the [preCICE wiki](https://github.com./precice/code_aster-adapter/wiki/Flow-over-plate-Code_Aster-Tutorial)
16
-
*`HT`: Heat Transfer
17
-
*`partitioned-heat`: Solving heat equation on a partitioned domain
18
-
*`fenics-fenics`: for running see `README.md`
19
-
*`FSI`: Fluid-Structure Interaction
20
-
*`flap_perp`: A flap attached on the walls of a channel, perpendicular to the flow
21
-
*`SU2-CalculiX`
22
-
*`OpenFOAM-CalculiX`
23
-
*`OpenFOAM-deal.II`: for running see the [preCICE wiki](https://github.com./precice/precice/wiki/Tutorial-for-FSI-with-deal.II-and-OpenFOAM)
24
-
*`flap_perp_2D`: 2D version of flap_perp
25
-
*`OpenFOAM-deal.II`: for running see the [preCICE wiki](https://github.com./precice/precice/wiki/Tutorial-for-FSI-with-deal.II-and-OpenFOAM)
26
-
*`cylinderFlap`: A cylinder with a flexible flap in a channel flow. The von Karman vortices cause the flap to oscillate.
27
-
*`OpenFOAM-CalculiX`
28
-
*`OpenFOAM-deal.II`: for running see the [preCICE wiki](https://github.com./precice/precice/wiki/Tutorial-for-FSI-with-deal.II-and-OpenFOAM)
29
-
*`cylinderFlap_2D`: 2D version of flap_perp
30
-
*`OpenFOAM-deal.II`: for running see the [preCICE wiki](https://github.com./precice/precice/wiki/Tutorial-for-FSI-with-deal.II-and-OpenFOAM)
31
-
*`3D_Tube`: A 3D expanding tube with a pressure inlet boundary condition.
32
-
*`OpenFOAM-CalculiX`
33
-
*`SSI`: Structure-Structure Interaction
34
-
*`loaded_beam`: A partitioned elastic beam fixed at both ends. A mechanical force is applied to one partition.
35
-
*`CalculiX-CalculiX`
8
+
Each folder in this directory represents a stand-alone tutorial containing:
9
+
* instructions in the `docs` folder.
10
+
* multiple participant folders with the format `<participant>_<solver>`. Pick a solver for each participant and start them to run the simulation.
11
+
12
+
13
+
The website import relies on the following rules:
14
+
* tutorials use dashes to separate words: `flow-over-plate`
15
+
* a tutorial contains a `docs` folder.
16
+
*`docs/instructions.md` contains a Jekyll front-matter and a `permalink: /tutorials-flow-over-plate.html`.
17
+
*`docs/images/` is optional and all content will be available in `images/tutorials/flow-over-plate/`. (Use this prefix to include images in `instructions.md`)
0 commit comments