STYLE: adjust some line lengths, doxygen comments

applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C

@@ -45,7 +45,8 @@ Usage
         List some information about the geometry
 
       - \par -name \<name\>
-        Provide alternative base name for export. Default is <tt>meshExport</tt>.
+        Provide alternative base name for export.
+        Default is <tt>meshExport</tt>.
 
       - \par -noBaffles
         Remove any baffles by merging the faces.
@@ -57,7 +58,8 @@ Usage
         Use numbered patch/zone (not names) directly from ccm ids.
 
       - \par -remap \<name\>
-        use specified remapping dictionary instead of <tt>constant/remapping</tt>
+        Use specified remapping dictionary instead of
+        <tt>constant/remapping</tt>
 
       - \par -scale \<factor\>
         Specify an alternative geometry scaling factor.
@@ -92,7 +94,8 @@ int main(int argc, char *argv[])
     (
         "Reads CCM files as written by PROSTAR/STARCCM and writes an OPENFOAM "
         " polyMesh. Multi-region support for PROSTAR meshes should be stable."
-        " Multi-region merging for STARCCM meshes will not always be successful."
+        " Multi-region merging for STARCCM meshes will not always be"
+        " successful."
     );
 
     argList::noParallel();

applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C

@@ -44,10 +44,11 @@ Usage
         No backup of existing output files.
 
       - \par -remap \<name\>
-        use specified remapping dictionary instead of <tt>constant/remapping</tt>
+        Use specified remapping dictionary instead of
+        <tt>constant/remapping</tt>
 
       - \par -results
-        convert results only to CCM format
+        Convert results only to CCM format
 
 Note
     - No parallel data
@@ -207,7 +208,6 @@ int main(int argc, char *argv[])
         // #include "checkHasLagrangian.H"
 
         IOobjectList objects(mesh, timeDirs[timeDirs.size()-1].name());
-        //  IOobjectList sprayObjects(mesh, Times[Times.size()-1].name(), "lagrangian");
 
         forAll(timeDirs, timeI)
         {

src/OpenFOAM/db/IOobject/IOobject.H

@@ -174,11 +174,11 @@ protected:
     // Protected Member Functions
 
         //- Construct and return an IFstream for the object.
-        // \Return nullptr if the stream construction failed
+        // \return nullptr if the stream construction failed
         Istream* objectStream();
 
         //- Return an IFstream for the object given the exact file.
-        // \Return nullptr if the stream construction failed
+        // \return nullptr if the stream construction failed
         Istream* objectStream(const fileName& fName);
 
         //- Set the object state to bad

src/OpenFOAM/db/dictionary/entry/entry.H

@@ -85,7 +85,8 @@ class entry
         );
 
         //- Get the next valid keyword.
-        //  Warn when an invalid token is encountered that is not an end-of-block or eof
+        //  Warn when an invalid token is encountered that is not EOF or
+        //  end-of-block
         //  \return True if it is a valid keyType.
         static bool getKeyword(keyType& keyword, Istream& is);
 

src/OpenFOAM/db/dictionary/entry/entryIO.C

@@ -190,8 +190,8 @@ bool Foam::entry::New(dictionary& parentDict, Istream& is)
                 // Do not allow empty substitutions.
                 stringOps::inplaceExpand(expanded, parentDict, true, false);
 
-                // Restore the '$' prefix. Use replace since operator= is private
+                // Restore the '$' prefix.
-
+                // Use replace since operator= is private
                 keyword.std::string::replace(1, keyword.size()-1, expanded);
             }
 

src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C

@@ -334,15 +334,15 @@ bool Foam::functionObjectList::readFunctionObject
 
 Foam::functionObjectList::functionObjectList
 (
-    const Time& t,
+    const Time& runTime,
     const bool execution
 )
 :
     PtrList<functionObject>(),
     digests_(),
     indices_(),
-    time_(t),
+    time_(runTime),
-    parentDict_(t.controlDict()),
+    parentDict_(runTime.controlDict()),
     stateDictPtr_(),
     execution_(execution),
     updated_(false)
@@ -351,7 +351,7 @@ Foam::functionObjectList::functionObjectList
 
 Foam::functionObjectList::functionObjectList
 (
-    const Time& t,
+    const Time& runTime,
     const dictionary& parentDict,
     const bool execution
 )
@@ -359,7 +359,7 @@ Foam::functionObjectList::functionObjectList
     PtrList<functionObject>(),
     digests_(),
     indices_(),
-    time_(t),
+    time_(runTime),
     parentDict_(parentDict),
     stateDictPtr_(),
     execution_(execution),

