From 26c2445f94fdc9c4bd4adb06536671c71a794bc8 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Thu, 18 Jun 2020 10:58:05 +0200
Subject: [PATCH] DOC: move the manual.md to be the top-level README.md
---
README | 16 ----------------
manual.md => README.md | 22 ++++++++--------------
2 files changed, 8 insertions(+), 30 deletions(-)
delete mode 100644 README
rename manual.md => README.md (97%)
diff --git a/README b/README
deleted file mode 100644
index 58968f4..0000000
--- a/README
+++ /dev/null
@@ -1,16 +0,0 @@
-What:
-
- Library, solver and utilities for avalanche modelling using finiteArea.
-
-Author:
-
- Matthias Rauter <matthias@rauter.it>
-
- who kindly supplied and ported the code from the original
- implementation using foam-extend to OpenFOAM-1712.
-
-License:
-
- Same terms as OpenFOAM.
- Licensed under GNU General Public License <http://www.gnu.org/licenses/>.
-
diff --git a/manual.md b/README.md
similarity index 97%
rename from manual.md
rename to README.md
index c1fb483..9dac31a 100644
--- a/manual.md
+++ b/README.md
@@ -2,9 +2,9 @@
**The OpenFOAM user guide can be found on https://www.openfoam.com/documentation/user-guide/**
-**Author: Matthias Rauter**
-**Mail: matthias (@) rauter (.) it**
-**Twitter: igt_matti**
+- **Author: Matthias Rauter**
+- **Mail: matthias (@) rauter (.) it**
+- **Twitter: igt_matti**
## Introduction
@@ -16,13 +16,7 @@ This module provides a model and tools for the simulation of **dense snow avalan
##### Source code
-Same as OpenFOAM:
-
-All code is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
-This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Licence: GPL-3.0-or-later
##### Real case example
@@ -434,10 +428,10 @@ with **unknown flow fields**
* the density ration between sediment and water $R$ and
* the gravitational acceleration $\mathbf{g} = \mathbf{g}_{\mathrm{s}}+\mathbf{g}_{\mathrm{n}}$.
-**Non-user-selectedable models** are used for
+**Non-user-selectedable models** are used for
* the water entrainment rate $e^{(w)}$:
$e^{(w)} = \dfrac{0.00153}{0.0204+Ri}|\mathbf{\overline{u}}|$
-with
+with
$Ri = \dfrac{R\,g_{\mathrm{n}}\,\overline{c}\,h}{|\mathbf{\overline{u}}|^2}$
* the sediment deposition rate $d^{(s)}$:
$d^{(s)} = v_{\mathrm{s}}\,r_0\,\overline{c}$
@@ -500,7 +494,7 @@ with the depth-averaged kinetic energy $\overline{k}$, calculated with the PDE
$\dfrac{\partial\,\overline{k}\,h}{\partial t} + \nabla\cdot\left(\overline{k}\,h\,\mathbf{\overline{u}}\right) = \boldsymbol{\tau}_{\mathrm{b}}\cdot\mathbf{\overline{u}}+\dfrac{1}{2}|\mathbf{\overline{u}}|^2\,e^{(w)}-\epsilon\,h-R\,g_{\mathrm{n}}\,v_{\mathrm{s}}\,\overline{c}\,h-\dfrac{1}{2}R\,g_{\mathrm{n}}\,h\left(e^{(s)}-d^{(s)}\right)$
-with
+with
$\epsilon = \beta\dfrac{\overline{k}^{3/2}}{h}$
@@ -652,7 +646,7 @@ Parameters:
* ```xmax```: extend in x-direction (optional)
* ```ymin```: extend in y-direction (optional)
* ```ymax```: extend in y-direction (optional)
-* ```postfix```: The postfix of the files.
+* ```postfix```: The postfix of the files.
* ```offset```: Mapping back to world coordinates from simulation coordinates (see gridToSTL/releaseAreaMapping)
--
GitLab