From a83eb8c203ada545580a621b02b63782f2518d96 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 11 Dec 2018 15:42:11 +0100 Subject: [PATCH] STYLE: add usage notes to utilities and solvers --- .../solvers/implicitSolver/faSavageHutterFoam.C | 7 +++++++ .../releaseAreaMapping/releaseAreaMapping.C | 14 +++++++++----- applications/utilities/slopeMesh/slopeMesh.C | 8 +++++++- 3 files changed, 23 insertions(+), 6 deletions(-) diff --git a/applications/solvers/implicitSolver/faSavageHutterFoam.C b/applications/solvers/implicitSolver/faSavageHutterFoam.C index 1275438..744a41c 100644 --- a/applications/solvers/implicitSolver/faSavageHutterFoam.C +++ b/applications/solvers/implicitSolver/faSavageHutterFoam.C @@ -48,6 +48,13 @@ Author int main(int argc, char *argv[]) { + argList::addNote + ( + "(avalanche)\n" + "A depth-integrated solver for shallow granular flows using" + " Finite Area Methods." + ); + #include "setRootCase.H" #include "createTime.H" #include "createMesh.H" diff --git a/applications/utilities/releaseAreaMapping/releaseAreaMapping.C b/applications/utilities/releaseAreaMapping/releaseAreaMapping.C index 211551b..f83131c 100644 --- a/applications/utilities/releaseAreaMapping/releaseAreaMapping.C +++ b/applications/utilities/releaseAreaMapping/releaseAreaMapping.C @@ -25,8 +25,8 @@ Application releaseAreaMapping Description - An preprocessing application to initialize finite area fields. - Used to create release areas for avalanche simulations. + Initialization of finite area fields, + used to create release areas for avalanche simulations. Author Matthias Rauter matthias.rauter@uibk.ac.at @@ -41,6 +41,13 @@ Author int main(int argc, char *argv[]) { + argList::addNote + ( + "(avalanche)\n" + "Initialization of finite area fields," + " used to create release areas for avalanche simulations." + ); + #include "setRootCase.H" #include "createTime.H" #include "createMesh.H" @@ -74,7 +81,6 @@ int main(int argc, char *argv[]) { const entry& fieldsInfo = fields[fieldsI]; - if (!fieldsInfo.isDict()) { FatalIOErrorIn("releaseAreaMapping.C", releaseArea) @@ -85,8 +91,6 @@ int main(int argc, char *argv[]) dictionary fieldsDict = fieldsInfo.dict(); - - Info<< "Reading field " << fieldNames[fieldsI] << endl; areaScalarField f diff --git a/applications/utilities/slopeMesh/slopeMesh.C b/applications/utilities/slopeMesh/slopeMesh.C index 4ad8e76..4cfdde0 100644 --- a/applications/utilities/slopeMesh/slopeMesh.C +++ b/applications/utilities/slopeMesh/slopeMesh.C @@ -25,7 +25,7 @@ Application slopeMesh Description - Application to create simple slope geometries for testing the granular flow solver. + Create simple slope geometries for testing the granular flow solver. Author Matthias Rauter matthias.rauter@uibk.ac.at @@ -40,6 +40,12 @@ Author int main(int argc, char *argv[]) { + argList::addNote + ( + "(avalanche)\n" + "Create simple slope geometries for testing the granular flow solver" + ); + #include "setRootCase.H" #include "createTime.H" -- 2.18.1