Skip to content

Commit 9d6584b

Browse files
committed
Add tables of supported fields
1 parent 2445838 commit 9d6584b

File tree

1 file changed

+52
-29
lines changed

1 file changed

+52
-29
lines changed

docs/README.md

Lines changed: 52 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,58 @@ This preCICE adapter is a plug-in (function object) for OpenFOAM, which can work
1212

1313
## What can it do?
1414

15-
This adapter can read/write the following fields in a surface coupling setup:
16-
17-
- Temperature (read + write)
18-
- Temperature surface-normal gradient (read + write)
19-
- Heat flux (read + write)
20-
- Sink temperature (read + write)
21-
- Heat transfer coefficient (read + write)
22-
- Force (read + write)
23-
- Stress (write)
24-
- Displacement (read + write)
25-
- Displacement delta (read)
26-
- Pressure (read + write)
27-
- Pressure surface-normal gradient (read + write)
28-
- Velocity (read + write)
29-
- Velocity surface-normal gradient (read + write)
30-
- Phase fraction (alpha) (read + write)
31-
- Phase fraction (alpha) gradient (read + write)
32-
- Phase flux (phi) (read + write)
33-
34-
In addition, the adapter supports the following fields in a volume coupling setup:
35-
36-
- Temperature (write)
37-
- Pressure (write)
38-
- Velocity (read + write)
39-
40-
Some fields might only be supported by specific solver types (e.g., fluid or solid).
41-
For example, writing forces is supported for fluid solvers, but not for solid solvers.
42-
43-
All features of preCICE are supported, including implicit coupling and nearest-projection mapping. Even though OpenFOAM is 3D, this adapter can also work in the 2D mode of preCICE, defining only one layer of interface nodes (automatically).
15+
This adapter has been demonstrated on different use cases (conjugate heat transfer, fluid-structure interaction, fluid-fluid coupling), both in 2D (3D with one layer of cells in the z-axis) and 3D, and both for flow and solid OpenFOAM-based solvers (see [tutorials](https://precice.org/tutorials.html)).
16+
The fields to read/write are provided by different adapter modules that one needs to [configure](https://precice.org/adapter-openfoam-config.html) and are currently the following.
17+
18+
Legend on locations to read/write:
19+
20+
- **N:** Mesh nodes (surface coupling)
21+
- **F:** Face centers (surface coupling)
22+
- **C:** cell centers (volume coupling)
23+
- ***:** mesh connectivity supported (for e.g., nearest-projection mapping)
24+
25+
### Module: Conjugate heat transfer
26+
27+
| Field | Write | Read | Config prefix |
28+
| --- | --- | --- | --- |
29+
| Heat flux | N*, F | N, F* | `Heat-Flux` |
30+
| Heat transfer coefficient | N*, F | N, F* | `Heat-Transfer-Coefficient` |
31+
| Sink temperature | N*, F | N, F* | `Sink-Temperature` |
32+
| Temperature | N*, F, C | N, F*, C | `Temperature` |
33+
34+
All fields are supported for both flow (compressible/incompressible) and basic (e.g., laplacianFoam) solvers.
35+
36+
### Module: Fluid-structure interaction
37+
38+
| Field | Write | Read | Config prefix |
39+
| --- | --- | --- | --- |
40+
| Displacement: absolute | N*, F* | N*, F* | `Displacement` |
41+
| Displacement: relative | N*, F* | N*, F* | `DisplacementDelta` |
42+
| Force | F* (flow) | F* | `Force` |
43+
| Stress | F* (flow) | F* | `Stress` |
44+
45+
Displacement reading and writing is supported both for flow (compressible or incompressible) and structure solvers.
46+
Force and stress writing in only supported for flow solvers, reading for both.
47+
48+
### Module: Fluid-fluid coupling
49+
50+
| Field | Write | Read | Config prefix |
51+
| --- | --- | --- | --- |
52+
| Drag force | F*, C | F*, C | `DragForce` |
53+
| Momentum: explicit | F*, C | F*, C | `ExplicitMomentum` |
54+
| Momentum: implicit | F*, C | F*, C | `ImplicitMomentum` |
55+
| Phase flux | F* | F* | `Phi` |
56+
| Phase fraction | F*, C | F*, C | `Alpha` |
57+
| Phase fraction gradient | F* | F* | `AlphaGradient` |
58+
| Pressure | F*, C | F*, C | `Pressure` |
59+
| Pressure: full gradient | F*, C* | F* | `PressureGradientFull` (TODO: read-only) |
60+
| Pressure: surface-normal gradient | F* | F* | `PressureGradient` |
61+
| Temperature | F* | F* | `FlowTemperature` |
62+
| Temperature surface-normal gradient | F* | F* | `FlowTemperatureGradient` |
63+
| Velocity | F*, C | F*, C | `Velocity` |
64+
| Velocity surface-normal gradient | F* | F* | `VelocityGradient` |
65+
66+
All fields assume a flow solver.
4467

4568
## Try
4669

0 commit comments

Comments
 (0)