From 707b29bbbd60f155f1346dba480e889479e42fb6 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Wed, 22 Jul 2020 19:11:28 +0200 Subject: [PATCH] STYLE: minor doc and formatting changes --- src/OpenFOAM/containers/HashTables/Map/Map.H | 4 +--- src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H | 2 +- src/OpenFOAM/db/error/messageStream.H | 2 +- .../functionObjects/functionObject/functionObject.H | 6 +++--- .../functionObjectList/functionObjectList.H | 12 +++++------- src/OpenFOAM/memory/tmpNrc/tmpNrc.H | 2 +- .../fanPressure/fanPressureFvPatchScalarField.C | 10 +++++----- 7 files changed, 17 insertions(+), 21 deletions(-) diff --git a/src/OpenFOAM/containers/HashTables/Map/Map.H b/src/OpenFOAM/containers/HashTables/Map/Map.H index 6495d456dc..406151539d 100644 --- a/src/OpenFOAM/containers/HashTables/Map/Map.H +++ b/src/OpenFOAM/containers/HashTables/Map/Map.H @@ -73,7 +73,7 @@ public: // Constructors - //- Construct null with default table capacity + //- Default construct with default table capacity Map() : parent_type() @@ -125,8 +125,6 @@ public: { parent_type::operator=(std::move(rhs)); } - - }; diff --git a/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H b/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H index 4be11db88f..46963c08f0 100644 --- a/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H +++ b/src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H @@ -65,7 +65,7 @@ public: // Constructors - //- Construct null with default table capacity + //- Default construct with default table capacity PtrMap() : parent_type() diff --git a/src/OpenFOAM/db/error/messageStream.H b/src/OpenFOAM/db/error/messageStream.H index abd624c3e2..cff2c8a198 100644 --- a/src/OpenFOAM/db/error/messageStream.H +++ b/src/OpenFOAM/db/error/messageStream.H @@ -369,7 +369,7 @@ extern messageStream SeriousError; //- Report an information message using Foam::Pout // for FUNCTION_NAME in file __FILE__ at line __LINE__ // if the local debug switch is true -#define DebugPoutInFunction \ +#define DebugPoutInFunction \ if (debug) PoutInFunction //- Report a variable name and value diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H index 852ff5ac7a..dd43486501 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H @@ -98,9 +98,9 @@ Description where the entries mean: \table - Property | Description | Type | Req'd | Dflt + Property | Description | Type | Reqd | Deflt type | Type name of function object | word | yes | - - libs | Library name containing implementation | word | yes | - + libs | Library name(s) for implementation | words | no | - region | Name of region for multi-region cases | word | no | region0 enabled | Switch to turn function object on/off | bool | no | true log | Switch to write log info to standard output | bool | no | true @@ -199,7 +199,7 @@ SourceFiles namespace Foam { -// Forward declarations +// Forward Declarations class Time; class polyMesh; class mapPolyMesh; diff --git a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H index 744dd331d6..bc1801e18e 100644 --- a/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H +++ b/src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H @@ -79,9 +79,8 @@ class functionObjectList //- Reference to Time const Time& time_; - //- The parent dictionary containing a "functions" entry - // This entry can either be a list or a dictionary of - // functionObject specifications + //- The parent dictionary containing a "functions" sub-dictionary + //- of functionObject specifications const dictionary& parentDict_; //- Function object properties - stores state information @@ -146,12 +145,11 @@ public: const bool execution=true ); - //- Construct from Time, a dictionary with "functions" entry - // and the execution setting. + //- Construct from Time, a dictionary with a "functions" entry + //- and the execution setting. // \param[in] runTime - the other Time instance to construct from // \param[in] parentDict - the parent dictionary containing - // a "functions" entry, which can either be a list or a dictionary - // of functionObject specifications. + // a "functions" sub-dictionary of functionObject specifications. // \param[in] execution - whether the function objects should execute // or not. Default: true. functionObjectList diff --git a/src/OpenFOAM/memory/tmpNrc/tmpNrc.H b/src/OpenFOAM/memory/tmpNrc/tmpNrc.H index 5756480033..fa63980fbd 100644 --- a/src/OpenFOAM/memory/tmpNrc/tmpNrc.H +++ b/src/OpenFOAM/memory/tmpNrc/tmpNrc.H @@ -5,7 +5,7 @@ \\ / A nd | www.openfoam.com \\/ M anipulation | ------------------------------------------------------------------------------- - Copyright (C) 2002 OpenCFD Ltd. + Copyright (C) 2020 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM, distributed under GPL-3.0-or-later. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.C index fff43cf530..59e729de7a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.C @@ -163,11 +163,11 @@ void Foam::fanPressureFvPatchScalarField::updateCoeffs() else { FatalErrorInFunction - << "dimensions of phi are not correct" - << "\n on patch " << patch().name() - << " of field " << internalField().name() - << " in file " << internalField().objectPath() << nl - << exit(FatalError); + << "dimensions of phi are not correct\n" + << " on patch " << patch().name() + << " of field " << internalField().name() + << " in file " << internalField().objectPath() << nl + << exit(FatalError); } if (nonDimensional_)