Merge branch 'develop' of develop.openfoam.com:Development/OpenFOAM-plus into develop

applications/solvers/DNS/dnsFoam/dnsFoam.C

@@ -44,6 +44,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Direct numerical simulation for boxes of isotropic turbulence."
+    );
+
     #include "postProcess.H"
 
     #include "setRootCase.H"

applications/solvers/basic/laplacianFoam/laplacianFoam.C

@@ -59,6 +59,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Laplace equation solver for a scalar quantity."
+    );
+
     #include "addCheckCaseOptions.H"
     #include "setRootCase.H"
 

applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C

@@ -60,6 +60,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Overset Laplace equation solver for a scalar quantity."
+    );
+
     #include "setRootCase.H"
 
     #include "createTime.H"

applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C

@@ -97,6 +97,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Overset potential flow solver which solves for the velocity potential"
+    );
+
     argList::addOption
     (
         "pName",

applications/solvers/basic/potentialFoam/potentialFoam.C

@@ -94,6 +94,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Potential flow solver which solves for the velocity potential"
+    );
+
     argList::addOption
     (
         "pName",

applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C

@@ -61,6 +61,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Passive scalar transport equation solver."
+    );
+
     #include "addCheckCaseOptions.H"
     #include "setRootCase.H"
     #include "createTime.H"

applications/solvers/combustion/PDRFoam/PDRFoam.C

@@ -86,6 +86,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for compressible premixed/partially-premixed combustion with"
+        " turbulence modelling."
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"

applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C

@@ -71,6 +71,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for compressible premixed/partially-premixed combustion with"
+        " turbulence modelling."
+    );
+
     #include "setRootCase.H"
 
     #include "createTime.H"

applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C

@@ -67,6 +67,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for compressible premixed/partially-premixed combustion with"
+        " turbulence modelling."
+    );
+
     #include "postProcess.H"
 
     #include "setRootCase.H"

applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C

@@ -65,6 +65,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for compressible premixed/partially-premixed combustion with"
+        " turbulence modelling in internal combustion engines."
+    );
+
     #define CREATE_TIME createEngineTime.H
     #define CREATE_MESH createEngineMesh.H
     #include "postProcess.H"

applications/solvers/combustion/XiFoam/XiFoam.C

@@ -65,6 +65,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for compressible premixed/partially-premixed combustion with"
+        " turbulence modelling."
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"

applications/solvers/combustion/chemFoam/chemFoam.C

@@ -32,7 +32,6 @@ Description
     provide comparison against other chemistry solvers, that uses a single cell
     mesh, and fields created from the initial conditions.
 
-
 \*---------------------------------------------------------------------------*/
 
 #include "fvCFD.H"
@@ -49,6 +48,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for chemistry problems, designed for use on single cell cases"
+        " to provide comparison against other chemistry solvers"
+    );
+
     argList::noParallel();
 
     #define CREATE_MESH createSingleCellMesh.H

applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C

@@ -45,6 +45,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for cold-flow in internal combustion engines."
+    );
+
     #define CREATE_TIME createEngineTime.H
     #define CREATE_MESH createEngineMesh.H
     #include "postProcess.H"

applications/solvers/combustion/fireFoam/fireFoam.C

@@ -50,6 +50,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Transient solver for fires and turbulent diffusion flames"
+        " with reacting particle clouds, surface film and pyrolysis modelling."
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"

applications/solvers/combustion/reactingFoam/reactingFoam.C

@@ -47,6 +47,11 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for combustion with chemical reactions"
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"

applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C

@@ -28,7 +28,7 @@ Group
     grpCombustionSolvers
 
 Description
-    Solver for combustion with chemical reactions using a density based
+    Solver for combustion with chemical reactions using a density-based
     thermodynamics package with enhanced buoyancy treatment.
 
 \*---------------------------------------------------------------------------*/
@@ -47,6 +47,13 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for combustion with chemical reactions using density-based"
+        " thermodynamics package,"
+        " with enhanced buoyancy treatment."
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"

applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C

@@ -28,7 +28,7 @@ Group
     grpCombustionSolvers
 
 Description
-    Solver for combustion with chemical reactions using density based
+    Solver for combustion with chemical reactions using density-based
     thermodynamics package.
 
 \*---------------------------------------------------------------------------*/
@@ -48,6 +48,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Solver for combustion with chemical reactions using density-based"
+        " thermodynamics package."
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"

applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C

@@ -28,8 +28,9 @@ Group
     grpCompressibleSolvers grpMovingMeshSolvers
 
 Description
-    Density-based compressible flow solver based on central-upwind schemes of
-    Kurganov and Tadmor with support for mesh-motion and topology changes.
+    Density-based compressible flow solver based on central-upwind
+    schemes of Kurganov and Tadmor
+    with support for mesh-motion and topology changes.
 
 \*---------------------------------------------------------------------------*/
 
@@ -47,6 +48,13 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Density-based compressible flow solver based on central-upwind"
+        " schemes of Kurganov and Tadmor.\n"
+        "With support for mesh-motion and topology changes."
+    );
+
     #define NO_CONTROL
     #include "postProcess.H"
 

applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C

@@ -28,8 +28,8 @@ Group
     grpCompressibleSolvers
 
 Description
-    Density-based compressible flow solver based on central-upwind schemes of
-    Kurganov and Tadmor.
+    Density-based compressible flow solver based on central-upwind
+    schemes of Kurganov and Tadmor.
 
 \*---------------------------------------------------------------------------*/
 
@@ -45,6 +45,12 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Density-based compressible flow solver based on central-upwind"
+        " schemes of Kurganov and Tadmor."
+    );
+
     #define NO_CONTROL
     #include "postProcess.H"
 

applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C

@@ -58,6 +58,13 @@ Description
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Transient solver for laminar or turbulent flow"
+        " of weakly compressible fluids for low Mach number"
+        " aeroacoustic applications."
+    );
+
     #include "postProcess.H"
 
     #include "addCheckCaseOptions.H"