From 1d626a343a01e9e6277dda9a8dd817550034c6fd Mon Sep 17 00:00:00 2001 From: Markus Muehlhaeusser Date: Mon, 20 Nov 2023 19:04:29 +0100 Subject: [PATCH] Update config.md for Phi --- docs/config.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/config.md b/docs/config.md index 06e293f9..7f22c51a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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. @@ -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 @@ -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 } ```