src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H

@@ -130,7 +130,7 @@ public:
 
         //- Construct from Time, a dictionary with "functions" entry
         //  and the execution setting.
-        //  \param[in]  t - the other Time instance to construct from
+        //  \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.

src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/outletMappedUniformInletHeatAddition/outletMappedUniformInletHeatAdditionFvPatchField.H

@@ -125,8 +125,7 @@ public:
             const dictionary&
         );
 
-        //- Construct by mapping given outletMappedUniformInletHeatAdditionFvPatchField
+        //- Construct by mapping onto a new patch
-        //  onto a new patch
         outletMappedUniformInletHeatAdditionFvPatchField
         (
             const outletMappedUniformInletHeatAdditionFvPatchField&,

src/TurbulenceModels/schemes/DEShybrid/DEShybrid.H

@@ -83,7 +83,7 @@ Description
             2                         // Reference length scale
             0                         // Minimum sigma limit (0-1)
             1                         // Maximum sigma limit (0-1)
-            1.0e-03;                      // Limiter of B function, typically 1.0e-03
+            1.0e-03;                  // Limiter of B function, typically 1e-03
         .
         .
     }
@@ -98,8 +98,9 @@ Notes
     solvers by default.  In order to use the scheme, add the library as a
     run-time loaded library in the \$FOAM\_CASE/system/controlDict
     dictionary, e.g.:
-
+    \verbatim
         libs ("libturbulenceModelSchemes.so");
+    \endverbatim
 
 SourceFiles
     DEShybrid.C
@@ -122,7 +123,7 @@ namespace Foam
 {
 
 /*---------------------------------------------------------------------------*\
-                          class DEShybrid Declaration
+                          Class DEShybrid Declaration
 \*---------------------------------------------------------------------------*/
 
 template<class Type>
@@ -199,7 +200,11 @@ class DEShybrid
             const volScalarField g(tanh(pow4(B)));
             const volScalarField A
             (
-                 CH2_*max(scalar(0), CDES_*delta/max(lTurb*g, 1.0e-15*L0_) - 0.5)
+                CH2_*max
+                (
+                    scalar(0),
+                    CDES_*delta/max(lTurb*g, 1.0e-15*L0_) - 0.5
+                )
             );
 
             const volScalarField factor
@@ -266,37 +271,37 @@ public:
             if (U0_.value() <= 0)
             {
                 FatalErrorInFunction
-                    << "U0 coefficient must be greater than 0. "
+                    << "U0 coefficient must be > 0. "
                     << "Current value: " << U0_ << exit(FatalError);
             }
             if (L0_.value() <= 0)
             {
                 FatalErrorInFunction
-                    << "L0 coefficient must be greater than 0. "
+                    << "L0 coefficient must be > 0. "
                     << "Current value: " << L0_ << exit(FatalError);
             }
             if (sigmaMin_ < 0)
             {
                 FatalErrorInFunction
-                    << "sigmaMin coefficient must be greater than or equal to 0. "
+                    << "sigmaMin coefficient must be >= 0. "
                     << "Current value: " << sigmaMin_ << exit(FatalError);
             }
             if (sigmaMax_ < 0)
             {
                 FatalErrorInFunction
-                    << "sigmaMax coefficient must be greater than or equal to 0. "
+                    << "sigmaMax coefficient must be >= 0. "
                     << "Current value: " << sigmaMax_ << exit(FatalError);
             }
             if (sigmaMin_ > 1)
             {
                 FatalErrorInFunction
-                    << "sigmaMin coefficient must be less than or equal to 1. "
+                    << "sigmaMin coefficient must be <= 1. "
                     << "Current value: " << sigmaMin_ << exit(FatalError);
             }
             if (sigmaMax_ > 1)
             {
                 FatalErrorInFunction
-                    << "sigmaMax coefficient must be less than or equal to 1. "
+                    << "sigmaMax coefficient must be <= 1. "
                     << "Current value: " << sigmaMax_ << exit(FatalError);
             }
         }
