From 30a49678d16c14fa353a23b1e4991ece05a9d914 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Fri, 7 Apr 2017 08:32:36 +0200
Subject: [PATCH] STYLE: add help to some thermophysical utilities and remove
 useless options

---
 .../thermophysical/adiabaticFlameT/adiabaticFlameT.C  |  8 ++++++++
 .../thermophysical/chemkinToFoam/chemkinToFoam.C      |  9 ++++++++-
 .../thermophysical/equilibriumCO/equilibriumCO.C      |  7 +++++++
 .../equilibriumFlameT/equilibriumFlameT.C             | 11 ++++++++++-
 .../mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C   |  7 +++++++
 5 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
index d29b262f57..35f89607fb 100644
--- a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
+++ b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
@@ -55,7 +55,15 @@ typedef species::thermo<janafThermo<perfectGas<specie>>, absoluteEnthalpy>
 
 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."
+    );
+    argList::noParallel();
+    argList::noFunctionObjects();
     argList::validArgs.append("controlFile");
+
     argList args(argc, argv);
 
     const fileName controlFileName = args[1];
diff --git a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
index fa46272ea5..f9d7f29a5b 100644
--- a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
+++ b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
@@ -45,6 +45,13 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Converts CHEMKINIII thermodynamics and reaction data files into\n"
+        "OpenFOAM format."
+    );
+    argList::noParallel();
+    argList::noFunctionObjects();
     argList::validArgs.append("CHEMKINFile");
     argList::validArgs.append("CHEMKINThermodynamicsFile");
     argList::validArgs.append("CHEMKINTransport");
@@ -59,7 +66,7 @@ int main(int argc, char *argv[])
 
     argList args(argc, argv);
 
-    bool newFormat = args.optionFound("newFormat");
+    const bool newFormat = args.optionFound("newFormat");
 
     speciesTable species;
 
diff --git a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
index 974b9c8549..f00066d0c9 100644
--- a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
+++ b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
@@ -56,6 +56,13 @@ typedef species::thermo<janafThermo<perfectGas<specie>>, absoluteEnthalpy>
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Calculates the equilibrium level of carbon monoxide."
+    );
+    argList::noParallel();
+    argList::noFunctionObjects();
+
     #include "setRootCase.H"
     #include "createTime.H"
 
diff --git a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
index b73a31f584..c246c1516f 100644
--- a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
+++ b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
@@ -30,7 +30,7 @@ Group
 Description
     Calculates the equilibrium flame temperature for a given fuel and
     pressure for a range of unburnt gas temperatures and equivalence
-    ratios; the effects of dissociation on O2, H2O and CO2 are included.
+    ratios; includes the effects of dissociation on O2, H2O and CO2.
 
 \*---------------------------------------------------------------------------*/
 
@@ -57,7 +57,16 @@ typedef species::thermo<janafThermo<perfectGas<specie>>, absoluteEnthalpy>
 
 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."
+    );
+    argList::noParallel();
+    argList::noFunctionObjects();
     argList::validArgs.append("controlFile");
+
     argList args(argc, argv);
 
     const fileName controlFileName = args[1];
diff --git a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
index 98a572c5dc..eaa1eeb482 100644
--- a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
+++ b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
@@ -55,6 +55,13 @@ typedef species::thermo<janafThermo<perfectGas<specie>>, absoluteEnthalpy>
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Calculates the adiabatic flame temperature for a given mixture\n"
+        "at a given temperature."
+    );
+    argList::noParallel();
+    argList::noFunctionObjects();
     argList::validArgs.append("controlFile");
     argList args(argc, argv);