Skip to content

Commit

Permalink
Update config.md for Phi
Browse files Browse the repository at this point in the history
  • Loading branch information
thesamriel committed Nov 20, 2023
1 parent 7627599 commit 1d626a3
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions 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`, `FlowTemperatureGradient`, `Alpha` and `AlphaGradient`.
The fluid-fluid coupling module supports reading and writing `Pressure`, `Velocity`, `PressureGradient`, `VelocityGradient`, `FlowTemperature`, `FlowTemperatureGradient`, `Alpha`, `AlphaGradient` and the face flux `Phi`.
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,16 +248,9 @@ 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`.
`Alpha` refers to the phase variable used in e.g. the volume of fluid multiphase solver `interFoam`.

```c++
// File preciceDict (example for interFoam)
FF
{
nameP p_rgh;
nameAlpha alpha.water;
}
```
When coupling face flux `Phi`, usually no specific boundary condition needs to be set. The coupled boundary values are therefore not persistent and may change within a timestep.

### Volume coupling

Expand Down Expand Up @@ -576,6 +569,12 @@ FF
nameU U;
// Pressure
nameP p;
// Face flux (phi for most sovlers)
namePhi phi;
// Temperature
nameT T;
// Multiphase variable
nameAlpha alpha
}
```

Expand Down

0 comments on commit 1d626a3

Please sign in to comment.