Skip to content
Snippets Groups Projects
Commit a83eb8c2 authored by Mark OLESEN's avatar Mark OLESEN
Browse files

STYLE: add usage notes to utilities and solvers

parent a82a2f62
No related branches found
No related tags found
1 merge request!6Content for 1812
......@@ -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"
......
......@@ -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
......
......@@ -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"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment