From faa9307c6923cb8cf665fb2d7ce91b6102d3c76b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Buchwald?= <joerg.buchwald@ufz.de>
Date: Tue, 15 Jun 2021 18:49:38 +0200
Subject: [PATCH] add documentation for ThermoRichardsFlow
---
.../THERMO_RICHARDS_FLOW/c_THERMO_RICHARDS_FLOW.md | 1 +
.../process_variables/i_process_variables.md | 1 +
.../process_variables/t_pressure.md | 1 +
.../process_variables/t_temperature.md | 1 +
.../THERMO_RICHARDS_FLOW/t_coupling_scheme.md | 1 +
.../process/THERMO_RICHARDS_FLOW/t_mass_lumping.md | 1 +
.../THERMO_RICHARDS_FLOW/t_simplified_elasticity.md | 2 ++
.../THERMO_RICHARDS_FLOW/t_specific_body_force.md | 1 +
Documentation/bibliography/other.bib | 12 +++++++++++-
9 files changed, 20 insertions(+), 1 deletion(-)
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/c_THERMO_RICHARDS_FLOW.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/i_process_variables.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_pressure.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_temperature.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_coupling_scheme.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_mass_lumping.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_simplified_elasticity.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_specific_body_force.md
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/c_THERMO_RICHARDS_FLOW.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/c_THERMO_RICHARDS_FLOW.md
new file mode 100644
index 00000000000..d2d28a3f9b1
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/c_THERMO_RICHARDS_FLOW.md
@@ -0,0 +1 @@
+\copydoc ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowProcess
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/i_process_variables.md
new file mode 100644
index 00000000000..d6b0eea49a3
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/i_process_variables.md
@@ -0,0 +1 @@
+The process variables for temperature, pressure.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_pressure.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_pressure.md
new file mode 100644
index 00000000000..a9fd77e321e
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_pressure.md
@@ -0,0 +1 @@
+Process variable name for pore pressure.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_temperature.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_temperature.md
new file mode 100644
index 00000000000..f6efd419ab8
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/process_variables/t_temperature.md
@@ -0,0 +1 @@
+Process variable name for temperature.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_coupling_scheme.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_coupling_scheme.md
new file mode 100644
index 00000000000..3a78fe4e48b
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_coupling_scheme.md
@@ -0,0 +1 @@
+Coupling scheme. So far, only the full monolithic scheme is available.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_mass_lumping.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_mass_lumping.md
new file mode 100644
index 00000000000..ee34f73d909
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_mass_lumping.md
@@ -0,0 +1 @@
+A tag for enabling diagonal lumping of the mass matrix of the Richards equation.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_simplified_elasticity.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_simplified_elasticity.md
new file mode 100644
index 00000000000..7d5746b5bfa
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_simplified_elasticity.md
@@ -0,0 +1,2 @@
+Considertion of mechanics in the mass balance equation under specific stress conditions
+to approximate the \f$ \nabla \cdot \dot {\mathbf u}\f$-term. See \cite Buchwald2021 for details.
diff --git a/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_specific_body_force.md b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_specific_body_force.md
new file mode 100644
index 00000000000..1263b236869
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/THERMO_RICHARDS_FLOW/t_specific_body_force.md
@@ -0,0 +1 @@
+\copydoc ProcessLib::RichardsMechanics::RichardsMechanicsProcessData::specific_body_force
diff --git a/Documentation/bibliography/other.bib b/Documentation/bibliography/other.bib
index d97cfb78f33..e9223585517 100644
--- a/Documentation/bibliography/other.bib
+++ b/Documentation/bibliography/other.bib
@@ -10,7 +10,17 @@
Year={1964},
Publisher={colorado State University}
}
-
+@Article{Buchwald2021,
+title = {Improved predictions of thermal fluid pressurization in hydro-thermal models based on consistent incorporation of thermo-mechanical effects in anisotropic porous media},
+journal = {International Journal of Heat and Mass Transfer},
+volume = {172},
+pages = {121127},
+year = {2021},
+issn = {0017-9310},
+doi = {https://doi.org/10.1016/j.ijheatmasstransfer.2021.121127},
+url = {https://www.sciencedirect.com/science/article/pii/S0017931021002301},
+author = {J. Buchwald and S. Kaiser and O. Kolditz and T. Nagel}
+}
@Article{Ehlers1995,
Title={A single-surface yield function for geomaterials},
Author={Ehlers, W},
--
GitLab