Skip to content

Commit

Permalink
Add Alpha comment to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thesamriel committed Nov 17, 2023
1 parent 51b507a commit 8509a3f
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ solver displacementLaplacian;
#### FF
The fluid-fluid coupling module supports reading and writing `Pressure`, `Velocity`, `PressureGradient`, `VelocityGradient`, `FlowTemperature` and `FlowTemperatureGradient`.
The fluid-fluid coupling module supports reading and writing `Pressure`, `Velocity`, `PressureGradient`, `VelocityGradient`, `FlowTemperature`, `FlowTemperatureGradient`, `Alpha` and `AlphaGradient`.
Similarly to the CHT module, you need a `fixedValue` boundary condition of the respective primary field in order to read and apply values, and a `fixedGradient` boundary condition of the respective gradient field in order to read and apply gradients.
Expand Down Expand Up @@ -248,6 +248,17 @@ interface
The FF module is still experimental and the boundary conditions presented here have not been rigorously tested.
{% endexperimental %}

`Alpha` refers to the phase variable used in e.g. the volume of fluid multiphase solver `interFoam`. When coupling multiphase flows the correct names for pressure and alpha need to be specified in the `preciceDict`.

```c++
// File preciceDict (example for interFoam)
FF
{
nameP p_rgh;
nameAlpha alpha.water;
}
```

### Volume coupling

Besides surface coupling on the domain boundaries, the OpenFOAM adapter also supports coupling overlapping domains, which can be the complete domain, or regions of it. In contrast to surface coupling, though, reading volume data (source terms) requires a few additional configuration steps compared to writing data.
Expand Down

0 comments on commit 8509a3f

Please sign in to comment.