From 4e96b37ff7fa44ab4758b876a1c06f76c285e67d Mon Sep 17 00:00:00 2001
From: renchao_lu <renchao.lu@gmail.com>
Date: Sun, 20 Jun 2021 20:20:13 +0200
Subject: [PATCH] [Docu] add documentation for the optional tag.
---
.../processes/process/StokesFlow/t_use_stokes_brinkman_form.md | 1 +
ProcessLib/StokesFlow/StokesFlowProcessData.h | 2 ++
2 files changed, 3 insertions(+)
create mode 100644 Documentation/ProjectFile/prj/processes/process/StokesFlow/t_use_stokes_brinkman_form.md
diff --git a/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_use_stokes_brinkman_form.md b/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_use_stokes_brinkman_form.md
new file mode 100644
index 00000000000..a30fd1b1440
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/StokesFlow/t_use_stokes_brinkman_form.md
@@ -0,0 +1 @@
+\copydoc ProcessLib::StokesFlow::StokesFlowProcessData::use_stokes_brinkman_form
diff --git a/ProcessLib/StokesFlow/StokesFlowProcessData.h b/ProcessLib/StokesFlow/StokesFlowProcessData.h
index 668d6cae4d9..0417237d0b5 100644
--- a/ProcessLib/StokesFlow/StokesFlowProcessData.h
+++ b/ProcessLib/StokesFlow/StokesFlowProcessData.h
@@ -31,6 +31,8 @@ struct StokesFlowProcessData
/// an external force that applies in the bulk of the fluid, like gravity.
Eigen::VectorXd const specific_body_force;
+ /// When this optional field is flagged on, the Darcy term will be
+ /// additionally included in the original momentum balance equation.
bool const use_stokes_brinkman_form;
MeshLib::PropertyVector<double>* pressure_interpolated = nullptr;
--
GitLab