From 283801208ed1585ccc087e64e8908c1a3f56d540 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Thu, 22 Nov 2018 10:46:37 +0100
Subject: [PATCH] STYLE: doxygen format for constants
---
src/OpenFOAM/global/constants/atomic/atomicConstants.C | 1 -
src/OpenFOAM/global/constants/constants.C | 2 --
src/OpenFOAM/global/constants/constants.H | 5 +----
.../constants/electromagnetic/electromagneticConstants.C | 1 -
.../global/constants/fundamental/fundamentalConstants.C | 6 ------
.../global/constants/fundamental/fundamentalConstants.H | 1 +
.../global/constants/mathematical/mathematicalConstants.H | 2 +-
.../global/constants/thermodynamic/thermodynamicConstants.H | 6 +++---
.../global/constants/universal/universalConstants.C | 1 -
9 files changed, 6 insertions(+), 19 deletions(-)
diff --git a/src/OpenFOAM/global/constants/atomic/atomicConstants.C b/src/OpenFOAM/global/constants/atomic/atomicConstants.C
index fa787fdb2e3..7afe7c39008 100644
--- a/src/OpenFOAM/global/constants/atomic/atomicConstants.C
+++ b/src/OpenFOAM/global/constants/atomic/atomicConstants.C
@@ -27,7 +27,6 @@ License
#include "universalConstants.H"
#include "electromagneticConstants.H"
#include "atomicConstants.H"
-
#include "dimensionedConstants.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/global/constants/constants.C b/src/OpenFOAM/global/constants/constants.C
index 926bcdf1a63..c1f653e137e 100644
--- a/src/OpenFOAM/global/constants/constants.C
+++ b/src/OpenFOAM/global/constants/constants.C
@@ -23,8 +23,6 @@ License
\*---------------------------------------------------------------------------*/
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
// Constants supplied in the main controlDict
#include "fundamentalConstants.C"
diff --git a/src/OpenFOAM/global/constants/constants.H b/src/OpenFOAM/global/constants/constants.H
index ae139b035e0..5ce8b5f696f 100644
--- a/src/OpenFOAM/global/constants/constants.H
+++ b/src/OpenFOAM/global/constants/constants.H
@@ -25,7 +25,7 @@ Namespace
Foam::constant
Description
- Collection of constants
+ Different types of constants
\*---------------------------------------------------------------------------*/
@@ -34,10 +34,7 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-// Mathematical constants
#include "mathematicalConstants.H"
-
-// Fundamental constants
#include "fundamentalConstants.H"
// Derived constants
diff --git a/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.C b/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.C
index f68f7c0ff8d..b08b88881b6 100644
--- a/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.C
+++ b/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.C
@@ -27,7 +27,6 @@ License
#include "universalConstants.H"
#include "electromagneticConstants.H"
#include "atomicConstants.H"
-
#include "dimensionedConstants.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.C b/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.C
index d3d3e5c0246..a187237aed3 100644
--- a/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.C
+++ b/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.C
@@ -21,9 +21,6 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-Description
- Fundamental dimensioned constants
-
\*---------------------------------------------------------------------------*/
#include "fundamentalConstants.H"
@@ -32,13 +29,10 @@ Description
#include "electromagneticConstants.H"
#include "atomicConstants.H"
#include "physicoChemicalConstants.H"
-
#include "dimensionedConstants.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-// Universal constants
-
namespace Foam
{
namespace constant
diff --git a/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.H b/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.H
index 4b5488902fd..98bd98a5067 100644
--- a/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.H
+++ b/src/OpenFOAM/global/constants/fundamental/fundamentalConstants.H
@@ -79,6 +79,7 @@ namespace physicoChemical
extern const dimensionedScalar k;
}
+//- Standard values
namespace standard
{
//- Standard pressure
diff --git a/src/OpenFOAM/global/constants/mathematical/mathematicalConstants.H b/src/OpenFOAM/global/constants/mathematical/mathematicalConstants.H
index a7121751479..442d4c54dde 100644
--- a/src/OpenFOAM/global/constants/mathematical/mathematicalConstants.H
+++ b/src/OpenFOAM/global/constants/mathematical/mathematicalConstants.H
@@ -25,7 +25,7 @@ Namespace
Foam::constant::mathematical
Description
- mathematical constants.
+ Mathematical constants.
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/global/constants/thermodynamic/thermodynamicConstants.H b/src/OpenFOAM/global/constants/thermodynamic/thermodynamicConstants.H
index 0c8378f87f4..ccca99a256f 100644
--- a/src/OpenFOAM/global/constants/thermodynamic/thermodynamicConstants.H
+++ b/src/OpenFOAM/global/constants/thermodynamic/thermodynamicConstants.H
@@ -43,13 +43,13 @@ namespace thermodynamic
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
- //- Universal gas constant (default in [J/(kmol K)])
+ //- Universal gas constant: default in [J/(kmol K)]
extern const scalar RR;
- //- Standard pressure (default in [Pa])
+ //- Standard pressure: default in [Pa]
extern const scalar Pstd;
- //- Standard temperature (default in [K])
+ //- Standard temperature: default in [K]
extern const scalar Tstd;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/global/constants/universal/universalConstants.C b/src/OpenFOAM/global/constants/universal/universalConstants.C
index aed91c8863f..d0caf52f10d 100644
--- a/src/OpenFOAM/global/constants/universal/universalConstants.C
+++ b/src/OpenFOAM/global/constants/universal/universalConstants.C
@@ -25,7 +25,6 @@ License
#include "universalConstants.H"
#include "mathematicalConstants.H"
-
#include "dimensionedConstants.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
--
GitLab