From 284fe6d1e841925e790292d77bc90e0c31b35ddf Mon Sep 17 00:00:00 2001
From: rinkk <karsten.rink@ufz.de>
Date: Tue, 3 Dec 2019 17:52:13 +0100
Subject: [PATCH] documentation
---
.../docs/tools/meshing/vtu2grid/index.pandoc | 79 +++++++++++++++++++
.../tools/meshing/vtu2grid/vtu2grid-100.png | 3 +
.../tools/meshing/vtu2grid/vtu2grid-200.png | 3 +
.../tools/meshing/vtu2grid/vtu2grid-50.png | 3 +
.../meshing/vtu2grid/vtu2grid-50x50x10.png | 3 +
.../tools/meshing/vtu2grid/vtu2grid-orig.png | 3 +
6 files changed, 94 insertions(+)
create mode 100644 web/content/docs/tools/meshing/vtu2grid/index.pandoc
create mode 100644 web/content/docs/tools/meshing/vtu2grid/vtu2grid-100.png
create mode 100644 web/content/docs/tools/meshing/vtu2grid/vtu2grid-200.png
create mode 100644 web/content/docs/tools/meshing/vtu2grid/vtu2grid-50.png
create mode 100644 web/content/docs/tools/meshing/vtu2grid/vtu2grid-50x50x10.png
create mode 100644 web/content/docs/tools/meshing/vtu2grid/vtu2grid-orig.png
diff --git a/web/content/docs/tools/meshing/vtu2grid/index.pandoc b/web/content/docs/tools/meshing/vtu2grid/index.pandoc
new file mode 100644
index 00000000000..8886c324ce8
--- /dev/null
+++ b/web/content/docs/tools/meshing/vtu2grid/index.pandoc
@@ -0,0 +1,79 @@
++++
+date = "2019-11-27T00:00:00+01:00"
+title = "Vtu2Grid"
+author = "Karsten Rink"
+
+[menu]
+ [menu.tools]
+ parent = "meshing"
++++
+
+## Introduction
+
+This utility rasterises an existing 3D mesh at a given given resolution. The result is a (quasi-)structured grid (consisting of hexahedral elements) with the same extent as the input mesh. Cell properties are mapped onto the grid (sampled at centre-points of each cube), while node properties are ignored. For large raster sizes, an undersampling of the original mesh is possible.
+
+The tool is part of the official [OpenGeoSys git repository](https://github.com/ufz/ogs).
+
+## Usage
+
+```bash
+ Vtu2Grid.exe -i <input.vtu> -o <output.vtu> -x <floating point number>
+ [-y <floating point number>] [-z <floating point number>]
+
+Where:
+
+ -i <input.vtu>, --input <input.vtu>
+ (required) the 3D input mesh (*.vtu, *.msh)
+
+ -o <output.vtu>, --output <output.vtu>
+ (required) the output grid (*.vtu)
+
+ -x <floating point number>, --cellsize-x <floating point number>
+ (required) edge length of cubes in x-direction (longitude) or all
+ directions, if y and z are not set
+
+ -y <floating point number>, --cellsize-y <floating point number>
+ edge length of cubes in y-direction (latitude)
+
+ -z <floating point number>, --cellsize-z <floating point number>
+ edge length of cubes in z-direction (depth)
+```
+
+The ```x```/```y```/```z```-parameters determine the raster size. If only ```x``` is given, all raster cells will be (equilateral) cubes. If all three parameters are specified, the programme will create rectangular cuboid cells.
+
+## Simple example
+
+{ width=66% }
+Original, unstructured grid consisting of 217,128 prism-elements. The subsurface represented by this mesh consists of a number of layers of very different thickness. The very thin layers at the top (reddish tones) and in the middle (green and cyan tones) are particularly difficult to handle during numerical simulation.
+
+**Command:**
+```
+Vtu2Grid -i input.vtu -o output.vtu -x 200
+```
+{ width=66% }
+Rasterised grid consisting of 9,240 cubes (equilateral hexahedral elements with an edge length of 200m). The result is severely undersampled and a continuous layer structure is no longer visible.
+
+**Command:**
+```
+Vtu2Grid -i input.vtu -o output.vtu -x 100
+```
+{ width=66% }
+Rasterised grid consisting of 74,048 equilateral hexahedral elements with an edge length of 100m. The result is still undersampled but layers become already visible.
+
+**Command:**
+```
+Vtu2Grid -i input.vtu -o output.vtu -x 50
+```
+{ width=66% }
+Rasterised grid consisting of 591,757 equilateral hexahedral elements with an edge length of 50m. There's still undersampling in regions containing thin layers but the overall structure is reasonably well represented.
+
+**Command:**
+```
+Vtu2Grid -i input.vtu -o output.vtu -x 50 -y 50 -z 10
+```
+{ width=66% }
+Rasterised grid consisting of 2,959,656 cuboid hexahedral elements with an edge length of 50m x 50m x 10m. The structure of the original mesh is very well represented while the number of elements has increased by an order of magnitude.
+
+## Application
+
+This utility can be used to convert complex unstructured 3D meshes with a numerically challenging geometry into simple, rasterised meshes. This will (significantly) increase the number of elements but prevents numerical issues during a subsequent simulation, thus exchanging a challenging model setup with a longer runtime. As such, the output mesh allows to quickly set-up a working model of region of interest to get first results that allow for informed decisions for a more realistic model using the unstructured input mesh.
diff --git a/web/content/docs/tools/meshing/vtu2grid/vtu2grid-100.png b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-100.png
new file mode 100644
index 00000000000..ebbc99a7c7d
--- /dev/null
+++ b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-100.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:370adef3353bba3830c4036aacc2c246709cfa9446621f0edd7260030012cdac
+size 164792
diff --git a/web/content/docs/tools/meshing/vtu2grid/vtu2grid-200.png b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-200.png
new file mode 100644
index 00000000000..8034a65303f
--- /dev/null
+++ b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-200.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5061070db60a27e0b0eaa8a4aeec37ff23d86a1503ecafc9821606a2a694821c
+size 106627
diff --git a/web/content/docs/tools/meshing/vtu2grid/vtu2grid-50.png b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-50.png
new file mode 100644
index 00000000000..3d27df2c6c2
--- /dev/null
+++ b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-50.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8415a9b9d1879e8e59e9dc8f69da0826639ca48350c1770877ce50a20db9baa7
+size 213540
diff --git a/web/content/docs/tools/meshing/vtu2grid/vtu2grid-50x50x10.png b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-50x50x10.png
new file mode 100644
index 00000000000..1417cfc8b74
--- /dev/null
+++ b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-50x50x10.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:90afa146929b51ff8d10d98de8570ba7d137bbbd7f33b35e3d5008b0ec7bba9d
+size 259655
diff --git a/web/content/docs/tools/meshing/vtu2grid/vtu2grid-orig.png b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-orig.png
new file mode 100644
index 00000000000..d5346245566
--- /dev/null
+++ b/web/content/docs/tools/meshing/vtu2grid/vtu2grid-orig.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a3db5df6ba9ffd6efe7740ae0ec4b38eb14869e8ec1584294b9e597ad96e9d06
+size 166845
--
GitLab