From 8c8b73f040d3a0ccbdcf2c9ff09010cdf5a3b142 Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Thu, 19 Sep 2024 16:58:46 +0200
Subject: [PATCH] [Doc/LF] Documentation for the new input tag of
equation_balance_type
---
.../process/LIQUID_FLOW/t_equation_balance_type.md | 1 +
ProcessLib/LiquidFlow/LiquidFlowData.h | 12 ++++++------
2 files changed, 7 insertions(+), 6 deletions(-)
create mode 100644 Documentation/ProjectFile/prj/processes/process/LIQUID_FLOW/t_equation_balance_type.md
diff --git a/Documentation/ProjectFile/prj/processes/process/LIQUID_FLOW/t_equation_balance_type.md b/Documentation/ProjectFile/prj/processes/process/LIQUID_FLOW/t_equation_balance_type.md
new file mode 100644
index 00000000000..e95eda4cc40
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/LIQUID_FLOW/t_equation_balance_type.md
@@ -0,0 +1 @@
+\copydoc ProcessLib::LiquidFlow::LiquidFlowData::equation_balance_type
diff --git a/ProcessLib/LiquidFlow/LiquidFlowData.h b/ProcessLib/LiquidFlow/LiquidFlowData.h
index 26897223def..c0f5b8640c0 100644
--- a/ProcessLib/LiquidFlow/LiquidFlowData.h
+++ b/ProcessLib/LiquidFlow/LiquidFlowData.h
@@ -30,12 +30,12 @@ enum class EquationBalanceType
struct LiquidFlowData final
{
- /// This is an indicator of whether the governing equation is volume
- /// balanced scaled or mass balanced. Its value can be `volume` or `mass`.
- /// If it is set to `volume`, note that the phase density must be constant,
- /// and the unit of the Neumann condition is m/s. Otherwise, the unit of the
- /// Neumann condition is kg/m³·m/s = kg/m²/s. By default, it is set to
- /// `volume`.
+ /// This indicates whether the governing equation is a volume balance or a
+ /// mass balance. Its value can be `volume` or `mass`. If it is set to
+ /// `volume`, note that the phase density must be constant, and the unit of
+ /// the Neumann boundary condition is m/s. Otherwise, the unit of the
+ /// Neumann boundary condition is kg/m³·m/s = kg/m²/s. By default, it is set
+ /// to `volume`.
EquationBalanceType const equation_balance_type;
MaterialPropertyLib::MaterialSpatialDistributionMap media_map;
--
GitLab