From fb74e8b0ce4ae752e8aa034677dad6807b1f9ab7 Mon Sep 17 00:00:00 2001
From: FZill <florian.zill@ufz.de>
Date: Fri, 8 Jan 2021 17:19:21 +0100
Subject: [PATCH] [MPL] Documentation for EmbeddedFracturePermeability
---
.../c_EmbeddedFracturePermeability.md | 1 +
.../t_fracture_normal.md | 1 +
.../t_initial_aperture.md | 1 +
.../t_intrinsic_permeability.md | 1 +
.../t_mean_frac_distance.md | 1 +
.../t_threshold_strain.md | 1 +
Documentation/bibliography/other.bib | 23 +++++++++++++++++
.../Properties/EmbeddedFracturePermeability.h | 25 +++++++++++++++++++
8 files changed, 54 insertions(+)
create mode 100644 Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/c_EmbeddedFracturePermeability.md
create mode 100644 Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_fracture_normal.md
create mode 100644 Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_initial_aperture.md
create mode 100644 Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_intrinsic_permeability.md
create mode 100644 Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_mean_frac_distance.md
create mode 100644 Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_threshold_strain.md
diff --git a/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/c_EmbeddedFracturePermeability.md b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/c_EmbeddedFracturePermeability.md
new file mode 100644
index 00000000000..4ba1c51740a
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/c_EmbeddedFracturePermeability.md
@@ -0,0 +1 @@
+\copydoc MaterialPropertyLib::EmbeddedFracturePermeability
diff --git a/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_fracture_normal.md b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_fracture_normal.md
new file mode 100644
index 00000000000..7551e5c72f7
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_fracture_normal.md
@@ -0,0 +1 @@
+Optional Parameter fracture_normal. Defines the normal vector of the fracture plane via its three components. If not specified, the fracture normal vector is calculated as the direction of the third principal stress vector.
diff --git a/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_initial_aperture.md b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_initial_aperture.md
new file mode 100644
index 00000000000..0204b03845f
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_initial_aperture.md
@@ -0,0 +1 @@
+The inital aperture.
diff --git a/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_intrinsic_permeability.md b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_intrinsic_permeability.md
new file mode 100644
index 00000000000..1c710341f15
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_intrinsic_permeability.md
@@ -0,0 +1 @@
+The permeability of the undisturbed material.
diff --git a/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_mean_frac_distance.md b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_mean_frac_distance.md
new file mode 100644
index 00000000000..276b5928f52
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_mean_frac_distance.md
@@ -0,0 +1 @@
+The mean distance between neighboring fractures.
diff --git a/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_threshold_strain.md b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_threshold_strain.md
new file mode 100644
index 00000000000..cba71c8dfd2
--- /dev/null
+++ b/Documentation/ProjectFile/properties/property/EmbeddedFracturePermeability/t_threshold_strain.md
@@ -0,0 +1 @@
+Threshold strain, which has to be exceeded to create additional permeability due to fracture opening.
diff --git a/Documentation/bibliography/other.bib b/Documentation/bibliography/other.bib
index 2b2ab112fc0..340c478a7e5 100644
--- a/Documentation/bibliography/other.bib
+++ b/Documentation/bibliography/other.bib
@@ -175,3 +175,26 @@
year={2011},
publisher={Elsevier}
}
+
+@article{alonso2006mechanisms,
+ title={Mechanisms of gas transport in clay barriers},
+ author={Alonso, EE and Olivella, S and Arnedo, Diego},
+ journal={Journal of Iberian Geology},
+ volume={32},
+ number={2},
+ pages={175--196},
+ year={2006},
+ publisher={Citeseer}
+}
+
+@article{olivella2008gas,
+author = {Olivella, S. and Alonso, E. E.},
+title = {Gas flow through clay barriers},
+journal = {G{\'e}otechnique},
+volume = {58},
+number = {3},
+pages = {157-176},
+year = {2008},
+doi = {10.1680/geot.2008.58.3.157},
+URL = {https://doi.org/10.1680/geot.2008.58.3.157}
+}
diff --git a/MaterialLib/MPL/Properties/EmbeddedFracturePermeability.h b/MaterialLib/MPL/Properties/EmbeddedFracturePermeability.h
index c87c1aa9196..ba0fc208dbe 100644
--- a/MaterialLib/MPL/Properties/EmbeddedFracturePermeability.h
+++ b/MaterialLib/MPL/Properties/EmbeddedFracturePermeability.h
@@ -19,6 +19,31 @@ namespace MaterialPropertyLib
* \brief Permeability model as proposed by Olivella&Alonso
* \details This property must be a medium property, it
* computes the permeability in dependence of the strain
+ *
+ * The model was proposed
+ * in \cite alonso2006mechanisms and it was further investigated
+ * in \cite olivella2008gas .
+ *
+ * The model takes the form of
+ * \f[ \mathbf{k} = k_\text{m} \mathbf{I} + \frac{b}{a} \left( \frac{b^2}{12}
+ * - k_\text{m} \right) \left( \mathbf{I} - \mathbf{M} \right)
+ * \f]
+ * with
+ * \f[ \mathbf{M} = \vec{n} \otimes \vec{n} \f]
+ * and
+ * \f[ b = b_0 + \Delta b \\
+ * \Delta b = a \langle \varepsilon_\text{n}- \varepsilon_0 \rangle
+ * \f]
+ * where
+ * <table>
+ * <tr><td>\f$ k_\text{m} \f$ <td> permeability of undisturbed material
+ * <tr><td>\f$ b \f$ <td> fracture aperture
+ * <tr><td>\f$ b_0 \f$ <td> initial aperture
+ * <tr><td>\f$ a \f$ <td> mean fracture distance
+ * <tr><td>\f$ \vec{n} \f$ <td> fracture normal vector
+ * <tr><td>\f$ \varepsilon_n \f$ <td> strain in fracture normal direction
+ * <tr><td>\f$ \varepsilon_0 \f$ <td> threshold strain
+ * </table>
*/
template <int DisplacementDim>
class EmbeddedFracturePermeability final : public Property
--
GitLab