From 7743fdb47f578ba015ea9e5ab82f68d59dc7750e Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Tue, 23 Jun 2020 09:38:50 +0200
Subject: [PATCH] Rename tool AddTopLayer -> AddLayer.
---
.../{AddTopLayer.cpp => AddLayer.cpp} | 8 ++++----
Applications/Utils/MeshEdit/CMakeLists.txt | 2 +-
.../SimpleQuadExampleWithNewTopLayer_1.png | Bin
.../SimpleQuadExample_1.png | Bin
.../{addtoplayer => addlayer}/index.pandoc | 19 ++++++++++++------
5 files changed, 18 insertions(+), 11 deletions(-)
rename Applications/Utils/MeshEdit/{AddTopLayer.cpp => AddLayer.cpp} (93%)
rename web/content/docs/tools/meshing/{addtoplayer => addlayer}/SimpleQuadExampleWithNewTopLayer_1.png (100%)
rename web/content/docs/tools/meshing/{addtoplayer => addlayer}/SimpleQuadExample_1.png (100%)
rename web/content/docs/tools/meshing/{addtoplayer => addlayer}/index.pandoc (57%)
diff --git a/Applications/Utils/MeshEdit/AddTopLayer.cpp b/Applications/Utils/MeshEdit/AddLayer.cpp
similarity index 93%
rename from Applications/Utils/MeshEdit/AddTopLayer.cpp
rename to Applications/Utils/MeshEdit/AddLayer.cpp
index 9bb1d4f091d..49b23ecc1bb 100644
--- a/Applications/Utils/MeshEdit/AddTopLayer.cpp
+++ b/Applications/Utils/MeshEdit/AddLayer.cpp
@@ -1,6 +1,6 @@
/*
- * \date 2015-04-14
- * \brief Adds a top layer to an existing mesh.
+ * \file
+ * \brief Adds a layer to an existing mesh.
*
* \copyright
* Copyright (c) 2012-2020, OpenGeoSys Community (http://www.opengeosys.org)
@@ -23,9 +23,9 @@
int main (int argc, char* argv[])
{
TCLAP::CmdLine cmd(
- "Adds a top layer to an existing mesh"
+ "Adds a layer to an existing mesh."
"The documentation is available at "
- "https://docs.opengeosys.org/docs/tools/meshing/addtoplayer.\n\n"
+ "https://docs.opengeosys.org/docs/tools/meshing/addlayer.\n\n"
"OpenGeoSys-6 software, version " +
GitInfoLib::GitInfo::ogs_version +
".\n"
diff --git a/Applications/Utils/MeshEdit/CMakeLists.txt b/Applications/Utils/MeshEdit/CMakeLists.txt
index 5e960edcf50..cebaa52f9e8 100644
--- a/Applications/Utils/MeshEdit/CMakeLists.txt
+++ b/Applications/Utils/MeshEdit/CMakeLists.txt
@@ -1,5 +1,5 @@
set(TOOLS
- AddTopLayer
+ AddLayer
appendLinesAlongPolyline
checkMesh
convertToLinearMesh
diff --git a/web/content/docs/tools/meshing/addtoplayer/SimpleQuadExampleWithNewTopLayer_1.png b/web/content/docs/tools/meshing/addlayer/SimpleQuadExampleWithNewTopLayer_1.png
similarity index 100%
rename from web/content/docs/tools/meshing/addtoplayer/SimpleQuadExampleWithNewTopLayer_1.png
rename to web/content/docs/tools/meshing/addlayer/SimpleQuadExampleWithNewTopLayer_1.png
diff --git a/web/content/docs/tools/meshing/addtoplayer/SimpleQuadExample_1.png b/web/content/docs/tools/meshing/addlayer/SimpleQuadExample_1.png
similarity index 100%
rename from web/content/docs/tools/meshing/addtoplayer/SimpleQuadExample_1.png
rename to web/content/docs/tools/meshing/addlayer/SimpleQuadExample_1.png
diff --git a/web/content/docs/tools/meshing/addtoplayer/index.pandoc b/web/content/docs/tools/meshing/addlayer/index.pandoc
similarity index 57%
rename from web/content/docs/tools/meshing/addtoplayer/index.pandoc
rename to web/content/docs/tools/meshing/addlayer/index.pandoc
index eade78c647f..a7a1b0a5ca1 100644
--- a/web/content/docs/tools/meshing/addtoplayer/index.pandoc
+++ b/web/content/docs/tools/meshing/addlayer/index.pandoc
@@ -1,25 +1,32 @@
+++
-date = "2018-02-27T11:00:13+01:00"
-title = "AddTopLayer"
+date = "2020-06-22T11:00:13+01:00"
+title = "AddLayer"
author = "Thomas Fischer"
[menu]
[menu.tools]
parent = "meshing"
+
+aliases = [ "/docs/tools/meshing/addtoplayer" ]
+++
## Introduction
-The tool `AddTopLayer` adds one layer of elements with a specified thickness `thickness` on top of an existing mesh `input-mesh` and returns the newly generated mesh `output-mesh` that has an new top layer.
+The tool `AddLayer` adds one layer of elements with a specified thickness
+`thickness` on either on top or bottom of an existing mesh `input-mesh` and
+returns the newly generated mesh `output-mesh` that has an new layer.
-One might want to take care that the material groups are reduced, eg. material groups should not be [0,2,5], but [0,1,2]. The new layer will have the material group number of the highest material group +1.
+One might want to take care that the material groups are reduced, eg. material
+groups should not be [0,2,5], but [0,1,2]. The new layer will have the material
+group number of the highest material group +1. With the switch
+`--copy-material-ids` the MaterialIDs of the extruded layer will be kept.
The tool requires the [OGS-6 node ordering](http://doxygen.opengeosys.org/index.html) in the elements. A different node ordering may lead to unexpected results. In case one might try to change the ordering using the tool `NodeReordering`.
## Usage
```bash
-AddTopLayer -i <input-mesh> -o <output-mesh> [-t <thickness>]
+AddLayer -i <input-mesh> -o <output-mesh> [-t <thickness>]
```
## Simple example
@@ -30,7 +37,7 @@ AddTopLayer -i <input-mesh> -o <output-mesh> [-t <thickness>]
Usage for example:
```
-AddTopLayer -i quad.vtu -o quad_with_new_top_layer.vtu -t 1
+AddLayer -i quad.vtu -o quad_with_new_top_layer.vtu -t 1
```
## Application
--
GitLab