@@ -331,37 +336,37 @@ public:
             if (U0_.value() <= 0)
             {
                 FatalErrorInFunction
-                    << "U0 coefficient must be greater than 0. "
+                    << "U0 coefficient must be > 0. "
                     << "Current value: " << U0_ << exit(FatalError);
             }
             if (L0_.value() <= 0)
             {
                 FatalErrorInFunction
-                    << "L0 coefficient must be greater than 0. "
+                    << "L0 coefficient must be > 0. "
                     << "Current value: " << U0_ << exit(FatalError);
             }
             if (sigmaMin_ < 0)
             {
                 FatalErrorInFunction
-                    << "sigmaMin coefficient must be greater than or equal to 0. "
+                    << "sigmaMin coefficient must be >= 0. "
                     << "Current value: " << sigmaMin_ << exit(FatalError);
             }
             if (sigmaMax_ < 0)
             {
                 FatalErrorInFunction
-                    << "sigmaMax coefficient must be greater than or equal to 0. "
+                    << "sigmaMax coefficient must be >= 0. "
                     << "Current value: " << sigmaMax_ << exit(FatalError);
             }
             if (sigmaMin_ > 1)
             {
                 FatalErrorInFunction
-                    << "sigmaMin coefficient must be less than or equal to 1. "
+                    << "sigmaMin coefficient must be <= 1. "
                     << "Current value: " << sigmaMin_ << exit(FatalError);
             }
             if (sigmaMax_ > 1)
             {
                 FatalErrorInFunction
-                    << "sigmaMax coefficient must be less than or equal to 1. "
+                    << "sigmaMax coefficient must be <= 1. "
                     << "Current value: " << sigmaMax_ << exit(FatalError);
             }
         }

src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.C

@@ -75,7 +75,12 @@ tmp<volScalarField> v2f<BasicTurbulenceModel>::Ls() const
                     max
                     (
                         this->nu(),
-                        dimensionedScalar("zero", this->nu()().dimensions(), 0.0)
+                        dimensionedScalar
+                        (
+                            "zero",
+                            this->nu()().dimensions(),
+                            0.0
+                        )
                     )
                 )/epsilon_
             )

src/combustionModels/diffusionMulticomponent/diffusionMulticomponent.C

@@ -380,7 +380,9 @@ Foam::combustionModels::diffusionMulticomponent<CombThermoType, ThermoType>::R
 
     if (this->active())
     {
-        const label specieI = this->thermo().composition().species()[Y.member()];
+        const label specieI =
+            this->thermo().composition().species()[Y.member()];
+
         Su += this->chemistryPtr_->RR(specieI);
     }
 

src/conversion/ccm/reader/ccmReader.C

@@ -211,7 +211,8 @@ void Foam::ccm::reader::readProblemDescription
 
 
 // readInterfaceDefinitions:
-// - get /InterfaceDefinitions. used by STARCCM to define in-place interfaces, etc
+// - get /InterfaceDefinitions.
+//   used by STARCCM to define in-place interfaces, etc
 // - only handle in-place one here
 void Foam::ccm::reader::readInterfaceDefinitions()
 {
@@ -388,7 +389,8 @@ void Foam::ccm::reader::readProblemDescription_boundaryRegion
             )
             {
 #ifdef DEBUG_CCMIOREAD
-                Info<< "boundary is on an interface: remap name for  " << Id << endl;
+                Info<< "boundary is on an interface: remap name for  "
+                    << Id << endl;
 #endif
                 // Substitute immediately with interface name
                 str = interfaceDefinitions_.interfaceName(Id);

src/conversion/ccm/reader/ccmReader.H

@@ -329,8 +329,9 @@ private:
         //- Get interfaces, cellTable and boundaryRegion information
         void readProblemDescription(const ccmID& probNode);
 
-        //- Get /InterfaceDefinitions, used by STARCCM to define in-place interfaces, etc
+        //- Get /InterfaceDefinitions, used by STARCCM to define in-place
-        //  only handle in-place (IN_PLACE) ones at the moment
+        //  interfaces, etc.
+        //  Only handle in-place (IN_PLACE) ones at the moment
         void readInterfaceDefinitions();
 
         //- Get boundaryRegion information
@@ -358,7 +359,8 @@ private:
         //- Read the monitoring
         void readMonitoring(const ccmID& topoId);
 
-        //- Move solid faces from Default_Boundary_Region -> Default_Boundary_Solid
+        //- Move solid faces from Default_Boundary_Region to
+        //  Default_Boundary_Solid
         void juggleSolids();
 
         //- Remove unwanted fluid/porous/solid regions

src/conversion/ccm/reader/ccmReaderMesh.C

@@ -1053,7 +1053,11 @@ void Foam::ccm::reader::readMonitoring
             //
             //- simulate ReadFaceCells with kCCMIOBoundaryFaces
             // CCMIOGetNode(nullptr, childNode, "Cells", &subNode);
-            // CCMIORead1i(nullptr, subNode, faceCells.begin(), kCCMIOStart, kCCMIOEnd);
+            // CCMIORead1i
+            // (
+            //     nullptr, subNode, faceCells.begin(),
+            //     kCCMIOStart, kCCMIOEnd
+            // );
             //
             // Info << "cells: " << faceCells << endl;
         }
