diff --git a/applications/solvers/DNS/dnsFoam/dnsFoam.C b/applications/solvers/DNS/dnsFoam/dnsFoam.C
index e7011cdb75b4eb83e34de6f6205015b34068a4da..28230c4db958a73904e205bbbded653fcf8236e0 100644
--- a/applications/solvers/DNS/dnsFoam/dnsFoam.C
+++ b/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"
diff --git a/applications/solvers/basic/laplacianFoam/laplacianFoam.C b/applications/solvers/basic/laplacianFoam/laplacianFoam.C
index 9bffe121d4e9e5ddf8fbba153bf34e9e1d39b651..251915b6d5d67e5c6cdab404ba1b23ec317ba1b6 100644
--- a/applications/solvers/basic/laplacianFoam/laplacianFoam.C
+++ b/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"
diff --git a/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C b/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C
index 9a1c1018d9feaea600f031ddfbc6de71dcd670d9..5d890a2c0e03908b9cf17f83d017ecea809ace46 100644
--- a/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C
+++ b/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"
diff --git a/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C b/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C
index 839023cfeed1efeaf094b6f82883371a9da0f06e..5811771600ad0a883005c18a66c54a19e987cb28 100644
--- a/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C
+++ b/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",
diff --git a/applications/solvers/basic/potentialFoam/potentialFoam.C b/applications/solvers/basic/potentialFoam/potentialFoam.C
index 9cd095c95d29cdc563c0c8e3fbd187d15d5ca819..3a3922fd114c708e5187c85f83251b329a78666a 100644
--- a/applications/solvers/basic/potentialFoam/potentialFoam.C
+++ b/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",
diff --git a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C b/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C
index 6c2d703b937c5ff406787160164bc8cb011f544f..06fa8c4198d67cf43fd9c747db97f30f93b74ea3 100644
--- a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/PDRFoam/PDRFoam.C b/applications/solvers/combustion/PDRFoam/PDRFoam.C
index 41500249940fff736e7ae64f301d5d9750311c16..8dd5abac03b4109f8c193ceb279524977b4dd0b0 100644
--- a/applications/solvers/combustion/PDRFoam/PDRFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C b/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C
index ef1d103b98ec091b6e359ca744ee121a2fe43582..00fd303810f8343e6f3707798bf7be0c8908424a 100644
--- a/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C
+++ b/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"
diff --git a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C b/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C
index 2b4dc4f107ca7139d3afe96a26b951758ac31460..8799b80034a118e27889fbcd973d51b3778df00c 100644
--- a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C b/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C
index 4c9c461d5da48bac5907a76f7446386fbf822bb1..a2e0a3320f6f8672e7232b01dbec447d344aa970 100644
--- a/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/XiFoam/XiFoam.C b/applications/solvers/combustion/XiFoam/XiFoam.C
index 069c481eb5f75a4bd26b0a4c1790239ce9a893aa..5235ad21953c3bbef0d4f9f62761420c9c2ab8ef 100644
--- a/applications/solvers/combustion/XiFoam/XiFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/chemFoam/chemFoam.C b/applications/solvers/combustion/chemFoam/chemFoam.C
index c053395cd0d9238325b038c511d7ff9017c6a7f2..8caf77ae1b19b758c896df549d54211b30bf7653 100644
--- a/applications/solvers/combustion/chemFoam/chemFoam.C
+++ b/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
diff --git a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C b/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C
index cd1f853c254bc4f6a5373e3004e6b3de8f04f834..70a3303cd2081ca7152e72896041fdfaf21a325a 100644
--- a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/fireFoam/fireFoam.C b/applications/solvers/combustion/fireFoam/fireFoam.C
index 0559abf21eda93a921525b3eddf8bd33a41a80d8..2498023e509a79cbaacdf3e3b163ea8a9efd2e5b 100644
--- a/applications/solvers/combustion/fireFoam/fireFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/reactingFoam/reactingFoam.C b/applications/solvers/combustion/reactingFoam/reactingFoam.C
index 0092fe97a5fcfd08cdac69d48666f4c993e9eb3e..d8bca088c8b7c305556dd01f1e0aa04423d6449b 100644
--- a/applications/solvers/combustion/reactingFoam/reactingFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C
index cca3dd36ddd75e8645d7e419edb7f75837487af5..e5f998d44be48866be15904a495dd96b0b935766 100644
--- a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C
+++ b/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"
diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C
index bc47c57f850aae5cce99ab5ec42e468fc147fef9..bf9988b2cb68d9cd77c2d8eb1c704188d314df50 100644
--- a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C
+++ b/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"
diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C
index f30c7784880b8bac2c6cffacbea77c5dd75843cb..e4eff920de5693ee495de6163174ec1d14fe296e 100644
--- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C
+++ b/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"
diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C
index 89066b01c931807380c9811f7d433813ed02962c..f0dc1a37ddbffa9ca797b7a3bf7f4e638a09bb5c 100644
--- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C
+++ b/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"
diff --git a/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C b/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C
index 1a21d32d225fdad0ddd008889459a2327fa5d8b8..83a16ef3fa39908a45f1a72aea8d98b205f8b1b5 100644
--- a/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C
+++ b/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"
diff --git a/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C b/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C
index b8439d075a3c4449d65d498b7fd0017be77a6a91..02021577328c8d8e155c681144f779a35be45a8d 100644
--- a/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C
+++ b/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C
@@ -54,6 +54,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible turbulent flow.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createDynamicFvMesh.H"
diff --git a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C
index 8ce729365b31159d28becb203c44aba4a5ca9f28..c27f505131154b70f474c6aadaf9fc5583e45b8c 100644
--- a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C
+++ b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C
@@ -52,6 +52,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible turbulent flow.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C
index d72329b0f9baa593c7693c0560d4ce1cac47d7ca..54ce9757b4fcea3cb68f40a53f31b36b22581f2d 100644
--- a/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C
+++ b/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C
@@ -28,7 +28,7 @@ Group
grpCompressibleSolvers
Description
- Overset steady-state solver for turbulent flow of compressible fluids.
+ Overset steady-state solver for compressible turbulent flow.
\*---------------------------------------------------------------------------*/
@@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Overset steady-state solver for compressible turbulent flow"
+ );
+
#define CREATE_MESH createUpdatedDynamicFvMesh.H
#include "postProcess.H"
diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C
index 0283b3823aed59e6172aecf58a6058fd16f66982..5b388b9378e6fbeb3bfd3a6c122fa495e5eb2acb 100644
--- a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C
+++ b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C
@@ -28,8 +28,8 @@ Group
grpCompressibleSolvers
Description
- Steady-state solver for turbulent flow of compressible fluids, with
- implicit or explicit porosity treatment and optional sources.
+ Steady-state solver for compressible turbulent flow,
+ with implicit or explicit porosity treatment and optional sources.
\*---------------------------------------------------------------------------*/
@@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for compressible turbulent flow,"
+ "with implicit or explicit porosity treatment and optional sources."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C
index ae8252bbf5277a69848ee2efcad321e17d8df505..5dd4b215928a6192bca100ffae91f98237e78cb5 100644
--- a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C
+++ b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C
@@ -28,7 +28,7 @@ Group
grpCompressibleSolvers
Description
- Steady-state solver for turbulent flow of compressible fluids.
+ Steady-state solver for compressible turbulent flow.
\*---------------------------------------------------------------------------*/
@@ -43,6 +43,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for compressible turbulent flow."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C b/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C
index 748a455158f92a88bbf4c555cabaab70087be2c0..07852d4daf31c1d88cb3316b2f29bdb16222bb47 100644
--- a/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C
+++ b/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C
@@ -45,6 +45,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for trans-sonic/supersonic, turbulent flow"
+ " of a compressible gas.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/compressible/sonicFoam/sonicFoam.C b/applications/solvers/compressible/sonicFoam/sonicFoam.C
index 1ffbb6738fde7ab7170094f22a08356cb01566d4..bf7811e5fdda7a83299e19dd8cf6a1ee43a7b041 100644
--- a/applications/solvers/compressible/sonicFoam/sonicFoam.C
+++ b/applications/solvers/compressible/sonicFoam/sonicFoam.C
@@ -43,6 +43,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for trans-sonic/supersonic, turbulent flow"
+ " of a compressible gas."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C
index afe963d8cf3f17a59aaf50075f5406c390cc4237..98eb4f4dfd005af3b246011681038f73964631b6 100644
--- a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C
+++ b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C
@@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for trans-sonic/supersonic, laminar flow"
+ " of a compressible liquid."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
index 38eb94fc4d77115101ba41bc0fc99722b2bb11ed..ab51c1e6105f86ae16e087324ac7a91063ebc612 100644
--- a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
+++ b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
@@ -28,8 +28,8 @@ Group
grpDiscreteMethodsSolvers
Description
- Direct simulation Monte Carlo (DSMC) solver for, transient, multi-species
- flows.
+ Direct simulation Monte Carlo (DSMC) solver
+ for transient, multi-species flows.
\*---------------------------------------------------------------------------*/
@@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Direct simulation Monte Carlo (DSMC) solver"
+ " for transient, multi-species flows."
+ );
+
#define NO_CONTROL
#include "postProcess.H"
diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
index 3bb0a881c3f55f2c3b4e67942c4236a0aa89898a..45b47df9083cbed3e2d8ec57901a94b9459f131f 100644
--- a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
+++ b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
@@ -37,6 +37,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Equilibrate and/or precondition molecular dynamics systems."
+ );
+
#include "addCheckCaseOptions.H"
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
index a9bbd6d32f3e0c34e7b29c98181e49816f296256..351882182ccab84b9969276455309fa75f585440 100644
--- a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
+++ b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
@@ -39,6 +39,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Molecular dynamics solver for fluid dynamics."
+ );
+
#define NO_CONTROL
#include "postProcess.H"
diff --git a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C
index 075a4504415a232a42befa047bb2175d2a3a57c3..cd3fd4e9bcf11f92cb73d82e9957ed61f659f9a7 100644
--- a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C
+++ b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C
@@ -38,6 +38,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for electrostatics."
+ );
+
#include "addCheckCaseOptions.H"
#include "setRootCase.H"
diff --git a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C
index e0bc47fe530699e88a370b16d467bf0671a66d90..679c19536e04c6bae7e0fa59030564336ac010f3 100644
--- a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C
+++ b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C
@@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for the magnetic field generated by permanent magnets."
+ );
+
argList::addBoolOption
(
"noH",
diff --git a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C
index 1f9d4e1b8e67d53bb7e5125e30344a527ca0f5ce..d1c8a1f89dd8c29bffd22b2637eddce6869d7c6d 100644
--- a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C
+++ b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C
@@ -58,6 +58,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for magnetohydrodynamics (MHD):"
+ " incompressible, laminar flow of a conducting fluid"
+ " under the influence of a magnetic field."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/financial/financialFoam/financialFoam.C b/applications/solvers/financial/financialFoam/financialFoam.C
index c8e8e7b5d08861ba1d1a3b730f053d5c7eb8fd8f..0c21f956baa80505c553af0dca6d69d5d1085864 100644
--- a/applications/solvers/financial/financialFoam/financialFoam.C
+++ b/applications/solvers/financial/financialFoam/financialFoam.C
@@ -40,6 +40,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solves the Black-Scholes equation to price commodities."
+ );
+
#define NO_CONTROL
#include "postProcess.H"
diff --git a/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C b/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C
index 2f57e0b7a17d6bbedc086d91dc48bc725bf1fd3f..0287d535f7fc6cebbbbc6e640b9c052f21f9749b 100644
--- a/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C
+++ b/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C
@@ -47,6 +47,12 @@ Author
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for incompressible, laminar flow"
+ " of Newtonian fluids in liquid film formulation."
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createMesh.H"
diff --git a/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C b/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C
index daee7e9e592b7fb605f72a7b698725740dd79363..a49102f1753b8da129eec5069fb17a3526c26658 100644
--- a/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C
+++ b/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C
@@ -41,6 +41,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Passive finiteArea scalar transport on a sphere"
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createMesh.H"
diff --git a/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C b/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C
index 4a0d63a89c8eb6b7266a44b7c84d8f64328ff1ef..2057706aea9b9888beee446df665f0f667212c94 100644
--- a/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C
+++ b/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C
@@ -30,7 +30,7 @@ Group
grpFiniteAreaSolvers
Description
- Passive scalar transport equation solver.
+ Passive scalar transport finiteArea equation solver.
\heading Solver details
The equation is given by:
@@ -65,6 +65,11 @@ Author
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Passive scalar transport finiteArea equation solver."
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createMesh.H"
diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C
index c4b8df08f1302c365986124cf63937296cd4d449..760b4bda4e597b2657ed0fbdd2ec79360f490d43 100644
--- a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C
+++ b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C
@@ -59,6 +59,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for buoyant, turbulent flow"
+ " of incompressible fluids.\n"
+ "Uses the Boussinesq approximation."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C
index 8cc6523fc7597c467bedb55b59ffc3e04f84bf07..65f04204b1d1a356e8b97c1b7b72291943924ebb 100644
--- a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C
+++ b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C
@@ -59,6 +59,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for buoyant, turbulent flow"
+ " of incompressible fluids."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C
index 39de4d66704bc845eada7287b41ef990a88ec8e3..f8432dee50ada2071e283e10080baf360e5d1207 100644
--- a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C
+++ b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C
@@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for buoyant, turbulent fluid flow"
+ " of compressible fluids, including radiation."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C
index a8fc1a9f35e81e828377cbb64c36993a4d9d3998..8d0e60bfd8a5b78fbc093d59459229655568e937 100644
--- a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C
+++ b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C
@@ -44,6 +44,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for buoyant, turbulent fluid flow"
+ " of compressible fluids, including radiation."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C
index e1bf6692112d871fc0e2ada3e1aebb2bffa164dd..2fba8295db79e3cd020cb71b0f6f591a51d373fb 100644
--- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C
+++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C
@@ -54,6 +54,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for buoyant, turbulent fluid flow and solid heat"
+ " conduction with conjugate heat transfer"
+ " between solid and fluid regions."
+ );
+
#define NO_CONTROL
#define CREATE_MESH createMeshesPostProcess.H
#include "postProcess.H"
diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C
index 12c7ac5514f6f54594cc46b57aad29fa7662409e..25faa39de73ad221f712307d564e8449fd59fa3e 100644
--- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C
+++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C
@@ -48,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for buoyant, turbulent fluid flow and solid heat"
+ " conduction with conjugate heat transfer"
+ " between solid and fluid regions."
+ );
+
#define NO_CONTROL
#define CREATE_MESH createMeshesPostProcess.H
#include "postProcess.H"
diff --git a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C
index ea210163c02dd37a25b5d02e9b22e9673de83da0..ecb753d38282fe17bc75b7213c4bb0b4ec81a7da 100644
--- a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C
+++ b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C
@@ -45,6 +45,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for energy transport and thermodynamics on a frozen flow field"
+ );
+
#define NO_CONTROL
#include "postProcess.H"
diff --git a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C
index 3094f0c7191b8769057d1e4c1b2a2470c3c480a8..9bdca6d9393577a1c167b774a0ba771cd7564e11 100644
--- a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C
+++ b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C
@@ -72,6 +72,13 @@ void zeroCells
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for incompressible, turbulent flow"
+ " of non-Newtonian fluids with duct shape optimisation"
+ " by applying 'blockage' in regions causing pressure loss"
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C
index d9ec41c0ab7acb57ebf648ef74a1ec1046ee8ae6..53e2ed6422e1715b911b8b9096660c2d8e66fdb6 100644
--- a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C
+++ b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C
@@ -28,8 +28,8 @@ Group
grpIncompressibleSolvers
Description
- Steady-state solver for incompressible, 1D turbulent flow, typically to
- generate boundary layer conditions at an inlet.
+ Steady-state solver for incompressible, 1D turbulent flow,
+ typically to generate boundary layer conditions at an inlet.
Boundary layer code to calculate the U, k and epsilon distributions.
Used to create inlet boundary conditions for experimental comparisons
@@ -49,6 +49,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for incompressible, 1D turbulent flow,"
+ " typically to generate boundary layer conditions at an inlet."
+ );
+
argList::noParallel();
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/icoFoam/icoFoam.C b/applications/solvers/incompressible/icoFoam/icoFoam.C
index eab1372654016e8722695676df5fe2853c52af99..6e07a47e33ad330d61dab7b7e1c787dcd9db10ae 100644
--- a/applications/solvers/incompressible/icoFoam/icoFoam.C
+++ b/applications/solvers/incompressible/icoFoam/icoFoam.C
@@ -67,6 +67,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for incompressible, laminar flow"
+ " of Newtonian fluids."
+ );
+
#include "addCheckCaseOptions.H"
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C
index 71656d352716e1c18885e981889ccf0ad909216a..da675122f8e671c2e7461dc602f40ae1e6e715a9 100644
--- a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C
+++ b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C
@@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for incompressible laminar flow"
+ " of non-Newtonian fluids."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C
index 3fd55b434d1e6e84393ea21b77427eadd013b75f..3bb41802dac2ca4a10a7ac1e2499065bb16f031f 100644
--- a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C
+++ b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C
@@ -28,8 +28,8 @@ Group
grpIncompressibleSolvers
Description
- Large time-step transient solver for incompressible, turbulent flow in a
- single rotating frame.
+ Large time-step transient solver for incompressible flow
+ in a single rotating frame.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@@ -46,6 +46,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Large time-step transient solver for incompressible flow"
+ " in a single rotating frame."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C b/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C
index 4084953c8eee3af3a2c3739409b7e29b21115ccb..75f02c44cc92d01f7b2fd6fb3e0781ba1e5877ca 100644
--- a/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C
+++ b/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C
@@ -28,7 +28,7 @@ Group
grpIncompressibleSolvers grpMovingMeshSolvers
Description
- Transient solver for incompressible, flow of Newtonian fluids
+ Transient solver for incompressible flow of Newtonian fluids
on a moving mesh using the PIMPLE (merged PISO-SIMPLE) algorithm.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@@ -54,6 +54,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for incompressible, turbulent flow"
+ " on a moving mesh."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C
index e12c04827ff4bebdf8a9ce0b0416c31e9da91e7d..9f801ddfe10056aa5db8b1aca4fce8b70e606bf6 100644
--- a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C
+++ b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C
@@ -79,6 +79,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for incompressible, turbulent flow"
+ " of Newtonian fluids on a moving mesh."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/pisoFoam/pisoFoam.C b/applications/solvers/incompressible/pisoFoam/pisoFoam.C
index d2e3efd2fbc25f30d97f71c427553f0289fcedb9..dac62ec676c3fc769c63b1fc4563fe33a8e186ac 100644
--- a/applications/solvers/incompressible/pisoFoam/pisoFoam.C
+++ b/applications/solvers/incompressible/pisoFoam/pisoFoam.C
@@ -75,6 +75,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for incompressible, turbulent flow,"
+ " using the PISO algorithm."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
index fa643a7a473741d70a25fce52e54a385cb16ecb8..dd3d5b10eb73eb0ddc596400ae2b91d635ef6391 100644
--- a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
+++ b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
@@ -42,6 +42,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for inviscid shallow-water equations with rotation"
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C
index 4b0cbe1547b5360d360a89d2c8fabd75e8eaafc7..2a61cae4998d0e8be1a31036e9aee051d84f62bf 100644
--- a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C
+++ b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C
@@ -44,6 +44,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for incompressible, turbulent flow"
+ " of non-Newtonian fluids in a single rotating frame."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C
index 6a4bf928cfa366e9a19a7f57946825d93fc32b5c..c97cd245065206b6fd21421824183e0fda9f74f0 100644
--- a/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C
+++ b/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C
@@ -79,6 +79,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for incompressible, turbulent flow"
+ );
+
#define CREATE_MESH createUpdatedDynamicFvMesh.H
#include "postProcess.H"
diff --git a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C
index 909a5b61b539eb69484e0c360e0d65f4ccf721af..e4649d2839fbc745bd2c3a6eff9409f768358164 100644
--- a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C
+++ b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C
@@ -45,6 +45,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for incompressible, turbulent flow with"
+ "implicit/explicit porosity treatment\n"
+ "With MRF support."
+ );
+
#define CREATE_FIELDS_2 createPorousZones.H
#include "postProcess.H"
diff --git a/applications/solvers/incompressible/simpleFoam/simpleFoam.C b/applications/solvers/incompressible/simpleFoam/simpleFoam.C
index 839dd3ddd6d2d127a35d8910fedfe6971cc7c1fe..964f3833401a9558a79e887e0b09a1f391b44357 100644
--- a/applications/solvers/incompressible/simpleFoam/simpleFoam.C
+++ b/applications/solvers/incompressible/simpleFoam/simpleFoam.C
@@ -28,7 +28,7 @@ Group
grpIncompressibleSolvers
Description
- Steady-state solver for incompressible flows with turbulence modelling.
+ Steady-state solver for incompressible, turbulent flows.
\heading Solver details
The solver uses the SIMPLE algorithm to solve the continuity equation:
@@ -71,6 +71,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for incompressible, turbulent flows."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C b/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C
index c1d24729214e0a9a006ac894ad4fcecbad5adae9..1bdb4cdb16da4d86c2894f469bd5790f0f7d9401 100644
--- a/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C
+++ b/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C
@@ -48,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for the coupled transport of a"
+ " single kinematic particle cloud including the effect"
+ " of the volume fraction of particles on the continuous phase.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
argList::addOption
(
"cloudName",
diff --git a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C
index 0ca222fa48c93c06de95bfb024321f2ec957e5e1..84f0b1220071a9ad68f2c50b183ed4d20c763a9e 100644
--- a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C
+++ b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C
@@ -49,6 +49,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for the coupled transport of a"
+ " single kinematic particle cloud including the effect"
+ " of the volume fraction of particles on the continuous phase."
+ );
argList::addOption
(
"cloud",
diff --git a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C
index a6f89528ab9aa59a1318c803eced14ce332364d8..4fd9a7ee64bbc98b650504dc091fdd07f333f039 100644
--- a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C
+++ b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C
@@ -51,6 +51,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible, turbulent flow"
+ " with coal and limestone clouds, energy sources and combustion."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C
index 418935b5c744927935ec6599cff55a1da35a7dbd..325be06b14f7796e32cc9de5f482298cf2e54e3e 100644
--- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C
+++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C
@@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for the passive transport"
+ " of a single kinematic particle cloud.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
argList::addOption
(
"cloud",
diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C
index 775e12099b59d12c04a2357acb6571500780c2b8..d44fce500a005b329eecb6f0cd7764678f2aaece 100644
--- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C
+++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C
@@ -44,6 +44,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for the passive transport"
+ " of a single kinematic particle cloud"
+ );
argList::addOption
(
"cloud",
diff --git a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C
index e8bf3113924930efb8046abf851f633be05694c5..0a974bf0821733b2d79fd9d8cbf7aaf1b27db08c 100644
--- a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C
+++ b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C
@@ -51,6 +51,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible, turbulent flow"
+ " with reacting, multiphase particle clouds"
+ " and surface film modelling."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C
index 00cdee6b1c1b80eb1f6b3596352e5efb97982860..809e15b2241f4c8a81038b304e7ef8d303e59d5b 100644
--- a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C
+++ b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C
@@ -25,7 +25,7 @@ Application
simpleReactingParcelFoam
Description
- Steady state solver for compressible, turbulent flow with reacting,
+ Steady-state solver for compressible, turbulent flow with reacting,
multiphase particle clouds and optional sources/constraints.
\*---------------------------------------------------------------------------*/
@@ -54,6 +54,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for compressible, turbulent flow"
+ " with reacting, multiphase particle clouds"
+ " and optional sources/constraints."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C b/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C
index 5c2a11b43ba7f7cf27552b414e5e34780c3630aa..69c432bcc4031bca5f8fb33ba33fea36a7664602 100644
--- a/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C
+++ b/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C
@@ -28,7 +28,7 @@ Group
grpLagrangianSolvers
Description
- Steady state solver for compressible, turbulent flow with coal particle
+ Steady-state solver for compressible, turbulent flow with coal particle
clouds and optional sources/constraints.
\*---------------------------------------------------------------------------*/
@@ -49,6 +49,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state solver for compressible, turbulent flow"
+ " with coal particle clouds and optional sources/constraints."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C b/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C
index d1f28f1f00e8a7d6b7cdd7e98aa0b6b3dcc3276a..64ed862cb695f525afe4927ae169c290c6559a18 100644
--- a/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C
+++ b/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C
@@ -46,6 +46,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible, turbulent engine flow"
+ " with a spray particle cloud."
+ );
+
#define CREATE_TIME createEngineTime.H
#define CREATE_MESH createEngineMesh.H
#include "postProcess.H"
diff --git a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C
index 13804c76cabec5993c966e7e8c509f81ea410cc0..7cb9d3d91026a4d7607fd8a19e69e3a360712b7c 100644
--- a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C
+++ b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C
@@ -49,6 +49,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible, turbulent flow"
+ " with a spray particle cloud.\n"
+ "With optional mesh motion and mesh topology changes.\n"
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C
index 3a7ded9055ef1af7627236d205949e906ac6bcc0..ee1c1c1596aa2a88bef308e4dd240562869ddd8b 100644
--- a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C
+++ b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C
@@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for compressible, turbulent flow"
+ " with a spray particle cloud."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C
index 81b323c5d34c4d9a51059146e293d0d69d3a5620..3d27c93a6c37479a98b550ecf438a2f2ec3c5d9f 100644
--- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C
+++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C
@@ -27,7 +27,7 @@ Application
Description
Transient solver for the passive transport of a particle cloud.
- Uses a pre- calculated velocity field to evolve the cloud.
+ Uses a pre-calculated velocity field to evolve the cloud.
\*---------------------------------------------------------------------------*/
@@ -41,6 +41,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for the passive transport of a particle cloud"
+ " with optional mesh motion"
+ "Uses a pre-calculated velocity field to evolve the cloud."
+ );
argList::addOption
(
"cloudName",
diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
index 4ac6e57a65193c0dc26ffce2d05f4043462e5d9e..4c0f64db559ddc0ec710cafbc732e1279abb7f3f 100644
--- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
+++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
@@ -30,7 +30,7 @@ Group
Description
Transient solver for the passive transport of a particle cloud.
- Uses a pre- calculated velocity field to evolve the cloud.
+ Uses a pre-calculated velocity field to evolve the cloud.
\*---------------------------------------------------------------------------*/
@@ -43,6 +43,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient solver for the passive transport of a particle cloud.\n"
+ "Uses a pre-calculated velocity field to evolve the cloud."
+ );
argList::addOption
(
"cloud",
diff --git a/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C b/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C
index d88736572a260db7fe2a08c3ad70d5e6da066965..2e3858251cacc0bc772f5c6511a9f3d316140235 100644
--- a/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C
+++ b/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C
@@ -25,7 +25,7 @@ Application
MPPICInterFoam
Description
- Solver for 2 incompressible, isothermal immiscible fluids using a VOF
+ Solver for two incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
momentum equation is solved.
@@ -56,6 +56,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, isothermal immiscible fluids using"
+ " VOF phase-fraction based interface capturing.\n"
+ "Includes MRF and an MPPIC cloud."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C
index 71012644e72ed0a4d6d18a7cb9b5f67f8c41fac5..788d71701275ed159c849831de265c587a907d7e 100644
--- a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C
+++ b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C
@@ -28,8 +28,8 @@ Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
- Transient cavitation code based on the homogeneous equilibrium model
- from which the compressibility of the liquid/vapour "mixture" is obtained,
+ Transient cavitation solver based on the homogeneous equilibrium model
+ from which the compressibility of the liquid/vapour 'mixture' is obtained,
with optional mesh motion and mesh topology changes.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@@ -48,6 +48,14 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient cavitation solver based on the homogeneous equilibrium"
+ " model from which the compressibility of the liquid/vapour 'mixture'"
+ " is obtained.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C
index 5dcea1f0c173fc9bc9cd97c181626bccb808a1ab..5d27662009d37ad5579d6f73796ce67d25849c97 100644
--- a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C
+++ b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C
@@ -28,8 +28,8 @@ Group
grpMultiphaseSolvers
Description
- Transient cavitation code based on the homogeneous equilibrium model
- from which the compressibility of the liquid/vapour "mixture" is obtained.
+ Transient cavitation solver based on the homogeneous equilibrium model
+ from which the compressibility of the liquid/vapour 'mixture' is obtained.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient cavitation solver based on the homogeneous equilibrium"
+ " model from which the compressibility of the liquid/vapour 'mixture'"
+ " is obtained."
+ );
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C
index 26858eea900035ca0412e4bf30530fcf87a1ee4a..8799c3384e3c94e5c431ad5f9b09d6858ded692d 100644
--- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C
+++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C
@@ -25,7 +25,7 @@ Application
compressibleInterDyMFoam
Description
- Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
+ Solver for two compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,
with optional mesh motion and mesh topology changes including adaptive
re-meshing.
@@ -54,6 +54,14 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two compressible, non-isothermal immiscible fluids"
+ " using VOF phase-fraction based interface capturing.\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C
index 1d169e30d4bf739d34bc6eb45b3291023c1106f3..ff701f853e25c01a677858a519af741ca71e7fe9 100644
--- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C
+++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C
@@ -25,7 +25,7 @@ Application
compressibleInterFoam
Description
- Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
+ Solver for two compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
@@ -53,6 +53,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two compressible, non-isothermal immiscible fluids"
+ " using VOF phase-fraction based interface capturing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
index 7604768d8d1ae374a16bef573a2f4456e7eb3ecd..f96daf82c433757e03dd0b45de970a3a30b1be19 100644
--- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
+++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
+ Solver for two compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
@@ -56,6 +56,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two compressible, non-isothermal immiscible fluids"
+ " using VOF phase-fraction based interface capturing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C
index fef72cbb7af38e948511389dc7a214fd28b7dd13..2481677353c58b7b8ec3359800eeb25623110b26 100644
--- a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C
+++ b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for n compressible, non-isothermal immiscible fluids using a VOF
+ Solver for N compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
@@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for N compressible, non-isothermal immiscible fluids"
+ " using VOF phase-fraction based interface capturing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C
index 6034716845992b2d70e85d33e7fd044e2b646292..2c178ea557dd40bc86fd39ff3cd7ce4b53b26128 100644
--- a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C
+++ b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C
@@ -28,11 +28,11 @@ Group
grpMultiphaseSolvers
Description
- Solver for 2 incompressible fluids using the mixture approach with the
- drift-flux approximation for relative motion of the phases.
+ Solver for two incompressible fluids using the mixture approach with
+ the drift-flux approximation for relative motion of the phases.
- Used for simulating the settling of the dispersed phase and other similar
- separation problems.
+ Used for simulating the settling of the dispersed phase and other
+ similar separation problems.
\*---------------------------------------------------------------------------*/
@@ -52,6 +52,14 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible fluids using the mixture approach with"
+ " the drift-flux approximation for relative motion of the phases.\n"
+ "Used for simulating the settling of the dispersed phase and other"
+ " similar separation problems."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C b/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C
index a3de274602b1453a747719f80b8d382ce68d735a..3791fc60f26abfef17897445d425e7e320883bb4 100644
--- a/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C
+++ b/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for n incompressible, non-isothermal immiscible fluids with
+ Solver for N incompressible, non-isothermal immiscible fluids with
phase-change. Uses a VOF (volume of fluid) phase-fraction based interface
capturing approach.
@@ -55,6 +55,15 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for N incompressible, non-isothermal immiscible fluids with"
+ " phase-change,"
+ " using VOF phase-fraction based interface capturing.\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C b/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C
index 6e28f57f5d68dc54f3013ce340477a67d5342a39..5bd2767e3ed804b4278d1b9c963a191bec07eac4 100644
--- a/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C
+++ b/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for 2 incompressible, non-isothermal immiscible fluids with
+ Solver for two incompressible, non-isothermal immiscible fluids with
phase-change (evaporation-condensation) between a fluid and its vapour.
Uses a VOF (volume of fluid) phase-fraction based interface capturing
approach.
@@ -56,6 +56,15 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, non-isothermal immiscible fluids with"
+ " phase-change,"
+ " using VOF phase-fraction based interface capturing.\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/interFoam/interFoam.C b/applications/solvers/multiphase/interFoam/interFoam.C
index 5b8d2e8b3e54706b2a23db799127037f5d8ff563..154f85c1deef21cbd44c709cd822319c7bfd68b9 100644
--- a/applications/solvers/multiphase/interFoam/interFoam.C
+++ b/applications/solvers/multiphase/interFoam/interFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for 2 incompressible, isothermal immiscible fluids using a VOF
+ Solver for two incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,
with optional mesh motion and mesh topology changes including adaptive
re-meshing.
@@ -53,6 +53,14 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, isothermal immiscible fluids"
+ " using VOF phase-fraction based interface capturing.\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C
index a065444dde15bd436ee2a8509a3e52cc5ec2841e..54cfe26f7d3fe696967e1585bdff1b8b66688204 100644
--- a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C
+++ b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C
@@ -50,6 +50,14 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for three incompressible fluids (two of which are immiscible)"
+ " using VOF phase-fraction based interface capturing.\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C b/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C
index 7f1df58eb95f876f7b4486d01eef4bedd76d4393..fbcc6ee8e1f4e1e951c5bcfe88f98be35e403cfc 100644
--- a/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C
+++ b/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
- Solver for 2 incompressible, isothermal immiscible fluids using a VOF
+ Solver for two incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,
with optional mesh motion and mesh topology changes including adaptive
re-meshing.
@@ -59,6 +59,14 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, isothermal immiscible fluids using"
+ " VOF phase-fraction based interface capturing\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C b/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C
index b7d12f5741518aa1b46969e9a55a9c561dcab9cb..131cebd555cbdd6c93b470c219039e38ff7b49a5 100644
--- a/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C
+++ b/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C
@@ -31,7 +31,7 @@ Group
grpMultiphaseSolvers
Description
- Solver derived from interFoam for 2 incompressible, isothermal immiscible
+ Solver derived from interFoam for two incompressible, isothermal immiscible
fluids using the isoAdvector phase-fraction based interface capturing
approach, with optional mesh motion and mesh topology changes including
adaptive re-meshing.
@@ -66,6 +66,15 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, isothermal immiscible fluids"
+ " using isoAdvector phase-fraction based interface capturing.\n"
+ "With optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing.\n"
+ "The solver is derived from interFoam"
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C
index 87e960fd6371e97080d812b1a79b5d9dfaad3054..dd80f4dc1439b29e5344202147a3c5e5d4894d5a 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C
+++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C
@@ -28,10 +28,11 @@ Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
- Solver for 2 incompressible, isothermal immiscible fluids with phase-change
- (e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based
- interface capturing approach, with optional mesh motion and mesh topology
- changes including adaptive re-meshing.
+ Solver for two incompressible, isothermal immiscible fluids with
+ phase-change (e.g. cavitation).
+ Uses VOF (volume of fluid) phase-fraction based interface capturing,
+ with optional mesh motion and mesh topology changes including
+ adaptive re-meshing.
The momentum and other fluid properties are of the "mixture" and a
single momentum equation is solved.
@@ -59,6 +60,15 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, isothermal immiscible fluids with"
+ " phase-change.\n"
+ "Uses VOF (volume of fluid) phase-fraction based interface capturing,"
+ " with optional mesh motion and mesh topology changes including"
+ " adaptive re-meshing."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
index 2fe1e45038eea9b871f4d509739398c3e1798aba..6009d9ea87ea71f2843d3181b6d32aa03cd09393 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
+++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
@@ -28,9 +28,9 @@ Group
grpMultiphaseSolvers
Description
- Solver for 2 incompressible, isothermal immiscible fluids with phase-change
- (e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based
- interface capturing approach.
+ Solver for two incompressible, isothermal immiscible fluids with
+ phase-change (e.g. cavitation).
+ Uses VOF (volume of fluid) phase-fraction based interface capturing.
The momentum and other fluid properties are of the "mixture" and a
single momentum equation is solved.
@@ -56,6 +56,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for two incompressible, isothermal immiscible fluids with"
+ " phase-change.\n"
+ "Uses VOF (volume of fluid) phase-fraction based interface capturing."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C
index 4d42facea1ff9bb94a5e805132d398b9c7c1574d..8dcbd7ed1d2ef9378119821e3d2e68de4ff62897 100644
--- a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C
+++ b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C
@@ -48,6 +48,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for a system of many compressible fluid phases including"
+ " heat-transfer."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
index 478dcccdb17d442bb7b3aabaee2690e92893e67d..85f5813843d5cd63ba5614265b8e7f97b552812d 100644
--- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
+++ b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for n incompressible fluids which captures the interfaces and
+ Solver for N incompressible fluids which captures the interfaces and
includes surface-tension and contact-angle effects for each phase, with
optional mesh motion and mesh topology changes.
@@ -48,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for N incompressible fluids which captures the interfaces and"
+ " includes surface-tension and contact-angle effects for each phase.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C
index 9c0bb8d4c3cc54060fe76e6e1b12b24c05122c7b..b4cf64fd24d7f6203f28e574542eb06a16c71f3b 100644
--- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C
+++ b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C
@@ -53,6 +53,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Incompressible Navier-Stokes solver with inclusion of a wave height"
+ " field to enable single-phase free-surface approximations.\n"
+ "With optional mesh motion and mesh topology changes."
+ );
+
#include "postProcess.H"
#include "setRootCase.H"
diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C
index e7502f67e068777251e0ee1511360ca5acfcffd2..4eec2e5f96ab987888c0f1dd174f17569bf157d6 100644
--- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C
+++ b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C
@@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Incompressible Navier-Stokes solver with inclusion of a wave height"
+ " field to enable single-phase free-surface approximations."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
index 4eeaa5ab1f26549e0f893370252467f2e25efa0b..b9ea18cf24ba16cd220b15cfb10a666a340f2808 100644
--- a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
+++ b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
@@ -46,6 +46,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for a system of any number of compressible fluid phases with a"
+ " common pressure, but otherwise separate properties."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
index c4c49f3a09c7954c28d38bec961ec29978293d46..01e0307fb39fb7f777ebaa6eb3cfb0e702a17f67 100644
--- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
+++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for a system of 2 compressible fluid phases with a common pressure,
+ Solver for a system of two compressible fluid phases with a common pressure,
but otherwise separate properties. The type of phase model is run time
selectable and can optionally represent multiple species and in-phase
reactions. The phase system is also run time selectable and can optionally
@@ -75,6 +75,12 @@ namespace Foam
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for a system of two compressible fluid phases with a"
+ " common pressure, but otherwise separate properties."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
index 0df1d48c5fac45af92e7b240621d0dbdc97cb221..0fcbfbac1f25d7b0b0b9071f5b19cd92c2b64cd5 100644
--- a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
+++ b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
@@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
- Solver for mixing 2 incompressible fluids.
+ Solver for mixing two incompressible fluids.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@@ -45,6 +45,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for mixing two incompressible fluids"
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C
index 9ad83f527587abcea4b29b30daed1e5b00a60e7c..bc213139efd1c1f7540f531ec1888bc953c38b6c 100644
--- a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C
+++ b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C
@@ -28,8 +28,8 @@ Group
grpMultiphaseSolvers
Description
- Solver for a system of 2 compressible fluid phases with one phase
- dispersed, e.g. gas bubbles in a liquid including heat-transfer.
+ Solver for a system of two compressible fluid phases with one dispersed
+ phase. Eg, gas bubbles in a liquid including heat-transfer.
\*---------------------------------------------------------------------------*/
@@ -44,6 +44,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Solver for a system of two compressible fluid phases with one"
+ " dispersed phase.\n"
+ "Eg, gas bubbles in a liquid including heat-transfer."
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C
index eb5707d2922a39ce4eec5c0a2c4f662bae65befe..2e053d859033ee3cd6c06e19ab92b7d2bf4cffc2 100644
--- a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C
+++ b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C
@@ -44,6 +44,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Transient segregated finite-volume solver of linear-elastic,"
+ " small-strain deformation of a solid body, with optional thermal"
+ " diffusion and thermal stresses"
+ );
+
#include "postProcess.H"
#include "addCheckCaseOptions.H"
diff --git a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C
index 29e8b701084b90c4eb1253b147ff9877833368f0..5a92ca839fe0e5fa93ca46d11d8d99e8debb3611 100644
--- a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C
+++ b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C
@@ -44,6 +44,13 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Steady-state segregated finite-volume solver of linear-elastic,"
+ " small-strain deformation of a solid body, with optional thermal"
+ " diffusion and thermal stresses"
+ );
+
#define NO_CONTROL
#include "postProcess.H"
diff --git a/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C b/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C
index 29e7fd8c154e33ec0d169cacf76a94cce6111da7..a0c307ea6ae4f1b25022c2eac8770f3a554448c0 100644
--- a/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C
+++ b/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C
@@ -27,7 +27,7 @@ Application
makeFaMesh
Description
- Check a Finite Area mesh
+ Check a finiteArea mesh
Author
Zeljko Tukovic, FAMENA
@@ -46,6 +46,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Check a finiteArea mesh"
+ );
+
#include "addRegionOption.H"
#include "setRootCase.H"
diff --git a/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C b/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C
index d9f1dea5f425a6202ee6d6fb78ad7081eac60363..fd556855de530a7e3e914060b3240ccf3fa2d0ba 100644
--- a/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C
+++ b/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C
@@ -27,7 +27,7 @@ Application
makeFaMesh
Description
- A mesh generator for finite area mesh.
+ A mesh generator for finiteArea mesh.
Author
Zeljko Tukovic, FAMENA
@@ -69,6 +69,11 @@ public:
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "A mesh generator for finiteArea mesh"
+ );
+
#include "addRegionOption.H"
argList::noParallel();
diff --git a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
index b54edbda5b1060525ab94bbed47b930967d8aa18..3aa52a84c10d2383155e3a46bf7ca70c31d2e7e3 100644
--- a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
+++ b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
@@ -614,6 +614,10 @@ label findPatch(const polyBoundaryMesh& patches, const word& patchName)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Mesh and field preparation utility for PDR type simulations."
+ );
#include "addOverwriteOption.H"
argList::noFunctionObjects(); // Never use function objects
diff --git a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
index f23d474a8389ce9bdc667c5318d3376c5f9c146e..7fbcb7c9bd2c4a7633cc10c54110756ff8ed0596 100644
--- a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
+++ b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
@@ -63,13 +63,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
- timeSelector::addOptions(true, false);
argList::addNote
(
"Collapses small edges to a point.\n"
"Optionally collapse small faces to a point and thin faces to an edge."
);
-
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
argList::addBoolOption
(
"collapseFaces",
diff --git a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
index 577f7435707a0aec108cfe2dcd29a4d905f04267..0b276b24b085027c145e2ad64d2c7ae930ff9a4d 100644
--- a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
+++ b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
@@ -28,7 +28,7 @@ Group
grpMeshAdvancedUtilities
Description
- Checks for multiple patch faces on same cell and combines them.
+ Checks for multiple patch faces on the same cell and combines them.
Multiple patch faces can result from e.g. removal of refined
neighbouring cells, leaving 4 exposed faces with same owner.
@@ -343,6 +343,11 @@ label mergeEdges(const scalar minCos, polyMesh& mesh)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Checks for multiple patch faces on the same cell and combines them."
+ );
+
#include "addOverwriteOption.H"
argList::addArgument("featureAngle [0..180]");
diff --git a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
index c522d8f48ab64861232280ecad54e2c70809156d..2c482069c7a1b4340a12c444cca13d795752f9fc 100644
--- a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
+++ b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
@@ -28,7 +28,7 @@ Group
grpMeshAdvancedUtilities
Description
- Manipulates mesh elements.
+ Manipulate mesh elements.
Actions are:
(boundary)points:
@@ -336,6 +336,11 @@ label findCell(const primitiveMesh& mesh, const point& nearPoint)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Manipulate mesh elements.\n"
+ "For example, moving points, splitting/collapsing edges etc."
+ );
#include "addOverwriteOption.H"
#include "addDictOption.H"
diff --git a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
index 5ea938de40d3bedddec89a621027fbff4e3e22e6..9946caf392c4e45b9810945b297e17529e7389c3 100644
--- a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
+++ b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
@@ -28,7 +28,7 @@ Group
grpMeshAdvancedUtilities
Description
- Refines a hex mesh by 2x2x2 cell splitting.
+ Refine a hex mesh by 2x2x2 cell splitting for the specified cellSet.
\*---------------------------------------------------------------------------*/
@@ -56,6 +56,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Refine a hex mesh by 2x2x2 cell splitting for the specified cellSet"
+ );
#include "addOverwriteOption.H"
#include "addRegionOption.H"
argList::addArgument("cellSet");
diff --git a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
index 0579c5ef694b33295c90ffc36f4bdbf90a53a34c..9c094f67bfef01e5bb0d8729b837a2dfb16c40b3 100644
--- a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
+++ b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
@@ -28,7 +28,7 @@ Group
grpMeshAdvancedUtilities
Description
- Utility to refine cells next to patches.
+ Refine cells next to specified patches.
Arguments:
1: List of patch name regular expressions
@@ -61,6 +61,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Refine cells next to specified patches.\n"
+ "The list of patches may contain regular expressions.\n"
+ );
+
#include "addOverwriteOption.H"
argList::addArgument("patches");
argList::addArgument("edgeFraction");
diff --git a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
index 44a4aabf25cfb2a7c44231839f56ece889d980d9..1e3b1522c51665f314b675d0fdc2bdc29b464dba 100644
--- a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
+++ b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
@@ -28,8 +28,8 @@ Group
grpMeshAdvancedUtilities
Description
- Tries to figure out what the refinement level is on refined cartesian
- meshes. Run BEFORE snapping.
+ Attempt to determine the refinement levels of a refined cartesian mesh.
+ Run BEFORE snapping.
Writes
- volScalarField 'refinementLevel' with current refinement level.
@@ -98,9 +98,14 @@ bool limitRefinementLevel
}
-
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Attempt to determine refinement levels of a refined cartesian mesh.\n"
+ "Run BEFORE snapping!"
+ );
+
argList::addBoolOption
(
"readLevel",
diff --git a/applications/utilities/mesh/advanced/removeFaces/removeFaces.C b/applications/utilities/mesh/advanced/removeFaces/removeFaces.C
index 19b3b3e548c1e2f950e55227a97d73a23479d652..2b41619c45e19eced605eac40cb422aa25a0697b 100644
--- a/applications/utilities/mesh/advanced/removeFaces/removeFaces.C
+++ b/applications/utilities/mesh/advanced/removeFaces/removeFaces.C
@@ -28,7 +28,7 @@ Group
grpMeshAdvancedUtilities
Description
- Utility to remove faces (combines cells on both sides).
+ Remove faces specified in faceSet by combining cells on both sides.
Takes faceSet of candidates for removal and writes faceSet with faces that
will actually be removed. (because e.g. would cause two faces between the
@@ -53,6 +53,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Remove faces specified in faceSet by combining cells on both sides"
+ );
#include "addOverwriteOption.H"
argList::addArgument("faceSet");
diff --git a/applications/utilities/mesh/advanced/selectCells/selectCells.C b/applications/utilities/mesh/advanced/selectCells/selectCells.C
index 31f918a9198908c841d1d0f6086fb20d2eed7e8c..077285c8d0fc22f135265831362443bdb41b2cea 100644
--- a/applications/utilities/mesh/advanced/selectCells/selectCells.C
+++ b/applications/utilities/mesh/advanced/selectCells/selectCells.C
@@ -335,6 +335,11 @@ label selectOutsideCells
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Select cells in relation to surface"
+ );
+
argList::noParallel();
#include "setRootCase.H"
diff --git a/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C b/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
index ee395ee80011a728eacff7d023691814e2cfd41a..aac8ee79f16c5b24843f472fdec4f85db188f720 100644
--- a/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
+++ b/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
@@ -28,7 +28,7 @@ Group
grpMeshAdvancedUtilities
Description
- Utility to refine cells near to a surface.
+ Refine cells near to a surface.
\*---------------------------------------------------------------------------*/
@@ -623,6 +623,10 @@ void classifyCells
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Refine cells near to a surface"
+ );
argList::noParallel();
#include "setRootCase.H"
diff --git a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
index d3fd7fe77238c433464a647abd98c9867cfb38ff..796de5b65c893548324a1a7f3e336cbfcfc92993 100644
--- a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
+++ b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts an ANSYS input mesh file, exported from I-DEAS,
+ Convert an ANSYS input mesh file (exported from I-DEAS)
to OpenFOAM format.
\*---------------------------------------------------------------------------*/
@@ -298,6 +298,12 @@ label findFace(const polyMesh& mesh, const face& f)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert an ANSYS input mesh file (exported from I-DEAS)"
+ " to OpenFOAM format"
+ );
+
argList::noParallel();
argList::addArgument("ANSYS input file");
argList::addOption
diff --git a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
index b0dc6584d15d43aae4f6cb865ffd18fcd8284f81..faf3277b8cce482e03d73453023e3351fcd5dfeb 100644
--- a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
+++ b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
@@ -86,7 +86,7 @@ int main(int argc, char *argv[])
"Translate OPENFOAM data to CCM format"
);
- Foam::timeSelector::addOptions();
+ timeSelector::addOptions();
argList::noParallel();
argList::addBoolOption
(
diff --git a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
index 484f5955a9cf49e6c889139880aa6ea8e226459a..dcc5dee8665733d335db31e6fc476f72587c6fb1 100644
--- a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
+++ b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts a CFX 4 mesh to OpenFOAM format.
+ Convert a CFX 4 mesh to OpenFOAM format.
\*---------------------------------------------------------------------------*/
@@ -48,6 +48,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a CFX 4 mesh to OpenFOAM format"
+ );
+
argList::noParallel();
argList::addArgument("CFX geom file");
argList::addOption
diff --git a/applications/utilities/mesh/conversion/datToFoam/datToFoam.C b/applications/utilities/mesh/conversion/datToFoam/datToFoam.C
index 8c295588fe601676bb3fa1553230d25fe79a68de..10269dfc924039bcb99d5cc28730c3e9dfa179d1 100644
--- a/applications/utilities/mesh/conversion/datToFoam/datToFoam.C
+++ b/applications/utilities/mesh/conversion/datToFoam/datToFoam.C
@@ -28,8 +28,8 @@ Group
grpMeshConversionUtilities
Description
- Reads in a datToFoam mesh file and outputs a points file. Used in
- conjunction with blockMesh.
+ Reads in a datToFoam mesh file and outputs a points file.
+ Used in conjunction with blockMesh.
\*---------------------------------------------------------------------------*/
@@ -45,6 +45,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Reads in a datToFoam mesh file and outputs a points file.\n"
+ "Used in conjunction with blockMesh."
+ );
+
argList::noParallel();
argList::addArgument("dat file");
diff --git a/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C b/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C
index 63a5c717496aa9947001efc542715eb93cc10556..80b6a66f37333c95e44c6ce8141a72c842203438 100644
--- a/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C
+++ b/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts an AVL/FIRE polyhedral mesh to OPENFOAM
+ Convert AVL/FIRE polyhedral mesh to OpenFOAM format
Usage
\b fireToFoam [OPTION] firePolyMesh
@@ -60,7 +60,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Convert AVL/FIRE polyhedral mesh to OPENFOAM format"
+ "Convert AVL/FIRE polyhedral mesh to OpenFOAM format"
);
argList::noParallel();
diff --git a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
index f8659f1e8206c220ce897e7145c12b83a463e3b9..c8bf3c35c4ac571f041ed4afbd1796d84650154e 100644
--- a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
+++ b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts a Fluent mesh to OpenFOAM format.
+ Convert a Fluent mesh to OpenFOAM format.
\*---------------------------------------------------------------------------*/
@@ -773,6 +773,10 @@ endOfSection {space}")"{space}
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a Fluent mesh to OpenFOAM format"
+ );
argList::noParallel();
argList::addArgument("Fluent mesh file");
argList::addOption
diff --git a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
index e029457d425f7ee13d6e66502c0987aa7c428f0c..2a81b4c1a8ebb293b9470a84a8ab25d0f6e6f9ee 100644
--- a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
+++ b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts a Fluent mesh to OpenFOAM format
+ Convert a Fluent mesh to OpenFOAM format,
including multiple region and region boundary handling.
\*---------------------------------------------------------------------------*/
@@ -865,6 +865,11 @@ label findFace(const primitiveMesh& mesh, const face& f)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a Fluent mesh to OpenFOAM format,"
+ " including multiple region and region boundary handling"
+ );
argList::noParallel();
argList::addArgument("Fluent mesh file");
argList::addOption
diff --git a/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C b/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
index d532e27d5fea4adca126035059f257692e292061..b634af754470047605565a93b70965299088a578 100644
--- a/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
+++ b/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Writes out the OpenFOAM mesh in Fluent mesh format.
+ Write an OpenFOAM mesh in Fluent mesh format.
\*---------------------------------------------------------------------------*/
@@ -42,6 +42,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Write an OpenFOAM mesh in Fluent mesh format"
+ );
argList::noParallel();
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C b/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C
index 9a9759df229fd92d4b186ab6ed671cf9793dc313..8f892fe260ec5d756c588c9b12a55b52a5a11e1f 100644
--- a/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C
+++ b/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C
@@ -25,7 +25,7 @@ Application
foamToFireMesh
Description
- Reads an OpenFOAM mesh and writes an AVL/FIRE fpma format
+ Write an OpenFOAM mesh in AVL/FIRE fpma format
Usage
\b foamToFireMesh [OPTION]
@@ -58,7 +58,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Read OpenFOAM mesh and write an AVL/FIRE fpma format"
+ "Write an OpenFOAM mesh in AVL/FIRE fpma format"
);
argList::noParallel();
timeSelector::addOptions();
diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
index c5e4c06ef8965c4faeeab98bdab7061294fa738e..57a53453696065ee923e4d14f0a3c7482bd0615d 100644
--- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
+++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Reads an OpenFOAM mesh and writes a STARCD/PROSTAR (v4) bnd/cel/vrt format.
+ Write an OpenFOAM mesh in STARCD/PROSTAR (v4) bnd/cel/vrt format.
Usage
\b foamToStarMesh [OPTION]
@@ -67,7 +67,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Read OpenFOAM mesh and write a STARCD/PROSTAR (v4) bnd/cel/vrt format"
+ "Write an OpenFOAM mesh in STARCD/PROSTAR (v4) bnd/cel/vrt format"
);
argList::noParallel();
timeSelector::addOptions();
diff --git a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
index 01b72c42e9ff4d2a7ffb23fe3b70d2d686fe02f8..d54a3895465fb28bf742825e2c286f9f38893efd 100644
--- a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
+++ b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Reads an OpenFOAM mesh and writes the boundaries in a surface format.
+ Extract boundaries from an OpenFOAM mesh and write in a surface format
Usage
\b foamToSurface [OPTION]
@@ -56,6 +56,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Extract boundaries from an OpenFOAM mesh and write in a surface format"
+ );
argList::noParallel();
argList::addArgument("outputFile.ext");
timeSelector::addOptions();
diff --git a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
index dfd13995bf88ea0c1c72fad7a00aee943eb66010..c51a01ab8060017e624dfd5427105cf7376c7aaa 100644
--- a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
+++ b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts a GAMBIT mesh to OpenFOAM format.
+ Convert a GAMBIT mesh to OpenFOAM format.
\*---------------------------------------------------------------------------*/
@@ -625,6 +625,11 @@ mtype {space}"MTYPE:"{space}
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a GAMBIT mesh to OpenFOAM format"
+ );
+
argList::noParallel();
argList::addArgument("GAMBIT file");
argList::addOption
diff --git a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
index 51e92215775b25f51df82fe73a02cd3224549e8f..acafed87c55a9a30b0f6977d2a3c6d629130d035 100644
--- a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
+++ b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
@@ -766,6 +766,11 @@ void readCells
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a gmsh .msh file to OpenFOAM"
+ );
+
argList::noParallel();
argList::addArgument(".msh file");
argList::addBoolOption
diff --git a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
index 6759d39ce482f9faa0db96efecaf65bf8445caa2..67775f3e2f3d608830d93cd189ee281df9b9fae9 100644
--- a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
+++ b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
@@ -648,6 +648,10 @@ label findPatch(const List<labelHashSet>& dofGroups, const face& f)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert I-Deas unv format to OpenFOAM"
+ );
argList::noParallel();
argList::addArgument(".unv file");
argList::addBoolOption
diff --git a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
index 7dd4c2a6a116cdb94f2575d0803ccdb16b86cdfd..8f64f5e616e6fd73ef6d1d6616192aae6ed4117c 100644
--- a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
+++ b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts a KIVA3v grid to OpenFOAM format.
+ Convert a KIVA3v grid to OpenFOAM.
\*---------------------------------------------------------------------------*/
@@ -58,6 +58,10 @@ enum kivaVersions
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a KIVA3v grid to OpenFOAM"
+ );
argList::noParallel();
argList::addOption
(
diff --git a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
index ae2973be247c96fed986920ce4cd6c75420302ac..cc6f1ebd23660ba0089929b95a91ac4fd657c34a 100644
--- a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
+++ b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts .msh file generated by the Adventure system.
+ Convert .msh file generated by the Adventure system.
Note: the .msh format does not contain any boundary information. It is
purely a description of the internal mesh.
@@ -59,6 +59,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert an Adventure .msh file to OpenFOAM"
+ );
argList::noParallel();
argList::addArgument(".msh file");
argList::addBoolOption
diff --git a/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C b/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C
index 48b55bd14b36fec4c8e3c42c6100fd65c192d3a9..bd91cc1b28d5afd9eba2a784f67fbc2cdf012e50 100644
--- a/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C
+++ b/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts neutral file format as written by Netgen v4.4.
+ Convert a neutral file format (Netgen v4.4) to OpenFOAM.
Example:
@@ -92,6 +92,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert a neutral file format (Netgen v4.4) to OpenFOAM"
+ );
argList::addArgument("Neutral file");
#include "setRootCase.H"
diff --git a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
index 31beb1eb9ba75ed4523f1352763e73f3aa270c91..69c00af00a88bb4cbc69feb684ac13c5872f03e6 100644
--- a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
+++ b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
@@ -58,6 +58,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Plot3d mesh (ascii/formatted format) converter"
+ );
argList::noParallel();
argList::addArgument("PLOT3D geom file");
argList::addOption
diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
index 13d08dfdd0915361bde886639741423cf0bfa492..1a18f874abe77969c58a6e9377009f153fa21262 100644
--- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
+++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts a STARCD/PROSTAR (v4) mesh into OpenFOAM format.
+ Convert a STARCD/PROSTAR (v4) mesh into OpenFOAM format.
Usage
\b star4ToFoam [OPTION] prostarMesh
diff --git a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
index 7917e5053dbc588413efd1dcb9638ff83ee2edef..8b11cdf887e4dec0cd63dbe45c5c43d6ef91299a 100644
--- a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
+++ b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
@@ -28,7 +28,7 @@ Group
grpMeshConversionUtilities
Description
- Converts .ele and .node and .face files, written by tetgen.
+ Convert tetgen .ele and .node and .face files to an OpenFOAM mesh.
Make sure to use add boundary attributes to the smesh file
(5 fifth column in the element section)
@@ -101,6 +101,11 @@ label findFace(const primitiveMesh& mesh, const face& f)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert tetgen .ele and .node and .face files to an OpenFOAM mesh"
+ );
+
argList::addArgument("file prefix");
argList::addBoolOption
(
diff --git a/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C b/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C
index 9b5e48055400cccd445dbe0d6d80bfd45f94052e..1d1fc344f13cc495446bb54b0745fbe38915343a 100644
--- a/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C
+++ b/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C
@@ -28,11 +28,12 @@ Group
grpMeshConversionUtilities
Description
- Converts ascii .vtk (legacy format) file generated by vtk/paraview.
-
- Note: the .vtk format does not contain any boundary information. It is
- purely a description of the internal mesh.
+ Convert legacy VTK file (ascii) containing an unstructured grid
+ to an OpenFOAM mesh without boundary information.
+Note
+ The .vtk format does not contain any boundary information.
+ It is purely a description of the internal mesh.
Not extensively tested.
\*---------------------------------------------------------------------------*/
@@ -50,6 +51,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert legacy VTK file (ascii) containing an unstructured grid"
+ " to an OpenFOAM mesh without boundary information"
+ );
+
argList::noParallel();
argList::addArgument(".vtk ascii file");
diff --git a/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C b/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C
index fefdd463cd74197cd7854ec72f05e353faf50a55..967ffb5234a77c5b68f2b3fdff6fd0cff3907d4a 100644
--- a/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C
+++ b/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C
@@ -261,6 +261,11 @@ void changeFrontBackPatches
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Extrude mesh from existing patch."
+ );
+
#include "addRegionOption.H"
#include "setRootCase.H"
#include "createTimeExtruded.H"
diff --git a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
index 44bd1b43674b69aa7d16b2bcccc3e36828582eb6..9569e7a25369bbe59d13f5f175434d1d4394e5c3 100644
--- a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
+++ b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
@@ -1462,7 +1462,10 @@ void extrudeGeometricProperties
int main(int argc, char *argv[])
{
- argList::addNote("Create region mesh by extruding a faceZone or faceSet");
+ argList::addNote
+ (
+ "Create region mesh by extruding a faceZone or faceSet"
+ );
#include "addRegionOption.H"
#include "addOverwriteOption.H"
diff --git a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C
index 82f0dd43a9da45b1e435d01787bfc6b5421e881e..40f8f31c66fa98f9481744aa45b5506cfd151b47 100644
--- a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C
+++ b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C
@@ -28,8 +28,8 @@ Group
grpMeshGenerationUtilities
Description
- Takes 2D mesh (all faces 2 points only, no front and back faces) and
- creates a 3D mesh by extruding with specified thickness.
+ Create a 3D mesh by extruding a 2D mesh with specified thickness.
+ For the 2D mesh, all faces are 2 points only, no front and back faces.
Note
Not sure about the walking of the faces to create the front and back faces.
@@ -110,6 +110,11 @@ static const Enum<ExtrudeMode> ExtrudeModeNames
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Create a 3D mesh from a 2D mesh by extruding with specified thickness"
+ );
+
argList::addArgument("surfaceFormat");
#include "addOverwriteOption.H"
diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
index d1a5fd797dcc48eee278df53f405a06110d2de97..3c2a8be40a8f9cca1d34c47239822c3eb3c89907 100644
--- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
+++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
@@ -45,6 +45,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Conformal Voronoi automatic mesh generator"
+ );
argList::addBoolOption
(
"checkGeometry",
diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
index b2218d48d8b7238d2dccf2111e671edb9dc5f074..f6545e6dda2e177e3dfed583623186d95ff2902b 100644
--- a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
+++ b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
@@ -53,6 +53,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Conformal Voronoi 2D automatic mesh generator"
+ );
+
argList::noParallel();
argList::addOption("pointsFile", "filename");
diff --git a/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C b/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C
index 9ca3abd5662a7226db737b9ee4b120c595598c0a..1a1e4b7d5d4542405833f9320753f3e6038e6618 100644
--- a/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C
+++ b/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C
@@ -43,6 +43,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Attach topologically detached mesh using prescribed mesh modifiers"
+ );
+
#include "addOverwriteOption.H"
argList::noParallel();
diff --git a/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C b/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C
index 8e9e884847ff87083b1c43a9abebc8ccfad4dc82..216f0b1f7874c04dc9b7dd82e233d4d604b677af 100644
--- a/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C
+++ b/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C
@@ -73,6 +73,11 @@ void collectFeatureEdges(const boundaryMesh& bMesh, labelList& markedEdges)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Divides external faces into patches based on feature angle"
+ );
+
#include "addOverwriteOption.H"
argList::noParallel();
diff --git a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
index df9e19dd24287ac6dcdbfd427b95dc7415548f03..c86db130f2c0aaec97516bf1891d24341566fb03 100644
--- a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
+++ b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
@@ -81,6 +81,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Checks validity of a mesh"
+ );
+
timeSelector::addOptions();
#include "addRegionOption.H"
argList::addBoolOption
@@ -112,7 +117,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"meshQuality",
- "Read user-defined mesh quality criterions from system/meshQualityDict"
+ "Read user-defined mesh quality criteria from system/meshQualityDict"
);
argList::addOption
(
diff --git a/applications/utilities/mesh/manipulation/createPatch/createPatch.C b/applications/utilities/mesh/manipulation/createPatch/createPatch.C
index 596b646dcc16692eb12cfd4e3e71b465c45dd071..d3acb0013daf3fa4aeb5373f52de0ed4428c04c1 100644
--- a/applications/utilities/mesh/manipulation/createPatch/createPatch.C
+++ b/applications/utilities/mesh/manipulation/createPatch/createPatch.C
@@ -28,12 +28,12 @@ Group
grpMeshManipulationUtilities
Description
- Utility to create patches out of selected boundary faces. Faces come either
+ Create patches out of selected boundary faces, which are either
from existing patches or from a faceSet.
More specifically it:
- - creates new patches (from selected boundary faces). Synchronise faces
- on coupled patches.
+ - creates new patches (from selected boundary faces).
+ Synchronise faces on coupled patches.
- synchronises points on coupled boundaries
- remove patches with 0 faces in them
@@ -510,6 +510,12 @@ void syncPoints
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Create patches out of selected boundary faces, which are either"
+ " from existing patches or from a faceSet"
+ );
+
#include "addOverwriteOption.H"
#include "addRegionOption.H"
#include "addDictOption.H"
diff --git a/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C b/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C
index 81f027fcf7a73e9655a6ca0903013567920cf803..673990720ed957175447e818ad321ef02d499e93 100644
--- a/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C
+++ b/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C
@@ -44,6 +44,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Deforms a polyMesh using a displacement field U and a scaling factor"
+ " supplied as an argument"
+ );
+
argList::addArgument("scaling factor");
#include "setRootCase.H"
diff --git a/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C b/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C
index 9c2a48d6ee8b9e7b2a609adb8e04bb74d67c1dc2..3cd919caf38bf363dad0e09ba7a6a19371284008 100644
--- a/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C
+++ b/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C
@@ -44,6 +44,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Flattens the front and back planes of a 2D cartesian mesh"
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createPolyMesh.H"
diff --git a/applications/utilities/mesh/manipulation/insideCells/insideCells.C b/applications/utilities/mesh/manipulation/insideCells/insideCells.C
index a3044092d252e15cdfa8e20c2f9e5716dca5d788..b26c63cf530a750d9902fd1f851bc417f3829f49 100644
--- a/applications/utilities/mesh/manipulation/insideCells/insideCells.C
+++ b/applications/utilities/mesh/manipulation/insideCells/insideCells.C
@@ -28,7 +28,8 @@ Group
grpMeshManipulationUtilities
Description
- Picks up cells with cell centre 'inside' of surface.
+ Create a cellSet for cells with their centres 'inside' the defined
+ surface.
Requires surface to be closed and singly connected.
\*---------------------------------------------------------------------------*/
@@ -50,8 +51,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Create a cellSet for cells with their centres inside the defined "
- "surface.\n"
+ "Create a cellSet for cells with their centres 'inside' the defined"
+ " surface.\n"
"Surface must be closed and singly connected."
);
diff --git a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
index 1262ac3fda54c4799ae9e9f918367754e576b079..6d74e39d28c5adf2382960de588cdb100d257bae 100644
--- a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
+++ b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
@@ -44,6 +44,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Mirrors a mesh around a given plane."
+ );
+
#include "addOverwriteOption.H"
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
index a56d685d0f3a1ce6d284fdb425655d72ec9cb172..fa73c3d8f3d28a08744865d6c9edfd55531a870f 100644
--- a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
+++ b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
@@ -164,11 +164,16 @@ void writeWeights(const polyMesh& mesh)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Mesh motion and topological mesh changes utility"
+ );
+
#include "addRegionOption.H"
argList::addBoolOption
(
"checkAMI",
- "Check AMI weights"
+ "Check AMI weights and write VTK files of the AMI patches"
);
#include "setRootCase.H"
diff --git a/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C b/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C
index a9c3181d59bd3d083c990bc4411d3290738432ea..42e56b305c81b8bacb970f572bff8085cc475c32 100644
--- a/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C
+++ b/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C
@@ -40,13 +40,15 @@ Description
int main(int argc, char *argv[])
{
- #include "setRootCase.H"
+ argList::addNote
+ (
+ "A solver utility for moving meshes for engine calculations"
+ );
+ #include "setRootCase.H"
#include "createEngineTime.H"
#include "createEngineMesh.H"
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
Info<< "\nStarting time loop\n" << endl;
while (runTime.loop())
diff --git a/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C b/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C
index d368859170553e7f55fc3facdcea31e0b9e7a014..f435c70f6180b383fcaeb306e185c31e2b99e67b 100644
--- a/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C
+++ b/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C
@@ -28,7 +28,7 @@ Group
grpMeshManipulationUtilities
Description
- Solver for moving meshes.
+ A solver utility for moving meshes.
\*---------------------------------------------------------------------------*/
@@ -43,6 +43,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "A solver utility for moving meshes"
+ );
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C b/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C
index 95508b6d82d1faf7efae5d767c6d51e5f91543e5..145add013bb37fabe80279f898f6563aa8c871ae 100644
--- a/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C
+++ b/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C
@@ -28,7 +28,7 @@ Group
grpMeshManipulationUtilities
Description
- Read obj line (not surface!) file and convert into vtk.
+ Read obj line (not surface) file and convert into legacy VTK file.
\*---------------------------------------------------------------------------*/
@@ -110,6 +110,11 @@ labelList parseVertices(const string& line)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Read obj line (not surface) file and convert into legacy VTK file"
+ );
+
argList::noParallel();
argList::addArgument("OBJ file");
argList::addArgument("output VTK file");
diff --git a/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C b/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C
index 972503c9ec8d04f04027d28d884d4c3090c38fa2..dd7cbb1dc2935bad4f3508d07e96ff37ac470134 100644
--- a/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C
+++ b/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C
@@ -28,7 +28,7 @@ Group
grpMeshManipulationUtilities
Description
- Corrects orientation of faceZone.
+ Corrects teh orientation of faceZone.
- correct in parallel - excludes coupled faceZones from walk
- correct for non-manifold faceZones - restarts walk
@@ -49,6 +49,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Corrects the orientation of faceZone"
+ );
#include "addRegionOption.H"
argList::addArgument("faceZone");
argList::addArgument("outsidePoint");
diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
index a1cbb287f6b40633938dbdbee5421db92b6b6fbc..ade2e37574a12e4d5c91fcd32639862b3ec209b9 100644
--- a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
+++ b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
@@ -28,8 +28,7 @@ Group
grpMeshManipulationUtilities
Description
- Calculates the dual of a polyMesh. Adheres to all the feature and patch
- edges.
+ Creates the dual of a polyMesh, adhering to all the feature and patch edges.
Usage
\b polyDualMesh featureAngle
@@ -47,8 +46,8 @@ Usage
Normally only constructs a single face between two cells. This single
face might be too distorted. splitAllFaces will create a single face for
every original cell the face passes through. The mesh will thus have
- multiple faces inbetween two cells! (so is not strictly upper-triangular
- anymore - checkMesh will complain)
+ multiple faces in between two cells! (so is not strictly
+ upper-triangular anymore - checkMesh will complain)
- \par -doNotPreserveFaceZones:
By default all faceZones are preserved by marking all faces, edges and
@@ -360,6 +359,12 @@ void dumpFeatures
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Creates the dual of a polyMesh,"
+ " adhering to all the feature and patch edges."
+ );
+
#include "addOverwriteOption.H"
argList::noParallel();
@@ -367,7 +372,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"splitAllFaces",
- "Have multiple faces inbetween cells"
+ "Have multiple faces in between cells"
);
argList::addBoolOption
(
@@ -378,7 +383,7 @@ int main(int argc, char *argv[])
(
"doNotPreserveFaceZones",
"Disable the default behaviour of preserving faceZones by having"
- " multiple faces inbetween cells"
+ " multiple faces in between cells"
);
#include "setRootCase.H"
diff --git a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
index 4e15db3fe6bf69f84aa53eaf30ff3f5e90f5a706..c23210e68bbd40170b04e97925e101d414898814 100644
--- a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
+++ b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
@@ -611,7 +611,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Renumber mesh to minimise bandwidth"
+ "Renumber mesh cells to reduce the bandwidth"
);
#include "addRegionOption.H"
diff --git a/applications/utilities/mesh/manipulation/setSet/setSet.C b/applications/utilities/mesh/manipulation/setSet/setSet.C
index e37212d160578fe821e037ec40a71726711ab33b..560cb5db079b093a414c2a2a0396419841b30055 100644
--- a/applications/utilities/mesh/manipulation/setSet/setSet.C
+++ b/applications/utilities/mesh/manipulation/setSet/setSet.C
@@ -28,7 +28,7 @@ Group
grpMeshManipulationUtilities
Description
- Manipulate a cell/face/point/ set or zone interactively.
+ Manipulate a cell/face/point Set or Zone interactively.
\*---------------------------------------------------------------------------*/
@@ -710,10 +710,17 @@ commandStatus parseAction(const word& actionName)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Manipulate a cell/face/point Set or Zone interactively."
+ );
+
// Specific to topoSet/setSet: quite often we want to block upon writing
// a set so we can immediately re-read it. So avoid use of threading
// for set writing.
- timeSelector::addOptions(true, false);
+
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
+
#include "addRegionOption.H"
argList::addBoolOption("noVTK", "Do not write VTK files");
argList::addBoolOption("loop", "Execute batch commands for all timesteps");
diff --git a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
index ebf513b2d3512acd587ba535a8654bcdef9d3d1a..7e56a821150142b14ab6ca2e39e3ac2c28226271 100644
--- a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
+++ b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
@@ -60,12 +60,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
- timeSelector::addOptions(true, false);
argList::addNote
(
"Add point/face/cell Zones from similarly named point/face/cell Sets"
);
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
argList::addBoolOption
(
"noFlipMap",
diff --git a/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C b/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C
index 93efe4341f6e13fa9140e54de5f0d9d065fe0573..0540853a99100d553fe9db50f8ed8a1c28c70752 100644
--- a/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C
+++ b/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C
@@ -73,8 +73,13 @@ void interpolateFields
int main(int argc, char *argv[])
{
- // constant, not false
- timeSelector::addOptions(true, false);
+ argList::addNote
+ (
+ "Map fields to a mesh with all internal faces removed"
+ " (singleCellFvMesh) which gets written to region 'singleCell'"
+ );
+
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C b/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C
index 0fdd9f128bc7e5158d5ac4d85e431f4aa8830a00..5626b4367c58e76499c71ef9142506d5116b089b 100644
--- a/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C
+++ b/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C
@@ -113,6 +113,11 @@ void checkPatch(const polyBoundaryMesh& bMesh, const word& name)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Splits mesh by making internal faces external at defined faceSet"
+ );
+
argList::noParallel();
argList::noFunctionObjects(); // Never use function objects
diff --git a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
index 2b9ff9c3b85f02bcba471d26a1f9708e232500a7..83f844fe821446946e654b17182002abbe86912f 100644
--- a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
+++ b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
@@ -34,7 +34,7 @@ Description
cell-face-cell walking without crossing
- boundary faces
- additional faces from faceset (-blockedFaces faceSet).
- - any face inbetween differing cellZones (-cellZones)
+ - any face between differing cellZones (-cellZones)
Output is:
- volScalarField with regions as different scalars (-detectOnly)
diff --git a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
index 95bc75b8a3b9843dc36232b76c350d431b50ef11..cdcc054103e417a1dce54e17da6e3602a0449d94 100644
--- a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
+++ b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
@@ -28,14 +28,14 @@ Group
grpMeshManipulationUtilities
Description
- Selects a section of mesh based on a cellSet.
+ Create a mesh subset for a particular region of interest based on a
+ cellSet or cellZone.
- The utility sub-sets the mesh to choose only a part of interest. Check
- the setSet/cellSet/topoSet utilities to see how to select cells based on
+ See setSet/topoSet utilities on how to define select cells based on
various shapes.
- The mesh will subset all points, faces and cells needed to make a sub-mesh
- but will not preserve attached boundary types.
+ Will subset all points, faces and cells needed to make a sub-mesh,
+ but not preserve attached boundary types.
\*---------------------------------------------------------------------------*/
@@ -372,8 +372,10 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Select a mesh subset based on a cellSet or on cellZone(s) specified "
- "as the first command argument."
+ "Create a mesh subset for a particular region of interest based on a"
+ " cellSet or cellZone(s) specified as the first command argument.\n"
+ "See setSet/topoSet utilities on how to select cells based on"
+ " various shapes."
);
#include "addOverwriteOption.H"
@@ -465,7 +467,7 @@ int main(int argc, char *argv[])
else if (args.found("patch"))
{
exposedPatchIDs.first() =
- getExposedPatchId(mesh, args["patch"]);
+ getExposedPatchId(mesh, args.opt<word>("patch"));
}
else
{
diff --git a/applications/utilities/mesh/manipulation/topoSet/topoSet.C b/applications/utilities/mesh/manipulation/topoSet/topoSet.C
index abc0cccfda18d64b61c333e3b6bf139b32f5b6d0..bda18339c49f8c354700b77eb1e76b4453019324 100644
--- a/applications/utilities/mesh/manipulation/topoSet/topoSet.C
+++ b/applications/utilities/mesh/manipulation/topoSet/topoSet.C
@@ -28,7 +28,8 @@ Group
grpMeshManipulationUtilities
Description
- Operates on cellSets/faceSets/pointSets through a dictionary.
+ Operates on cellSets/faceSets/pointSets through a dictionary,
+ normally system/topoSetDict
\*---------------------------------------------------------------------------*/
@@ -199,7 +200,13 @@ polyMesh::readUpdateState meshReadUpdate(polyMesh& mesh)
int main(int argc, char *argv[])
{
- timeSelector::addOptions(true, false);
+ argList::addNote
+ (
+ "Operates on cellSets/faceSets/pointSets through a dictionary,"
+ " normally system/topoSetDict"
+ );
+
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
#include "addDictOption.H"
#include "addRegionOption.H"
argList::addBoolOption
diff --git a/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C b/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C
index 4dbc6a4a75940c8a64e41bab280203c465be4380..5292d86e14dc194c8e016b4570972418c38de84a 100644
--- a/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C
+++ b/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C
@@ -28,8 +28,8 @@ Group
grpMeshManipulationUtilities
Description
- Reads in a mesh with hanging vertices and zips up the cells to guarantee
- that all polyhedral cells of valid shape are closed.
+ Reads in a mesh with hanging vertices and 'zips' up the cells
+ to guarantee that all polyhedral cells of valid shape are closed.
Meshes with hanging vertices may occur as a result of split
hex mesh conversion or integration or coupled math face pairs.
@@ -48,6 +48,14 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Reads in a mesh with hanging vertices and 'zips' up the cells"
+ " to guarantee that all polyhedral cells of valid shape are closed.\n"
+ "Meshes with hanging vertices may occur as a result of split"
+ " hex mesh conversion or integration or coupled math face pairs."
+ );
+
#include "addRegionOption.H"
#include "setRootCase.H"
diff --git a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
index ce2e7ae1017358e5681e1d1f63983f06e4ac5d78..509b8cd99994788931e7f48fc04d05f4ffdfe722 100644
--- a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
+++ b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
@@ -25,7 +25,7 @@ Application
foamDictionary
Description
- Interrogates and manipulates dictionaries.
+ Interrogate and manipulate dictionaries.
Usage
\b foamDictionary [OPTION] dictionary
@@ -262,7 +262,10 @@ void removeDict(dictionary& dict, const dictionary& dictToRemove)
int main(int argc, char *argv[])
{
- argList::addNote("Manipulates dictionaries");
+ argList::addNote
+ (
+ "Interrogate and manipulate dictionaries"
+ );
argList::noBanner();
argList::noJobInfo();
diff --git a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
index e43bb0710cabadce96f7466df5db27388a568019..4a56962209a8e8c52b1933f477b407bfc79bc4f9 100644
--- a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
+++ b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
@@ -235,6 +235,11 @@ bool writeOptionalMeshObject
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Converts all IOobjects associated with a case into the format"
+ " specified in the controlDict"
+ );
timeSelector::addOptions();
argList::addBoolOption
(
diff --git a/applications/utilities/miscellaneous/foamHelp/addToolOption.H b/applications/utilities/miscellaneous/foamHelp/addToolOption.H
index 8abb062b00b41e6e7e6da9b4bf04e034d94d8566..fdef14d7ca2d3a005bf6425411a3b279d3d2101e 100644
--- a/applications/utilities/miscellaneous/foamHelp/addToolOption.H
+++ b/applications/utilities/miscellaneous/foamHelp/addToolOption.H
@@ -1,12 +1,12 @@
argList::addArgument("tool");
-argList::notes.append("Valid <tool> options include:");
+argList::addNote("Valid <tool> options include:");
for (const word& tool : helpType::dictionaryConstructorTablePtr_->sortedToc())
{
- argList::notes.append(" " + tool);
+ argList::addNote(" " + tool);
}
-argList::notes.append
+argList::addNote
(
"\nNOTE the <tool> must actually appear *before* any options"
);
diff --git a/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C b/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C
index 7c1db951c1b834a6390724d0e86c84c975006879..008000da3c453bf7ad1619b595ee0628d6901880 100644
--- a/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C
+++ b/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C
@@ -30,12 +30,13 @@ Group
Description
List regions from constant/regionProperties.
- To simplify parsing of the output, the normal banner information
- is suppressed.
-
Usage
\b foamListRegions [OPTION]
+Note
+ The OpenFOAM banner information is suppressed so that the output can be
+ piped into another command.
+
\*---------------------------------------------------------------------------*/
#include "argList.H"
@@ -48,7 +49,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
- argList::addNote("List regions from constant/regionProperties");
+ argList::addNote
+ (
+ "List regions from constant/regionProperties"
+ );
argList::noBanner();
argList::noParallel();
diff --git a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
index c8b35074abcd28ece1b04307552bc22063412c71..8c4d43020d5ad7012b3d38f5a40ef067dcd296ca 100644
--- a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
+++ b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
@@ -28,8 +28,8 @@ Group
grpPostProcessingUtilities
Description
- List times using timeSelector.
- The normal banner information is suppressed.
+ List times using the timeSelector, or use to remove selected time
+ directories.
Usage
\b foamListTimes [OPTION]
@@ -44,6 +44,10 @@ Usage
- \par -verbose
Report progress during removal
+Note
+ The OpenFOAM banner information is suppressed so that the output can be
+ piped into another command.
+
\*---------------------------------------------------------------------------*/
#include "argList.H"
@@ -58,9 +62,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
- argList::addNote("List times using timeSelector");
-
- timeSelector::addOptions(true, true);
+ argList::addNote
+ (
+ "List times using the timeSelector,"
+ " or use to remove selected time directories"
+ );
+ timeSelector::addOptions(true, true); // constant(true), zero(true)
argList::noBanner();
argList::noParallel();
argList::noJobInfo();
diff --git a/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C b/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C
index ce8c452f42d0946f32fa8ceb823fd96360dc0b1a..96009c8314c759eaefef2f0df705eeca78759d06 100644
--- a/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C
+++ b/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C
@@ -188,9 +188,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Restore field names by removing the ending. The fields are "
- "selected\n"
- "automatically or can be specified as optional command arguments.\n"
+ "Restore field names by removing the ending. Fields are selected"
+ " automatically or can be specified as optional command arguments"
);
profiling::disable(); // Disable profiling (and its output)
@@ -225,7 +224,7 @@ int main(int argc, char *argv[])
// Non-mandatory arguments
argList::addArgument("fieldName ... fieldName");
- timeSelector::addOptions(true, true);
+ timeSelector::addOptions(true, true); // constant(true), zero(true)
#include "setRootCaseNonMandatoryArgs.H"
dryrun = args.found("dry-run");
diff --git a/applications/utilities/miscellaneous/patchSummary/patchSummary.C b/applications/utilities/miscellaneous/patchSummary/patchSummary.C
index c843ce59c1a904b3dfcd86341c966299bb867b1c..b9eadef2a91df85ed46776cde765f5c0d926985e 100644
--- a/applications/utilities/miscellaneous/patchSummary/patchSummary.C
+++ b/applications/utilities/miscellaneous/patchSummary/patchSummary.C
@@ -28,7 +28,7 @@ Group
grpMiscUtilities
Description
- Writes fields and boundary condition info for each patch at each requested
+ Write field and boundary condition info for each patch at each requested
time instance.
Default action is to write a single entry for patches/patchGroups with the
@@ -48,6 +48,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Write field and boundary condition info for each patch"
+ " at each requested time instance"
+ );
+
timeSelector::addOptions();
#include "addRegionOption.H"
diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
index d7354e91ac6f9e57fbe84ecc092ce63f077c50de..beed8776ae2f60532660125636dd9da8bab934df 100644
--- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
+++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
@@ -289,8 +289,8 @@ int main(int argc, char *argv[])
"Only decompose geometry if the number of domains has changed"
);
- // Include explicit constant options, have zero from time range
- timeSelector::addOptions(true, false);
+ // Allow explicit -constant, have zero from time range
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
#include "setRootCase.H"
diff --git a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
index 91c03b49ef7e7e2be5d6f67ce1f98f2218fa0e8f..d1480120b96e944f70086b94608629fa5bf381ad 100644
--- a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
+++ b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
@@ -84,7 +84,7 @@ int main(int argc, char *argv[])
// Enable -constant ... if someone really wants it
// Enable -withZero to prevent accidentally trashing the initial fields
- timeSelector::addOptions(true, true);
+ timeSelector::addOptions(true, true); // constant(true), zero(true)
argList::noParallel();
#include "addRegionOption.H"
argList::addBoolOption
diff --git a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
index 8bc73b9040e4b29212d499ccb04f8122be3930ce..072535b47fd0723866bd5d6f2d16df40d55ca7ab 100644
--- a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
+++ b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
@@ -452,7 +452,8 @@ int main(int argc, char *argv[])
// Enable -constant ... if someone really wants it
// Enable -withZero to prevent accidentally trashing the initial fields
- timeSelector::addOptions(true, true);
+ timeSelector::addOptions(true, true); // constant(true), zero(true)
+
argList::noParallel();
argList::addOption
(
diff --git a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C
index 4d994c3b6d42c8ae4b38c1fc218a12d2bbf46255..7cd4726305e892a42f7c519ac8c97b0151725034 100644
--- a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C
+++ b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C
@@ -2261,6 +2261,13 @@ void redistributeLagrangian
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Redistribute decomposed mesh and fields according"
+ " to the decomposeParDict settings.\n"
+ "Optionally run in decompose/reconstruct mode"
+ );
+
argList::noFunctionObjects(); // Never use function objects
// enable -constant ... if someone really wants it
diff --git a/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C b/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C
index 448964a78533fcff8cea8f427ee1c462380ac9f7..c89903b5261163e9cee3b603718321e6684bef66 100644
--- a/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C
+++ b/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Translates OpenFOAM data to Fluent format.
+ Translate OpenFOAM data to Fluent format.
\*---------------------------------------------------------------------------*/
@@ -41,8 +41,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Translate OpenFOAM data to Fluent format"
+ );
argList::noParallel();
- timeSelector::addOptions(false); // no constant
+ timeSelector::addOptions(false); // constant(false), zero(false)
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
index 26aa2582216eedad39e54a3a21987ec8a48ce1a6..afc95c7f533ec7bffdeba7d46c2b145d95f4873e 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
@@ -28,8 +28,7 @@ Group
grpPostProcessingUtilitie
Description
- Translates OpenFOAM data to EnSight format.
-
+ Translate OpenFOAM data to EnSight format.
An Ensight part is created for the internalMesh and for each patch.
Usage
@@ -127,6 +126,11 @@ getZeroGradInternalField(IOobject& io, const fvMeshSubsetProxy& proxy)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Translate OpenFOAM data to Ensight format with a part for"
+ " the internalMesh and for each patch."
+ );
timeSelector::addOptions();
#include "addRegionOption.H"
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
index 6112c199a680eb006529ad441d81988ffb720cfb..19e1e7ab2392ff50ebf2963f70a64b989a016e4f 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
@@ -28,8 +28,8 @@ Group
grpPostProcessingUtilities
Description
- Translates OpenFOAM data to Ensight format.
- An Ensight part is created for each cellZone and patch.
+ Translate OpenFOAM data to Ensight format with an Ensight part
+ for each cellZone and patch.
Usage
\b foamToEnsightParts [OPTION]
@@ -111,10 +111,16 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Translate OpenFOAM data to Ensight format with an Ensight part"
+ " for each cellZone and patch."
+ );
+
// Enable -constant
// Probably don't need -withZero though, since the fields are vetted
// afterwards anyhow
- timeSelector::addOptions(true, false);
+ timeSelector::addOptions(true, false); // constant(true), zero(false)
#include "addRegionOption.H"
argList::noParallel();
diff --git a/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C b/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C
index 65eeadaca90d6d140cde76e01a2a978b4e7dca13..04be4c0eddf6e1dc0b9bfadaa4bbac155e4f6cc8 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Translates foam output to GMV readable files.
+ Translate OpenFOAM output to GMV readable files.
A free post-processor with available binaries from
http://www-xdiv.lanl.gov/XCM/gmv/
@@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Translate OpenFOAM output to GMV readable files"
+ );
+
const wordList fieldTypes
({
"volScalarField",
diff --git a/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C b/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C
index 295e34c98e480311ee9c26fa989a148a80a09269..ecd62c9d17333fd8e7202fbfb3d8ac553cb4fbfa 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Converts polyMesh results to tetDualMesh.
+ Convert polyMesh results to tetDualMesh.
\*---------------------------------------------------------------------------*/
@@ -140,6 +140,11 @@ void ReadAndMapFields
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Convert polyMesh results to tetDualMesh"
+ );
+
#include "addOverwriteOption.H"
#include "addTimeOptions.H"
diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
index dd37ad5c1b5c5bfa76e9b034651b17387f17f88c..f79efb579a18af6cd3f0ec18edbc345fa3ac4953 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
@@ -248,7 +248,10 @@ vtk::outputOptions getOutputOptions(const argList& args)
int main(int argc, char *argv[])
{
- argList::addNote("OpenFOAM to VTK writer");
+ argList::addNote
+ (
+ "General OpenFOAM to VTK file writer"
+ );
timeSelector::addOptions();
// Infrequently needed, mark as advanced.
diff --git a/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C b/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C
index 76af6283ef0dccb66acde42edd3100df2410805e..2c627c6d3c7624272c675a804f925b55cad3de4b 100644
--- a/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C
+++ b/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Translates a STAR-CD SMAP data file into OpenFOAM field format.
+ Translate a STARCD SMAP data file into OpenFOAM field format.
\*---------------------------------------------------------------------------*/
@@ -39,6 +39,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Translate a STARCD SMAP data file into OpenFOAM field format"
+ );
+
argList::noParallel();
argList::addArgument("SMAP fileName");
diff --git a/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
index 1a9d3624d2843471656160f782af76c718304ac8..d61ba155f3309fda6507fe77fe9c22f19eb4447c 100644
--- a/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
+++ b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
@@ -28,8 +28,8 @@ Group
grpPostProcessingUtilities
Description
- Generates a VTK file of particle tracks for cases that were computed using
- a tracked-parcel-type cloud.
+ Generate a legacy VTK file of particle tracks for cases that were
+ computed using a tracked-parcel-type cloud.
\*---------------------------------------------------------------------------*/
@@ -49,6 +49,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generate a legacy VTK file of particle tracks for cases that were"
+ " computed using a tracked-parcel-type cloud"
+ );
+
timeSelector::addOptions();
#include "addRegionOption.H"
diff --git a/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
index 821d949de599dc4948f56126e7310cbd01e27881..9830ce3bdf6ecf180b43650306f111204cacf1c7 100644
--- a/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
+++ b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
@@ -28,8 +28,8 @@ Group
grpPostProcessingUtilitie
Description
- Generates a VTK file of particle tracks for cases that were computed using
- a steady-state cloud
+ Generate a legacy VTK file of particle tracks for cases that were
+ computed using a steady-state cloud
Note:
- Case must be re-constructed (if running in parallel) before use
@@ -115,6 +115,12 @@ void writeVTK(OFstream& os, const scalar& value)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generate a legacy VTK file of particle tracks for cases that were"
+ " computed using a steady-state cloud"
+ );
+
argList::noParallel();
timeSelector::addOptions();
#include "addRegionOption.H"
diff --git a/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C b/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C
index d61edb57ef9a60e1a2feebad0b387640f10113ac..4c8bec0cfb1ba89eef72be64ee24df0e8330a0e0 100644
--- a/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C
+++ b/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C
@@ -81,8 +81,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Extract force/moment information from existing calculations based "
- "on the lumpedPoints pressure zones."
+ "Extract force/moment information from existing calculations based"
+ " on the lumpedPoints pressure zones."
);
argList::addBoolOption
diff --git a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C
index f603e34896d884b41a03ccf7e0f55188ea6eca0b..622184450457090fc96d342abf752af3a588360f 100644
--- a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C
+++ b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C
@@ -27,6 +27,7 @@ Application
Description
This utility can be used to produce VTK files to visualize the response
points/rotations and the corresponding movement of the building surfaces.
+
Uses the tabulated responses from the specified file.
Optionally, it can also be used to a dummy responder for the
externalFileCoupler logic, which makes it useful as a debugging facility
@@ -52,8 +53,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Visualize lumpedPoint movements or provide a slave responder "
- "for diagnostic purposes."
+ "Visualize lumpedPoint movements or provide a slave responder"
+ " for diagnostic purposes."
);
argList::noParallel();
diff --git a/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C b/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C
index 2d94cf2c69634ac682aec1a3812292d54b96128d..72b6d0a85a47793cc478919dfecd52ba61982550 100644
--- a/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C
+++ b/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C
@@ -25,7 +25,7 @@ Application
lumpedPointZones
Description
- Produces a VTK PolyData file \c lumpedPointZones.vtp in which the
+ Produce a VTK PolyData file \c lumpedPointZones.vtp in which the
segmentation of the pressure integration zones can be visualized
for diagnostic purposes. Does not use external coupling.
@@ -46,8 +46,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Create lumpedPointZones.vtp to verify the segmentation of "
- "pressure integration zones used by lumpedPoint BC."
+ "Create lumpedPointZones.vtp to verify the segmentation of"
+ " pressure integration zones used by lumpedPoint BC."
);
argList::noParallel(); // The VTP writer is not yet in parallel
diff --git a/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C b/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C
index 707d1eaac2c10d4abebce04d881d3c77cfbe5d53..1a0960cf477a45f849209e122bb6c2321fe08607 100644
--- a/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C
+++ b/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Calculate the geometric compression ratio.
+ Calculate the engine geometric compression ratio.
Note: if you have valves and/or extra volumes it will not work,
since it calculates the volume at BDC and TCD.
@@ -43,6 +43,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Calculate the engine geometric compression ratio"
+ );
+
#include "setRootCase.H"
#include "createEngineTime.H"
#include "createEngineMesh.H"
diff --git a/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C b/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C
index 57bcfa95108979db8f8a197999bc23e065e7812f..e65345d2f99f8c50e3b600bc473f01c395c3c26d 100644
--- a/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C
+++ b/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilitie
Description
- Generates a graph of a probability distribution function.
+ Generate a graph of a probability distribution function.
\*---------------------------------------------------------------------------*/
@@ -41,6 +41,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generate a graph of a probability distribution function"
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createFields.H"
diff --git a/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C b/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C
index c5602a64966fa57c2653d9f2e6e7e874d7804b1f..fa47bca48f781b2c453edf2ecc70be88327b1ec4 100644
--- a/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C
+++ b/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Post-processes data from channel flow calculations.
+ Post-process data from channel flow calculations.
For each time: calculate: txx, txy,tyy, txy,
eps, prod, vorticity, enstrophy and helicity. Assuming that the mesh
@@ -48,6 +48,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Post-process data from channel flow calculations"
+ );
+
argList::noParallel();
timeSelector::addOptions();
diff --git a/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C b/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C
index f2da76d0894786bcd4f559132fba49deec01e3ba..15c5a8f28182321dccb6206ffa33d842fc921ec3 100644
--- a/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C
+++ b/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C
@@ -69,11 +69,11 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Collect profiling information from processor directories and\n"
- "summarize the time spent and number of calls as (max avg min) values."
+ "Collect profiling information from processor directories and"
+ " summarize time spent and number of calls as (max avg min) values."
);
- timeSelector::addOptions(true, true);
+ timeSelector::addOptions(true, true); // constant(true), zero(true)
argList::noParallel();
argList::noFunctionObjects(); // Never use function objects
diff --git a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
index 5f934dc020ccca57b8c4afc796c9f8e623e8e70d..3ddf0f82524e0c3a4c3bb73168dc992dd7355abc 100644
--- a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
+++ b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
@@ -188,6 +188,11 @@ void fieldInterpolator::interpolate()
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Interpolate fields between time-steps. Eg, for animation."
+ );
+
timeSelector::addOptions();
#include "addRegionOption.H"
argList::addOption
diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C
index a97edc185418e1df5941edde9a5933306398cbff..9f01b669c2b94dab7e6e6e2be5224068fae24bbc 100644
--- a/applications/utilities/postProcessing/noise/noise.C
+++ b/applications/utilities/postProcessing/noise/noise.C
@@ -28,7 +28,7 @@ Group
grpPostProcessingUtilities
Description
- Utility to perform noise analysis of pressure data.
+ Perform noise analysis of pressure data.
The utility provides a light wrapper around the run-time selectable
noise model. Current options include:
@@ -102,6 +102,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Perform noise analysis of pressure data"
+ );
+
argList::noCheckProcessorDirectories();
#include "addDictOption.H"
diff --git a/applications/utilities/postProcessing/postProcess/postProcess.C b/applications/utilities/postProcessing/postProcess/postProcess.C
index f0a2b99b6483deb399ef860de6bec3b7970441a7..767fb9ff950ff5ce79cd0cc745c6ed1abcc1b12f 100644
--- a/applications/utilities/postProcessing/postProcess/postProcess.C
+++ b/applications/utilities/postProcessing/postProcess/postProcess.C
@@ -133,7 +133,14 @@ void executeFunctionObjects
int main(int argc, char *argv[])
{
- Foam::timeSelector::addOptions();
+ argList::addNote
+ (
+ "Execute the set of functionObjects specified in the selected"
+ " dictionary or on the command-line for the"
+ " selected set of times on the selected set of fields"
+ );
+
+ timeSelector::addOptions();
#include "addProfilingOption.H"
#include "addRegionOption.H"
#include "addFunctionObjectOptions.H"
@@ -150,7 +157,7 @@ int main(int argc, char *argv[])
}
#include "createTime.H"
- Foam::instantList timeDirs = Foam::timeSelector::select0(runTime, args);
+ instantList timeDirs = timeSelector::select0(runTime, args);
#include "createNamedMesh.H"
// Initialize the set of selected fields from the command-line options
diff --git a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
index ffde5b2b38e8a3f9c7d7a7dee8e89b414931453b..84ae8b3590d43ab508bf9541a5454d42f8f29f72 100644
--- a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
+++ b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
@@ -273,8 +273,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Apply a simplified boundary-layer model to the velocity and\n"
- "turbulence fields based on the 1/7th power-law."
+ "Apply a simplified boundary-layer model to the velocity and"
+ " turbulence fields based on the 1/7th power-law."
);
#include "addRegionOption.H"
diff --git a/applications/utilities/preProcessing/boxTurb/boxTurb.C b/applications/utilities/preProcessing/boxTurb/boxTurb.C
index faa9b37e43f69dbb9f6f87bd8f41ae44edbd00dd..a37eb981bf56710b1024e72257d4f61f024dcdbf 100644
--- a/applications/utilities/preProcessing/boxTurb/boxTurb.C
+++ b/applications/utilities/preProcessing/boxTurb/boxTurb.C
@@ -28,8 +28,8 @@ Group
grpPreProcessingUtilities
Description
- Makes a box of turbulence which conforms to a given energy
- spectrum and is divergence free.
+ Create a box of divergence-free turbulence conforming to a given
+ energy spectrum.
\*---------------------------------------------------------------------------*/
@@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Create a box of divergence-free turbulence conforming to a given"
+ " energy spectrum"
+ );
+
argList::noParallel();
#include "setRootCase.H"
diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
index d9a09229842baf7ccf2dca0c96034a3779a6da53..f767b62d9fdf045220e96787eb7958afb00849c7 100644
--- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
+++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
@@ -390,6 +390,12 @@ bool merge
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Utility to change dictionary entries"
+ " (such as the patch type for fields and polyMesh/boundary files)."
+ );
+
#include "addDictOption.H"
argList::addOption
(
diff --git a/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C b/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C
index 9da5d767952ad2cb49a3b5eba690b441730e6a91..db6e7a479bb3eede2eaab5fa4ad22ba6d159a957 100644
--- a/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C
+++ b/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C
@@ -25,7 +25,7 @@ Application
createBoxTurb
Description
- Creates a box of isotropic turbulence based on a user-specified
+ Create a box of isotropic turbulence based on a user-specified
energy spectrum.
Based on the reference
@@ -67,6 +67,12 @@ Foam::vector randomUnitVector(Random& rndGen)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Create a box of isotropic turbulence based on a user-specified"
+ " energy spectrum."
+ );
+
argList::addBoolOption
(
"createBlockMesh",
@@ -82,6 +88,7 @@ int main(int argc, char *argv[])
{
// Create a box block mesh with cyclic patches
#include "createBlockMesh.H"
+ Info<< "\nEnd\n" << endl;
return 0;
}
@@ -176,7 +183,6 @@ int main(int argc, char *argv[])
runTime.printExecutionTime(Info);
Info<< "End\n" << endl;
-
return 0;
}
diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
index 1be51398da6ba71d1c8ad4dd5fc3aded35da6e3e..b318fedb94794e70b998d7d76746c4eb02b4b16c 100644
--- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
+++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
@@ -28,7 +28,7 @@ Group
grpPreProcessingUtilities
Description
- Application to generate the patch geometry (points and faces) for use
+ Generate the patch geometry (points and faces) for use
with the externalCoupled functionObject.
Usage
@@ -68,6 +68,12 @@ See also
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generate the patch geometry (points and faces) for use"
+ " with the externalCoupled functionObject."
+ );
+
#include "addRegionOption.H"
#include "addRegionsOption.H"
argList::addArgument("patchGroup");
diff --git a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
index 40c72fc2ab4e0fd460f5228296b60706f0718898..68b7e607a98f76c2ffc98f47594379bff77a03cc 100644
--- a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
+++ b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
@@ -208,6 +208,12 @@ void createFieldFiles
// Main program:
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Create a 0/ directory with fields appropriate for the chosen"
+ " solver and turbulence model."
+ );
+
argList::addOption
(
"templateDir",
diff --git a/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C b/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
index 666311ea50e3e446493f5e56d46d83f8df94d11c..f41dffe896717e216ea7a4bcbde70270121a4545 100644
--- a/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
+++ b/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
@@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Initialise a case for dsmcFoam from the system/dsmcInitialise"
+ " dictionary"
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createNamedMesh.H"
diff --git a/applications/utilities/preProcessing/engineSwirl/engineSwirl.C b/applications/utilities/preProcessing/engineSwirl/engineSwirl.C
index c781b81c7178cc175abf236418e8f160f5a3b542..46791cebf9a13f6d5d1bfe650b0451a2e1356c3b 100644
--- a/applications/utilities/preProcessing/engineSwirl/engineSwirl.C
+++ b/applications/utilities/preProcessing/engineSwirl/engineSwirl.C
@@ -28,7 +28,7 @@ Group
grpPreProcessingUtilities
Description
- Generates a swirling flow for engine calulations.
+ Generate a swirl flow for engine calculations.
\*---------------------------------------------------------------------------*/
@@ -39,6 +39,10 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generate a swirl flow for engine calculations"
+ );
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
index 03427de8ed09c4d0e8f4e48481a799923d1537ee..62c2c2e2ee7704a8fe9813e9d8d2651041799234 100644
--- a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
+++ b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
@@ -53,6 +53,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Agglomerate boundary faces using the pairPatchAgglomeration"
+ " algorithm. Writes a map of fine to coarse grid."
+ );
+
#include "addRegionOption.H"
#include "addDictOption.H"
#include "setRootCase.H"
diff --git a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
index 7bd8e9d1d3461216ee25b04eca412c8a6e8d48a8..320557b7d849e9dc3771a8fec8d3bb11f718f417 100644
--- a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
+++ b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
@@ -393,6 +393,11 @@ void rewriteFields
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Tool to upgrade mesh and fields for split cyclics"
+ );
+
timeSelector::addOptions();
argList::addOptionCompat("dry-run", {"test", 1806});
diff --git a/applications/utilities/preProcessing/mdInitialise/mdInitialise.C b/applications/utilities/preProcessing/mdInitialise/mdInitialise.C
index 2c04a689c25fdd80703442b518ddaa009ad41338..8c497fda95a28eaa3ee22996b0e85c41aa8de585 100644
--- a/applications/utilities/preProcessing/mdInitialise/mdInitialise.C
+++ b/applications/utilities/preProcessing/mdInitialise/mdInitialise.C
@@ -39,6 +39,10 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Initialises fields for a molecular dynamics (MD) simulation"
+ );
#include "setRootCase.H"
#include "createTime.H"
#include "createNamedMesh.H"
diff --git a/applications/utilities/preProcessing/setAlphaField/setAlphaField.C b/applications/utilities/preProcessing/setAlphaField/setAlphaField.C
index 6647f088ac0c762494ad724256857a532e4342b2..9853791143a6fe4403244306ea764c11a078d569 100644
--- a/applications/utilities/preProcessing/setAlphaField/setAlphaField.C
+++ b/applications/utilities/preProcessing/setAlphaField/setAlphaField.C
@@ -75,6 +75,12 @@ shapeSelector::shapeTypeNames
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Uses isoCutCell to create a volume fraction field from a"
+ " cylinder, sphere or a plane."
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createNamedMesh.H"
diff --git a/applications/utilities/preProcessing/setFields/setFields.C b/applications/utilities/preProcessing/setFields/setFields.C
index 0e551df0e48efe974508f63d76fd69cb99427f82..01510ad72e628fdf3d085e0a71172b8840dc159f 100644
--- a/applications/utilities/preProcessing/setFields/setFields.C
+++ b/applications/utilities/preProcessing/setFields/setFields.C
@@ -28,7 +28,7 @@ Group
grpPreProcessingUtilities
Description
- Set values on a selected set of cells/patchfaces through a dictionary.
+ Set values on a selected set of cells/patch-faces via a dictionary.
\*---------------------------------------------------------------------------*/
@@ -396,6 +396,11 @@ public:
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Set values on a selected set of cells/patch-faces via a dictionary"
+ );
+
#include "addDictOption.H"
#include "addRegionOption.H"
#include "setRootCase.H"
diff --git a/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C b/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
index 5bae07c86af572f1a09fca644a88b135080beb16..c80fec2be3407c6ac6f60fd01cd27327c74a21d1 100644
--- a/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
+++ b/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
@@ -256,6 +256,12 @@ void insertMatrixElements
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Calculate view factors from face agglomeration array."
+ " The finalAgglom generated by faceAgglomerate utility."
+ );
+
#include "addRegionOption.H"
#include "setRootCase.H"
#include "createTime.H"
diff --git a/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C b/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C
index e31e42e7385ce1f989f954b8ffc2e2cee3d1ecbe..13ed9d6c07223120abc250a4760813a9ea1d20c3 100644
--- a/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C
+++ b/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C
@@ -39,6 +39,11 @@ Description
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generates a table suitable for use by tabulated wall functions"
+ );
+
#include "setRootCase.H"
#include "createTime.H"
#include "createNamedMesh.H"
diff --git a/applications/utilities/surface/surfaceAdd/surfaceAdd.C b/applications/utilities/surface/surfaceAdd/surfaceAdd.C
index 48bb9abcfe2eb8708be781318316da3b5942054f..1b76e56ca8b96ddb076616ef2502a0aadfe9319a 100644
--- a/applications/utilities/surface/surfaceAdd/surfaceAdd.C
+++ b/applications/utilities/surface/surfaceAdd/surfaceAdd.C
@@ -28,8 +28,8 @@ Group
grpSurfaceUtilities
Description
- Add two surfaces. Does geometric merge on points. Does not check for
- overlapping/intersecting triangles.
+ Add two surfaces. Does geometric merge on points.
+ Does not check for overlapping/intersecting triangles.
Keeps patches separate by renumbering.
@@ -52,6 +52,7 @@ int main(int argc, char *argv[])
argList::addNote
(
"Add two surfaces via a geometric merge on points."
+ " Does not check for overlapping/intersecting triangles."
);
argList::noParallel();
diff --git a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
index d0cdb3a94415c2377a89427c13ab726b7799ff10..2d8099236e1638b05241d0721c7b66bb09436166 100644
--- a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
+++ b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
@@ -31,33 +31,33 @@ Description
Generates the extendedFeatureEdgeMesh for the interface between a boolean
operation on two surfaces.
- Assumes that the orientation of the surfaces iscorrect:
+ Assumes that the orientation of the surfaces is correct:
- if the operation is union or intersection, that both surface's normals
- (n) have the same orientation with respect to a point, i.e. surfaces and b
- are orientated the same with respect to point x:
+ (n) have the same orientation with respect to a point, i.e. surfaces
+ A and B are orientated the same with respect to point x:
\verbatim
_______
| |--> n
| ___|___ x
- |a | | |--> n
- |___|___| b|
+ |A | | |--> n
+ |___|___| B|
| |
|_______|
\endverbatim
- if the operation is a subtraction, the surfaces should be oppositely
- oriented with respect to a point, i.e. for (a - b), then b's orientation
- should be such that x is "inside", and a's orientation such that x is
+ oriented with respect to a point, i.e. for (A - B), then B's orientation
+ should be such that x is "inside", and A's orientation such that x is
"outside"
\verbatim
_______
| |--> n
| ___|___ x
- |a | | |
- |___|___| b|
+ |A | | |
+ |___|___| B|
| n <--|
|_______|
@@ -65,8 +65,8 @@ Description
When the operation is peformed - for union, all of the edges generates where
one surfaces cuts another are all "internal" for union, and "external" for
- intersection, b - a and a - b. This has been assumed, formal (dis)proof is
- invited.
+ intersection, (B - A) and (A - B).
+ This has been assumed, formal (dis)proof is invited.
\*---------------------------------------------------------------------------*/
@@ -1507,6 +1507,12 @@ autoPtr<extendedFeatureEdgeMesh> createEdgeMesh
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Generates the extendedFeatureEdgeMesh for the interface between"
+ " a boolean operation on two surfaces."
+ );
+
argList::noParallel();
argList::addArgument("action");
argList::addArgument("surfaceFile1");
diff --git a/applications/utilities/surface/surfaceCheck/surfaceCheck.C b/applications/utilities/surface/surfaceCheck/surfaceCheck.C
index 71993246e83c7f642f8da454e6fbe5115891a223..f648c8a9626ea5c5f64715a3e7f1e0ae2e4e2a2c 100644
--- a/applications/utilities/surface/surfaceCheck/surfaceCheck.C
+++ b/applications/utilities/surface/surfaceCheck/surfaceCheck.C
@@ -28,7 +28,7 @@ Group
grpSurfaceUtilities
Description
- Checks geometric and topological quality of a surface.
+ Check geometric and topological quality of a surface.
Usage
\b surfaceCheck [OPTION] surfaceFile
@@ -317,6 +317,11 @@ void writeEdgeSet
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Check geometric and topological quality of a surface"
+ );
+
argList::noParallel();
argList::addArgument("surfaceFile");
argList::addBoolOption
diff --git a/applications/utilities/surface/surfaceClean/surfaceClean.C b/applications/utilities/surface/surfaceClean/surfaceClean.C
index 138ea2d40250ea7097a06c131d9f385c7b4bf8ba..c6e725ff69d65fc706873b8d2fc770e53750d0f1 100644
--- a/applications/utilities/surface/surfaceClean/surfaceClean.C
+++ b/applications/utilities/surface/surfaceClean/surfaceClean.C
@@ -52,6 +52,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Clean surface by removing baffles, sliver faces,"
+ " collapsing small edges, etc."
+ );
+
argList::noParallel();
argList::addArgument("surfaceFile");
argList::addArgument("min length");
diff --git a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
index df7b9f2b17ce0e035beb1f5db0657c2818bb57df..754c0be069421c8cb611ba4f0ae41fd49d96c46f 100644
--- a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
+++ b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
@@ -71,6 +71,11 @@ int mapVertex(::List<int>& collapse_map, int a, int mx)
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Surface coarsening using 'bunnylod'"
+ );
+
argList::noParallel();
argList::addArgument("surfaceFile");
argList::addArgument("reductionFactor");
diff --git a/applications/utilities/surface/surfaceFind/surfaceFind.C b/applications/utilities/surface/surfaceFind/surfaceFind.C
index 8b985357c26840ef0f4158bad5fb050484ef373e..709481d5b796250b46d8e97255776e3584eda568 100644
--- a/applications/utilities/surface/surfaceFind/surfaceFind.C
+++ b/applications/utilities/surface/surfaceFind/surfaceFind.C
@@ -29,6 +29,7 @@ Group
Description
Finds nearest face and vertex.
+ Uses a zero origin unless otherwise specified.
\*---------------------------------------------------------------------------*/
@@ -44,6 +45,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Find nearest face and vertex."
+ " Uses a zero origin unless otherwise specified"
+ );
+
argList::noParallel();
argList::addArgument("surfaceFile");
argList::addOption("x", "X", "The point x-coordinate (if non-zero)");
diff --git a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
index a62ecb2877eae30e71465b1d3d3f52cc1786a9bd..5f83dfe06fee63120b0bbc9a882bf4b73f0c7b37 100644
--- a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
+++ b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
@@ -270,7 +270,7 @@ int main(int argc, char *argv[])
argList::addNote
(
"Hook surfaces to other surfaces by moving and retriangulating their"
- "boundary edges to match other surface boundary edges"
+ " boundary edges to match other surface boundary edges"
);
argList::noParallel();
argList::addArgument("hookTolerance");
diff --git a/applications/utilities/surface/surfaceInertia/surfaceInertia.C b/applications/utilities/surface/surfaceInertia/surfaceInertia.C
index c1935bc7daa6a22524d2ba254c134a09f03eca58..88a977c5c38dfc9f35dd2784dad591e85bb4f77a 100644
--- a/applications/utilities/surface/surfaceInertia/surfaceInertia.C
+++ b/applications/utilities/surface/surfaceInertia/surfaceInertia.C
@@ -54,8 +54,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Calculates the inertia tensor and principal axes and moments "
- "of the specified surface.\n"
+ "Calculates the inertia tensor and principal axes and moments"
+ " of the specified surface.\n"
"Inertia can either be of the solid body or of a thin shell."
);
diff --git a/applications/utilities/surface/surfaceInflate/surfaceInflate.C b/applications/utilities/surface/surfaceInflate/surfaceInflate.C
index 731d583065c6ccc836592f7111c718345575bcce..82d104ed2ffb44cd795ea56eb00300ffd8ee37c8 100644
--- a/applications/utilities/surface/surfaceInflate/surfaceInflate.C
+++ b/applications/utilities/surface/surfaceInflate/surfaceInflate.C
@@ -563,7 +563,10 @@ void lloydsSmoothing
int main(int argc, char *argv[])
{
- argList::addNote("Inflates surface according to point normals.");
+ argList::addNote
+ (
+ "Inflates surface according to point normals."
+ );
argList::noParallel();
argList::addNote
diff --git a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
index 6485163063888dd6d9311ea329629aa1a464d1e3..abe37f073b4a172c40efededf3835ef862f67910 100644
--- a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
+++ b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
@@ -28,7 +28,7 @@ Group
grpSurfaceUtilities
Description
- Smooths a surface using lambda/mu smoothing.
+ Smooth a surface using lambda/mu smoothing.
To get laplacian smoothing, set lambda to the relaxation factor and mu to
zero.
@@ -131,6 +131,13 @@ void getFixedPoints
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Smooth a surface using lambda/mu smoothing.\n"
+ "For laplacian smoothing, set lambda to the relaxation factor"
+ " and mu to zero."
+ );
+
argList::noParallel();
argList::validOptions.clear();
argList::addArgument("surfaceFile");
diff --git a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
index a030599286aa739a76077cfa81258b427b1f49b4..5a44082175680b505c1f2911d5ee0cc300d415c0 100644
--- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
+++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
@@ -28,7 +28,7 @@ Group
grpSurfaceUtilities
Description
- Converts between surface formats with optional scaling or
+ Convert between surface formats with optional scaling or
transformations (rotate/translate) on a coordinateSystem.
Usage
@@ -76,7 +76,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "convert between surface formats, using MeshSurface library components"
+ "Convert between surface formats, using MeshSurface library components"
);
argList::noParallel();
diff --git a/applications/utilities/surface/surfacePatch/surfacePatch.C b/applications/utilities/surface/surfacePatch/surfacePatch.C
index 09085ff4f39ec5519bcdc6e03142745e68977f23..a2b2169dd2e193ee98e1867db8e84f2fd685247e 100644
--- a/applications/utilities/surface/surfacePatch/surfacePatch.C
+++ b/applications/utilities/surface/surfacePatch/surfacePatch.C
@@ -52,6 +52,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Add patches (regions) to a surface with a user-selectable method"
+ );
argList::noParallel();
#include "addDictOption.H"
diff --git a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
index 3c2f829aa6b336c67e28c6b81e0f5604909201a8..2853f651a30ecf183d7c7e907b1adc3a72193594 100644
--- a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
+++ b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
@@ -104,9 +104,9 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Redistribute a triSurface. "
- "The specified surface must be located in the constant/triSurface "
- "directory"
+ "Redistribute a triSurface."
+ " The specified surface must be located in the constant/triSurface"
+ " directory"
);
argList::addArgument("triSurfaceMesh");
diff --git a/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C b/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C
index ab27396d4a1cc32008fd1edabf9ed2c94d221597..d7ec473afb8bc0d6601e6c898f67c4978ffeeb10 100644
--- a/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C
+++ b/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C
@@ -54,6 +54,10 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Refine by splitting all three edges of triangle"
+ );
argList::noParallel();
argList::addArgument("surfaceFile");
argList::addArgument("output surfaceFile");
diff --git a/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C b/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C
index 1ba612cc588f75312889defbaf4b178c90885df3..9c930f85e64d5472dfb853c109c92d6dcae62d1d 100644
--- a/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C
+++ b/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C
@@ -44,6 +44,13 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "Strips any baffle parts of a surface.\n"
+ "A baffle region is one which is reached by walking from an open edge,"
+ " and stopping when a multiply connected edge is reached."
+ );
+
argList::noParallel();
argList::validOptions.clear();
argList::addArgument("input surface file");
diff --git a/applications/utilities/surface/surfaceSubset/surfaceSubset.C b/applications/utilities/surface/surfaceSubset/surfaceSubset.C
index 052b05a2283dfd4c10cb9147fce0160956edfa5d..5e41538818e7c62d48dfee975dbcbefb9629db5b 100644
--- a/applications/utilities/surface/surfaceSubset/surfaceSubset.C
+++ b/applications/utilities/surface/surfaceSubset/surfaceSubset.C
@@ -28,8 +28,8 @@ Group
grpSurfaceUtilities
Description
- A surface analysis tool which sub-sets the triSurface
- to choose only a part of interest. Based on subsetMesh.
+ A surface analysis tool that subsets the triSurface to choose a
+ region of interest. Based on subsetMesh.
\*---------------------------------------------------------------------------*/
@@ -51,6 +51,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
+ argList::addNote
+ (
+ "A surface analysis tool that subsets the triSurface to choose a"
+ " region of interest."
+ );
+
argList::noParallel();
argList::addArgument("surfaceSubsetDict");
argList::addArgument("surfaceFile");
diff --git a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
index eccc4949db476867d9bb94b86380947aee6321ba..8692bc32c7483a0bb45593f4302d7d53c9c272eb 100644
--- a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
+++ b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
@@ -28,7 +28,7 @@ Group
grpThermophysicalUtilities
Description
- Calculates the adiabatic flame temperature for a given fuel over a
+ Calculate adiabatic flame temperature for a given fuel over a
range of unburnt temperatures and equivalence ratios.
\*---------------------------------------------------------------------------*/
@@ -57,8 +57,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Calculates the adiabatic flame temperature for a given fuel\n"
- "over a range of unburnt temperatures and equivalence ratios."
+ "Calculate the adiabatic flame temperature for a given fuel over a "
+ " range of unburnt temperatures and equivalence ratios."
);
argList::noParallel();
diff --git a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
index 0458642a44779e5963c15ac8b2b3fd8103f263ec..c84b2ff2a275ef9b8d88e3eccea3a64f5aa320da 100644
--- a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
+++ b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
@@ -28,7 +28,7 @@ Group
grpSurfaceUtilities
Description
- Converts CHEMKINIII thermodynamics and reaction data files into
+ Convert CHEMKINIII thermodynamics and reaction data files into
OpenFOAM format.
\*---------------------------------------------------------------------------*/
@@ -49,8 +49,8 @@ int main(int argc, char *argv[])
argList::addNote
(
- "Converts CHEMKINIII thermodynamics and reaction data files into\n"
- "OpenFOAM format."
+ "Convert CHEMKINIII thermodynamics and reaction data files into"
+ " OpenFOAM format."
);
argList::noParallel();
diff --git a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
index fc3478900bcd82cbe7ae7cae4a9cb99f760718fa..b3153ad0b4546bb9cfeb013838096d22e3a6e022 100644
--- a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
+++ b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
@@ -28,7 +28,7 @@ Group
grpThermophysicalUtilities
Description
- Calculates the equilibrium level of carbon monoxide.
+ Calculate the equilibrium level of carbon monoxide.
\*---------------------------------------------------------------------------*/
@@ -59,7 +59,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Calculates the equilibrium level of carbon monoxide."
+ "Calculate the equilibrium level of carbon monoxide."
);
argList::noParallel();
diff --git a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
index a7f1eb6659421cd470b9def3901027df4310e1ff..7f593ff57bbf78a7e6d82d365d24f30226bb0090 100644
--- a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
+++ b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
@@ -28,9 +28,9 @@ Group
grpThermophysicalUtilities
Description
- Calculates the equilibrium flame temperature for a given fuel and
+ Calculate the equilibrium flame temperature for a given fuel and
pressure for a range of unburnt gas temperatures and equivalence
- ratios; includes the effects of dissociation on O2, H2O and CO2.
+ ratios. Includes the effects of dissociation on O2, H2O and CO2.
\*---------------------------------------------------------------------------*/
@@ -59,9 +59,10 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Calculates the equilibrium flame temperature for a given fuel\n"
- "and pressure for a range of unburnt gas temperatures and equivalence\n"
- "ratios; includes the effects of dissociation on O2, H2O and CO2."
+ "Calculate the equilibrium flame temperature for a given fuel and"
+ " pressure for a range of unburnt gas temperatures and equivalence"
+ " ratios.\n"
+ "Includes the effects of dissociation on O2, H2O and CO2."
);
argList::noParallel();
diff --git a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
index 235e43b1a5d3fce461e6e88bb2bb51ad32679bbd..75c45e3cf754812afc27f67d2d7f256f0676b6e8 100644
--- a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
+++ b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
@@ -28,7 +28,7 @@ Group
grpThermophysicalUtilities
Description
- Calculates the adiabatic flame temperature for a given mixture
+ Calculate adiabatic flame temperature for a given mixture
at a given temperature.
\*---------------------------------------------------------------------------*/
@@ -57,8 +57,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
- "Calculates the adiabatic flame temperature for a given mixture\n"
- "at a given temperature."
+ "Calculate adiabatic flame temperature for a given mixture"
+ " at a given temperature"
);
argList::noParallel();
diff --git a/bin/tools/foamCreateManpage b/bin/tools/foamCreateManpage
index ed7ad21ff190b11a784a6a565b88fb42b0e0133e..29e38fdb90c0e0a4d611b1e90521012cbbff8d96 100755
--- a/bin/tools/foamCreateManpage
+++ b/bin/tools/foamCreateManpage
@@ -129,7 +129,7 @@ process()
if grep -F -q "SYNOPSIS" "$tmpFile" 2>/dev/null
then
cat "$tmpFile" | \
- sed -e "${sedFilter:-p}" | "${gzipFilter:-cat}" \
+ sed -e "${sedFilter}" | "${gzipFilter:-cat}" \
>| "$outFile${gzipFilter:+.gz}"
echo "$outFile${gzipFilter:+.gz}" 1>&2
diff --git a/modules/avalanche b/modules/avalanche
index a82a2f62a93c60cfe8dfcd4dfe206f8ac798b285..a83eb8c203ada545580a621b02b63782f2518d96 160000
--- a/modules/avalanche
+++ b/modules/avalanche
@@ -1 +1 @@
-Subproject commit a82a2f62a93c60cfe8dfcd4dfe206f8ac798b285
+Subproject commit a83eb8c203ada545580a621b02b63782f2518d96
diff --git a/modules/cfmesh b/modules/cfmesh
index 024454c8dbef41a19d4e401b2c32ca4f03090d00..768075fbef083b2b66e8c79cfaf5fc97e6d18187 160000
--- a/modules/cfmesh
+++ b/modules/cfmesh
@@ -1 +1 @@
-Subproject commit 024454c8dbef41a19d4e401b2c32ca4f03090d00
+Subproject commit 768075fbef083b2b66e8c79cfaf5fc97e6d18187
diff --git a/src/OpenFOAM/global/argList/argListHelp.C b/src/OpenFOAM/global/argList/argListHelp.C
index 4199e0eb5d7e12eef7715b33d6f2d7baef20f9a5..35ced1a0ea1daa7b670b55873ba8ce267dcd0caa 100644
--- a/src/OpenFOAM/global/argList/argListHelp.C
+++ b/src/OpenFOAM/global/argList/argListHelp.C
@@ -40,7 +40,7 @@ static inline void printManFooter()
<< "Online documentation "
<< "https://www.openfoam.com/documentation/" << nl
<< ".SH COPYRIGHT" << nl
- << "Copyright 2018 OpenCFD Ltd." << nl;
+ << "Copyright \\(co 2018 OpenCFD Ltd." << nl;
}
@@ -162,12 +162,11 @@ void Foam::argList::printMan() const
{
// .TH "<APPLICATION>" 1 "OpenFOAM-<version>" "source" "category"
- Info
- << ".TH" << token::SPACE
- // All uppercase and quoted
+ Info<< ".TH" << token::SPACE
+ // All uppercase (returns a Foam::string) and thus also quoted
<< stringOps::upper(executable_) << token::SPACE
- << "\"1\"" << token::SPACE
- << token::DQUOTE << "OpenFOAM-v" << OPENFOAM << token::DQUOTE
+ << 1 << token::SPACE
+ << token::DQUOTE << "OpenFOAM-v" << foamVersion::api << token::DQUOTE
<< token::SPACE
<< token::DQUOTE << "www.openfoam.com" << token::DQUOTE
<< token::SPACE
@@ -177,8 +176,7 @@ void Foam::argList::printMan() const
// .SH NAME
// <application> \- part of OpenFOAM (The Open Source CFD Toolbox).
- Info
- << ".SH \"NAME\"" << nl
+ Info<< ".SH \"NAME\"" << nl
<< executable_
<< " \\- part of \\fBOpenFOAM\\fR (The Open Source CFD Toolbox)."
<< nl;
@@ -187,8 +185,7 @@ void Foam::argList::printMan() const
// .SH SYNOPSIS
// .B command [OPTIONS] ...
- Info
- << ".SH \"SYNOPSIS\"" << nl
+ Info<< ".SH \"SYNOPSIS\"" << nl
<< "\\fB" << executable_ << "\\fR [\\fIOPTIONS\\fR]";
if (validArgs.size())
@@ -217,10 +214,9 @@ void Foam::argList::printMan() const
// .SH DESCRIPTION
{
- Info
- << ".SH \"DESCRIPTION\"" << nl;
+ Info<< ".SH \"DESCRIPTION\"" << nl;
- Info<< ".nf" << nl;
+ Info<< ".nf" << nl; // No fill lines
if (notes.empty())
{
@@ -228,7 +224,6 @@ void Foam::argList::printMan() const
}
else
{
- Info<< nl;
for (const std::string& note : notes)
{
if (note.empty())
@@ -241,13 +236,12 @@ void Foam::argList::printMan() const
}
}
}
- Info<< ".fi" << nl;
+ Info<< ".fi" << nl; // Fill lines
}
// .SH "OPTIONS"
- Info
- << ".SH \"OPTIONS\"" << nl;
+ Info<< ".SH \"OPTIONS\"" << nl;
for (const word& optName : validOptions.sortedToc())
{
@@ -266,9 +260,8 @@ void Foam::argList::printMan() const
printManOption("help-full", "Display full help and exit");
- // .SH "ADVANCED OPTIONS"
- Info
- << ".SH \"ADVANCED OPTIONS\"" << nl;
+ // .SS "ADVANCED OPTIONS"
+ Info<< ".SS \"ADVANCED OPTIONS\"" << nl;
for (const word& optName : validOptions.sortedToc())
{
@@ -402,9 +395,8 @@ void Foam::argList::printManCompat() const
}
- // .SH "COMPATIBILITY OPTIONS"
- Info
- << ".SH \"COMPATIBILITY OPTIONS\"" << nl;
+ // .SS "COMPATIBILITY OPTIONS"
+ Info<< ".SS \"COMPATIBILITY OPTIONS\"" << nl;
for (const word& k : argList::validOptionsCompat.sortedToc())
{
diff --git a/src/fileFormats/vtk/file/foamVtmWriter.C b/src/fileFormats/vtk/file/foamVtmWriter.C
index d935c22c762dd45b175fc057501eaa3ed5f2c592..3a83eb00d523b37d15b5556c648aa485f0fe31b2 100644
--- a/src/fileFormats/vtk/file/foamVtmWriter.C
+++ b/src/fileFormats/vtk/file/foamVtmWriter.C
@@ -314,20 +314,13 @@ void Foam::vtk::vtmWriter::dump(Ostream& os) const
Foam::vtk::vtmWriter::vtmWriter()
:
- vtmWriter(true, false)
+ vtmWriter(true)
{}
Foam::vtk::vtmWriter::vtmWriter(bool autoName)
-:
- vtmWriter(autoName, false)
-{}
-
-
-Foam::vtk::vtmWriter::vtmWriter(bool autoName, bool autoCollapse)
:
autoName_(autoName),
- autoCollapse_(autoCollapse),
hasTime_(false),
entries_(),
blocks_(),
diff --git a/src/fileFormats/vtk/file/foamVtmWriter.H b/src/fileFormats/vtk/file/foamVtmWriter.H
index 24b9bed0fd880f7567412cdffadc87664f6688f8..c4c9dd530a1b6b526e15e7a29e0003c4d6ceea42 100644
--- a/src/fileFormats/vtk/file/foamVtmWriter.H
+++ b/src/fileFormats/vtk/file/foamVtmWriter.H
@@ -176,9 +176,6 @@ class vtmWriter
//- Auto-generate names from 'file' entry?
bool autoName_;
- //- Collapse empty blocks and combine block/dataset etc.
- bool autoCollapse_;
-
//- Has a TimeValue for FieldData?
bool hasTime_;
@@ -214,9 +211,6 @@ public:
//- Construct with specified behaviour for autoName
explicit vtmWriter(bool autoName);
- //- Construct with specified behaviour for autoName, autoCollapse
- vtmWriter(bool autoName, bool autoCollapse);
-
//- Destructor
~vtmWriter() = default;
diff --git a/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver b/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver
index 2b64cfef4a0f19c25b2b7080aadf952ebb42154c..dc5c6bbd21b05bca79c3def89712af2bfaca264f 100755
--- a/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver
+++ b/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver
@@ -211,4 +211,7 @@ case "$action" in
;;
esac
+# For log collector:
+echo "End"
+
#------------------------------------------------------------------------------
diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver b/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver
index dc8b42fe155d6e2df96750172e69af11db81d3b8..559fdd1ae3116ed694893585ef004945cbb48363 100755
--- a/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver
+++ b/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver
@@ -170,4 +170,7 @@ log "done"
# Remove the lock file too
\rm -f $lockFile 2>/dev/null
+# For log collector:
+echo "End"
+
#------------------------------------------------------------------------------
diff --git a/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver b/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver
index d83dd3109cac5500c04b898dedb626ce5c0ec6c0..6123b21c006e0bb5b137db948c995f9899c75491 100755
--- a/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver
+++ b/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver
@@ -171,4 +171,7 @@ log "done"
# Remove the lock file too
\rm -f $lockFile 2>/dev/null
+# For log collector:
+echo "End"
+
#------------------------------------------------------------------------------
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/U b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/U
similarity index 100%
rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/U
rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/U
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/epsilon b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/epsilon
similarity index 100%
rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/epsilon
rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/epsilon
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/k b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/k
similarity index 100%
rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/k
rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/k
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/nut b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/nut
similarity index 100%
rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/nut
rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/nut
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/p b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/p
similarity index 100%
rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/p
rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/p
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean
index 53afd7eaead4f95652b0abc5f78451e168a55318..98ff9b6209aad26096420b5fb01d29f3c6ab7625 100755
--- a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean
+++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean
@@ -2,7 +2,7 @@
cd ${0%/*} || exit 1 # Run from this directory
. $WM_PROJECT_DIR/bin/tools/CleanFunctions # Tutorial clean functions
-cleanCase
+cleanCase0
rm -rf constant/extendedFeatureEdgeMesh > /dev/null 2>&1
rm -f constant/triSurface/buildings.eMesh > /dev/null 2>&1
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun
index cc32f55043deddf9844861ef86ec686d32f75632..30cbfe82f6fd50547446fdbd00e5cd263659d686 100755
--- a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun
+++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun
@@ -2,10 +2,9 @@
cd ${0%/*} || exit 1 # Run from this directory
. $WM_PROJECT_DIR/bin/tools/RunFunctions # Tutorial run functions
-runApplication surfaceFeatureExtract
+runApplication ./Allrun.pre
-runApplication blockMesh
-runApplication snappyHexMesh -overwrite
+restore0Dir
runApplication $(getApplication)
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel
index 444dc97cc96e17f0f4f92da7ad4b4befff57c704..87dec4ec716faa71b1c0d2fa34e6da3d4155ed93 100755
--- a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel
+++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel
@@ -2,13 +2,12 @@
cd ${0%/*} || exit 1 # Run from this directory
. $WM_PROJECT_DIR/bin/tools/RunFunctions # Tutorial run functions
-runApplication surfaceFeatureExtract
-
-runApplication blockMesh
-runApplication snappyHexMesh -overwrite
+runApplication ./Allrun.pre
runApplication decomposePar
+restore0Dir -processor
+
runParallel $(getApplication)
runApplication reconstructPar
diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre
new file mode 100755
index 0000000000000000000000000000000000000000..162f1e5f74ab49650af1df9d5251cba1be562d96
--- /dev/null
+++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre
@@ -0,0 +1,11 @@
+#!/bin/sh
+cd ${0%/*} || exit 1 # Run from this directory
+. $WM_PROJECT_DIR/bin/tools/RunFunctions # Tutorial run functions
+
+runApplication surfaceFeatureExtract
+
+runApplication blockMesh
+
+runApplication snappyHexMesh -overwrite
+
+#------------------------------------------------------------------------------