From 68ec561df8346fc0b9491aa46c862c3e83ef9658 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Tue, 11 Dec 2018 15:25:27 +0100
Subject: [PATCH] STYLE: add usage notes to more utilities and solvers
---
applications/solvers/DNS/dnsFoam/dnsFoam.C | 5 ++++
.../basic/laplacianFoam/laplacianFoam.C | 5 ++++
.../overLaplacianDyMFoam.C | 5 ++++
.../overPotentialFoam/overPotentialFoam.C | 5 ++++
.../basic/potentialFoam/potentialFoam.C | 5 ++++
.../scalarTransportFoam/scalarTransportFoam.C | 5 ++++
.../solvers/combustion/PDRFoam/PDRFoam.C | 6 ++++
.../combustion/PDRFoam/PDRFoamAutoRefine.C | 6 ++++
.../combustion/XiFoam/XiDyMFoam/XiDyMFoam.C | 6 ++++
.../XiFoam/XiEngineFoam/XiEngineFoam.C | 6 ++++
.../solvers/combustion/XiFoam/XiFoam.C | 6 ++++
.../solvers/combustion/chemFoam/chemFoam.C | 7 ++++-
.../coldEngineFoam/coldEngineFoam.C | 5 ++++
.../solvers/combustion/fireFoam/fireFoam.C | 6 ++++
.../combustion/reactingFoam/reactingFoam.C | 5 ++++
.../rhoReactingBuoyantFoam.C | 9 +++++-
.../rhoReactingFoam/rhoReactingFoam.C | 8 +++++-
.../rhoCentralDyMFoam/rhoCentralDyMFoam.C | 12 ++++++--
.../rhoCentralFoam/rhoCentralFoam.C | 10 +++++--
.../rhoPimpleAdiabaticFoam.C | 7 +++++
.../overRhoPimpleDyMFoam.C | 6 ++++
.../rhoPimpleFoam/rhoPimpleFoam.C | 6 ++++
.../overRhoSimpleFoam/overRhoSimpleFoam.C | 7 ++++-
.../rhoPorousSimpleFoam/rhoPorousSimpleFoam.C | 10 +++++--
.../rhoSimpleFoam/rhoSimpleFoam.C | 7 ++++-
.../sonicFoam/sonicDyMFoam/sonicDyMFoam.C | 7 +++++
.../compressible/sonicFoam/sonicFoam.C | 6 ++++
.../sonicLiquidFoam/sonicLiquidFoam.C | 6 ++++
.../discreteMethods/dsmc/dsmcFoam/dsmcFoam.C | 10 +++++--
.../mdEquilibrationFoam/mdEquilibrationFoam.C | 5 ++++
.../molecularDynamics/mdFoam/mdFoam.C | 5 ++++
.../electrostaticFoam/electrostaticFoam.C | 5 ++++
.../magneticFoam/magneticFoam.C | 5 ++++
.../electromagnetics/mhdFoam/mhdFoam.C | 7 +++++
.../financial/financialFoam/financialFoam.C | 5 ++++
.../liquidFilmFoam/liquidFilmFoam.C | 6 ++++
.../sphereSurfactantFoam.C | 5 ++++
.../surfactantFoam/surfactantFoam.C | 7 ++++-
.../buoyantBoussinesqPimpleFoam.C | 7 +++++
.../buoyantBoussinesqSimpleFoam.C | 6 ++++
.../buoyantPimpleFoam/buoyantPimpleFoam.C | 6 ++++
.../buoyantSimpleFoam/buoyantSimpleFoam.C | 6 ++++
.../chtMultiRegionFoam/chtMultiRegionFoam.C | 7 +++++
.../chtMultiRegionSimpleFoam.C | 7 +++++
.../heatTransfer/thermoFoam/thermoFoam.C | 5 ++++
.../adjointShapeOptimizationFoam.C | 7 +++++
.../boundaryFoam/boundaryFoam.C | 10 +++++--
.../solvers/incompressible/icoFoam/icoFoam.C | 6 ++++
.../nonNewtonianIcoFoam/nonNewtonianIcoFoam.C | 6 ++++
.../pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C | 10 +++++--
.../overPimpleDyMFoam/overPimpleDyMFoam.C | 8 +++++-
.../incompressible/pimpleFoam/pimpleFoam.C | 6 ++++
.../incompressible/pisoFoam/pisoFoam.C | 6 ++++
.../shallowWaterFoam/shallowWaterFoam.C | 5 ++++
.../simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C | 6 ++++
.../overSimpleFoam/overSimpleFoam.C | 5 ++++
.../porousSimpleFoam/porousSimpleFoam.C | 7 +++++
.../incompressible/simpleFoam/simpleFoam.C | 7 ++++-
.../DPMFoam/DPMDyMFoam/DPMDyMFoam.C | 7 +++++
.../solvers/lagrangian/DPMFoam/DPMFoam.C | 6 ++++
.../coalChemistryFoam/coalChemistryFoam.C | 6 ++++
.../icoUncoupledKinematicParcelDyMFoam.C | 6 ++++
.../icoUncoupledKinematicParcelFoam.C | 5 ++++
.../reactingParcelFoam/reactingParcelFoam.C | 7 +++++
.../simpleReactingParcelFoam.C | 9 +++++-
.../simpleCoalParcelFoam.C | 8 +++++-
.../sprayFoam/engineFoam/engineFoam.C | 6 ++++
.../sprayFoam/sprayDyMFoam/sprayDyMFoam.C | 7 +++++
.../solvers/lagrangian/sprayFoam/sprayFoam.C | 6 ++++
.../uncoupledKinematicParcelDyMFoam.C | 8 +++++-
.../uncoupledKinematicParcelFoam.C | 7 ++++-
.../MPPICInterFoam/MPPICInterFoam.C | 9 +++++-
.../cavitatingDyMFoam/cavitatingDyMFoam.C | 12 ++++++--
.../cavitatingFoam/cavitatingFoam.C | 10 +++++--
.../compressibleInterDyMFoam.C | 10 ++++++-
.../compressibleInterFilmFoam.C | 8 +++++-
.../compressibleInterFoam.C | 8 +++++-
.../compressibleMultiphaseInterFoam.C | 8 +++++-
.../multiphase/driftFluxFoam/driftFluxFoam.C | 16 ++++++++---
.../icoReactingMultiphaseInterFoam.C | 11 +++++++-
.../interCondensatingEvaporatingFoam.C | 11 +++++++-
.../solvers/multiphase/interFoam/interFoam.C | 10 ++++++-
.../interMixingFoam/interMixingFoam.C | 8 ++++++
.../overInterDyMFoam/overInterDyMFoam.C | 10 ++++++-
.../multiphase/interIsoFoam/interIsoFoam.C | 11 +++++++-
.../interPhaseChangeDyMFoam.C | 18 +++++++++---
.../interPhaseChangeFoam.C | 13 +++++++--
.../multiphaseEulerFoam/multiphaseEulerFoam.C | 6 ++++
.../multiphaseInterFoam/multiphaseInterFoam.C | 9 +++++-
.../potentialFreeSurfaceDyMFoam.C | 7 +++++
.../potentialFreeSurfaceFoam.C | 6 ++++
.../reactingMultiphaseEulerFoam.C | 6 ++++
.../reactingTwoPhaseEulerFoam.C | 8 +++++-
.../twoLiquidMixingFoam/twoLiquidMixingFoam.C | 7 ++++-
.../twoPhaseEulerFoam/twoPhaseEulerFoam.C | 11 ++++++--
.../solidDisplacementFoam.C | 7 +++++
.../solidEquilibriumDisplacementFoam.C | 7 +++++
.../finiteArea/checkFaMesh/checkFaMesh.C | 7 ++++-
.../finiteArea/makeFaMesh/makeFaMesh.C | 7 ++++-
.../utilities/mesh/advanced/PDRMesh/PDRMesh.C | 4 +++
.../advanced/collapseEdges/collapseEdges.C | 3 +-
.../combinePatchFaces/combinePatchFaces.C | 7 ++++-
.../mesh/advanced/modifyMesh/modifyMesh.C | 7 ++++-
.../advanced/refineHexMesh/refineHexMesh.C | 6 +++-
.../refineWallLayer/refineWallLayer.C | 8 +++++-
.../refinementLevel/refinementLevel.C | 11 ++++++--
.../mesh/advanced/removeFaces/removeFaces.C | 6 +++-
.../mesh/advanced/selectCells/selectCells.C | 5 ++++
.../snappyRefineMesh/snappyRefineMesh.C | 6 +++-
.../mesh/conversion/ansysToFoam/ansysToFoam.L | 8 +++++-
.../mesh/conversion/ccm/foamToCcm/foamToCcm.C | 2 +-
.../mesh/conversion/cfx4ToFoam/cfx4ToFoam.C | 7 ++++-
.../mesh/conversion/datToFoam/datToFoam.C | 10 +++++--
.../mesh/conversion/fireToFoam/fireToFoam.C | 4 +--
.../fluent3DMeshToFoam/fluent3DMeshToFoam.L | 6 +++-
.../fluentMeshToFoam/fluentMeshToFoam.L | 7 ++++-
.../foamMeshToFluent/foamMeshToFluent.C | 6 +++-
.../foamToFireMesh/foamToFireMesh.C | 4 +--
.../foamToStarMesh/foamToStarMesh.C | 4 +--
.../conversion/foamToSurface/foamToSurface.C | 6 +++-
.../conversion/gambitToFoam/gambitToFoam.L | 7 ++++-
.../mesh/conversion/gmshToFoam/gmshToFoam.C | 5 ++++
.../ideasUnvToFoam/ideasUnvToFoam.C | 4 +++
.../mesh/conversion/kivaToFoam/kivaToFoam.C | 6 +++-
.../mesh/conversion/mshToFoam/mshToFoam.C | 6 +++-
.../netgenNeutralToFoam/netgenNeutralToFoam.C | 6 +++-
.../conversion/plot3dToFoam/plot3dToFoam.C | 4 +++
.../mesh/conversion/star4ToFoam/star4ToFoam.C | 2 +-
.../conversion/tetgenToFoam/tetgenToFoam.C | 7 ++++-
.../vtkUnstructuredToFoam.C | 15 +++++++---
.../extrude/extrudeMesh/extrudeMesh.C | 5 ++++
.../extrudeToRegionMesh/extrudeToRegionMesh.C | 5 +++-
.../extrude2DMesh/extrude2DMeshApp.C | 9 ++++--
.../foamyMesh/foamyHexMesh/foamyHexMesh.C | 4 +++
.../foamyMesh/foamyQuadMesh/foamyQuadMesh.C | 5 ++++
.../mesh/manipulation/attachMesh/attachMesh.C | 5 ++++
.../mesh/manipulation/autoPatch/autoPatch.C | 5 ++++
.../mesh/manipulation/checkMesh/checkMesh.C | 7 ++++-
.../manipulation/createPatch/createPatch.C | 12 ++++++--
.../manipulation/deformedGeom/deformedGeom.C | 6 ++++
.../manipulation/flattenMesh/flattenMesh.C | 5 ++++
.../manipulation/insideCells/insideCells.C | 7 +++--
.../mesh/manipulation/mirrorMesh/mirrorMesh.C | 5 ++++
.../moveDynamicMesh/moveDynamicMesh.C | 7 ++++-
.../moveEngineMesh/moveEngineMesh.C | 8 ++++--
.../mesh/manipulation/moveMesh/moveMesh.C | 6 +++-
.../mesh/manipulation/objToVTK/objToVTK.C | 7 ++++-
.../orientFaceZone/orientFaceZone.C | 6 +++-
.../polyDualMesh/polyDualMeshApp.C | 17 +++++++----
.../manipulation/renumberMesh/renumberMesh.C | 2 +-
.../mesh/manipulation/setSet/setSet.C | 11 ++++++--
.../manipulation/setsToZones/setsToZones.C | 2 +-
.../singleCellMesh/singleCellMesh.C | 9 ++++--
.../mesh/manipulation/splitMesh/splitMesh.C | 5 ++++
.../splitMeshRegions/splitMeshRegions.C | 2 +-
.../mesh/manipulation/subsetMesh/subsetMesh.C | 18 ++++++------
.../mesh/manipulation/topoSet/topoSet.C | 11 ++++++--
.../mesh/manipulation/zipUpMesh/zipUpMesh.C | 12 ++++++--
.../foamDictionary/foamDictionary.C | 7 +++--
.../foamFormatConvert/foamFormatConvert.C | 5 ++++
.../miscellaneous/foamHelp/addToolOption.H | 6 ++--
.../foamListRegions/foamListRegions.C | 12 +++++---
.../foamListTimes/foamListTimes.C | 17 +++++++----
.../foamRestoreFields/foamRestoreFields.C | 7 ++---
.../miscellaneous/patchSummary/patchSummary.C | 8 +++++-
.../decomposePar/decomposePar.C | 4 +--
.../reconstructPar/reconstructPar.C | 2 +-
.../reconstructParMesh/reconstructParMesh.C | 3 +-
.../redistributePar/redistributePar.C | 7 +++++
.../foamDataToFluent/foamDataToFluent.C | 8 ++++--
.../foamToEnsight/foamToEnsight.C | 8 ++++--
.../foamToEnsightParts/foamToEnsightParts.C | 12 ++++++--
.../dataConversion/foamToGMV/foamToGMV.C | 7 ++++-
.../foamToTetDualMesh/foamToTetDualMesh.C | 7 ++++-
.../dataConversion/foamToVTK/foamToVTK.C | 5 +++-
.../dataConversion/smapToFoam/smapToFoam.C | 7 ++++-
.../particleTracks/particleTracks.C | 10 +++++--
.../steadyParticleTracks.C | 10 +++++--
.../lumpedPointForces/lumpedPointForces.C | 4 +--
.../lumpedPointMovement/lumpedPointMovement.C | 5 ++--
.../lumpedPointZones/lumpedPointZones.C | 6 ++--
.../engineCompRatio/engineCompRatio.C | 7 ++++-
.../miscellaneous/pdfPlot/pdfPlot.C | 7 ++++-
.../miscellaneous/postChannel/postChannel.C | 7 ++++-
.../profilingSummary/profilingSummary.C | 6 ++--
.../temporalInterpolate/temporalInterpolate.C | 5 ++++
.../utilities/postProcessing/noise/noise.C | 7 ++++-
.../postProcessing/postProcess/postProcess.C | 11 ++++++--
.../applyBoundaryLayer/applyBoundaryLayer.C | 4 +--
.../utilities/preProcessing/boxTurb/boxTurb.C | 10 +++++--
.../changeDictionary/changeDictionary.C | 6 ++++
.../createBoxTurb/createBoxTurb.C | 8 +++++-
.../createExternalCoupledPatchGeometry.C | 8 +++++-
.../createZeroDirectory/createZeroDirectory.C | 6 ++++
.../dsmcInitialise/dsmcInitialise.C | 6 ++++
.../preProcessing/engineSwirl/engineSwirl.C | 6 +++-
.../faceAgglomerate/faceAgglomerate.C | 6 ++++
.../foamUpgradeCyclics/foamUpgradeCyclics.C | 5 ++++
.../preProcessing/mdInitialise/mdInitialise.C | 4 +++
.../setAlphaField/setAlphaField.C | 6 ++++
.../preProcessing/setFields/setFields.C | 7 ++++-
.../viewFactorsGen/viewFactorsGen.C | 6 ++++
.../wallFunctionTable/wallFunctionTable.C | 5 ++++
.../utilities/surface/surfaceAdd/surfaceAdd.C | 5 ++--
.../surfaceBooleanFeatures.C | 28 +++++++++++--------
.../surface/surfaceCheck/surfaceCheck.C | 7 ++++-
.../surface/surfaceClean/surfaceClean.C | 6 ++++
.../surface/surfaceCoarsen/surfaceCoarsen.C | 5 ++++
.../surface/surfaceFind/surfaceFind.C | 7 +++++
.../surface/surfaceHookUp/surfaceHookUp.C | 2 +-
.../surface/surfaceInertia/surfaceInertia.C | 4 +--
.../surface/surfaceInflate/surfaceInflate.C | 5 +++-
.../surfaceLambdaMuSmooth.C | 9 +++++-
.../surfaceMeshConvert/surfaceMeshConvert.C | 4 +--
.../surface/surfacePatch/surfacePatch.C | 4 +++
.../surfaceRedistributePar.C | 6 ++--
.../surfaceRefineRedGreen.C | 4 +++
.../surfaceSplitByTopology.C | 7 +++++
.../surface/surfaceSubset/surfaceSubset.C | 10 +++++--
.../adiabaticFlameT/adiabaticFlameT.C | 6 ++--
.../chemkinToFoam/chemkinToFoam.C | 6 ++--
.../equilibriumCO/equilibriumCO.C | 4 +--
.../equilibriumFlameT/equilibriumFlameT.C | 11 ++++----
.../mixtureAdiabaticFlameT.C | 6 ++--
224 files changed, 1336 insertions(+), 238 deletions(-)
diff --git a/applications/solvers/DNS/dnsFoam/dnsFoam.C b/applications/solvers/DNS/dnsFoam/dnsFoam.C
index e7011cdb75b..28230c4db95 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 9bffe121d4e..251915b6d5d 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 9a1c1018d9f..5d890a2c0e0 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 839023cfeed..5811771600a 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 9cd095c95d2..3a3922fd114 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 6c2d703b937..06fa8c4198d 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 41500249940..8dd5abac03b 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 ef1d103b98e..00fd303810f 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 2b4dc4f107c..8799b80034a 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 4c9c461d5da..a2e0a3320f6 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 069c481eb5f..5235ad21953 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 c053395cd0d..8caf77ae1b1 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 cd1f853c254..70a3303cd20 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 0559abf21ed..2498023e509 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 0092fe97a5f..d8bca088c8b 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 cca3dd36ddd..e5f998d44be 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 bc47c57f850..bf9988b2cb6 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 f30c7784880..e4eff920de5 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 89066b01c93..f0dc1a37ddb 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 1a21d32d225..83a16ef3fa3 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 b8439d075a3..02021577328 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 8ce729365b3..c27f5051311 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 d72329b0f9b..54ce9757b4f 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 0283b3823ae..5b388b9378e 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 ae8252bbf52..5dd4b215928 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 748a455158f..07852d4daf3 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 1ffbb6738fd..bf7811e5fdd 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 afe963d8cf3..98eb4f4dfd0 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 38eb94fc4d7..ab51c1e6105 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 3bb0a881c3f..45b47df9083 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 a9bbd6d32f3..351882182cc 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 075a4504415..cd3fd4e9bcf 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 e0bc47fe530..679c19536e0 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 1f9d4e1b8e6..d1c8a1f89dd 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 c8e8e7b5d08..0c21f956baa 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 2f57e0b7a17..0287d535f7f 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 daee7e9e592..a49102f1753 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 4a0d63a89c8..2057706aea9 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 c4b8df08f13..760b4bda4e5 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 8cc6523fc75..65f04204b1d 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 39de4d66704..f8432dee50a 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 a8fc1a9f35e..8d0e60bfd8a 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 e1bf6692112..2fba8295db7 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 12c7ac5514f..25faa39de73 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 ea210163c02..ecb753d3828 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 3094f0c7191..9bdca6d9393 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 d9ec41c0ab7..53e2ed6422e 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 eab13726540..6e07a47e33a 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 71656d35271..da675122f8e 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 3fd55b434d1..3bb41802dac 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 4084953c8ee..75f02c44cc9 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 e12c04827ff..9f801ddfe10 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 d2e3efd2fbc..dac62ec676c 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 fa643a7a473..dd3d5b10eb7 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 4b0cbe1547b..2a61cae4998 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 6a4bf928cfa..c97cd245065 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 909a5b61b53..e4649d2839f 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 839dd3ddd6d..964f3833401 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 c1d24729214..1bdb4cdb16d 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 0ca222fa48c..84f0b122007 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 a6f89528ab9..4fd9a7ee64b 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 418935b5c74..325be06b14f 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 775e12099b5..d44fce500a0 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 e8bf3113924..0a974bf0821 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 00cdee6b1c1..809e15b2241 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 5c2a11b43ba..69c432bcc40 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 d1f28f1f00e..64ed862cb69 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 13804c76cab..7cb9d3d9102 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 3a7ded9055e..ee1c1c1596a 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 81b323c5d34..3d27c93a6c3 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 4ac6e57a651..4c0f64db559 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 d88736572a2..2e3858251ca 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 71012644e72..788d7170127 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 5dcea1f0c17..5d27662009d 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 26858eea900..8799c3384e3 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 1d169e30d4b..ff701f853e2 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 7604768d8d1..f96daf82c43 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 fef72cbb7af..2481677353c 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 60347168459..2c178ea557d 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 a3de274602b..3791fc60f26 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 6e28f57f5d6..5bd2767e3ed 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 5b8d2e8b3e5..154f85c1dee 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 a065444dde1..54cfe26f7d3 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 7f1df58eb95..fbcc6ee8e1f 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 b7d12f57415..131cebd555c 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 87e960fd637..dd80f4dc143 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 2fe1e45038e..6009d9ea87e 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 4d42facea1f..8dcbd7ed1d2 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 478dcccdb17..85f5813843d 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 9c0bb8d4c3c..b4cf64fd24d 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 e7502f67e06..4eec2e5f96a 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 4eeaa5ab1f2..b9ea18cf24b 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 c4c49f3a09c..01e0307fb39 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 0df1d48c5fa..0fcbfbac1f2 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 9ad83f52758..bc213139efd 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 eb5707d2922..2e053d85903 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 29e8b701084..5a92ca839fe 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 29e7fd8c154..a0c307ea6ae 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 d9f1dea5f42..fd556855de5 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 b54edbda5b1..3aa52a84c10 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 f23d474a838..7fbcb7c9bd2 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 577f7435707..0b276b24b08 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 c522d8f48ab..2c482069c7a 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 5ea938de40d..9946caf392c 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 0579c5ef694..9c094f67bfe 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 44a4aabf25c..1e3b1522c51 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 19b3b3e548c..2b41619c45e 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 31f918a9198..077285c8d0f 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 ee395ee8001..aac8ee79f16 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 d3fd7fe7723..796de5b65c8 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 b0dc6584d15..faf3277b8cc 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 484f5955a9c..dcc5dee8665 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 8c295588fe6..10269dfc924 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 63a5c717496..80b6a66f373 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 f8659f1e820..c8bf3c35c4a 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 e029457d425..2a81b4c1a8e 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 d532e27d5fe..b634af75447 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 9a9759df229..8f892fe260e 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 c5e4c06ef89..57a53453696 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 01b72c42e9f..d54a3895465 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 dfd13995bf8..c51a01ab806 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 51e92215775..acafed87c55 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 6759d39ce48..67775f3e2f3 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 7dd4c2a6a11..8f64f5e616e 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 ae2973be247..cc6f1ebd236 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 48b55bd14b3..bd91cc1b28d 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 31beb1eb9ba..69c00af00a8 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 13d08dfdd09..1a18f874abe 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 7917e5053db..8b11cdf887e 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 9b5e4805540..1d1fc344f13 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 fefdd463cd7..967ffb5234a 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 44bd1b43674..9569e7a2536 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 82f0dd43a9d..40f8f31c66f 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 d1a5fd797dc..3c2a8be40a8 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 b2218d48d8b..f6545e6dda2 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 9ca3abd5662..1a1e4b7d5d4 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 8e9e884847f..216f0b1f787 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 df9e19dd242..c86db130f2c 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 596b646dcc1..d3acb0013da 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 81f027fcf7a..673990720ed 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 9c2a48d6ee8..3cd919caf38 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 a3044092d25..b26c63cf530 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 1262ac3fda5..6d74e39d28c 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 a56d685d0f3..fa73c3d8f3d 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 a9c3181d59b..42e56b305c8 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 d3688591705..f435c70f618 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 95508b6d82d..145add013bb 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 972503c9ec8..dd7cbb1dc29 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 a1cbb287f6b..ade2e37574a 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 4e15db3fe6b..c23210e68bb 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 e37212d1605..560cb5db079 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 ebf513b2d35..7e56a821150 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 93efe4341f6..0540853a991 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 0fdd9f128bc..5626b4367c5 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 2b9ff9c3b85..83f844fe821 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 95bc75b8a3b..cdcc054103e 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 abc0cccfda1..bda18339c49 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 4dbc6a4a759..5292d86e14d 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 ce2e7ae1017..509b8cd9999 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 e43bb0710ca..4a56962209a 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 8abb062b00b..fdef14d7ca2 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 7c1db951c1b..008000da3c4 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 c8b35074abc..8c4d43020d5 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 ce8c452f42d..96009c8314c 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 c843ce59c1a..b9eadef2a91 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 d7354e91ac6..beed8776ae2 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 91c03b49ef7..d1480120b96 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 8bc73b9040e..072535b47fd 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 4d994c3b6d4..7cd4726305e 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 448964a7853..c89903b5261 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 26aa2582216..afc95c7f533 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 6112c199a68..19e1e7ab239 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 65eeadaca90..04be4c0eddf 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 295e34c98e4..ecd62c9d173 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 dd37ad5c1b5..f79efb579a1 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 76af6283ef0..2c627c6d3c7 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 1a9d3624d28..d61ba155f33 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 821d949de59..9830ce3bdf6 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 d61edb57ef9..4c8bec0cfb1 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 f603e34896d..62218445045 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 2d94cf2c696..72b6d0a85a4 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 707d1eaac2c..1a0960cf477 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 57bcfa95108..e65345d2f99 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 c5602a64966..fa47bca48f7 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 f2da76d0894..15c5a8f2818 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 5f934dc020c..3ddf0f82524 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 a97edc18541..9f01b669c2b 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 f0a2b99b648..767fb9ff950 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 ffde5b2b38e..84ae8b3590d 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 faa9b37e43f..a37eb981bf5 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 d9a09229842..f767b62d9fd 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 9da5d767952..0ced2d52edb 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",
diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
index 1be51398da6..b318fedb947 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 40c72fc2ab4..68b7e607a98 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 666311ea50e..f41dffe8967 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 c781b81c717..46791cebf9a 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 03427de8ed0..62c2c2e2ee7 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 7bd8e9d1d34..320557b7d84 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 2c04a689c25..8c497fda95a 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 6647f088ac0..9853791143a 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 0e551df0e48..01510ad72e6 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 5bae07c86af..c80fec2be34 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 e31e42e7385..13ed9d6c072 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 48bb9abcfe2..1b76e56ca8b 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 d0cdb3a9441..2d8099236e1 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 71993246e83..f648c8a9626 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 138ea2d4025..c6e725ff69d 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 df7b9f2b17c..754c0be0694 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 8b985357c26..709481d5b79 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 a62ecb2877e..5f83dfe06fe 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 c1935bc7daa..88a977c5c38 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 731d583065c..82d104ed2ff 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 64851630638..abe37f073b4 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 a030599286a..5a440821756 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 09085ff4f39..a2b2169dd2e 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 3c2f829aa6b..2853f651a30 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 ab27396d4a1..d7ec473afb8 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 1ba612cc588..9c930f85e64 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 052b05a2283..5e41538818e 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 eccc4949db4..8692bc32c74 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 0458642a447..c84b2ff2a27 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 fc3478900bc..b3153ad0b45 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 a7f1eb66594..7f593ff57bb 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 235e43b1a5d..75c45e3cf75 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();
--
GitLab