@@ -1159,7 +1163,8 @@ void Foam::ccm::reader::juggleSolids()
     // Adjust start and sizes
     patchSizes_[patchIndex] -= adjustPatch;
     patchSizes_[patchIndex+1] = adjustPatch;
-    patchStarts[patchIndex+1] = patchStarts[patchIndex] + patchSizes_[patchIndex];
+    patchStarts[patchIndex+1] =
+        patchStarts[patchIndex] + patchSizes_[patchIndex];
 
     origBndId_[patchIndex+1] = boundaryRegion_.append
     (
@@ -1686,8 +1691,9 @@ void Foam::ccm::reader::cleanupInterfaces()
                         oldToNew[face0] = pos + nsorted;
                         oldToNew[face1] = pos + nsorted + nsizeby2;
 
-                        // Mark destination of the faces, but cannot renumber yet
+                        // Mark destination of the faces, but cannot renumber
-                        // use negative to potential overlap with other patch regions
+                        // yet. Use negative to potential overlap with other
+                        // patch regions
                         bafInterfaces_[elemI][0] = -oldToNew[face0];
                         bafInterfaces_[elemI][1] = -oldToNew[face1];
 
@@ -1743,14 +1749,6 @@ void Foam::ccm::reader::cleanupInterfaces()
             oldToNew[face1] = oldToNew[face0];
         }
 
-//         Info<< "nInternalFaces " << nInternalFaces_ << nl
-//             << "oldToNew (internal) "
-//             << SubList<label>(oldToNew, nInternalFaces_)
-//             << nl
-//             << "oldToNew (extern) "
-//             << SubList<label>(oldToNew, nFaces_ - nInternalFaces_, nInternalFaces_)
-//             << endl;
-
         forAllIters(monitoringSets_, iter)
         {
             inplaceRenumber(oldToNew, iter());

src/conversion/ccm/writer/ccmWriterMesh.C

@@ -162,7 +162,8 @@ void Foam::ccm::writer::writeFaces
 
     if (ccm::debug)
     {
-        Info<<"CCMIOWriteFaces()  size:" << size << " streamSize:" << streamSize << endl;
+        Info<<"CCMIOWriteFaces()  size:" << size << " streamSize:"
+            << streamSize << endl;
     }
 
     CCMIOWriteFaces

src/conversion/fire/FIREMeshReader.C

@@ -241,7 +241,8 @@ void Foam::fileFormats::FIREMeshReader::reorganize()
     inplaceReorder(oldToNew, neigh_);
     inplaceReorder(oldToNew, faceZoneId_);
 
-    // determine the patch sizes - faceNames_ already has extra place for missed faces
+    // Determine the patch sizes
+    // - faceNames_ already has extra place for missed faces
     const label zoneMissed = faceNames_.size() - 1;
     patchSizes_.setSize(faceNames_.size());
     patchSizes_ = 0;
@@ -292,7 +293,8 @@ void Foam::fileFormats::FIREMeshReader::reorganize()
         label patchI = faceZoneId_[faceI];
         if (patchI == -1)
         {
-            oldToNew[faceI] = patchStarts_[zoneMissed] + patchSizes_[zoneMissed];
+            oldToNew[faceI] =
+                patchStarts_[zoneMissed] + patchSizes_[zoneMissed];
             ++patchSizes_[zoneMissed];
         }
         else

src/conversion/starcd/STARCDMeshReader.C

@@ -864,7 +864,9 @@ void Foam::fileFormats::STARCDMeshReader::readBoundary
                     if (prostarShapeLookup.found(mapIndex))
                     {
                         mapIndex = prostarShapeLookup[mapIndex];
-                        cellFaceId = STARCDCore::starToFoamFaceAddr[mapIndex][cellFaceId];
+                        cellFaceId =
+                            STARCDCore::starToFoamFaceAddr
+                            [mapIndex][cellFaceId];
                     }
                 }
                 else

src/conversion/starcd/STARCDMeshWriter.C

@@ -409,7 +409,8 @@ void Foam::fileFormats::STARCDMeshWriter::writeBoundary
                 }
 
                 mapIndex = prostarShapeLookup[mapIndex];
-                cellFaceId = STARCDCore::foamToStarFaceAddr[mapIndex][cellFaceId];
+                cellFaceId =
+                    STARCDCore::foamToStarFaceAddr[mapIndex][cellFaceId];
             }
             // Info<< endl;
 

