From 394861c3c967338d08b8845bd9f4a9c8b84a81a1 Mon Sep 17 00:00:00 2001
From: Lars Bilke <lars.bilke@ufz.de>
Date: Tue, 29 Mar 2022 15:11:46 +0200
Subject: [PATCH] [web] Converted to page bundle: userguide.
---
.../{cli-arguments.md => cli-arguments/index.md} | 0
.../basics/{container.md => container/index.md} | 0
.../basics/{conventions.md => conventions/index.md} | 0
.../basics/{envinf1.md => envinf1/index.md} | 0
.../{introduction.md => introduction/index.md} | 0
.../index.md} | 0
.../{project-file.md => project-file/index.md} | 0
.../index.md} | 0
.../{ => Heat_Transport_BHE}/coaxial.png | Bin
.../index.md} | 4 ++--
.../{ => Heat_Transport_BHE}/u_type.png | Bin
.../BHE_PipeNetwork_feature_workflow.png | Bin
.../BHE_network.png | Bin
.../index.md} | 4 ++--
.../index.md} | 6 +++---
.../{general.md => general/index.md} | 0
.../{get-support.md => get-support/index.md} | 0
17 files changed, 7 insertions(+), 7 deletions(-)
rename web/content/docs/userguide/basics/{cli-arguments.md => cli-arguments/index.md} (100%)
rename web/content/docs/userguide/basics/{container.md => container/index.md} (100%)
rename web/content/docs/userguide/basics/{conventions.md => conventions/index.md} (100%)
rename web/content/docs/userguide/basics/{envinf1.md => envinf1/index.md} (100%)
rename web/content/docs/userguide/basics/{introduction.md => introduction/index.md} (100%)
rename web/content/docs/userguide/basics/{jupyter-notebooks.md => jupyter-notebooks/index.md} (100%)
rename web/content/docs/userguide/basics/{project-file.md => project-file/index.md} (100%)
rename web/content/docs/userguide/post-processing/{paraview-on-eve.md => paraview-on-eve/index.md} (100%)
rename web/content/docs/userguide/process-dependent-configuration/{ => Heat_Transport_BHE}/coaxial.png (100%)
rename web/content/docs/userguide/process-dependent-configuration/{Heat_Transport_BHE.md => Heat_Transport_BHE/index.md} (99%)
rename web/content/docs/userguide/process-dependent-configuration/{ => Heat_Transport_BHE}/u_type.png (100%)
rename web/content/docs/userguide/process-dependent-configuration/{ => Heat_Transport_BHE_PipelineNetwork}/BHE_PipeNetwork_feature_workflow.png (100%)
rename web/content/docs/userguide/process-dependent-configuration/{ => Heat_Transport_BHE_PipelineNetwork}/BHE_network.png (100%)
rename web/content/docs/userguide/process-dependent-configuration/{Heat_Transport_BHE_PipelineNetwork.md => Heat_Transport_BHE_PipelineNetwork/index.md} (99%)
rename web/content/docs/userguide/process-dependent-configuration/{Multiphase_Flow_Overview.md => Multiphase_Flow_Overview/index.md} (89%)
rename web/content/docs/userguide/troubleshooting/{general.md => general/index.md} (100%)
rename web/content/docs/userguide/troubleshooting/{get-support.md => get-support/index.md} (100%)
diff --git a/web/content/docs/userguide/basics/cli-arguments.md b/web/content/docs/userguide/basics/cli-arguments/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/cli-arguments.md
rename to web/content/docs/userguide/basics/cli-arguments/index.md
diff --git a/web/content/docs/userguide/basics/container.md b/web/content/docs/userguide/basics/container/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/container.md
rename to web/content/docs/userguide/basics/container/index.md
diff --git a/web/content/docs/userguide/basics/conventions.md b/web/content/docs/userguide/basics/conventions/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/conventions.md
rename to web/content/docs/userguide/basics/conventions/index.md
diff --git a/web/content/docs/userguide/basics/envinf1.md b/web/content/docs/userguide/basics/envinf1/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/envinf1.md
rename to web/content/docs/userguide/basics/envinf1/index.md
diff --git a/web/content/docs/userguide/basics/introduction.md b/web/content/docs/userguide/basics/introduction/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/introduction.md
rename to web/content/docs/userguide/basics/introduction/index.md
diff --git a/web/content/docs/userguide/basics/jupyter-notebooks.md b/web/content/docs/userguide/basics/jupyter-notebooks/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/jupyter-notebooks.md
rename to web/content/docs/userguide/basics/jupyter-notebooks/index.md
diff --git a/web/content/docs/userguide/basics/project-file.md b/web/content/docs/userguide/basics/project-file/index.md
similarity index 100%
rename from web/content/docs/userguide/basics/project-file.md
rename to web/content/docs/userguide/basics/project-file/index.md
diff --git a/web/content/docs/userguide/post-processing/paraview-on-eve.md b/web/content/docs/userguide/post-processing/paraview-on-eve/index.md
similarity index 100%
rename from web/content/docs/userguide/post-processing/paraview-on-eve.md
rename to web/content/docs/userguide/post-processing/paraview-on-eve/index.md
diff --git a/web/content/docs/userguide/process-dependent-configuration/coaxial.png b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/coaxial.png
similarity index 100%
rename from web/content/docs/userguide/process-dependent-configuration/coaxial.png
rename to web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/coaxial.png
diff --git a/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE.md b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/index.md
similarity index 99%
rename from web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE.md
rename to web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/index.md
index 3458d361425..21eb5da3c00 100644
--- a/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE.md
+++ b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/index.md
@@ -78,9 +78,9 @@ Especially in CXA and CXC type, the direction of the borehole itself could be de
The cross-sections of these 4 types of BHEs are illustrated in the following figures.
-{{< img src="../u_type.png" width="50">}}
+{{< img src="u_type.png" width="50">}}
-{{< img src="../coaxial.png" width="50">}}
+{{< img src="coaxial.png" width="50">}}
### < pipes >
diff --git a/web/content/docs/userguide/process-dependent-configuration/u_type.png b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/u_type.png
similarity index 100%
rename from web/content/docs/userguide/process-dependent-configuration/u_type.png
rename to web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE/u_type.png
diff --git a/web/content/docs/userguide/process-dependent-configuration/BHE_PipeNetwork_feature_workflow.png b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/BHE_PipeNetwork_feature_workflow.png
similarity index 100%
rename from web/content/docs/userguide/process-dependent-configuration/BHE_PipeNetwork_feature_workflow.png
rename to web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/BHE_PipeNetwork_feature_workflow.png
diff --git a/web/content/docs/userguide/process-dependent-configuration/BHE_network.png b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/BHE_network.png
similarity index 100%
rename from web/content/docs/userguide/process-dependent-configuration/BHE_network.png
rename to web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/BHE_network.png
diff --git a/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork.md b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/index.md
similarity index 99%
rename from web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork.md
rename to web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/index.md
index 9e8422af0bf..bc1b633ed33 100644
--- a/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork.md
+++ b/web/content/docs/userguide/process-dependent-configuration/Heat_Transport_BHE_PipelineNetwork/index.md
@@ -35,7 +35,7 @@ Thermal Engineering Systems in Python (software paper: <https://doi.org/10.21105
The coupled model that is going to be built is demonstrated in Figure 1. It consists of a pipeline network connected with 3 BHEs, a water pump, a virtual heat pump as the consumer, a splitter to split up the feeding fluid flow and a merge to returned flow. These devices are all defined as `components` in TESPy. A full list of available components can be found in the TESPy components module. In the pipeline network, these components are connected with each other through `connections` parts, which are illustrated by the black lines in the figure. With these two main parts, a completely TESPy pipeline network model can be set up.
-{{< img src="../BHE_network.png" width="200">}}
+{{< img src="BHE_network.png" width="200">}}
Figure 1: Pipeline network model in TESPy
@@ -175,7 +175,7 @@ btes.save('tespy_nw')
The work flow of the PipeNetwork feature is illustrated in Figure 2. To explicitly simulate both the BHE and the pipe network, OGS is coupled with the TESPy through a Python interface. Within every time step and each iteration, the outflow temperature `Tout` from each BHE is computed by OGS and transferred to TESPy via the interface. Then TESPy will use these `Tout` temperature and the current hydraulic state as the boundary condition imposed on the pipeline network to calculate the current inflow temperature `Tin` of each BHE and the currently flow rate, which satisfies the overall thermal load of the building. After the calculation, all data will be transferred back to OGS and update the inlet temperature and flow rate of each BHE for the next iteration. The convergence is set to be satisfied when the difference from the last two iteration results is smaller than a preset tolerance value. Additionally, OGS will transfer the currently time step 't' to TESPy within each iteration, which makes TESPy able to adjust its time dependent network boundary conditions according to the user's configuration.
-{{< img src="../BHE_PipeNetwork_feature_workflow.png" width="100">}}
+{{< img src="BHE_PipeNetwork_feature_workflow.png" width="100">}}
Figure 2: Work flow of the model with BHEs coupled with a pipe network
diff --git a/web/content/docs/userguide/process-dependent-configuration/Multiphase_Flow_Overview.md b/web/content/docs/userguide/process-dependent-configuration/Multiphase_Flow_Overview/index.md
similarity index 89%
rename from web/content/docs/userguide/process-dependent-configuration/Multiphase_Flow_Overview.md
rename to web/content/docs/userguide/process-dependent-configuration/Multiphase_Flow_Overview/index.md
index d049b57d170..72be7d270fd 100644
--- a/web/content/docs/userguide/process-dependent-configuration/Multiphase_Flow_Overview.md
+++ b/web/content/docs/userguide/process-dependent-configuration/Multiphase_Flow_Overview/index.md
@@ -27,8 +27,8 @@ Nomenclature: $P_g$: gas pressure; $P_c$: capillary pressure; $T$: temperature;
Some remarks:
-1\. The `TwoPhaseFlowWithPP` process assumes that the two fluid phases are immiscible. Thus, it is most suitable for simulating two-phase flow under capillary effects (e.g. replacement of one phase by another due to gravity). Note that the wetting and non-wetting phases are not limited to water and gas, see the [McWhorter benchmark]({{< ref "../../benchmarks/two-phase-flow-pp-form/two-phase-flow-pp-mcwhorter.md" >}}) for example.
+1\. The `TwoPhaseFlowWithPP` process assumes that the two fluid phases are immiscible. Thus, it is most suitable for simulating two-phase flow under capillary effects (e.g. replacement of one phase by another due to gravity). Note that the wetting and non-wetting phases are not limited to water and gas, see the [McWhorter benchmark]({{< ref "docs/benchmarks/two-phase-flow-pp-form/two-phase-flow-pp-mcwhorter" >}}) for example.
-2\. The `TwoPhaseFlowWithPrho` process assumes that the main component of the gas phase can be dissolved in the liquid phase. Water evaporation is neglected here. The appearance/disappearance of the gas phase is controlled by the solubility (given by the Henry's Law) of the gaseous component, e.g. H2. It is therefore most suitable for nuclear waste repository (see the [MoMaS benchmark]({{< ref "../../benchmarks/two-phase-flow/momas.md" >}})) or CO2 storage problems.
+2\. The `TwoPhaseFlowWithPrho` process assumes that the main component of the gas phase can be dissolved in the liquid phase. Water evaporation is neglected here. The appearance/disappearance of the gas phase is controlled by the solubility (given by the Henry's Law) of the gaseous component, e.g. H2. It is therefore most suitable for nuclear waste repository (see the [MoMaS benchmark]({{< ref "docs/benchmarks/two-phase-flow/momas" >}})) or CO2 storage problems.
-3\. The `ThermalTwoPhaseFlowWithPP` process simulates the temperature-dependent two-phase flow and moisture transport. Water evaporation and recondensation can be modeled thanks to that the gas phase is compositional. This process is most favorably used for shallow geothermal applications (e.g. borehole thermal energy storage), especially in unsaturated soils (see the [heat pipe benchmark]({{< ref "../../benchmarks/thermal-two-phase-flow/heat-pipe.md" >}})).
\ No newline at end of file
+3\. The `ThermalTwoPhaseFlowWithPP` process simulates the temperature-dependent two-phase flow and moisture transport. Water evaporation and recondensation can be modeled thanks to that the gas phase is compositional. This process is most favorably used for shallow geothermal applications (e.g. borehole thermal energy storage), especially in unsaturated soils (see the [heat pipe benchmark]({{< ref "docs/benchmarks/thermal-two-phase-flow/heat-pipe" >}})).
diff --git a/web/content/docs/userguide/troubleshooting/general.md b/web/content/docs/userguide/troubleshooting/general/index.md
similarity index 100%
rename from web/content/docs/userguide/troubleshooting/general.md
rename to web/content/docs/userguide/troubleshooting/general/index.md
diff --git a/web/content/docs/userguide/troubleshooting/get-support.md b/web/content/docs/userguide/troubleshooting/get-support/index.md
similarity index 100%
rename from web/content/docs/userguide/troubleshooting/get-support.md
rename to web/content/docs/userguide/troubleshooting/get-support/index.md
--
GitLab