src/dynamicMesh/fvMeshTools/fvMeshTools.C

@@ -483,7 +483,11 @@ Foam::autoPtr<Foam::fvMesh> Foam::fvMeshTools::newMesh
     else
     {
         // Receive patches
-        IPstream fromMaster(Pstream::commsTypes::scheduled, Pstream::masterNo());
+        IPstream fromMaster
+        (
+            Pstream::commsTypes::scheduled,
+            Pstream::masterNo()
+        );
         fromMaster >> patchEntries;
     }
 

src/fileFormats/ensight/file/ensightCase.C

@@ -307,7 +307,8 @@ void Foam::ensightCase::noteCloud
     else
     {
         FatalErrorInFunction
-            << "Tried to add a cloud variable for writing without having added a cloud"
+            << "Tried to add a cloud variable for writing"
+            << " - without having added a cloud"
             << abort(FatalError);
     }
 }

src/fileFormats/ensight/file/ensightCase.H

@@ -280,12 +280,12 @@ public:
         ) const;
 
 
-        //- Open stream for new data file (on master), using the current index.
+        //- Open stream for new data file (on master), with current index.
         template<class Type>
         autoPtr<ensightFile> newData(const word& varName) const;
 
 
-        //- Open stream for new cloud data file (on master), using the current index.
+        //- Open stream for new cloud data file (on master), with current index.
         template<class Type>
         autoPtr<ensightFile> newCloudData
         (

src/fileFormats/starcd/STARCDCore.H

@@ -147,7 +147,11 @@ public:
     // Public Member Functions
 
         //- Resolve base file-name for the given file-type
-        static fileName starFileName(const fileName& baseName, const enum fileExt);
+        static fileName starFileName
+        (
+            const fileName& baseName,
+            const enum fileExt
+        );
 
 
         //- Remove existing PROSTAR files for the given base file-name

src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.C

@@ -287,7 +287,8 @@ void Foam::activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs()
             }
             else
             {
-                Info<< "Area-averaged pressure difference = " << valueDiff << endl;
+                Info<< "Area-averaged pressure difference = "
+                    << valueDiff << endl;
             }
         }
 

src/functionObjects/graphics/runTimePostProcessing/pointData.C

@@ -130,7 +130,8 @@ Foam::functionObjects::runTimePostPro::pointData::pointData
 
 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
 
-Foam::autoPtr<Foam::functionObjects::runTimePostPro::pointData> Foam::functionObjects::runTimePostPro::pointData::New
+Foam::autoPtr<Foam::functionObjects::runTimePostPro::pointData>
+Foam::functionObjects::runTimePostPro::pointData::New
 (
     const runTimePostProcessing& parent,
     const dictionary& dict,

src/lagrangian/DSMC/submodels/BinaryCollisionModel/LarsenBorgnakkeVariableHardSphere/LarsenBorgnakkeVariableHardSphere.C

@@ -245,12 +245,14 @@ void Foam::LarsenBorgnakkeVariableHardSphere<CloudType>::collide
 
             if (iDofQ == 2)
             {
-                scalar energyRatio = 1.0 - pow(rndGen.sample01<scalar>(), (1.0/ChiB));
+                const scalar energyRatio =
+                    1.0 - pow(rndGen.sample01<scalar>(), (1.0/ChiB));
+
                 EiQ = energyRatio*availableEnergy;
             }
             else
             {
-                scalar ChiA = 0.5*iDofQ;
+                const scalar ChiA = 0.5*iDofQ;
                 EiQ = energyRatio(ChiA, ChiB)*availableEnergy;
             }
 

src/lumpedPointMotion/lumpedPointMovement.C

@@ -302,7 +302,8 @@ void Foam::lumpedPointMovement::setBoundBox
         centre_ -= (centre_ & axis_) * axis_;
         if (lumpedPointIOMovement::debug)
         {
-            Pout<<"autoCentre on " << centre_ << " boundBox: " << boundBox_ << endl;
+            Pout<<"autoCentre on " << centre_
+                << " boundBox: " << boundBox_ << endl;
         }
     }
     else
@@ -310,7 +311,8 @@ void Foam::lumpedPointMovement::setBoundBox
         // User-specified centre
         if (lumpedPointIOMovement::debug)
         {
-            Pout<<"centre on " << centre_ << " boundBox: " << boundBox_ << endl;
+            Pout<<"centre on " << centre_
+                << " boundBox: " << boundBox_ << endl;
         }
     }
 }