From 8628ef2fea3c89acfb326218a05a56971ff90e4a Mon Sep 17 00:00:00 2001 From: Henry <Henry> Date: Sat, 14 Feb 2015 13:10:15 +0000 Subject: [PATCH] Corrected capitalization of Doxygen documentation comments --- .../mixedFixedValueSlipFvPatchField.H | 2 +- .../twoPhaseMixtureThermo.H | 6 +- .../multiphaseMixtureThermo.H | 6 +- .../relativeVelocityModels/general/general.H | 4 +- .../relativeVelocityModels/simple/simple.H | 4 +- .../phaseChangeTwoPhaseMixtures/Kunz/Kunz.H | 4 +- .../Merkle/Merkle.H | 4 +- .../SchnerrSauer/SchnerrSauer.H | 4 +- .../dragModels/dragModel/dragModel.H | 4 +- .../heatTransferModel/heatTransferModel.H | 4 +- .../HrenyaSinclairConductivity.H | 4 +- .../twoPhaseSystem/phaseModel/phaseModel.H | 4 +- .../advanced/collapseEdges/meshQualityDict | 2 +- .../mesh/conversion/star3ToFoam/starMesh.H | 4 +- .../backgroundMeshDecomposition.H | 2 +- .../linearDistance/linearDistance.H | 6 +- .../surfaceOffsetLinearDistance.H | 2 +- .../conformalVoronoiMesh.H | 4 +- .../pointFeatureEdgesTypes.H | 2 +- .../indexedCell/indexedCell.H | 2 +- .../cvControls/cvControls.H | 4 +- .../foamyMesh/foamyHexMesh/foamyHexMeshDict | 2 +- .../foamyHexMeshSurfaceSimplify.C | 4 +- .../mesh/manipulation/stitchMesh/stitchMesh.C | 4 +- .../ensightOutputFunctions.C | 4 +- .../ensightOutputFunctions.H | 4 +- .../dataConversion/foamToTecplot360/vtkMesh.H | 4 +- .../dataConversion/foamToVTK/vtkMesh.H | 4 +- .../dataConversion/foamToVTK/vtkTopo.H | 4 +- .../PV3FoamReader/vtkPV3Foam/vtkPV3Foam.H | 6 +- .../vtkPV3blockMesh/vtkPV3blockMesh.H | 10 +-- .../PV4FoamReader/vtkPV4Foam/vtkPV4Foam.H | 6 +- .../vtkPV4blockMesh/vtkPV4blockMesh.H | 10 +-- .../miscellaneous/postChannel/channelIndex.H | 6 +- bin/tools/doxyFilter.awk | 4 +- etc/caseDicts/meshQualityDict | 2 +- src/OSspecific/POSIX/fileMonitor.C | 6 +- src/OSspecific/POSIX/fileStat.H | 8 +-- .../POSIX/signals/sigStopAtWriteNow.H | 4 +- src/OSspecific/POSIX/signals/sigWriteNow.H | 4 +- src/OSspecific/POSIX/timer.H | 14 ++-- .../dynamicIndexedOctree.H | 4 +- .../algorithms/indexedOctree/indexedOctree.H | 4 +- .../algorithms/indexedOctree/treeDataCell.H | 4 +- .../HashTables/HashTable/HashTable.H | 4 +- .../StaticHashTable/StaticHashTable.H | 8 +-- .../linkTypes/DLListBase/DLListBase.H | 4 +- .../linkTypes/SLListBase/SLListBase.H | 4 +- .../containers/Lists/PackedList/PackedList.H | 6 +- .../db/IOstreams/IOstreams/IOstream.H | 4 +- .../db/IOstreams/Pstreams/PstreamBuffers.H | 8 +-- .../db/dynamicLibrary/codedBase/codedBase.H | 6 +- .../codedFixedValuePointPatchField.H | 6 +- ...eVaryingUniformFixedValuePointPatchField.H | 4 +- .../pointConstraint/pointConstraint.H | 6 +- src/OpenFOAM/global/argList/argList.H | 4 +- .../electromagneticConstants.H | 4 +- src/OpenFOAM/include/OSspecific.H | 4 +- .../interpolation2DTable.H | 4 +- .../interpolationTable/interpolationTable.H | 4 +- .../tableReaders/csv/csvTableReader.H | 4 +- .../matrices/LduMatrix/LduMatrix/LduMatrix.H | 4 +- .../matrices/lduMatrix/lduMatrix/lduMatrix.H | 4 +- .../matrices/scalarMatrices/SVD/SVD.H | 4 +- .../ProcessorTopology/ProcessorTopology.H | 4 +- .../meshes/ProcessorTopology/commSchedule.H | 4 +- .../meshShapes/cellMatcher/hexMatcher.H | 4 +- .../meshShapes/cellMatcher/prismMatcher.H | 4 +- .../meshShapes/cellMatcher/pyrMatcher.H | 4 +- .../meshShapes/cellMatcher/tetMatcher.H | 4 +- .../meshShapes/cellMatcher/tetWedgeMatcher.H | 4 +- .../meshShapes/cellMatcher/wedgeMatcher.H | 4 +- src/OpenFOAM/meshes/meshShapes/edge/edge.H | 4 +- src/OpenFOAM/meshes/meshShapes/face/face.H | 4 +- .../meshes/meshShapes/triFace/triFace.H | 4 +- .../polyMesh/globalMeshData/globalIndex.H | 4 +- .../polyMesh/mapPolyMesh/mapAddedPolyMesh.H | 10 +-- .../mapDistribute/mapDistributeLagrangian.H | 4 +- .../mapDistribute/mapDistributePolyMesh.H | 12 ++-- .../mapPatchChange/mapPatchChange.H | 6 +- src/OpenFOAM/meshes/polyMesh/polyMesh.H | 6 +- .../polyMeshTetDecomposition/tetIndices.H | 14 ++-- .../basic/coupled/coupledPolyPatch.H | 8 +-- .../constraint/cyclic/cyclicPolyPatch.H | 6 +- .../constraint/oldCyclic/oldCyclicPolyPatch.C | 4 +- .../constraint/oldCyclic/oldCyclicPolyPatch.H | 4 +- .../preservePatchTypes/preservePatchTypes.H | 4 +- .../primitiveShapes/objectHit/PointIndexHit.H | 4 +- .../primitiveShapes/objectHit/pointHitSort.H | 4 +- .../meshes/treeBoundBox/treeBoundBox.H | 4 +- src/OpenFOAM/primitives/Vector2D/Vector2D.H | 4 +- .../globalIndexAndTransform.H | 4 +- .../primitives/hashes/Hasher/Hasher.C | 4 +- src/OpenFOAM/primitives/ints/int32/int32.H | 2 +- src/OpenFOAM/primitives/ints/int64/int64.H | 2 +- src/OpenFOAM/primitives/ints/uint32/uint32.H | 2 +- src/OpenFOAM/primitives/ints/uint64/uint64.H | 2 +- .../primitives/random/Random/Random.H | 10 +-- .../primitives/strings/lists/hashedWordList.H | 4 +- src/OpenFOAM/primitives/triad/triad.H | 4 +- ...entHeatFluxTemperatureFvPatchScalarField.C | 2 +- .../LienCubicKELowReSetWallDissipation.H | 2 +- .../LienLeschzinerLowReSetWallDissipation.H | 2 +- .../RAS/include/nonLinearWallFunctionsI.H | 2 +- .../atmBoundaryLayer/atmBoundaryLayer.H | 2 +- ...thDissipationRateInletFvPatchScalarField.H | 4 +- src/conversion/ensight/file/ensightFile.H | 22 +++--- src/conversion/ensight/file/ensightGeoFile.H | 4 +- src/conversion/ensight/part/ensightPart.H | 68 +++++++++---------- .../ensight/part/ensightPartCells.H | 16 ++--- .../ensight/part/ensightPartFaces.H | 14 ++-- src/conversion/ensight/part/ensightParts.H | 24 +++---- src/conversion/meshReader/meshReader.H | 6 +- .../meshReader/starcd/STARCDMeshReader.C | 4 +- src/conversion/meshTables/cellTable.H | 4 +- src/dynamicMesh/boundaryMesh/boundaryMesh.H | 10 +-- src/dynamicMesh/meshCut/cellCuts/cellCuts.H | 4 +- .../meshCut/cellLooper/hexCellLooper.H | 4 +- .../meshCut/cellLooper/topoCellLooper.H | 6 +- .../meshCut/edgeVertex/edgeVertex.H | 8 +-- .../multiDirRefinement/multiDirRefinement.H | 4 +- .../meshCut/refineCell/refineCell.H | 6 +- .../motionSmoother/motionSmootherAlgo.H | 6 +- .../polyTopoChange/addPatchCellLayer.H | 4 +- .../polyTopoChange/polyTopoChange/hexRef8.H | 4 +- .../polyTopoChange/refinementDistanceData.H | 6 +- .../polyTopoChange/refinementHistory.H | 4 +- src/engine/engineTime/engineTime.H | 2 +- src/fileFormats/vtk/vtkUnstructuredReader.H | 14 ++-- .../porosityModel/fixedCoeff/fixedCoeff.H | 6 +- .../codedFixedValueFvPatchField.H | 6 +- .../codedMixed/codedMixedFvPatchField.H | 6 +- .../syringePressureFvPatchScalarField.H | 8 +-- .../cellPointWeight/cellPointWeight.H | 6 +- .../interpolationPointMVC/pointMVCWeight.H | 4 +- .../motionDiffusivity/motionDiffusivity.H | 4 +- ...surfaceDisplacementPointPatchVectorField.H | 8 +-- ...aceSlipDisplacementPointPatchVectorField.H | 10 +-- .../sources/general/codedSource/CodedSource.H | 6 +- src/lagrangian/basic/particle/particle.H | 4 +- .../distributionModels/general/general.H | 4 +- .../clouds/Templates/DsmcCloud/DsmcCloud.H | 12 ++-- .../PairSpringSliderDashpot.H | 4 +- .../WallLocalSpringSliderDashpot.H | 4 +- .../WallSpringSliderDashpot.H | 4 +- .../ConeNozzleInjection/ConeNozzleInjection.H | 4 +- .../IsotropyModels/NoIsotropy/NoIsotropy.H | 4 +- .../distribution/distribution.H | 4 +- .../AtomizationModel/AtomizationModel.H | 4 +- .../BlobsSheetAtomization.H | 6 +- .../LISAAtomization/LISAAtomization.H | 6 +- .../spray/submodels/BreakupModel/ETAB/ETAB.H | 4 +- .../BreakupModel/NoBreakup/NoBreakup.H | 4 +- .../BreakupModel/PilchErdman/PilchErdman.H | 4 +- .../BreakupModel/ReitzDiwakar/ReitzDiwakar.H | 4 +- .../BreakupModel/ReitzKHRT/ReitzKHRT.H | 4 +- .../spray/submodels/BreakupModel/SHF/SHF.H | 4 +- .../spray/submodels/BreakupModel/TAB/TAB.H | 4 +- .../autoHexMeshDriver/autoLayerDriver.H | 6 +- .../autoHexMeshDriver/autoSnapDriverFeature.C | 6 +- .../autoHexMeshDriver/pointData/pointData.H | 6 +- .../medialAxisMeshMover.H | 6 +- .../meshRefinement/meshRefinement.H | 24 +++---- .../meshRefinement/meshRefinementRefine.C | 10 +-- .../meshRefinement/patchFaceOrientation.H | 4 +- .../trackedParticle/trackedParticle.H | 26 +++---- src/mesh/blockMesh/blockMesh/blockMesh.H | 4 +- .../linearDirection/linearDirection.H | 4 +- .../extrudeModel/linearNormal/linearNormal.H | 8 +-- .../AMIMethod/AMIMethod/AMIMethod.H | 4 +- .../cyclicAMIPolyPatch/cyclicAMIPolyPatch.H | 4 +- .../PatchEdgeFaceWave/patchEdgeFaceInfo.H | 6 +- .../PatchEdgeFaceWave/patchEdgeFaceRegions.H | 4 +- .../algorithms/PointEdgeWave/pointEdgePoint.H | 6 +- src/meshTools/cellDist/wallPoint/wallPoint.H | 6 +- .../cellDist/wallPoint/wallPointData.H | 4 +- src/meshTools/cellFeatures/cellFeatures.H | 4 +- .../coordinateRotation/axesRotation.H | 6 +- .../coordinateSystems/coordinateSystems.H | 4 +- .../edgeFaceCirculator/edgeFaceCirculator.H | 8 +-- src/meshTools/indexedOctree/treeDataEdge.H | 8 +-- src/meshTools/indexedOctree/treeDataFace.H | 6 +- .../indexedOctree/treeDataPrimitivePatch.H | 4 +- src/meshTools/meshSearch/meshSearch.H | 22 +++--- .../searchableSurface/searchableCylinder.H | 6 +- .../searchableSurfaceCollection.H | 16 ++--- .../searchableSurfaceWithGaps.H | 4 +- .../sets/cellSources/boxToCell/boxToCell.H | 4 +- .../cellSources/fieldToCell/fieldToCell.H | 6 +- .../cellSources/labelToCell/labelToCell.H | 4 +- .../cellSources/nearestToCell/nearestToCell.H | 4 +- .../rotatedBoxToCell/rotatedBoxToCell.H | 4 +- .../cellSources/shapeToCell/shapeToCell.H | 4 +- .../cellSources/surfaceToCell/surfaceToCell.H | 10 +-- .../sets/faceSources/boxToFace/boxToFace.H | 4 +- .../faceSources/labelToFace/labelToFace.H | 4 +- .../sets/pointSources/boxToPoint/boxToPoint.H | 4 +- .../pointSources/labelToPoint/labelToPoint.H | 4 +- .../nearestToPoint/nearestToPoint.H | 4 +- .../surfaceToPoint/surfaceToPoint.H | 8 +-- .../booleanSurface/booleanSurface.H | 4 +- .../intersectedSurface/edgeSurface.H | 4 +- .../surfaceIntersection/edgeIntersections.H | 4 +- .../surfaceFeatures/surfaceFeatures.H | 8 +-- .../triSurfaceTools/triSurfaceTools.H | 8 +-- .../hierarchGeomDecomp/hierarchGeomDecomp.H | 6 +- .../manualDecomp/manualDecomp.H | 4 +- .../decompositionMethods/noDecomp/noDecomp.H | 4 +- .../decompose/scotchDecomp/scotchDecomp.C | 2 +- .../distributedTriSurfaceMesh.H | 4 +- .../field/fieldValues/faceSource/faceSource.H | 4 +- .../field/nearWallFields/findCellParticle.H | 10 +-- .../regionSizeDistribution.C | 4 +- .../field/streamLine/streamLineParticle.H | 8 +-- .../wallBoundedStreamLineParticle.H | 8 +-- .../codedFunctionObject/codedFunctionObject.H | 6 +- src/sampling/cuttingPlane/cuttingPlane.H | 6 +- src/sampling/probes/probesTemplates.C | 4 +- .../sampledSet/polyLine/polyLineSet.H | 4 +- .../sampledSet/sampledSets/sampledSets.H | 6 +- .../distanceSurface/distanceSurface.H | 30 ++++---- .../isoSurface/sampledIsoSurface.H | 32 ++++----- .../isoSurface/sampledIsoSurfaceCell.H | 28 ++++---- .../sampledCuttingPlane/sampledCuttingPlane.H | 30 ++++---- .../sampledPatchInternalField.H | 4 +- .../sampledPlane/sampledPlane.H | 24 +++---- .../sampledSurface/sampledSurface.H | 4 +- .../sampledSurfaces/sampledSurfaces.H | 8 +-- .../sampledTriSurfaceMesh.H | 24 +++---- .../sampledThresholdCellFaces.H | 24 +++---- .../externalPointEdgePoint.H | 6 +- src/surfMesh/MeshedSurface/MeshedSurface.H | 6 +- src/surfMesh/surfZone/surfZone/surfZone.H | 4 +- .../surfaceFormats/ftr/FTRsurfaceFormat.H | 4 +- .../Chung/Chung.H | 4 +- .../Wallis/Wallis.H | 4 +- .../linear/linear.H | 4 +- .../basic/basicThermo/basicThermo.H | 6 +- .../basic/heThermo/heThermo.H | 6 +- .../chemkinReader/chemkinReader.H | 4 +- .../thermo/hExponential/hExponentialThermo.H | 4 +- .../specie/thermo/thermo/thermo.H | 4 +- .../viscosityModels/BirdCarreau/BirdCarreau.H | 4 +- .../viscosityModels/Newtonian/Newtonian.H | 4 +- .../meshTriangulation/meshTriangulation.H | 8 +-- .../tools/labelledTri/sortLabelledTri.H | 4 +- .../triSurface/surfacePatch/surfacePatch.H | 4 +- src/triSurface/triSurface/triSurface.H | 6 +- .../iglooWithFridges/system/snappyHexMeshDict | 2 +- .../system/snappyHexMeshDict | 2 +- .../propeller/system/snappyHexMeshDict | 4 +- .../system/snappyHexMeshDict | 4 +- .../motorBike/system/snappyHexMeshDict | 4 +- .../motorBike/system/snappyHexMeshDict | 2 +- .../constant/polyMesh/blockMeshDict | 2 +- .../turbineSiting/system/snappyHexMeshDict | 6 +- .../cyclone/system/snappyHexMeshDict | 2 +- .../foamyHexMesh/blob/system/meshQualityDict | 2 +- .../blob/system/snappyHexMeshDict | 2 +- .../flange/system/meshQualityDict | 2 +- .../flange/system/snappyHexMeshDict | 2 +- .../simpleShapes/system/meshQualityDict | 2 +- .../flange/system/snappyHexMeshDict | 2 +- .../DTCHull/system/meshQualityDict | 6 +- .../ras/DTCHull/system/meshQualityDict | 6 +- .../mixerVesselAMI/system/snappyHexMeshDict | 2 +- .../propeller/system/snappyHexMeshDict | 4 +- .../cavitatingBullet/system/snappyHexMeshDict | 4 +- 268 files changed, 818 insertions(+), 818 deletions(-) diff --git a/applications/solvers/compressible/rhoCentralFoam/BCs/mixedFixedValueSlip/mixedFixedValueSlipFvPatchField.H b/applications/solvers/compressible/rhoCentralFoam/BCs/mixedFixedValueSlip/mixedFixedValueSlipFvPatchField.H index 46d71ab0df3..d27b722a936 100644 --- a/applications/solvers/compressible/rhoCentralFoam/BCs/mixedFixedValueSlip/mixedFixedValueSlipFvPatchField.H +++ b/applications/solvers/compressible/rhoCentralFoam/BCs/mixedFixedValueSlip/mixedFixedValueSlipFvPatchField.H @@ -85,7 +85,7 @@ public: ); //- Construct by mapping given mixedFixedValueSlipFvPatchField - //- onto a new patch + //- Onto a new patch mixedFixedValueSlipFvPatchField ( const mixedFixedValueSlipFvPatchField<Type>&, diff --git a/applications/solvers/multiphase/compressibleInterFoam/twoPhaseMixtureThermo/twoPhaseMixtureThermo.H b/applications/solvers/multiphase/compressibleInterFoam/twoPhaseMixtureThermo/twoPhaseMixtureThermo.H index 608dc91a9b1..b8320bd105e 100644 --- a/applications/solvers/multiphase/compressibleInterFoam/twoPhaseMixtureThermo/twoPhaseMixtureThermo.H +++ b/applications/solvers/multiphase/compressibleInterFoam/twoPhaseMixtureThermo/twoPhaseMixtureThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -203,10 +203,10 @@ public: const label patchi ) const; - //- gamma = Cp/Cv [] + //- Gamma = Cp/Cv [] virtual tmp<volScalarField> gamma() const; - //- gamma = Cp/Cv for patch [] + //- Gamma = Cp/Cv for patch [] virtual tmp<scalarField> gamma ( const scalarField& p, diff --git a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/multiphaseMixtureThermo.H b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/multiphaseMixtureThermo.H index 546048894f4..6d797d16c5b 100644 --- a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/multiphaseMixtureThermo.H +++ b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/multiphaseMixtureThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -337,10 +337,10 @@ public: const label patchi ) const; - //- gamma = Cp/Cv [] + //- Gamma = Cp/Cv [] virtual tmp<volScalarField> gamma() const; - //- gamma = Cp/Cv for patch [] + //- Gamma = Cp/Cv for patch [] virtual tmp<scalarField> gamma ( const scalarField& p, diff --git a/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/general/general.H b/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/general/general.H index b3621c32068..df9aaa17097 100644 --- a/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/general/general.H +++ b/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/general/general.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ class general { // Private data - //- a coefficient + //- A coefficient dimensionedScalar a_; //- a1 coefficient diff --git a/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/simple/simple.H b/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/simple/simple.H index 82cec551124..162d2406e3b 100644 --- a/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/simple/simple.H +++ b/applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/simple/simple.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ class simple { // Private data - //- a coefficient + //- A coefficient dimensionedScalar a_; //- Drift velocity diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H index f0290efc959..393357a7ffc 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H +++ b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -87,7 +87,7 @@ public: // Constructors - //- construct from components + //- Construct from components Kunz ( const volVectorField& U, diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H index e675c83df75..0152b2d18ab 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H +++ b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -81,7 +81,7 @@ public: // Constructors - //- construct from components + //- Construct from components Merkle ( const volVectorField& U, diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H index ce096105d90..67eb0dd5ba9 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H +++ b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -94,7 +94,7 @@ public: // Constructors - //- construct from components + //- Construct from components SchnerrSauer ( const volVectorField& U, diff --git a/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/dragModels/dragModel/dragModel.H b/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/dragModels/dragModel/dragModel.H index bf9f301bdda..eff4c389c6a 100644 --- a/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/dragModels/dragModel/dragModel.H +++ b/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/dragModels/dragModel/dragModel.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -128,7 +128,7 @@ public: return residualSlip_; } - //- the dragfunction K used in the momentum eq. + //- The dragfunction K used in the momentum eq. // ddt(alpha1*rho1*U1) + ... = ... alpha1*alpha2*K*(U1-U2) // ddt(alpha2*rho2*U2) + ... = ... alpha1*alpha2*K*(U2-U1) // ********************************** NB! ***************************** diff --git a/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/heatTransferModels/heatTransferModel/heatTransferModel.H b/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/heatTransferModels/heatTransferModel/heatTransferModel.H index b4ad05b303d..6ad7f137d7d 100644 --- a/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/heatTransferModels/heatTransferModel/heatTransferModel.H +++ b/applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/heatTransferModels/heatTransferModel/heatTransferModel.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -111,7 +111,7 @@ public: // Member Functions - //- the heat-transfer function K used in the enthalpy eq. + //- The heat-transfer function K used in the enthalpy eq. // ddt(alpha1*rho1*ha) + ... = ... alpha1*alpha2*K*(Ta - Tb) // ddt(alpha2*rho2*hb) + ... = ... alpha1*alpha2*K*(Tb - Ta) // ********************************** NB! ***************************** diff --git a/applications/solvers/multiphase/twoPhaseEulerFoam/phaseCompressibleTurbulenceModels/kineticTheoryModels/conductivityModel/HrenyaSinclair/HrenyaSinclairConductivity.H b/applications/solvers/multiphase/twoPhaseEulerFoam/phaseCompressibleTurbulenceModels/kineticTheoryModels/conductivityModel/HrenyaSinclair/HrenyaSinclairConductivity.H index 376913747ea..14ff59acee7 100644 --- a/applications/solvers/multiphase/twoPhaseEulerFoam/phaseCompressibleTurbulenceModels/kineticTheoryModels/conductivityModel/HrenyaSinclair/HrenyaSinclairConductivity.H +++ b/applications/solvers/multiphase/twoPhaseEulerFoam/phaseCompressibleTurbulenceModels/kineticTheoryModels/conductivityModel/HrenyaSinclair/HrenyaSinclairConductivity.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class HrenyaSinclair { dictionary coeffDict_; - //- characteristic length of geometry + //- Characteristic length of geometry dimensionedScalar L_; diff --git a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseSystem/phaseModel/phaseModel.H b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseSystem/phaseModel/phaseModel.H index 242b8a8a040..a61e603d1b2 100644 --- a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseSystem/phaseModel/phaseModel.H +++ b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseSystem/phaseModel/phaseModel.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -92,7 +92,7 @@ class phaseModel //- Diameter model autoPtr<diameterModel> dPtr_; - //- turbulence model + //- Turbulence model autoPtr<PhaseCompressibleTurbulenceModel<phaseModel> > turbulence_; diff --git a/applications/utilities/mesh/advanced/collapseEdges/meshQualityDict b/applications/utilities/mesh/advanced/collapseEdges/meshQualityDict index 40b4927f6c9..43eb9a58363 100644 --- a/applications/utilities/mesh/advanced/collapseEdges/meshQualityDict +++ b/applications/utilities/mesh/advanced/collapseEdges/meshQualityDict @@ -50,7 +50,7 @@ minArea -1; // and face centre triangles normal minTwist 0.0; -//- minimum normalised cell determinant +//- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; diff --git a/applications/utilities/mesh/conversion/star3ToFoam/starMesh.H b/applications/utilities/mesh/conversion/star3ToFoam/starMesh.H index 2bcec6115b8..1fbc8f68360 100644 --- a/applications/utilities/mesh/conversion/star3ToFoam/starMesh.H +++ b/applications/utilities/mesh/conversion/star3ToFoam/starMesh.H @@ -192,10 +192,10 @@ class starMesh void operator=(const starMesh&); - //- read fixed format vertex label + //- Read fixed format vertex label static label readVtxLabel(IFstream&); - //- read fixed format vertex coordinate component + //- Read fixed format vertex coordinate component static scalar readVtxCmpt(IFstream&); //- Read to nl diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H index 69b08d21255..90dde14aa4a 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H @@ -133,7 +133,7 @@ class backgroundMeshDecomposition //- Decomposition method autoPtr<decompositionMethod> decomposerPtr_; - //- merge distance required by fvMeshDistribute + //- Merge distance required by fvMeshDistribute scalar mergeDist_; //- Scale of a cell span vs cell size used to decide to refine a cell diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/linearDistance/linearDistance.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/linearDistance/linearDistance.H index 8956e0f24ce..e787fb77715 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/linearDistance/linearDistance.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/linearDistance/linearDistance.H @@ -54,13 +54,13 @@ private: // Private data - //- cell size at distance_ from the surface + //- Cell size at distance_ from the surface scalar distanceCellSize_; - //- distance from the surface to control over + //- Distance from the surface to control over scalar distance_; - //- distance squared + //- Distance squared scalar distanceSqr_; diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/surfaceOffsetLinearDistance/surfaceOffsetLinearDistance.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/surfaceOffsetLinearDistance/surfaceOffsetLinearDistance.H index 7277d76ccb9..5ccf3b98d2e 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/surfaceOffsetLinearDistance/surfaceOffsetLinearDistance.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/surfaceOffsetLinearDistance/surfaceOffsetLinearDistance.H @@ -54,7 +54,7 @@ private: // Private data - //- cell size at distance_ from the surface + //- Cell size at distance_ from the surface scalar distanceCellSize_; //- Offset distance from surface for constant size portion diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMesh.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMesh.H index fca6a65658c..f6d44489b78 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMesh.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMesh.H @@ -546,7 +546,7 @@ private: ) const; //- Check if a location is in the exclusion range of an existing feature - //- edge conformation location + //- Edge conformation location bool nearFeatureEdgeLocation ( const pointIndexHit& pHit, @@ -731,7 +731,7 @@ private: label classifyBoundaryPoint(Cell_handle cit) const; //- Index all of the the Delaunay cells and calculate their - //- dual points + //- Dual points void indexDualVertices ( pointField& pts, diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/featurePointConformer/pointFeatureEdgesTypes.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/featurePointConformer/pointFeatureEdgesTypes.H index 89703efdd86..c3c3d823f0f 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/featurePointConformer/pointFeatureEdgesTypes.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/featurePointConformer/pointFeatureEdgesTypes.H @@ -58,7 +58,7 @@ class pointFeatureEdgesTypes //- Reference to the feature edge mesh const extendedFeatureEdgeMesh& feMesh_; - //- label of the point + //- Label of the point label pointLabel_; diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCell.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCell.H index c04a19e10aa..92905e3a439 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCell.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCell.H @@ -88,7 +88,7 @@ class indexedCell // Private data //- The index for this Delaunay tetrahedral cell. Type information is - //- also carried: + //- Also carried: // ctFar : the dual point of this cell does not form part of the // internal or boundary of the dual mesh diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cvControls/cvControls.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cvControls/cvControls.H index fee0b92adea..8d86f756801 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cvControls/cvControls.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cvControls/cvControls.H @@ -163,7 +163,7 @@ class cvControls //- Allowed relative load unbalance scalar maxLoadUnbalance_; - //- cosine of angle of alignment with required direction within which a + //- Cosine of angle of alignment with required direction within which a // face will be accepted for rotation scalar cosAlignmentAcceptanceAngle_; @@ -179,7 +179,7 @@ class cvControls // size scalar faceAreaRatioCoeff_; - //- cosine of the angle of alignment with the required direction + //- Cosine of the angle of alignment with the required direction // within which a long De will be accepted for a new Dv insertion scalar cosInsertionAcceptanceAngle_; diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMeshDict b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMeshDict index 5d7e68ae0fe..deca4e0edb2 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMeshDict +++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMeshDict @@ -457,7 +457,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.02; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant //- 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshSurfaceSimplify/foamyHexMeshSurfaceSimplify.C b/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshSurfaceSimplify/foamyHexMeshSurfaceSimplify.C index c8df890cc12..515dc5e032a 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshSurfaceSimplify/foamyHexMeshSurfaceSimplify.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshSurfaceSimplify/foamyHexMeshSurfaceSimplify.C @@ -149,7 +149,7 @@ public: // Member Functions - //- test function + //- Test function virtual bool need_refine( const Cube &c ) { int l = c.lv() ; @@ -352,7 +352,7 @@ public: //} } - //- data function + //- Data function virtual real value_at( const Cube &c ) { return signedDistance(converter_.toGlobal(c)) - _iso_val; diff --git a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C index a5ec424e457..c8cba9f2b2c 100644 --- a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C +++ b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -443,7 +443,7 @@ int main(int argc, char *argv[]) PtrList<volTensorField> volTensorFields; ReadFields(mesh, objects, volTensorFields); - //- uncomment if you want to interpolate surface fields (usually bad idea) + //- Uncomment if you want to interpolate surface fields (usually bad idea) //Info<< "Reading all current surfaceFields" << endl; //PtrList<surfaceScalarField> surfaceScalarFields; //ReadFields(mesh, objects, surfaceScalarFields); diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.C index 2e661680fbb..ace330060df 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -206,7 +206,7 @@ void Foam::ensightLagrangianField } -//- write generalized field components +//- Write generalized field components template<class Type> void Foam::ensightVolField ( diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.H b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.H index 69083404d8e..0b02a997e65 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.H +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/ensightOutputFunctions.H @@ -64,7 +64,7 @@ void ensightParticlePositions ); -//- write lagrangian parcels +//- Write lagrangian parcels template<class Type> void ensightLagrangianField ( @@ -75,7 +75,7 @@ void ensightLagrangianField IOstream::streamFormat format ); -//- write generalized field components +//- Write generalized field components template<class Type> void ensightVolField ( diff --git a/applications/utilities/postProcessing/dataConversion/foamToTecplot360/vtkMesh.H b/applications/utilities/postProcessing/dataConversion/foamToTecplot360/vtkMesh.H index 3c50c300b35..c9ea6c4b147 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToTecplot360/vtkMesh.H +++ b/applications/utilities/postProcessing/dataConversion/foamToTecplot360/vtkMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -89,7 +89,7 @@ public: // Access - //- whole mesh + //- Whole mesh const fvMesh& baseMesh() const { return baseMesh_; diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkMesh.H b/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkMesh.H index 8d981401a5a..d9d65a12012 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkMesh.H +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -90,7 +90,7 @@ public: // Access - //- whole mesh + //- Whole mesh const fvMesh& baseMesh() const { return baseMesh_; diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkTopo.H b/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkTopo.H index 8fd31ada29a..451c5c7cebe 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkTopo.H +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/vtkTopo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -79,7 +79,7 @@ public: // Public static data - //- equivalent to enumeration in "vtkCellType.h" + //- Equivalent to enumeration in "vtkCellType.h" enum vtkTypes { VTK_TRIANGLE = 5, diff --git a/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/vtkPV3Foam/vtkPV3Foam.H b/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/vtkPV3Foam/vtkPV3Foam.H index b7e37a81bbe..e21bd33fc95 100644 --- a/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/vtkPV3Foam/vtkPV3Foam.H +++ b/applications/utilities/postProcessing/graphics/PV3Readers/PV3FoamReader/vtkPV3Foam/vtkPV3Foam.H @@ -184,7 +184,7 @@ class vtkPV3Foam } }; - //- bookkeeping for polyhedral cell decomposition + //- Bookkeeping for polyhedral cell decomposition // hide in extra pointMap (cellSet/cellZone) for now class polyDecomp { @@ -536,7 +536,7 @@ class vtkPV3Foam const label datasetNo ); - //- face set/zone field + //- Face set/zone field template<class Type> void convertFaceField ( @@ -700,7 +700,7 @@ public: //- Add/remove patch names to/from the view void renderPatchNames(vtkRenderer*, const bool show); - //- set the runTime to the first plausible request time, + //- Set the runTime to the first plausible request time, // returns the timeIndex // sets to "constant" on error int setTime(int count, const double requestTimes[]); diff --git a/applications/utilities/postProcessing/graphics/PV3Readers/PV3blockMeshReader/vtkPV3blockMesh/vtkPV3blockMesh.H b/applications/utilities/postProcessing/graphics/PV3Readers/PV3blockMeshReader/vtkPV3blockMesh/vtkPV3blockMesh.H index 4aed8443058..cf5c25f3071 100644 --- a/applications/utilities/postProcessing/graphics/PV3Readers/PV3blockMeshReader/vtkPV3blockMesh/vtkPV3blockMesh.H +++ b/applications/utilities/postProcessing/graphics/PV3Readers/PV3blockMeshReader/vtkPV3blockMesh/vtkPV3blockMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -243,7 +243,7 @@ class vtkPV3blockMesh //- Internal block info void updateInfoBlocks(vtkDataArraySelection*); - //- block curved edges info + //- Block curved edges info void updateInfoEdges(vtkDataArraySelection*); // Update helper functions @@ -253,13 +253,13 @@ class vtkPV3blockMesh // Mesh conversion functions - //- mesh blocks + //- Mesh blocks void convertMeshBlocks(vtkMultiBlockDataSet*, int& blockNo); - //- mesh curved edges + //- Mesh curved edges void convertMeshEdges(vtkMultiBlockDataSet*, int& blockNo); - //- mesh corners + //- Mesh corners void convertMeshCorners(vtkMultiBlockDataSet*, int& blockNo); diff --git a/applications/utilities/postProcessing/graphics/PV4Readers/PV4FoamReader/vtkPV4Foam/vtkPV4Foam.H b/applications/utilities/postProcessing/graphics/PV4Readers/PV4FoamReader/vtkPV4Foam/vtkPV4Foam.H index 8fdc74b7509..0bd35573e1d 100644 --- a/applications/utilities/postProcessing/graphics/PV4Readers/PV4FoamReader/vtkPV4Foam/vtkPV4Foam.H +++ b/applications/utilities/postProcessing/graphics/PV4Readers/PV4FoamReader/vtkPV4Foam/vtkPV4Foam.H @@ -184,7 +184,7 @@ class vtkPV4Foam } }; - //- bookkeeping for polyhedral cell decomposition + //- Bookkeeping for polyhedral cell decomposition // hide in extra pointMap (cellSet/cellZone) for now class polyDecomp { @@ -536,7 +536,7 @@ class vtkPV4Foam const label datasetNo ); - //- face set/zone field + //- Face set/zone field template<class Type> void convertFaceField ( @@ -700,7 +700,7 @@ public: //- Add/remove patch names to/from the view void renderPatchNames(vtkRenderer*, const bool show); - //- set the runTime to the first plausible request time, + //- Set the runTime to the first plausible request time, // returns the timeIndex // sets to "constant" on error int setTime(int count, const double requestTimes[]); diff --git a/applications/utilities/postProcessing/graphics/PV4Readers/PV4blockMeshReader/vtkPV4blockMesh/vtkPV4blockMesh.H b/applications/utilities/postProcessing/graphics/PV4Readers/PV4blockMeshReader/vtkPV4blockMesh/vtkPV4blockMesh.H index 37c83a6f421..48b0b036dff 100644 --- a/applications/utilities/postProcessing/graphics/PV4Readers/PV4blockMeshReader/vtkPV4blockMesh/vtkPV4blockMesh.H +++ b/applications/utilities/postProcessing/graphics/PV4Readers/PV4blockMeshReader/vtkPV4blockMesh/vtkPV4blockMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -243,7 +243,7 @@ class vtkPV4blockMesh //- Internal block info void updateInfoBlocks(vtkDataArraySelection*); - //- block curved edges info + //- Block curved edges info void updateInfoEdges(vtkDataArraySelection*); // Update helper functions @@ -253,13 +253,13 @@ class vtkPV4blockMesh // Mesh conversion functions - //- mesh blocks + //- Mesh blocks void convertMeshBlocks(vtkMultiBlockDataSet*, int& blockNo); - //- mesh curved edges + //- Mesh curved edges void convertMeshEdges(vtkMultiBlockDataSet*, int& blockNo); - //- mesh corners + //- Mesh corners void convertMeshCorners(vtkMultiBlockDataSet*, int& blockNo); diff --git a/applications/utilities/postProcessing/miscellaneous/postChannel/channelIndex.H b/applications/utilities/postProcessing/miscellaneous/postChannel/channelIndex.H index dc05052dbfd..5e554fa0621 100644 --- a/applications/utilities/postProcessing/miscellaneous/postChannel/channelIndex.H +++ b/applications/utilities/postProcessing/miscellaneous/postChannel/channelIndex.H @@ -60,7 +60,7 @@ class channelIndex //- Is mesh symmetric const bool symmetric_; - //- direction to sort + //- Direction to sort const direction dir_; //- Per cell the global region @@ -123,7 +123,7 @@ public: template<class T> Field<T> regionSum(const Field<T>& cellField) const; - //- collapse a field to a line + //- Collapse a field to a line template<class T> Field<T> collapse ( @@ -131,7 +131,7 @@ public: const bool asymmetric=false ) const; - //- return the field of Y locations from the cell centres + //- Return the field of Y locations from the cell centres const scalarField& y() const { return y_; diff --git a/bin/tools/doxyFilter.awk b/bin/tools/doxyFilter.awk index 92f8e147b12..e6d7226e825 100644 --- a/bin/tools/doxyFilter.awk +++ b/bin/tools/doxyFilter.awk @@ -2,7 +2,7 @@ # ========= | # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / O peration | -# \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation +# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation # \\/ M anipulation | # ----------------------------------------------------------------------------- # License @@ -28,7 +28,7 @@ # Converts cocoon style sentinel strings into doxygen style strings # # Assumes comment strings are formatted as follows -# //- general description +# //- General description # // more information # // and even more information # This should be re-formatted as the following diff --git a/etc/caseDicts/meshQualityDict b/etc/caseDicts/meshQualityDict index bcb4415797a..734f368f4f9 100644 --- a/etc/caseDicts/meshQualityDict +++ b/etc/caseDicts/meshQualityDict @@ -69,7 +69,7 @@ minVolRatio 0.01; minTriangleTwist -1; -//- if >0 : preserve cells with all points on the surface if the +//- If >0 : preserve cells with all points on the surface if the // resulting volume after snapping (by approximation) is larger than // minVolCollapseRatio times old volume (i.e. not collapsed to flat cell). // If <0 : delete always. diff --git a/src/OSspecific/POSIX/fileMonitor.C b/src/OSspecific/POSIX/fileMonitor.C index 2b2e7308815..d15fab273d4 100644 --- a/src/OSspecific/POSIX/fileMonitor.C +++ b/src/OSspecific/POSIX/fileMonitor.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -130,7 +130,7 @@ namespace Foam - //- initialise inotify + //- Initialise inotify inline fileMonitorWatcher(const bool useInotify, const label sz = 20) : useInotify_(useInotify), @@ -179,7 +179,7 @@ namespace Foam } } - //- remove all watches + //- Remove all watches inline ~fileMonitorWatcher() { #ifdef FOAM_USE_INOTIFY diff --git a/src/OSspecific/POSIX/fileStat.H b/src/OSspecific/POSIX/fileStat.H index da51d40d727..fe16d20470b 100644 --- a/src/OSspecific/POSIX/fileStat.H +++ b/src/OSspecific/POSIX/fileStat.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -105,13 +105,13 @@ public: // Check - //- compare two fileStats for same device + //- Compare two fileStats for same device bool sameDevice(const fileStat& stat2) const; - //- compare two fileStats for same Inode + //- Compare two fileStats for same Inode bool sameINode(const fileStat& stat2) const; - //- compare state against inode + //- Compare state against inode bool sameINode(const label iNode) const; diff --git a/src/OSspecific/POSIX/signals/sigStopAtWriteNow.H b/src/OSspecific/POSIX/signals/sigStopAtWriteNow.H index d7d9d113b08..12da420a96f 100644 --- a/src/OSspecific/POSIX/signals/sigStopAtWriteNow.H +++ b/src/OSspecific/POSIX/signals/sigStopAtWriteNow.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class sigStopAtWriteNow { // Private data - //- number of signal to use + //- Number of signal to use static int signal_; //- Saved old signal trapping setting diff --git a/src/OSspecific/POSIX/signals/sigWriteNow.H b/src/OSspecific/POSIX/signals/sigWriteNow.H index f89933721f2..ea1207cfb8a 100644 --- a/src/OSspecific/POSIX/signals/sigWriteNow.H +++ b/src/OSspecific/POSIX/signals/sigWriteNow.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ class sigWriteNow { // Private data - //- number of signal to use + //- Number of signal to use static int signal_; //- Saved old signal trapping setting diff --git a/src/OSspecific/POSIX/timer.H b/src/OSspecific/POSIX/timer.H index 1074ff05dd4..b20d07dddb1 100644 --- a/src/OSspecific/POSIX/timer.H +++ b/src/OSspecific/POSIX/timer.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,7 +67,7 @@ SourceFiles // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -//- check it a timeout has occured +//- Check it a timeout has occured // keep setjmp in same stack frame so no function calls #define timedOut(x) \ (((x).newTimeOut_ > 0) ? setjmp(Foam::timer::envAlarm) : false) @@ -83,16 +83,16 @@ class timer { // Private data - //- old signal masks + //- Old signal masks static struct sigaction oldAction_; - //- old alarm() value + //- Old alarm() value static unsigned int oldTimeOut_; // Private Member Functions - //- alarm handler + //- Alarm handler static void signalHandler(int); @@ -103,10 +103,10 @@ public: //- Declare name of the class and its debug switch ClassName("timer"); - //- current time out value. Needed by macro timedOut + //- Current time out value. Needed by macro timedOut unsigned int newTimeOut_; - //- state for setjmp. Needed by macro timedOut + //- State for setjmp. Needed by macro timedOut static jmp_buf envAlarm; diff --git a/src/OpenFOAM/algorithms/dynamicIndexedOctree/dynamicIndexedOctree.H b/src/OpenFOAM/algorithms/dynamicIndexedOctree/dynamicIndexedOctree.H index e0a298855f9..ccb929f188f 100644 --- a/src/OpenFOAM/algorithms/dynamicIndexedOctree/dynamicIndexedOctree.H +++ b/src/OpenFOAM/algorithms/dynamicIndexedOctree/dynamicIndexedOctree.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -92,7 +92,7 @@ public: //- Bounding box of this node treeBoundBox bb_; - //- parent node (index into nodes_ of tree) + //- Parent node (index into nodes_ of tree) label parent_; //- IDs of the 8 nodes on all sides of the mid point diff --git a/src/OpenFOAM/algorithms/indexedOctree/indexedOctree.H b/src/OpenFOAM/algorithms/indexedOctree/indexedOctree.H index 83b773289be..96abc1a43fa 100644 --- a/src/OpenFOAM/algorithms/indexedOctree/indexedOctree.H +++ b/src/OpenFOAM/algorithms/indexedOctree/indexedOctree.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -83,7 +83,7 @@ public: //- Bounding box of this node treeBoundBox bb_; - //- parent node (index into nodes_ of tree) + //- Parent node (index into nodes_ of tree) label parent_; //- IDs of the 8 nodes on all sides of the mid point diff --git a/src/OpenFOAM/algorithms/indexedOctree/treeDataCell.H b/src/OpenFOAM/algorithms/indexedOctree/treeDataCell.H index c302f6cbece..deb5d25868d 100644 --- a/src/OpenFOAM/algorithms/indexedOctree/treeDataCell.H +++ b/src/OpenFOAM/algorithms/indexedOctree/treeDataCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,7 +67,7 @@ class treeDataCell //- How to decide if point is inside cell const polyMesh::cellRepresentation decompMode_; - //- cell bounding boxes (valid only if cacheBb_) + //- Cell bounding boxes (valid only if cacheBb_) treeBoundBoxList bbs_; diff --git a/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H b/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H index d19fc974adf..cd42beb0238 100644 --- a/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H +++ b/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -461,7 +461,7 @@ public: inline iterator operator++(int); }; - //- iterator set to the beginning of the HashTable + //- Iterator set to the beginning of the HashTable inline iterator begin(); diff --git a/src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTable.H b/src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTable.H index 52cbf9dfb13..8d6cfb42049 100644 --- a/src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTable.H +++ b/src/OpenFOAM/containers/HashTables/StaticHashTable/StaticHashTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -350,10 +350,10 @@ public: }; - //- iterator set to the beginning of the StaticHashTable + //- Iterator set to the beginning of the StaticHashTable inline iterator begin(); - //- iterator set to beyond the end of the StaticHashTable + //- Iterator set to beyond the end of the StaticHashTable inline const iterator& end(); //- const_iterator set to the beginning of the StaticHashTable @@ -385,7 +385,7 @@ public: private: - //- iterator returned by end() + //- Iterator returned by end() iterator endIter_; //- const_iterator returned by end() diff --git a/src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H b/src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H index 2894931bcee..095e51fe1ff 100644 --- a/src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H +++ b/src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -302,7 +302,7 @@ public: private: - //- iterator returned by end() + //- Iterator returned by end() static iterator endIter_; //- const_iterator returned by end() diff --git a/src/OpenFOAM/containers/LinkedLists/linkTypes/SLListBase/SLListBase.H b/src/OpenFOAM/containers/LinkedLists/linkTypes/SLListBase/SLListBase.H index ff744e61996..57717c797d0 100644 --- a/src/OpenFOAM/containers/LinkedLists/linkTypes/SLListBase/SLListBase.H +++ b/src/OpenFOAM/containers/LinkedLists/linkTypes/SLListBase/SLListBase.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -249,7 +249,7 @@ public: private: - //- iterator returned by end() + //- Iterator returned by end() static iterator endIter_; //- const_iterator returned by end() diff --git a/src/OpenFOAM/containers/Lists/PackedList/PackedList.H b/src/OpenFOAM/containers/Lists/PackedList/PackedList.H index 4fac0090e1f..ccec25c25e4 100644 --- a/src/OpenFOAM/containers/Lists/PackedList/PackedList.H +++ b/src/OpenFOAM/containers/Lists/PackedList/PackedList.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -544,10 +544,10 @@ public: }; - //- iterator set to the beginning of the PackedList + //- Iterator set to the beginning of the PackedList inline iterator begin(); - //- iterator set to beyond the end of the PackedList + //- Iterator set to beyond the end of the PackedList inline iterator end(); diff --git a/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H b/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H index 8a2cc3f19e3..95d4a5f3117 100644 --- a/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H +++ b/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -182,7 +182,7 @@ public: return index_ > vn.index_; } - //- this version the same as or newer than the one given + //- This version the same as or newer than the one given bool operator>=(const versionNumber& vn) { return index_ >= vn.index_; diff --git a/src/OpenFOAM/db/IOstreams/Pstreams/PstreamBuffers.H b/src/OpenFOAM/db/IOstreams/Pstreams/PstreamBuffers.H index 8d5998fe828..718366cd5be 100644 --- a/src/OpenFOAM/db/IOstreams/Pstreams/PstreamBuffers.H +++ b/src/OpenFOAM/db/IOstreams/Pstreams/PstreamBuffers.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -101,13 +101,13 @@ class PstreamBuffers const IOstream::versionNumber version_; - //- send buffer + //- Send buffer List<DynamicList<char> > sendBuf_; - //- receive buffer + //- Receive buffer List<DynamicList<char> > recvBuf_; - //- read position in recvBuf_ + //- Read position in recvBuf_ labelList recvBufPos_; bool finishedSendsCalled_; diff --git a/src/OpenFOAM/db/dynamicLibrary/codedBase/codedBase.H b/src/OpenFOAM/db/dynamicLibrary/codedBase/codedBase.H index e0d4db77bfe..8ac7114ce67 100644 --- a/src/OpenFOAM/db/dynamicLibrary/codedBase/codedBase.H +++ b/src/OpenFOAM/db/dynamicLibrary/codedBase/codedBase.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -97,10 +97,10 @@ protected: const word& redirectType ) const; - //- get the loaded dynamic libraries + //- Get the loaded dynamic libraries virtual dlLibraryTable& libs() const = 0; - //- adapt the context for the current object + //- Adapt the context for the current object virtual void prepare ( dynamicCode&, diff --git a/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H b/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H index 9aa6a77ab59..71212ed4d97 100644 --- a/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H +++ b/src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -121,10 +121,10 @@ class codedFixedValuePointPatchField //- Set the rewrite vars controlling the Type static void setFieldTemplates(dynamicCode& dynCode); - //- get the loaded dynamic libraries + //- Get the loaded dynamic libraries virtual dlLibraryTable& libs() const; - //- adapt the context for the current object + //- Adapt the context for the current object virtual void prepare(dynamicCode&, const dynamicCodeContext&) const; // Return a description (type + name) for the output diff --git a/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H b/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H index 1698c3d776b..e1509c88ea9 100644 --- a/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H +++ b/src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,7 +57,7 @@ class timeVaryingUniformFixedValuePointPatchField { // Private data - //- the time series being used, including the bounding treatment + //- The time series being used, including the bounding treatment interpolationTable<Type> timeSeries_; diff --git a/src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointConstraint/pointConstraint.H b/src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointConstraint/pointConstraint.H index 04de1932202..9696efeed2d 100644 --- a/src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointConstraint/pointConstraint.H +++ b/src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointConstraint/pointConstraint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -90,14 +90,14 @@ public: }; -//- reduce operator +//- Reduce operator class combineConstraintsEqOp { public: inline void operator()(pointConstraint&, const pointConstraint&) const; }; -//- transformation function +//- Transformation function inline pointConstraint transform(const tensor& tt, const pointConstraint& v); //- contiguous diff --git a/src/OpenFOAM/global/argList/argList.H b/src/OpenFOAM/global/argList/argList.H index ed4b07e205d..12be421f800 100644 --- a/src/OpenFOAM/global/argList/argList.H +++ b/src/OpenFOAM/global/argList/argList.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -134,7 +134,7 @@ class argList const string& str ); - //- get rootPath_ / globalCase_ from one of the following forms + //- Get rootPath_ / globalCase_ from one of the following forms // * [-case dir] // * cwd // diff --git a/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.H b/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.H index 6d3a2472e4d..bc802d392b4 100644 --- a/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.H +++ b/src/OpenFOAM/global/constants/electromagnetic/electromagneticConstants.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -69,7 +69,7 @@ namespace electromagnetic //- Magnetic flux quantum: default SI units: [Wb] extern const dimensionedScalar phi0; - //- von Klitzing constant: default SI units: [ohm] + //- Von Klitzing constant: default SI units: [ohm] extern const dimensionedScalar RK; diff --git a/src/OpenFOAM/include/OSspecific.H b/src/OpenFOAM/include/OSspecific.H index 313985c1be9..d190f67045e 100644 --- a/src/OpenFOAM/include/OSspecific.H +++ b/src/OpenFOAM/include/OSspecific.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -196,7 +196,7 @@ bool ping(const string&, const label timeOut=10); //- Execute the specified command int system(const std::string& command); -//- open a shared library. Return handle to library. Print error message +//- Open a shared library. Return handle to library. Print error message // if library cannot be loaded (check = true) void* dlOpen(const fileName& lib, const bool check = true); diff --git a/src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.H b/src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.H index 9dca73bf0f5..c34090c9852 100644 --- a/src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.H +++ b/src/OpenFOAM/interpolations/interpolation2DTable/interpolation2DTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -80,7 +80,7 @@ private: //- File name fileName fileName_; - //- the actual reader + //- The actual reader autoPtr<tableReader<Type> > reader_; diff --git a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H index 085b171ab10..21523832e86 100644 --- a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H +++ b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -103,7 +103,7 @@ private: //- File name fileName fileName_; - //- the actual reader + //- The actual reader autoPtr<tableReader<Type> > reader_; // Private Member Functions diff --git a/src/OpenFOAM/interpolations/interpolationTable/tableReaders/csv/csvTableReader.H b/src/OpenFOAM/interpolations/interpolationTable/tableReaders/csv/csvTableReader.H index de306042923..f3f067b0c4e 100644 --- a/src/OpenFOAM/interpolations/interpolationTable/tableReaders/csv/csvTableReader.H +++ b/src/OpenFOAM/interpolations/interpolationTable/tableReaders/csv/csvTableReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -110,7 +110,7 @@ public: List<Tuple2<scalar, List<Tuple2<scalar, Type> > > >& ); - //- write the remaining parameters + //- Write the remaining parameters virtual void write(Ostream& os) const; }; diff --git a/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H b/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H index 4291dbde4b6..64b925c066a 100644 --- a/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H +++ b/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -119,7 +119,7 @@ public: word fieldName_; const LduMatrix<Type, DType, LUType>& matrix_; - //- dictionary of controls + //- Dictionary of controls dictionary controlDict_; //- Maximum number of iterations in the solver diff --git a/src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H b/src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H index fdaf834a74c..f9da5b3a99b 100644 --- a/src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H +++ b/src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -101,7 +101,7 @@ public: const FieldField<Field, scalar>& interfaceIntCoeffs_; lduInterfaceFieldPtrsList interfaces_; - //- dictionary of controls + //- Dictionary of controls dictionary controlDict_; //- Maximum number of iterations in the solver diff --git a/src/OpenFOAM/matrices/scalarMatrices/SVD/SVD.H b/src/OpenFOAM/matrices/scalarMatrices/SVD/SVD.H index 828c3414790..d1e38c9082e 100644 --- a/src/OpenFOAM/matrices/scalarMatrices/SVD/SVD.H +++ b/src/OpenFOAM/matrices/scalarMatrices/SVD/SVD.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,7 +57,7 @@ class SVD //- Rectangular matrix with the same dimensions as the input scalarRectangularMatrix U_; - //- square matrix V + //- Square matrix V scalarRectangularMatrix V_; //- The singular values diff --git a/src/OpenFOAM/meshes/ProcessorTopology/ProcessorTopology.H b/src/OpenFOAM/meshes/ProcessorTopology/ProcessorTopology.H index 5953be984cc..ef1ad593dc0 100644 --- a/src/OpenFOAM/meshes/ProcessorTopology/ProcessorTopology.H +++ b/src/OpenFOAM/meshes/ProcessorTopology/ProcessorTopology.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -88,7 +88,7 @@ public: // Member Functions - //- from neighbour processor to index in boundaryMesh. Local information + //- From neighbour processor to index in boundaryMesh. Local information // (so not same over all processors) const labelList& procPatchMap() const { diff --git a/src/OpenFOAM/meshes/ProcessorTopology/commSchedule.H b/src/OpenFOAM/meshes/ProcessorTopology/commSchedule.H index 061ef0e4c63..bfeb62d6320 100644 --- a/src/OpenFOAM/meshes/ProcessorTopology/commSchedule.H +++ b/src/OpenFOAM/meshes/ProcessorTopology/commSchedule.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -98,7 +98,7 @@ public: // Member Functions - //- order in which comms is scheduled + //- Order in which comms is scheduled const labelList& schedule() const { return schedule_; diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H index cc835068cbd..cbe7cac4d71 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class hexMatcher { // Static data members - //- constants for this shape + //- Constants for this shape static const label vertPerCell; static const label facePerCell; static const label maxVertPerFace; diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H index 905f1fabe44..e30aa6bafaa 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class prismMatcher { // Static data members - //- constants for this shape + //- Constants for this shape static const label vertPerCell; static const label facePerCell; static const label maxVertPerFace; diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H index 914bdbde0de..69c8b7c1389 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class pyrMatcher { // Static data members - //- constants for this shape + //- Constants for this shape static const label vertPerCell; static const label facePerCell; static const label maxVertPerFace; diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H index 6ac88600291..e36e6b5f438 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class tetMatcher { // Static data members - //- constants for this shape + //- Constants for this shape static const label vertPerCell; static const label facePerCell; static const label maxVertPerFace; diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H index e13020e7bc2..bbece3cf674 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class tetWedgeMatcher { // Static data members - //- constants for this shape + //- Constants for this shape static const label vertPerCell; static const label facePerCell; static const label maxVertPerFace; diff --git a/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H b/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H index 935d02bbdfa..85faf2ab328 100644 --- a/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H +++ b/src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class wedgeMatcher { // Static data members - //- constants for this shape + //- Constants for this shape static const label vertPerCell; static const label facePerCell; static const label maxVertPerFace; diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edge.H b/src/OpenFOAM/meshes/meshShapes/edge/edge.H index 722fe741a5a..e1c314d1f2f 100644 --- a/src/OpenFOAM/meshes/meshShapes/edge/edge.H +++ b/src/OpenFOAM/meshes/meshShapes/edge/edge.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -121,7 +121,7 @@ public: //- Return edge line inline linePointRef line(const pointField&) const; - //- compare edges + //- Compare edges // Returns: // - 0: different // - +1: identical diff --git a/src/OpenFOAM/meshes/meshShapes/face/face.H b/src/OpenFOAM/meshes/meshShapes/face/face.H index adedf991bd7..6648e4ad2aa 100644 --- a/src/OpenFOAM/meshes/meshShapes/face/face.H +++ b/src/OpenFOAM/meshes/meshShapes/face/face.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -365,7 +365,7 @@ public: faceList& quadFaces ) const; - //- compare faces + //- Compare faces // 0: different // +1: identical // -1: same face, but different orientation diff --git a/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H b/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H index 11f7d966bf7..892fd6d4802 100644 --- a/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H +++ b/src/OpenFOAM/meshes/meshShapes/triFace/triFace.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -218,7 +218,7 @@ public: // - 0: edge not found on the face inline int edgeDirection(const edge&) const; - //- compare triFaces + //- Compare triFaces // Returns: // - 0: different // - +1: identical diff --git a/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalIndex.H b/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalIndex.H index 1aa39c17549..3a6d49e7576 100644 --- a/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalIndex.H +++ b/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalIndex.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -110,7 +110,7 @@ public: // Queries relating to my processor (using world communicator) - //- my local size + //- My local size inline label localSize() const; //- From local to global diff --git a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapAddedPolyMesh.H b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapAddedPolyMesh.H index a4d54bcef1c..68a7ef6b7de 100644 --- a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapAddedPolyMesh.H +++ b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapAddedPolyMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -83,16 +83,16 @@ class mapAddedPolyMesh //- From added mesh cells to new cells labelList addedCellMap_; - //- original mesh to new mesh patch map. -1 for deleted patches. + //- Original mesh to new mesh patch map. -1 for deleted patches. labelList oldPatchMap_; - //- added mesh to new mesh patch map. -1 for deleted patches. + //- Added mesh to new mesh patch map. -1 for deleted patches. labelList addedPatchMap_; - //- original patch sizes on old mesh + //- Original patch sizes on old mesh labelList oldPatchSizes_; - //- original patch starts + //- Original patch starts labelList oldPatchStarts_; diff --git a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributeLagrangian.H b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributeLagrangian.H index 5a92d8341c2..23daa35db97 100644 --- a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributeLagrangian.H +++ b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributeLagrangian.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -96,7 +96,7 @@ public: // Edit - //- distribute list of lagrangian data + //- Distribute list of lagrangian data template<class T> void distributeLagrangianData(List<T>& lst) const { diff --git a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributePolyMesh.H b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributePolyMesh.H index c13b5e80fe3..5429e75730f 100644 --- a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributePolyMesh.H +++ b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributePolyMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -208,28 +208,28 @@ public: // Edit - //- distribute list of point data + //- Distribute list of point data template<class T> void distributePointData(List<T>& lst) const { pointMap_.distribute(lst); } - //- distribute list of face data + //- Distribute list of face data template<class T> void distributeFaceData(List<T>& lst) const { faceMap_.distribute(lst); } - //- distribute list of cell data + //- Distribute list of cell data template<class T> void distributeCellData(List<T>& lst) const { cellMap_.distribute(lst); } - //- distribute list of patch data + //- Distribute list of patch data template<class T> void distributePatchData(List<T>& lst) const { @@ -237,7 +237,7 @@ public: } - //- distribute list of point/face/cell/patch indices. + //- Distribute list of point/face/cell/patch indices. // (Converts to boolList, distributes boolList and reconstructs) void distributePointIndices(labelList& pointIDs) const; diff --git a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapPatchChange/mapPatchChange.H b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapPatchChange/mapPatchChange.H index 529e3f91b6e..e6ee23544de 100644 --- a/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapPatchChange/mapPatchChange.H +++ b/src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapPatchChange/mapPatchChange.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -90,7 +90,7 @@ public: // Utility functions - //- labels of added patches + //- Labels of added patches labelList addedPatches() const { labelList added(patchMap_.size()); @@ -108,7 +108,7 @@ public: return added; } - //- labels (on old mesh) of deleted patches + //- Labels (on old mesh) of deleted patches labelList deletedPatches() const { labelList oldToNew(nOldPatches_, -1); diff --git a/src/OpenFOAM/meshes/polyMesh/polyMesh.H b/src/OpenFOAM/meshes/polyMesh/polyMesh.H index ffabc4c7295..5c4ae545a44 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyMesh.H +++ b/src/OpenFOAM/meshes/polyMesh/polyMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -136,11 +136,11 @@ private: //- Communicator used for parallel communication label comm_; - //- vector of non-constrained directions in mesh + //- Vector of non-constrained directions in mesh // defined according to the presence of empty and wedge patches mutable Vector<label> geometricD_; - //- vector of valid directions in mesh + //- Vector of valid directions in mesh // defined according to the presence of empty patches mutable Vector<label> solutionD_; diff --git a/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H b/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H index cd03b21d69d..bacfca53638 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H +++ b/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -75,26 +75,26 @@ class tetIndices { // Private data - //- cell that this is a decomposed tet of + //- Cell that this is a decomposed tet of label cellI_; - //- face that holds this decomposed tet + //- Face that holds this decomposed tet label faceI_; - //- base point on the face + //- Base point on the face label faceBasePtI_; - //- point on the face such that the right-hand circulation + //- Point on the face such that the right-hand circulation // {faceBasePtI_, facePtAI_, facePtBI_} // forms a triangle that points out of the tet label facePtAI_; - //- point on the face such that the right-hand circulation + //- Point on the face such that the right-hand circulation // {faceBasePtI_, facePtAI_, facePtBI_} // forms a triangle that points out of the tet label facePtBI_; - //- point on the face, *relative to the base point*, which + //- Point on the face, *relative to the base point*, which // characterises this tet on the face. label tetPtI_; diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H index 0208dacb478..9c761907af5 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -72,16 +72,16 @@ private: // Private data - //- default matching tolerance + //- Default matching tolerance static const scalar defaultMatchTol_; - //- local matching tolerance + //- Local matching tolerance const scalar matchTolerance_; //- Type of transformation transformType transform_; - //- offset (distance) vector from one side of the couple to the other + //- Offset (distance) vector from one side of the couple to the other mutable vectorField separation_; //- Face transformation tensor diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicPolyPatch.H b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicPolyPatch.H index 90474015ce7..88352668261 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicPolyPatch.H +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicPolyPatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -81,7 +81,7 @@ class cyclicPolyPatch //- Axis of rotation for rotational cyclics vector rotationAxis_; - //- point on axis of rotation for rotational cyclics + //- Point on axis of rotation for rotational cyclics point rotationCentre_; // For translation @@ -377,7 +377,7 @@ public: return rotationAxis_; } - //- point on axis of rotation for rotational cyclics + //- Point on axis of rotation for rotational cyclics const point& rotationCentre() const { return rotationCentre_; diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.C b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.C index d9b95491154..2c8383c4072 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.C +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -340,7 +340,7 @@ void Foam::oldCyclicPolyPatch::getCentresAndAnchors break; } //- Problem: usually specified translation is not accurate enough - //- to get proper match so keep automatic determination over here. + //- To get proper match so keep automatic determination over here. //case TRANSLATIONAL: //{ // // Transform 0 points. diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.H b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.H index e238154f98d..0b8b0955e24 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.H +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/oldCyclic/oldCyclicPolyPatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -66,7 +66,7 @@ class oldCyclicPolyPatch //- Axis of rotation for rotational cyclics vector rotationAxis_; - //- point on axis of rotation for rotational cyclics + //- Point on axis of rotation for rotational cyclics point rotationCentre_; // For translation diff --git a/src/OpenFOAM/meshes/preservePatchTypes/preservePatchTypes.H b/src/OpenFOAM/meshes/preservePatchTypes/preservePatchTypes.H index 4770a8cbad6..ad0c9f08a1f 100644 --- a/src/OpenFOAM/meshes/preservePatchTypes/preservePatchTypes.H +++ b/src/OpenFOAM/meshes/preservePatchTypes/preservePatchTypes.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -46,7 +46,7 @@ namespace Foam class objectRegistry; -//- preserve patch types +//- Preserve patch types void preservePatchTypes ( const objectRegistry& obr, diff --git a/src/OpenFOAM/meshes/primitiveShapes/objectHit/PointIndexHit.H b/src/OpenFOAM/meshes/primitiveShapes/objectHit/PointIndexHit.H index eafc21d8715..7e1103b2769 100644 --- a/src/OpenFOAM/meshes/primitiveShapes/objectHit/PointIndexHit.H +++ b/src/OpenFOAM/meshes/primitiveShapes/objectHit/PointIndexHit.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,7 +61,7 @@ class PointIndexHit //- Point of hit; invalid for misses Point hitPoint_; - //- label of face hit + //- Label of face hit label index_; diff --git a/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointHitSort.H b/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointHitSort.H index b6b44dd7741..97eea8bc7c8 100644 --- a/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointHitSort.H +++ b/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointHitSort.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class pointHitSort //- intersection pointHit inter_; - //- original index + //- Original index label index_; public: diff --git a/src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.H b/src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.H index 15528c02ba7..6648ba7bcc2 100644 --- a/src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.H +++ b/src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -202,7 +202,7 @@ public: //- Typical dimension length,height,width inline scalar typDim() const; - //- vertex coordinates. In octant coding. + //- Vertex coordinates. In octant coding. tmp<pointField> points() const; diff --git a/src/OpenFOAM/primitives/Vector2D/Vector2D.H b/src/OpenFOAM/primitives/Vector2D/Vector2D.H index 2f429673d1f..e63fbad951b 100644 --- a/src/OpenFOAM/primitives/Vector2D/Vector2D.H +++ b/src/OpenFOAM/primitives/Vector2D/Vector2D.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -106,7 +106,7 @@ public: // Operators - //- perp dot product (dot product with perpendicular vector) + //- Perp dot product (dot product with perpendicular vector) inline scalar perp(const Vector2D<Cmpt>& b) const; }; diff --git a/src/OpenFOAM/primitives/globalIndexAndTransform/globalIndexAndTransform.H b/src/OpenFOAM/primitives/globalIndexAndTransform/globalIndexAndTransform.H index 7cb4bab4956..b0698ad673c 100644 --- a/src/OpenFOAM/primitives/globalIndexAndTransform/globalIndexAndTransform.H +++ b/src/OpenFOAM/primitives/globalIndexAndTransform/globalIndexAndTransform.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -124,7 +124,7 @@ private: void determineTransformPermutations(); //- Determine which patch uses which transform (if any) and which - //- sign to use + //- Sign to use void determinePatchTransformSign(); //- Test a list of reference transforms to see if the test diff --git a/src/OpenFOAM/primitives/hashes/Hasher/Hasher.C b/src/OpenFOAM/primitives/hashes/Hasher/Hasher.C index fb3ad3396b1..685179d98fa 100644 --- a/src/OpenFOAM/primitives/hashes/Hasher/Hasher.C +++ b/src/OpenFOAM/primitives/hashes/Hasher/Hasher.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -187,7 +187,7 @@ Description // acceptable. Do NOT use for cryptographic purposes. // ---------------------------------------------------------------------------- -//- specialized little-endian code +//- Specialized little-endian code #if !defined (__BYTE_ORDER) || (__BYTE_ORDER == __LITTLE_ENDIAN) static unsigned jenkins_hashlittle ( diff --git a/src/OpenFOAM/primitives/ints/int32/int32.H b/src/OpenFOAM/primitives/ints/int32/int32.H index e97430e0ca7..c2a3097ab60 100644 --- a/src/OpenFOAM/primitives/ints/int32/int32.H +++ b/src/OpenFOAM/primitives/ints/int32/int32.H @@ -69,7 +69,7 @@ bool read(const char*, int32_t&); Istream& operator>>(Istream&, int32_t&); Ostream& operator<<(Ostream&, const int32_t); -//- template specialization for pTraits<int32_t> +//- Template specialization for pTraits<int32_t> template<> class pTraits<int32_t> { diff --git a/src/OpenFOAM/primitives/ints/int64/int64.H b/src/OpenFOAM/primitives/ints/int64/int64.H index 33ab5419dc4..3169232a40d 100644 --- a/src/OpenFOAM/primitives/ints/int64/int64.H +++ b/src/OpenFOAM/primitives/ints/int64/int64.H @@ -69,7 +69,7 @@ bool read(const char*, int64_t&); Istream& operator>>(Istream&, int64_t&); Ostream& operator<<(Ostream&, const int64_t); -//- template specialization for pTraits<int64_t> +//- Template specialization for pTraits<int64_t> template<> class pTraits<int64_t> { diff --git a/src/OpenFOAM/primitives/ints/uint32/uint32.H b/src/OpenFOAM/primitives/ints/uint32/uint32.H index b224b81c063..07058dcdcc9 100644 --- a/src/OpenFOAM/primitives/ints/uint32/uint32.H +++ b/src/OpenFOAM/primitives/ints/uint32/uint32.H @@ -69,7 +69,7 @@ bool read(const char*, uint32_t&); Istream& operator>>(Istream&, uint32_t&); Ostream& operator<<(Ostream&, const uint32_t); -//- template specialization for pTraits<uint32_t> +//- Template specialization for pTraits<uint32_t> template<> class pTraits<uint32_t> { diff --git a/src/OpenFOAM/primitives/ints/uint64/uint64.H b/src/OpenFOAM/primitives/ints/uint64/uint64.H index 6e2ecacd1ae..c4f3b581c63 100644 --- a/src/OpenFOAM/primitives/ints/uint64/uint64.H +++ b/src/OpenFOAM/primitives/ints/uint64/uint64.H @@ -69,7 +69,7 @@ bool read(const char*, uint64_t&); Istream& operator>>(Istream&, uint64_t&); Ostream& operator<<(Ostream&, const uint64_t); -//- template specialization for pTraits<uint64_t> +//- Template specialization for pTraits<uint64_t> template<> class pTraits<uint64_t> { diff --git a/src/OpenFOAM/primitives/random/Random/Random.H b/src/OpenFOAM/primitives/random/Random/Random.H index aee8b067daf..1dd109a235b 100644 --- a/src/OpenFOAM/primitives/random/Random/Random.H +++ b/src/OpenFOAM/primitives/random/Random/Random.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,10 +67,10 @@ public: int bit(); - //- scalar [0..1] (so including 0,1) + //- Scalar [0..1] (so including 0,1) scalar scalar01(); - //- vector with every component scalar01 + //- Vector with every component scalar01 vector vector01(); //- sphericalTensor with every component scalar01 @@ -79,10 +79,10 @@ public: //- symmTensor with every component scalar01 symmTensor symmTensor01(); - //- tensor with every component scalar01 + //- Tensor with every component scalar01 tensor tensor01(); - //- label [lower..upper] + //- Label [lower..upper] label integer(const label lower, const label upper); vector position(const vector&, const vector&); diff --git a/src/OpenFOAM/primitives/strings/lists/hashedWordList.H b/src/OpenFOAM/primitives/strings/lists/hashedWordList.H index fb8869fda06..a4cda161637 100644 --- a/src/OpenFOAM/primitives/strings/lists/hashedWordList.H +++ b/src/OpenFOAM/primitives/strings/lists/hashedWordList.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -66,7 +66,7 @@ class hashedWordList // Private Member Functions - //- rebuild the hash of indices + //- Rebuild the hash of indices void rehash(); public: diff --git a/src/OpenFOAM/primitives/triad/triad.H b/src/OpenFOAM/primitives/triad/triad.H index aeb2c38d6c1..8755b60bc13 100644 --- a/src/OpenFOAM/primitives/triad/triad.H +++ b/src/OpenFOAM/primitives/triad/triad.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -133,7 +133,7 @@ public: //- Sort the axes such that they are closest to the x, y and z axes triad sortxyz() const; - //- convert to a quaternion + //- Convert to a quaternion operator quaternion() const; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.C b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.C index 4ebd0c18037..fa137f34b55 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.C +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.C @@ -198,7 +198,7 @@ void turbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs() scalarField qr(this->size(), 0.0); - //- qr is negative going into the domain + //- Qr is negative going into the domain if (QrName_ != "none") { qr = patch().lookupPatchField<volScalarField, scalar>(QrName_); diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowReSetWallDissipation.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowReSetWallDissipation.H index a150d52b927..38aacf37497 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowReSetWallDissipation.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKELowRe/LienCubicKELowReSetWallDissipation.H @@ -4,7 +4,7 @@ { labelList cellBoundaryFaceCount(epsilon_.size(), 0); - //- use constant Cmu for epsilon in the near-wall cell + //- Use constant Cmu for epsilon in the near-wall cell scalar Cmu75 = pow(CmuWall_.value(), 0.75); const fvPatchList& patches = mesh_.boundary(); diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowReSetWallDissipation.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowReSetWallDissipation.H index 54ef9356c7e..62481f5c793 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowReSetWallDissipation.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienLeschzinerLowRe/LienLeschzinerLowReSetWallDissipation.H @@ -4,7 +4,7 @@ { labelList cellBoundaryFaceCount(epsilon_.size(), 0); - //- use constant Cmu for epsilon in the near-wall cell + //- Use constant Cmu for epsilon in the near-wall cell scalar Cmu75 = pow(Cmu_.value(), 0.75); const fvPatchList& patches = mesh_.boundary(); diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/include/nonLinearWallFunctionsI.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/include/nonLinearWallFunctionsI.H index 46bf81176f4..c9a4feb16b6 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/include/nonLinearWallFunctionsI.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/include/nonLinearWallFunctionsI.H @@ -82,7 +82,7 @@ Description { label faceCelli = curPatch.faceCells()[facei]; - //- using local Cmu ! + //- Using local Cmu ! scalar Cmu25 = pow025(Cmu_[faceCelli]); scalar Cmu75 = pow(Cmu_[faceCelli], 0.75); diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H index 2c7f4910921..f551ecc7e4e 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H @@ -137,7 +137,7 @@ class atmBoundaryLayer //- Direction of the z-coordinate vector zDir_; - //- von Karman constant + //- Von Karman constant const scalar kappa_; //- Turbulent viscosity coefficient diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 75032e20684..5fdf8160c2e 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -95,7 +95,7 @@ class turbulentMixingLengthDissipationRateInletFvPatchScalarField { // Private data - //- turbulent length scale + //- Turbulent length scale scalar mixingLength_; //- Name of the turbulent kinetic energy field diff --git a/src/conversion/ensight/file/ensightFile.H b/src/conversion/ensight/file/ensightFile.H index f8c24755b73..18c71fa02f5 100644 --- a/src/conversion/ensight/file/ensightFile.H +++ b/src/conversion/ensight/file/ensightFile.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -51,10 +51,10 @@ class ensightFile { // Private data - //- allow undef in results + //- Allow undef in results static bool allowUndef_; - //- value to represent undef in results + //- Value to represent undef in results static scalar undefValue_; //- The '*' mask appropriate for subDir @@ -120,28 +120,28 @@ public: // Output - //- binary write + //- Binary write virtual Ostream& write(const char* buf, std::streamsize count); - //- write element keyword with trailing newline, optionally with undef + //- Write element keyword with trailing newline, optionally with undef virtual Ostream& writeKeyword(const string& key); - //- write "C Binary" for binary files (eg, geometry/measured) + //- Write "C Binary" for binary files (eg, geometry/measured) Ostream& writeBinaryHeader(); - //- write undef value + //- Write undef value Ostream& writeUndef(); - //- write string as "%80s" or as binary + //- Write string as "%80s" or as binary Ostream& write(const string& value); - //- write integer as "%10d" or as binary + //- Write integer as "%10d" or as binary Ostream& write(const label value); - //- write integer with specified width or as binary + //- Write integer with specified width or as binary Ostream& write(const label value, const label fieldWidth); - //- write float as "%12.5e" or as binary + //- Write float as "%12.5e" or as binary Ostream& write(const scalar value); //- Add carriage return to ascii stream diff --git a/src/conversion/ensight/file/ensightGeoFile.H b/src/conversion/ensight/file/ensightGeoFile.H index a9c1d8d84d1..c4fc94180cb 100644 --- a/src/conversion/ensight/file/ensightGeoFile.H +++ b/src/conversion/ensight/file/ensightGeoFile.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -74,7 +74,7 @@ public: // Output - //- write keyword with trailing newline + //- Write keyword with trailing newline virtual Ostream& writeKeyword(const string& key); }; diff --git a/src/conversion/ensight/part/ensightPart.H b/src/conversion/ensight/part/ensightPart.H index 9a26c99a368..8166f953dc2 100644 --- a/src/conversion/ensight/part/ensightPart.H +++ b/src/conversion/ensight/part/ensightPart.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,25 +67,25 @@ protected: // Protected data - //- part number + //- Part number label number_; - //- part name (or description) + //- Part name (or description) string name_; - //- simple labelList with a name + //- Simple labelList with a name labelListList elemLists_; - //- start offset for elemLists_ + //- Start offset for elemLists_ label offset_; - //- number of elements in this part + //- Number of elements in this part label size_; - //- cell or face data + //- Cell or face data bool isCellData_; - //- material id (numeric) + //- Material id (numeric) label matId_; //- pointField referenced @@ -94,24 +94,24 @@ protected: // Protected Classes - //- track the points used by the part and map global to local indices + //- Track the points used by the part and map global to local indices class localPoints { public: - //- number of points used + //- Number of points used label nPoints; - //- map global to local indices + //- Map global to local indices labelList list; - //- null constructor + //- Null constructor localPoints() : nPoints(0), list(0) {} - //- construct for mesh points + //- Construct for mesh points localPoints(const pointField& pts) : nPoints(0), @@ -127,13 +127,13 @@ protected: // but cannot be used to write a new geometry void reconstruct(Istream&); - //- check for fully defined fields + //- Check for fully defined fields bool isFieldDefined(const List<scalar>&) const; - //- write the part header + //- Write the part header void writeHeader(ensightFile&, bool withDescription=false) const; - //- write a scalar field for idList + //- Write a scalar field for idList // A null reference for idList writes the perNode values void writeFieldList ( @@ -142,13 +142,13 @@ protected: const labelUList& idList ) const; - //- track points used + //- Track points used virtual localPoints calcLocalPoints() const { return localPoints(); } - //- write connectivities + //- Write connectivities virtual void writeConnectivity ( ensightGeoFile&, @@ -224,37 +224,37 @@ public: // Access - //- number of elements in this part + //- Number of elements in this part label size() const { return size_; } - //- represents cell data + //- Represents cell data bool isCellData() const { return isCellData_; } - //- represents face data + //- Represents face data bool isFaceData() const { return !isCellData_; } - //- part number + //- Part number label number() const { return number_; } - //- part name or description + //- Part name or description const string& name() const { return name_; } - //- material id + //- Material id label materialId() const { return matId_; @@ -272,13 +272,13 @@ public: matId_ = value; } - //- simple labelList with a name + //- Simple labelList with a name const labelListList& elemLists() const { return elemLists_; } - //- offset for element ids + //- Offset for element ids label offset() const { return offset_; @@ -287,13 +287,13 @@ public: // Edit - //- renumber elements + //- Renumber elements void renumber(const labelUList&); - //- write summary information about the object + //- Write summary information about the object bool writeSummary(Ostream&) const; - //- write reconstruction information for the object + //- Write reconstruction information for the object bool writeData(Ostream&) const; //- Write geometry @@ -303,7 +303,7 @@ public: //- Helper: write geometry given the pointField void writeGeometry(ensightGeoFile&, const pointField&) const; - //- write scalar field + //- Write scalar field // optionally write data per node void writeScalarField ( @@ -312,7 +312,7 @@ public: const bool perNode = false ) const; - //- write vector field components + //- Write vector field components // optionally write data per node void writeVectorField ( @@ -324,7 +324,7 @@ public: ) const; - //- write generalized field components + //- Write generalized field components // optionally write data per node template<class Type> void writeField @@ -346,10 +346,10 @@ public: // IOstream Operators - //- write data (reconstruction information) + //- Write data (reconstruction information) friend Ostream& operator<<(Ostream&, const ensightPart&); - //- write geometry + //- Write geometry friend ensightGeoFile& operator<<(ensightGeoFile&, const ensightPart&); }; diff --git a/src/conversion/ensight/part/ensightPartCells.H b/src/conversion/ensight/part/ensightPartCells.H index f9178fe0fd9..d1b3bcb72db 100644 --- a/src/conversion/ensight/part/ensightPartCells.H +++ b/src/conversion/ensight/part/ensightPartCells.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -63,13 +63,13 @@ class ensightPartCells const labelUList& idLabels = labelUList::null() ); - //- track points used + //- Track points used virtual localPoints calcLocalPoints() const; - //- track the points used + //- Track the points used // virtual void makeLocalPointMap(); - //- element connectivity + //- Element connectivity virtual void writeConnectivity ( ensightGeoFile&, @@ -81,7 +81,7 @@ class ensightPartCells protected: - //- addressable ensight element types + //- Addressable ensight element types enum elemType { tetra4Elements, @@ -99,7 +99,7 @@ protected: // Protected data - //- mesh referenced + //- Mesh referenced const polyMesh& mesh_; @@ -154,10 +154,10 @@ public: // Member Functions - //- write geometry + //- Write geometry virtual void writeGeometry(ensightGeoFile&) const; - //- static listing of the element types + //- Static listing of the element types virtual const List<word>& elementTypes() const { return elemTypes_; diff --git a/src/conversion/ensight/part/ensightPartFaces.H b/src/conversion/ensight/part/ensightPartFaces.H index 1e3ffbb4fa8..ea27d0cf51e 100644 --- a/src/conversion/ensight/part/ensightPartFaces.H +++ b/src/conversion/ensight/part/ensightPartFaces.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,10 +55,10 @@ class ensightPartFaces //- Disallow default bitwise assignment void operator=(const ensightPartFaces&); - //- track points used + //- Track points used virtual localPoints calcLocalPoints() const; - //- element connectivity + //- Element connectivity virtual void writeConnectivity ( ensightGeoFile&, @@ -70,7 +70,7 @@ class ensightPartFaces protected: - //- addressable ensight element types + //- Addressable ensight element types enum elemType { tria3Elements, @@ -86,7 +86,7 @@ protected: // Protected data - //- faces referenced + //- Faces referenced const faceList& faces_; //- Can skip local point renumbering when points are contiguous @@ -160,10 +160,10 @@ public: // Member Functions - //- write geometry + //- Write geometry virtual void writeGeometry(ensightGeoFile&) const; - //- static listing of the element types + //- Static listing of the element types virtual const List<word>& elementTypes() const { return elemTypes_; diff --git a/src/conversion/ensight/part/ensightParts.H b/src/conversion/ensight/part/ensightParts.H index d31e7365355..10faa7ea75c 100644 --- a/src/conversion/ensight/part/ensightParts.H +++ b/src/conversion/ensight/part/ensightParts.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ class ensightParts { // Private Data - //- list of parts + //- List of parts PtrList<ensightPart> partsList_; // Private Member Functions @@ -83,32 +83,32 @@ public: // Member functions - //- clear old information and construct anew from polyMesh + //- Clear old information and construct anew from polyMesh void recalculate(const polyMesh&); - //- renumber elements + //- Renumber elements void renumber ( const labelUList& origCellId, const labelUList& origFaceId ); - //- number of parts + //- Number of parts label size() const { return partsList_.size(); } - //- write the geometry + //- Write the geometry void writeGeometry(ensightGeoFile&) const; - //- write summary information about the objects + //- Write summary information about the objects bool writeSummary(Ostream&) const; - //- write the lists + //- Write the lists void writeData(Ostream&) const; - //- write (volume) scalar field + //- Write (volume) scalar field // optionally write data for face parts // optionally write data per node void writeScalarField @@ -119,7 +119,7 @@ public: const bool perNode = false ) const; - //- write (volume) vector field components + //- Write (volume) vector field components // optionally write data for face parts // optionally write data per node void writeVectorField @@ -133,7 +133,7 @@ public: ) const; - //- write generalized volume field components + //- Write generalized volume field components template<class Type> void writeField ( @@ -144,7 +144,7 @@ public: // Friend Operators - //- write geometry + //- Write geometry friend ensightGeoFile& operator<<(ensightGeoFile&, const ensightParts&); }; diff --git a/src/conversion/meshReader/meshReader.H b/src/conversion/meshReader/meshReader.H index 3339b03fa8e..a0b696d6dc4 100644 --- a/src/conversion/meshReader/meshReader.H +++ b/src/conversion/meshReader/meshReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -154,10 +154,10 @@ private: labelList patchStarts_; labelList patchSizes_; - //- association between two faces + //- Association between two faces List<labelPair> interfaces_; - //- list of cells/faces id pairs for each baffle + //- List of cells/faces id pairs for each baffle List<List<cellFaceIdentifier> > baffleIds_; //- Global face list for polyMesh diff --git a/src/conversion/meshReader/starcd/STARCDMeshReader.C b/src/conversion/meshReader/starcd/STARCDMeshReader.C index 09b651efd04..3e3e94383b4 100644 --- a/src/conversion/meshReader/starcd/STARCDMeshReader.C +++ b/src/conversion/meshReader/starcd/STARCDMeshReader.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -149,7 +149,7 @@ void Foam::meshReaders::STARCD::readPoints points_.setSize(nPoints); mapToFoamPointId_.setSize(maxId+1); - //- original Point number for a given vertex + //- Original Point number for a given vertex // might need again in the future //// labelList origPointId(nPoints); //// origPointId = -1; diff --git a/src/conversion/meshTables/cellTable.H b/src/conversion/meshTables/cellTable.H index 67fcd1fd598..951575610d6 100644 --- a/src/conversion/meshTables/cellTable.H +++ b/src/conversion/meshTables/cellTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -173,7 +173,7 @@ public: const fileName& instance = "constant" ); - //- write constant/cellTable for later reuse + //- Write constant/cellTable for later reuse void writeDict ( const objectRegistry&, diff --git a/src/dynamicMesh/boundaryMesh/boundaryMesh.H b/src/dynamicMesh/boundaryMesh/boundaryMesh.H index a495c03eed4..d6eca3f7709 100644 --- a/src/dynamicMesh/boundaryMesh/boundaryMesh.H +++ b/src/dynamicMesh/boundaryMesh/boundaryMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -87,16 +87,16 @@ class boundaryMesh // Edge handling // - //- points referenced by feature edges. + //- Points referenced by feature edges. pointField featurePoints_; - //- feature edges. Indices into featurePoints. + //- Feature edges. Indices into featurePoints. edgeList featureEdges_; - //- from feature edge to mesh edge. + //- From feature edge to mesh edge. labelList featureToEdge_; - //- from mesh edges to featureEdges_; + //- From mesh edges to featureEdges_; labelList edgeToFeature_; //- Feature 'segments'. Collections of connected featureEdges. diff --git a/src/dynamicMesh/meshCut/cellCuts/cellCuts.H b/src/dynamicMesh/meshCut/cellCuts/cellCuts.H index 18cad9cf0c8..4fb1173db62 100644 --- a/src/dynamicMesh/meshCut/cellCuts/cellCuts.H +++ b/src/dynamicMesh/meshCut/cellCuts/cellCuts.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -435,7 +435,7 @@ class cellCuts //- Set orientation of loops void orientPlanesAndLoops(); - //- top level driver: adressing calculation and loop detection + //- Top level driver: adressing calculation and loop detection void calcLoopsAndAddressing(const labelList& cutCells); //- Check various consistencies. diff --git a/src/dynamicMesh/meshCut/cellLooper/hexCellLooper.H b/src/dynamicMesh/meshCut/cellLooper/hexCellLooper.H index b105e4ba3f7..f00a0254c24 100644 --- a/src/dynamicMesh/meshCut/cellLooper/hexCellLooper.H +++ b/src/dynamicMesh/meshCut/cellLooper/hexCellLooper.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -74,7 +74,7 @@ private: // Private Member Functions - //- walk across faces of hex. Update loop/loopWeights with edges cut. + //- Walk across faces of hex. Update loop/loopWeights with edges cut. // Return true if successful walk. (should be always!) bool walkHex ( diff --git a/src/dynamicMesh/meshCut/cellLooper/topoCellLooper.H b/src/dynamicMesh/meshCut/cellLooper/topoCellLooper.H index 2e33ef880fe..3d983568953 100644 --- a/src/dynamicMesh/meshCut/cellLooper/topoCellLooper.H +++ b/src/dynamicMesh/meshCut/cellLooper/topoCellLooper.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -80,7 +80,7 @@ class topoCellLooper DynamicList<T>& lst ); - //- walk across superface discarding non-feature points. + //- Walk across superface discarding non-feature points. void walkFace ( const cellFeatures& features, @@ -158,7 +158,7 @@ public: // Static data members - //- cos of angle for feature recognition (of splitHexes) + //- Cos of angle for feature recognition (of splitHexes) static const scalar featureCos; diff --git a/src/dynamicMesh/meshCut/edgeVertex/edgeVertex.H b/src/dynamicMesh/meshCut/edgeVertex/edgeVertex.H index 87470843e43..b8d9e054836 100644 --- a/src/dynamicMesh/meshCut/edgeVertex/edgeVertex.H +++ b/src/dynamicMesh/meshCut/edgeVertex/edgeVertex.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -104,7 +104,7 @@ public: // EdgeVertex handling - //- is eVert an edge? + //- Is eVert an edge? static bool isEdge(const primitiveMesh& mesh, const label eVert) { if (eVert < 0 || eVert >= (mesh.nPoints() + mesh.nEdges())) @@ -125,7 +125,7 @@ public: return isEdge(mesh_, eVert); } - //- convert eVert to edge label + //- Convert eVert to edge label static label getEdge(const primitiveMesh& mesh, const label eVert) { if (!isEdge(mesh, eVert)) @@ -143,7 +143,7 @@ public: return getEdge(mesh_, eVert); } - //- convert eVert to vertex label + //- Convert eVert to vertex label static label getVertex(const primitiveMesh& mesh, const label eVert) { if (isEdge(mesh, eVert) || (eVert < 0)) diff --git a/src/dynamicMesh/meshCut/meshModifiers/multiDirRefinement/multiDirRefinement.H b/src/dynamicMesh/meshCut/meshModifiers/multiDirRefinement/multiDirRefinement.H index c698ffaf999..bf148149802 100644 --- a/src/dynamicMesh/meshCut/meshModifiers/multiDirRefinement/multiDirRefinement.H +++ b/src/dynamicMesh/meshCut/meshModifiers/multiDirRefinement/multiDirRefinement.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -79,7 +79,7 @@ class multiDirRefinement //- Current set of cells to refine. Extended with added cells. labelList cellLabels_; - //- from original to added cells. + //- From original to added cells. // Gives for every cell in the original mesh an empty list or the // list of cells this one has been split into (note: will include // itself so e.g. for hex will be 8 if 2x2x2 refinement) diff --git a/src/dynamicMesh/meshCut/refineCell/refineCell.H b/src/dynamicMesh/meshCut/refineCell/refineCell.H index 191af276b7f..58bf0de9342 100644 --- a/src/dynamicMesh/meshCut/refineCell/refineCell.H +++ b/src/dynamicMesh/meshCut/refineCell/refineCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,10 +67,10 @@ public: //- Null refineCell(); - //- from components. Vector will be normalized upon construction. + //- From components. Vector will be normalized upon construction. refineCell(const label, const vector&); - //- from Istream. Vector will be normalized upon construction. + //- From Istream. Vector will be normalized upon construction. refineCell(Istream& is); diff --git a/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H b/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H index deff3f1c6f1..d4c10548605 100644 --- a/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H +++ b/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -213,7 +213,7 @@ class motionSmootherAlgo //- Calculate per-edge weight tmp<scalarField> calcEdgeWeights(const pointField&) const; - //- explicit smoothing and min on all affected internal points + //- Explicit smoothing and min on all affected internal points void minSmooth ( const scalarField& edgeWeights, @@ -222,7 +222,7 @@ class motionSmootherAlgo pointScalarField& newFld ) const; - //- same but only on selected points (usually patch points) + //- Same but only on selected points (usually patch points) void minSmooth ( const scalarField& edgeWeights, diff --git a/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H b/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H index 9e8269df937..158af5e1d8e 100644 --- a/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H +++ b/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -288,7 +288,7 @@ public: const labelListList& layerFaces ); - //- added cells given current mesh & layerfaces. + //- Added cells given current mesh & layerfaces. labelListList addedCells() const; diff --git a/src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.H b/src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.H index f33ee706f9d..58dfc8559bd 100644 --- a/src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.H +++ b/src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -90,7 +90,7 @@ class hexRef8 //- Level of saved cells Map<label> savedCellLevel_; - //- cell shapes when seen as split hexes + //- Cell shapes when seen as split hexes mutable autoPtr<cellShapeList> cellShapesPtr_; diff --git a/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementDistanceData.H b/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementDistanceData.H index 19fd5e32715..63970726c4e 100644 --- a/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementDistanceData.H +++ b/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementDistanceData.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,10 +57,10 @@ class refinementDistanceData // Private data - //- unrefined (level0) buffer size (nBufferLayers*level0Size) + //- Unrefined (level0) buffer size (nBufferLayers*level0Size) scalar level0Size_; - //- nearest point with highest level + //- Nearest point with highest level point origin_; label originLevel_; diff --git a/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementHistory.H b/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementHistory.H index 1eb9f40e777..4d5d854b457 100644 --- a/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementHistory.H +++ b/src/dynamicMesh/polyTopoChange/polyTopoChange/refinementHistory.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -106,7 +106,7 @@ public: // -2: free splitCell (so should also be in freeSplitCells_) label parent_; - //- cells this cell was refined into + //- Cells this cell was refined into autoPtr<FixedList<label, 8> > addedCellsPtr_; //- Construct null (parent = -1) diff --git a/src/engine/engineTime/engineTime.H b/src/engine/engineTime/engineTime.H index 69f4edb7b6b..84d33c0a4c1 100644 --- a/src/engine/engineTime/engineTime.H +++ b/src/engine/engineTime/engineTime.H @@ -92,7 +92,7 @@ class engineTime //- Disallow default bitwise assignment void operator=(const engineTime&); - //- adjust read time values + //- Adjust read time values void timeAdjustment(); public: diff --git a/src/fileFormats/vtk/vtkUnstructuredReader.H b/src/fileFormats/vtk/vtkUnstructuredReader.H index bc9612afaaa..7c93f86be66 100644 --- a/src/fileFormats/vtk/vtkUnstructuredReader.H +++ b/src/fileFormats/vtk/vtkUnstructuredReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -168,13 +168,13 @@ private: // Data - //- cell based fields + //- Cell based fields objectRegistry cellData_; - //- point based fields + //- Point based fields objectRegistry pointData_; - //- other fields + //- Other fields objectRegistry otherData_; @@ -317,7 +317,7 @@ public: return lineMap_; } - //- cell based fields + //- Cell based fields const objectRegistry& cellData() const { return cellData_; @@ -328,7 +328,7 @@ public: return cellData_; } - //- point based fields + //- Point based fields const objectRegistry& pointData() const { return pointData_; @@ -339,7 +339,7 @@ public: return pointData_; } - //- other fields + //- Other fields const objectRegistry& otherData() const { return otherData_; diff --git a/src/finiteVolume/cfdTools/general/porosityModel/fixedCoeff/fixedCoeff.H b/src/finiteVolume/cfdTools/general/porosityModel/fixedCoeff/fixedCoeff.H index ad441f3ac10..7bb52032d76 100644 --- a/src/finiteVolume/cfdTools/general/porosityModel/fixedCoeff/fixedCoeff.H +++ b/src/finiteVolume/cfdTools/general/porosityModel/fixedCoeff/fixedCoeff.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -64,10 +64,10 @@ private: // Private data - //- alpha coefficient XYZ components (user-supplied) [1/s] + //- Alpha coefficient XYZ components (user-supplied) [1/s] dimensionedVector alphaXYZ_; - //- beta coefficient XYZ components (user-supplied) [1/m] + //- Beta coefficient XYZ components (user-supplied) [1/m] dimensionedVector betaXYZ_; //- Model alpha coefficient - converted from alphaXYZ [1/s] diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 9723a2116af..e050e2b1933 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -124,10 +124,10 @@ class codedFixedValueFvPatchField //- Set the rewrite vars controlling the Type static void setFieldTemplates(dynamicCode& dynCode); - //- get the loaded dynamic libraries + //- Get the loaded dynamic libraries virtual dlLibraryTable& libs() const; - //- adapt the context for the current object + //- Adapt the context for the current object virtual void prepare(dynamicCode&, const dynamicCodeContext&) const; // Return a description (type + name) for the output diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 59c434ee72e..52662aee511 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -134,10 +134,10 @@ class codedMixedFvPatchField //- Set the rewrite vars controlling the Type static void setFieldTemplates(dynamicCode& dynCode); - //- get the loaded dynamic libraries + //- Get the loaded dynamic libraries virtual dlLibraryTable& libs() const; - //- adapt the context for the current object + //- Adapt the context for the current object virtual void prepare(dynamicCode&, const dynamicCodeContext&) const; // Return a description (type + name) for the output diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index c4dc0a1e4ff..3fb31d25b0f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -100,10 +100,10 @@ class syringePressureFvPatchScalarField { // Private data - //- syringe piston area + //- Syringe piston area scalar Ap_; - //- syringe piston speed + //- Syringe piston speed scalar Sp_; //- Initial syringe volume @@ -118,7 +118,7 @@ class syringePressureFvPatchScalarField //- Start of piston deceleration scalar tds_; - //- end of piston deceleration + //- End of piston deceleration scalar tde_; //- Initial syringe pressure diff --git a/src/finiteVolume/interpolation/interpolation/interpolationCellPoint/cellPointWeight/cellPointWeight.H b/src/finiteVolume/interpolation/interpolation/interpolationCellPoint/cellPointWeight/cellPointWeight.H index 8e0028e2b7b..13371a77896 100644 --- a/src/finiteVolume/interpolation/interpolation/interpolationCellPoint/cellPointWeight/cellPointWeight.H +++ b/src/finiteVolume/interpolation/interpolation/interpolationCellPoint/cellPointWeight/cellPointWeight.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -111,13 +111,13 @@ public: return cellI_; } - //- interpolation weights + //- Interpolation weights inline const List<scalar>& weights() const { return weights_; } - //- interpolation addressing for points on face + //- Interpolation addressing for points on face inline const List<label>& faceVertices() const { return faceVertices_; diff --git a/src/finiteVolume/interpolation/interpolation/interpolationPointMVC/pointMVCWeight.H b/src/finiteVolume/interpolation/interpolation/interpolationPointMVC/pointMVCWeight.H index 1d3cf24a486..32b6c5ec368 100644 --- a/src/finiteVolume/interpolation/interpolation/interpolationPointMVC/pointMVCWeight.H +++ b/src/finiteVolume/interpolation/interpolation/interpolationPointMVC/pointMVCWeight.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -132,7 +132,7 @@ public: return cellIndex_; } - //- interpolation weights (in order of cellPoints) + //- Interpolation weights (in order of cellPoints) inline const scalarField& weights() const { return weights_; diff --git a/src/fvMotionSolver/motionDiffusivity/motionDiffusivity/motionDiffusivity.H b/src/fvMotionSolver/motionDiffusivity/motionDiffusivity/motionDiffusivity.H index b28ee1cfad8..a8b042d71d7 100644 --- a/src/fvMotionSolver/motionDiffusivity/motionDiffusivity/motionDiffusivity.H +++ b/src/fvMotionSolver/motionDiffusivity/motionDiffusivity/motionDiffusivity.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -51,7 +51,7 @@ class motionDiffusivity { // Private data - //- mesh reference + //- Mesh reference const fvMesh& mesh_; public: diff --git a/src/fvMotionSolver/pointPatchFields/derived/surfaceDisplacement/surfaceDisplacementPointPatchVectorField.H b/src/fvMotionSolver/pointPatchFields/derived/surfaceDisplacement/surfaceDisplacementPointPatchVectorField.H index 7fbe8c5ec05..c5db3f0c6a6 100644 --- a/src/fvMotionSolver/pointPatchFields/derived/surfaceDisplacement/surfaceDisplacementPointPatchVectorField.H +++ b/src/fvMotionSolver/pointPatchFields/derived/surfaceDisplacement/surfaceDisplacementPointPatchVectorField.H @@ -91,22 +91,22 @@ private: // Private data - //- project mode names + //- Project mode names static const NamedEnum<projectMode, 3> projectModeNames_; //- Maximum velocity const vector velocity_; - //- names of surfaces + //- Names of surfaces const dictionary surfacesDict_; //- How to project/project onto surface const projectMode projectMode_; - //- direction to project + //- Direction to project const vector projectDir_; - //- plane for 2D wedge case or -1. + //- Plane for 2D wedge case or -1. const label wedgePlane_; //- pointZone with frozen points diff --git a/src/fvMotionSolver/pointPatchFields/derived/surfaceSlipDisplacement/surfaceSlipDisplacementPointPatchVectorField.H b/src/fvMotionSolver/pointPatchFields/derived/surfaceSlipDisplacement/surfaceSlipDisplacementPointPatchVectorField.H index 3115c3af3e3..7adb6d3d83b 100644 --- a/src/fvMotionSolver/pointPatchFields/derived/surfaceSlipDisplacement/surfaceSlipDisplacementPointPatchVectorField.H +++ b/src/fvMotionSolver/pointPatchFields/derived/surfaceSlipDisplacement/surfaceSlipDisplacementPointPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -85,19 +85,19 @@ private: // Private data - //- project mode names + //- Project mode names static const NamedEnum<projectMode, 3> projectModeNames_; - //- names of surfaces + //- Names of surfaces const dictionary surfacesDict_; //- How to project/project onto surface const projectMode projectMode_; - //- direction to project + //- Direction to project const vector projectDir_; - //- plane for 2D wedge case or -1. + //- Plane for 2D wedge case or -1. const label wedgePlane_; //- pointZone with frozen points diff --git a/src/fvOptions/sources/general/codedSource/CodedSource.H b/src/fvOptions/sources/general/codedSource/CodedSource.H index ed22a6d2b06..c10b42d2626 100644 --- a/src/fvOptions/sources/general/codedSource/CodedSource.H +++ b/src/fvOptions/sources/general/codedSource/CodedSource.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -152,10 +152,10 @@ protected: // Protected Member Functions - //- get the loaded dynamic libraries + //- Get the loaded dynamic libraries virtual dlLibraryTable& libs() const; - //- adapt the context for the current object + //- Adapt the context for the current object virtual void prepare(dynamicCode&, const dynamicCodeContext&) const; // Return a description (type + name) for the output diff --git a/src/lagrangian/basic/particle/particle.H b/src/lagrangian/basic/particle/particle.H index 6cb1838e83a..c2d10f46b7c 100644 --- a/src/lagrangian/basic/particle/particle.H +++ b/src/lagrangian/basic/particle/particle.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -213,7 +213,7 @@ protected: //- Hit wall faces in the current cell if the //- wallImpactDistance is non-zero. They may not be in - //- different tets to the current. + //- Different tets to the current. template<class CloudType> inline void hitWallFaces ( diff --git a/src/lagrangian/distributionModels/general/general.H b/src/lagrangian/distributionModels/general/general.H index 53ee4716a2b..d2625ed9c70 100644 --- a/src/lagrangian/distributionModels/general/general.H +++ b/src/lagrangian/distributionModels/general/general.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -62,7 +62,7 @@ class general label nEntries_; - //- min and max values of the distribution + //- Min and max values of the distribution scalar minValue_; scalar maxValue_; diff --git a/src/lagrangian/dsmc/clouds/Templates/DsmcCloud/DsmcCloud.H b/src/lagrangian/dsmc/clouds/Templates/DsmcCloud/DsmcCloud.H index 423bd87160e..fbc5b7081f5 100644 --- a/src/lagrangian/dsmc/clouds/Templates/DsmcCloud/DsmcCloud.H +++ b/src/lagrangian/dsmc/clouds/Templates/DsmcCloud/DsmcCloud.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -109,16 +109,16 @@ class DsmcCloud //- Force density at surface field volVectorField fD_; - //- number density field + //- Number density field volScalarField rhoN_; //- Mass density field volScalarField rhoM_; - //- dsmc particle density field + //- Dsmc particle density field volScalarField dsmcRhoN_; - //- linear kinetic energy density field + //- Linear kinetic energy density field volScalarField linearKE_; //- Internal energy density field @@ -139,10 +139,10 @@ class DsmcCloud // boundary value fields - //- boundary temperature + //- Boundary temperature volScalarField boundaryT_; - //- boundary velocity + //- Boundary velocity volVectorField boundaryU_; diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairSpringSliderDashpot/PairSpringSliderDashpot.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairSpringSliderDashpot/PairSpringSliderDashpot.H index 142ac505b09..f5e4b31ff9d 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairSpringSliderDashpot/PairSpringSliderDashpot.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairModel/PairSpringSliderDashpot/PairSpringSliderDashpot.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -104,7 +104,7 @@ class PairSpringSliderDashpot // Private Member Functions //- Find the appropriate properties for determining the minimum - //- allowable timestep + //- Allowable timestep void findMinMaxProperties ( scalar& RMin, diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallLocalSpringSliderDashpot/WallLocalSpringSliderDashpot.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallLocalSpringSliderDashpot/WallLocalSpringSliderDashpot.H index cd7f840fe32..e48e949f573 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallLocalSpringSliderDashpot/WallLocalSpringSliderDashpot.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallLocalSpringSliderDashpot/WallLocalSpringSliderDashpot.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -107,7 +107,7 @@ class WallLocalSpringSliderDashpot // Private Member Functions //- Find the appropriate properties for determining the minimum - //- allowable timestep + //- Allowable timestep void findMinMaxProperties ( scalar& rMin, diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallSpringSliderDashpot/WallSpringSliderDashpot.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallSpringSliderDashpot/WallSpringSliderDashpot.H index 7c709340fb3..88dca9b66c4 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallSpringSliderDashpot/WallSpringSliderDashpot.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallSpringSliderDashpot/WallSpringSliderDashpot.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -101,7 +101,7 @@ class WallSpringSliderDashpot // Private Member Functions //- Find the appropriate properties for determining the minimum - //- allowable timestep + //- Allowable timestep void findMinMaxProperties ( scalar& rMin, diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H index 54ae9557be9..bd67443ce15 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -152,7 +152,7 @@ private: //- Second tangential vector vector tanVec2_; - //- injection vector orthogonal to direction + //- Injection vector orthogonal to direction vector normal_; diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H index e5aafff43e3..749b77ae781 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -81,7 +81,7 @@ public: //- Member Functions - //- calculate velocities + //- Calculate velocities virtual void calculate(); //- Return the model 'active' status diff --git a/src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H b/src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H index 7897c034ec3..ed25c5e1f04 100644 --- a/src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H +++ b/src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -66,7 +66,7 @@ public: // Static functions - //- write to file + //- Write to file static void write ( diff --git a/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H b/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H index 42323553b6c..c344b2b5902 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H @@ -114,13 +114,13 @@ public: // Member Functions - //- initial value of liquidCore + //- Initial value of liquidCore virtual scalar initLiquidCore() const; //- Average temperature calculation scalar Taverage(const scalar& Tliq, const scalar& Tc) const; - //- flag to indicate if chi needs to be calculated + //- Flag to indicate if chi needs to be calculated virtual bool calcChi() const; virtual void update diff --git a/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H b/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H index 22970e7c487..f6a2af70933 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -97,10 +97,10 @@ public: // Member Functions - //- initial value of liquidCore + //- Initial value of liquidCore virtual scalar initLiquidCore() const; - //- flag to indicate if chi needs to be calculated + //- Flag to indicate if chi needs to be calculated virtual bool calcChi() const; virtual void update diff --git a/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H b/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H index f03a02642f1..a993c3e9112 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -117,10 +117,10 @@ public: // Member Functions - //- initial value of liquidCore + //- Initial value of liquidCore virtual scalar initLiquidCore() const; - //- flag to indicate if chi needs to be calculated + //- Flag to indicate if chi needs to be calculated virtual bool calcChi() const; virtual void update diff --git a/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H b/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H index 9b8b45c04f0..7a681c8dbee 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -107,7 +107,7 @@ public: // Member Functions - //- update the parcel properties + //- Update the parcel properties virtual bool update ( const scalar dt, diff --git a/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H b/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H index b27792c54ca..6371570638f 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H +++ b/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -80,7 +80,7 @@ public: //- Flag to indicate whether model activates break-up model virtual bool active() const; - //- update the parcel properties + //- Update the parcel properties virtual bool update ( const scalar dt, diff --git a/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H b/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H index 09d1f3fe031..235c9d76c09 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H +++ b/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -111,7 +111,7 @@ public: // Member Functions - //- update the parcel properties + //- Update the parcel properties virtual bool update ( const scalar dt, diff --git a/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H b/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H index 84e9dac4a25..9d9081ab342 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -105,7 +105,7 @@ public: // Member Functions - //- update the parcel properties + //- Update the parcel properties virtual bool update ( const scalar dt, diff --git a/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H b/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H index d14d92b81e2..0cc56e87537 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -92,7 +92,7 @@ public: // Member Functions - //- update the parcel diameter + //- Update the parcel diameter virtual bool update ( const scalar dt, diff --git a/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H b/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H index 2708488e0b8..94456c64a8a 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H +++ b/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -134,7 +134,7 @@ public: // Member Functions - //- update the parcel properties + //- Update the parcel properties virtual bool update ( const scalar dt, diff --git a/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H b/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H index 462953f1ee3..f5f6b73c715 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H +++ b/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -117,7 +117,7 @@ public: // Member Functions - //- update the parcel diameter + //- Update the parcel diameter virtual bool update ( const scalar dt, diff --git a/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoLayerDriver.H b/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoLayerDriver.H index 07bf19ce0de..7aa5050a229 100644 --- a/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoLayerDriver.H +++ b/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoLayerDriver.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -284,7 +284,7 @@ private: List<extrudeMode>& extrudeStatus ) const; - //- for truncateDisplacement: find strings of edges + //- For truncateDisplacement: find strings of edges bool sameEdgeNeighbour ( const labelListList& globalEdgeFaces, @@ -293,7 +293,7 @@ private: const label edgeI ) const; - //- for truncateDisplacement: find strings of edges + //- For truncateDisplacement: find strings of edges void getVertexString ( const indirectPrimitivePatch& pp, diff --git a/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoSnapDriverFeature.C b/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoSnapDriverFeature.C index 5a0bf08e100..6fc6363bb95 100644 --- a/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoSnapDriverFeature.C +++ b/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoSnapDriverFeature.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -856,7 +856,7 @@ void Foam::autoSnapDriver::featureAttractionUsingReconstruction // Bin according to surface normal // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - //- bins of differing normals: + //- Bins of differing normals: // - one normal : flat(tish) surface // - two normals : geometric feature edge // - three normals: geometric feature point @@ -864,7 +864,7 @@ void Foam::autoSnapDriver::featureAttractionUsingReconstruction surfacePoints.clear(); surfaceNormals.clear(); - //- from face to above normals bin + //- From face to above normals bin faceToNormalBin.setSize(pfDisp.size()); faceToNormalBin = -1; diff --git a/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H b/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H index c2a83752a29..9b933d744c0 100644 --- a/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H +++ b/src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,10 +57,10 @@ class pointData { // Private data - //- additional information. + //- Additional information. scalar s_; - //- additional information. + //- Additional information. vector v_; public: diff --git a/src/mesh/autoMesh/autoHexMesh/externalDisplacementMeshMover/medialAxisMeshMover.H b/src/mesh/autoMesh/autoHexMesh/externalDisplacementMeshMover/medialAxisMeshMover.H index c060e4d2093..a060a04fe6f 100644 --- a/src/mesh/autoMesh/autoHexMesh/externalDisplacementMeshMover/medialAxisMeshMover.H +++ b/src/mesh/autoMesh/autoHexMesh/externalDisplacementMeshMover/medialAxisMeshMover.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -78,11 +78,11 @@ class medialAxisMeshMover // Pre-calculated medial axis information - //- normal of nearest wall. Where this normal changes direction + //- Normal of nearest wall. Where this normal changes direction // defines the medial axis pointVectorField dispVec_; - //- ratio of medial distance to wall distance. + //- Ratio of medial distance to wall distance. // (1 at wall, 0 at medial axis) pointScalarField medialRatio_; diff --git a/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H b/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H index 1b1ff73b2d9..7281a3d520d 100644 --- a/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H +++ b/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -159,10 +159,10 @@ private: //- Reference to mesh fvMesh& mesh_; - //- tolerance used for sorting coordinates (used in 'less' routine) + //- Tolerance used for sorting coordinates (used in 'less' routine) const scalar mergeDistance_; - //- overwrite the mesh? + //- Overwrite the mesh? const bool overwrite_; //- Instance of mesh upon construction. Used when in overwrite_ mode. @@ -177,13 +177,13 @@ private: //- All shell-refinement interaction const shellSurfaces& shells_; - //- refinement engine + //- Refinement engine hexRef8 meshCutter_; - //- per cc-cc vector the index of the surface hit + //- Per cc-cc vector the index of the surface hit labelIOList surfaceIndex_; - //- user supplied face based data. + //- User supplied face based data. List<Tuple2<mapType, labelList> > userFaceData_; //- Meshed patches - are treated differently. Stored as wordList since @@ -605,7 +605,7 @@ public: // Access - //- reference to mesh + //- Reference to mesh const fvMesh& mesh() const { return mesh_; @@ -632,31 +632,31 @@ public: return oldInstance_; } - //- reference to surface search engines + //- Reference to surface search engines const refinementSurfaces& surfaces() const { return surfaces_; } - //- reference to feature edge mesh + //- Reference to feature edge mesh const refinementFeatures& features() const { return features_; } - //- reference to refinement shells (regions) + //- Reference to refinement shells (regions) const shellSurfaces& shells() const { return shells_; } - //- reference to meshcutting engine + //- Reference to meshcutting engine const hexRef8& meshCutter() const { return meshCutter_; } - //- per start-end edge the index of the surface hit + //- Per start-end edge the index of the surface hit const labelList& surfaceIndex() const { return surfaceIndex_; diff --git a/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C b/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C index ff1465dd0ba..3ccaa728350 100644 --- a/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C +++ b/src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -83,7 +83,7 @@ namespace Foam }; - //- template specialization for pTraits<labelList> so we can have fields + //- Template specialization for pTraits<labelList> so we can have fields template<> class pTraits<labelList> { @@ -94,7 +94,7 @@ namespace Foam typedef labelList cmptType; }; - //- template specialization for pTraits<labelList> so we can have fields + //- Template specialization for pTraits<labelList> so we can have fields template<> class pTraits<vectorList> { @@ -1519,7 +1519,7 @@ bool Foam::meshRefinement::isGap const vector& normal1 ) const { - //- hits differ and angles are oppositeish and + //- Hits differ and angles are oppositeish and // hits have a normal distance vector d = point1-point0; scalar magD = mag(d); @@ -1576,7 +1576,7 @@ bool Foam::meshRefinement::isNormalGap const vector& normal1 ) const { - //- hits differ and angles are oppositeish and + //- Hits differ and angles are oppositeish and // hits have a normal distance vector d = point1-point0; scalar magD = mag(d); diff --git a/src/mesh/autoMesh/autoHexMesh/meshRefinement/patchFaceOrientation.H b/src/mesh/autoMesh/autoHexMesh/meshRefinement/patchFaceOrientation.H index 0d7dc569271..116a68ee39a 100644 --- a/src/mesh/autoMesh/autoHexMesh/meshRefinement/patchFaceOrientation.H +++ b/src/mesh/autoMesh/autoHexMesh/meshRefinement/patchFaceOrientation.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class patchFaceOrientation { // Private data - //- flip status + //- Flip status label flipStatus_; public: diff --git a/src/mesh/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H b/src/mesh/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H index c98a53929aa..802581ab6d4 100644 --- a/src/mesh/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H +++ b/src/mesh/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,19 +56,19 @@ class trackedParticle { // Private data - //- end point to track to + //- End point to track to point end_; - //- level of this particle + //- Level of this particle label level_; - //- passive label (used to store feature edge mesh) + //- Passive label (used to store feature edge mesh) label i_; - //- passive label (used to store feature edge point) + //- Passive label (used to store feature edge point) label j_; - //- passive label (used to store feature edge label) + //- Passive label (used to store feature edge label) label k_; @@ -162,43 +162,43 @@ public: // Member Functions - //- point to track to + //- Point to track to point& end() { return end_; } - //- transported label + //- Transported label label i() const { return i_; } - //- transported label + //- Transported label label& i() { return i_; } - //- transported label + //- Transported label label j() const { return j_; } - //- transported label + //- Transported label label& j() { return j_; } - //- transported label + //- Transported label label k() const { return k_; } - //- transported label + //- Transported label label& k() { return k_; diff --git a/src/mesh/blockMesh/blockMesh/blockMesh.H b/src/mesh/blockMesh/blockMesh/blockMesh.H index e3a6619ce9a..2ab190179fb 100644 --- a/src/mesh/blockMesh/blockMesh/blockMesh.H +++ b/src/mesh/blockMesh/blockMesh/blockMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -140,7 +140,7 @@ class blockMesh void createCells() const; void createPatches() const; - //- as copy (not implemented) + //- As copy (not implemented) blockMesh(const blockMesh&); diff --git a/src/mesh/extrudeModel/linearDirection/linearDirection.H b/src/mesh/extrudeModel/linearDirection/linearDirection.H index fd761467eed..9dea1084086 100644 --- a/src/mesh/extrudeModel/linearDirection/linearDirection.H +++ b/src/mesh/extrudeModel/linearDirection/linearDirection.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class linearDirection //- Extrude direction vector direction_; - //- layer thickness + //- Layer thickness scalar thickness_; diff --git a/src/mesh/extrudeModel/linearNormal/linearNormal.H b/src/mesh/extrudeModel/linearNormal/linearNormal.H index db2863ff755..97afea2b6a3 100644 --- a/src/mesh/extrudeModel/linearNormal/linearNormal.H +++ b/src/mesh/extrudeModel/linearNormal/linearNormal.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -53,13 +53,13 @@ class linearNormal { // Private data - //- layer thickness + //- Layer thickness scalar thickness_; - //- first cell thickness + //- First cell thickness scalar firstCellThickness_; - //- layer cell distibution + //- Layer cell distibution scalarList layerPoints_; diff --git a/src/meshTools/AMIInterpolation/AMIInterpolation/AMIMethod/AMIMethod/AMIMethod.H b/src/meshTools/AMIInterpolation/AMIInterpolation/AMIMethod/AMIMethod/AMIMethod.H index 06afc1a2803..0d01235be84 100644 --- a/src/meshTools/AMIInterpolation/AMIInterpolation/AMIMethod/AMIMethod/AMIMethod.H +++ b/src/meshTools/AMIInterpolation/AMIInterpolation/AMIMethod/AMIMethod/AMIMethod.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -69,7 +69,7 @@ private: protected: - //- local typedef to octree tree-type + //- Local typedef to octree tree-type typedef treeDataPrimitivePatch<TargetPatch> treeType; diff --git a/src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatch.H b/src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatch.H index 40cfc95e25a..5f22b735d90 100644 --- a/src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatch.H +++ b/src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPolyPatch/cyclicAMIPolyPatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -313,7 +313,7 @@ public: //- Axis of rotation for rotational cyclic AMI inline const vector& rotationAxis() const; - //- point on axis of rotation for rotational cyclic AMI + //- Point on axis of rotation for rotational cyclic AMI inline const point& rotationCentre() const; //- Translation vector for translational cyclic AMI diff --git a/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceInfo.H b/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceInfo.H index f02120d7d9a..5ac9f32c505 100644 --- a/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceInfo.H +++ b/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceInfo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -59,10 +59,10 @@ class patchEdgeFaceInfo { // Private data - //- position of nearest wall center + //- Position of nearest wall center point origin_; - //- normal distance (squared) from point to origin + //- Normal distance (squared) from point to origin scalar distSqr_; diff --git a/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceRegions.H b/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceRegions.H index a60a38ce457..5dd12902408 100644 --- a/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceRegions.H +++ b/src/meshTools/algorithms/PatchEdgeFaceWave/patchEdgeFaceRegions.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -59,7 +59,7 @@ class patchEdgeFaceRegions { // Private data - //- region per point + //- Region per point labelList regions_; public: diff --git a/src/meshTools/algorithms/PointEdgeWave/pointEdgePoint.H b/src/meshTools/algorithms/PointEdgeWave/pointEdgePoint.H index 5c323b0a3b1..c1704440a5d 100644 --- a/src/meshTools/algorithms/PointEdgeWave/pointEdgePoint.H +++ b/src/meshTools/algorithms/PointEdgeWave/pointEdgePoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,10 +61,10 @@ class pointEdgePoint { // Private data - //- position of nearest wall center + //- Position of nearest wall center point origin_; - //- normal distance (squared) from point to origin + //- Normal distance (squared) from point to origin scalar distSqr_; diff --git a/src/meshTools/cellDist/wallPoint/wallPoint.H b/src/meshTools/cellDist/wallPoint/wallPoint.H index 95cfdd41417..62643899095 100644 --- a/src/meshTools/cellDist/wallPoint/wallPoint.H +++ b/src/meshTools/cellDist/wallPoint/wallPoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -65,10 +65,10 @@ class wallPoint { // Private data - //- position of nearest wall center + //- Position of nearest wall center point origin_; - //- normal distance (squared) from cellcenter to origin + //- Normal distance (squared) from cellcenter to origin scalar distSqr_; diff --git a/src/meshTools/cellDist/wallPoint/wallPointData.H b/src/meshTools/cellDist/wallPoint/wallPointData.H index 0c40fde6504..c1463de2541 100644 --- a/src/meshTools/cellDist/wallPoint/wallPointData.H +++ b/src/meshTools/cellDist/wallPoint/wallPointData.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -65,7 +65,7 @@ class wallPointData { // Private data - //- data at nearest wall center + //- Data at nearest wall center Type data_; diff --git a/src/meshTools/cellFeatures/cellFeatures.H b/src/meshTools/cellFeatures/cellFeatures.H index 208bc4bbd33..b5d79ac52c7 100644 --- a/src/meshTools/cellFeatures/cellFeatures.H +++ b/src/meshTools/cellFeatures/cellFeatures.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -65,7 +65,7 @@ class cellFeatures const primitiveMesh& mesh_; - //- cos of angle between two connected faces or two connected edges on + //- Cos of angle between two connected faces or two connected edges on // same face before edge/point is 'feature'. scalar minCos_; diff --git a/src/meshTools/coordinateSystems/coordinateRotation/axesRotation.H b/src/meshTools/coordinateSystems/coordinateRotation/axesRotation.H index a0bc1b2c119..937f28c0419 100644 --- a/src/meshTools/coordinateSystems/coordinateRotation/axesRotation.H +++ b/src/meshTools/coordinateSystems/coordinateRotation/axesRotation.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -70,7 +70,7 @@ class axesRotation //- Global-to-Local transformation tensor tensor Rtr_; - //- the combination of local axes to be used + //- The combination of local axes to be used enum axisOrder { e1e2, @@ -210,7 +210,7 @@ public: // Member Operators - //- assign from dictionary + //- Assign from dictionary void operator=(const dictionary&); diff --git a/src/meshTools/coordinateSystems/coordinateSystems.H b/src/meshTools/coordinateSystems/coordinateSystems.H index c85cf48b45f..7ed818c1ab3 100644 --- a/src/meshTools/coordinateSystems/coordinateSystems.H +++ b/src/meshTools/coordinateSystems/coordinateSystems.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -132,7 +132,7 @@ public: //- Return the table of contents (list of all keywords) wordList toc() const; - //- write data + //- Write data bool writeData(Ostream&, bool subDict=true) const; }; diff --git a/src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H b/src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H index 37400bb0cf2..970c2d96c20 100644 --- a/src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H +++ b/src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -88,7 +88,7 @@ class edgeFaceCirculator { // Static data members - //- end iterator + //- End iterator static const edgeFaceCirculator endConstIter; @@ -187,13 +187,13 @@ public: //- Step to next face. Uses no edge addressing! inline edgeFaceCirculator& operator++(); - //- iterator set to the beginning face. For internal edges this is + //- Iterator set to the beginning face. For internal edges this is // the current face. For boundary edges this is the first boundary face // reached from walking back (i.e. in opposite direction to ++) inline edgeFaceCirculator begin() const; inline edgeFaceCirculator cbegin() const; - //- iterator set to beyond the end of the walk. + //- Iterator set to beyond the end of the walk. inline const edgeFaceCirculator& end() const; inline const edgeFaceCirculator& cend() const; }; diff --git a/src/meshTools/indexedOctree/treeDataEdge.H b/src/meshTools/indexedOctree/treeDataEdge.H index be82a2a09c5..d26c5f0cf47 100644 --- a/src/meshTools/indexedOctree/treeDataEdge.H +++ b/src/meshTools/indexedOctree/treeDataEdge.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class treeDataEdge { // Static data - //- tolerance on linear dimensions + //- Tolerance on linear dimensions static scalar tol; @@ -67,13 +67,13 @@ class treeDataEdge //- Reference to points const pointField& points_; - //- labels of edges + //- Labels of edges const labelList edgeLabels_; //- Whether to precalculate and store face bounding box const bool cacheBb_; - //- bbs for all above edges (valid only if cacheBb_) + //- Bbs for all above edges (valid only if cacheBb_) treeBoundBoxList bbs_; diff --git a/src/meshTools/indexedOctree/treeDataFace.H b/src/meshTools/indexedOctree/treeDataFace.H index 3867ba02062..44a735d8c59 100644 --- a/src/meshTools/indexedOctree/treeDataFace.H +++ b/src/meshTools/indexedOctree/treeDataFace.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -60,7 +60,7 @@ class treeDataFace { // Static data - //- tolerance on linear dimensions + //- Tolerance on linear dimensions static scalar tolSqr; @@ -78,7 +78,7 @@ class treeDataFace //- Whether to precalculate and store face bounding box const bool cacheBb_; - //- face bounding boxes (valid only if cacheBb_) + //- Face bounding boxes (valid only if cacheBb_) treeBoundBoxList bbs_; diff --git a/src/meshTools/indexedOctree/treeDataPrimitivePatch.H b/src/meshTools/indexedOctree/treeDataPrimitivePatch.H index 18c901244e5..08d5705a60b 100644 --- a/src/meshTools/indexedOctree/treeDataPrimitivePatch.H +++ b/src/meshTools/indexedOctree/treeDataPrimitivePatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -74,7 +74,7 @@ class treeDataPrimitivePatch //- Tolerance to use for intersection tests const scalar planarTol_; - //- face bounding boxes (valid only if cacheBb_) + //- Face bounding boxes (valid only if cacheBb_) treeBoundBoxList bbs_; diff --git a/src/meshTools/meshSearch/meshSearch.H b/src/meshTools/meshSearch/meshSearch.H index 637e3f3e139..c57c4375da0 100644 --- a/src/meshTools/meshSearch/meshSearch.H +++ b/src/meshTools/meshSearch/meshSearch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -65,10 +65,10 @@ class meshSearch //- Whether to use cell decomposition for all geometric tests const polyMesh::cellRepresentation cellDecompMode_; - //- data bounding box + //- Data bounding box mutable autoPtr<treeBoundBox> overallBbPtr_; - //- demand driven octrees + //- Demand driven octrees mutable autoPtr<indexedOctree<treeDataFace> > boundaryTreePtr_; mutable autoPtr<indexedOctree<treeDataCell> > cellTreePtr_; @@ -97,20 +97,20 @@ class meshSearch // Cells - //- nearest cell centre using octree + //- Nearest cell centre using octree label findNearestCellTree(const point&) const; - //- nearest cell centre going through all cells + //- Nearest cell centre going through all cells label findNearestCellLinear(const point&) const; - //- walk from seed. Does not 'go around' boundary, just returns + //- Walk from seed. Does not 'go around' boundary, just returns // last cell before boundary. label findNearestCellWalk(const point&, const label) const; - //- cell containing location. Linear search. + //- Cell containing location. Linear search. label findCellLinear(const point&) const; - //- walk from seed. Does not 'go around' boundary, just returns + //- Walk from seed. Does not 'go around' boundary, just returns // last cell before boundary. label findCellWalk(const point&, const label) const; @@ -127,7 +127,7 @@ class meshSearch // Boundary faces - //- walk from seed to find nearest boundary face. Gets stuck in + //- Walk from seed to find nearest boundary face. Gets stuck in // local minimum. label findNearestBoundaryFaceWalk ( @@ -160,7 +160,7 @@ public: // Static data members - //- tolerance on linear dimensions + //- Tolerance on linear dimensions static scalar tol_; @@ -271,7 +271,7 @@ public: bool isInside(const point&) const; - //- delete all storage + //- Delete all storage void clearOut(); //- Correct for mesh geom/topo changes diff --git a/src/meshTools/searchableSurface/searchableCylinder.H b/src/meshTools/searchableSurface/searchableCylinder.H index ccf6850dc1b..2ec3c6671ef 100644 --- a/src/meshTools/searchableSurface/searchableCylinder.H +++ b/src/meshTools/searchableSurface/searchableCylinder.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -63,10 +63,10 @@ private: //- 'right' point const point point2_; - //- length of vector point2-point1 + //- Length of vector point2-point1 const scalar magDir_; - //- normalised vector point2-point1 + //- Normalised vector point2-point1 const vector unitDir_; //- Radius squared diff --git a/src/meshTools/searchableSurface/searchableSurfaceCollection.H b/src/meshTools/searchableSurface/searchableSurfaceCollection.H index dd8a21664b9..7d9c6631211 100644 --- a/src/meshTools/searchableSurface/searchableSurfaceCollection.H +++ b/src/meshTools/searchableSurface/searchableSurfaceCollection.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -63,10 +63,10 @@ private: // Per instance data - //- instance name + //- Instance name wordList instance_; - //- scaling vector + //- Scaling vector vectorField scale_; //- transformation @@ -76,7 +76,7 @@ private: Switch mergeSubRegions_; - //- offsets for indices coming from different surfaces + //- Offsets for indices coming from different surfaces // (sized with size() of each surface) labelList indexOffset_; @@ -136,25 +136,25 @@ public: // Member Functions - //- scaling vector per subsurface + //- Scaling vector per subsurface const vectorField& scale() const { return scale_; } - //- scaling vector per subsurface + //- Scaling vector per subsurface vectorField& scale() { return scale_; } - //- coordinate system per subsurface + //- Coordinate system per subsurface const PtrList<coordinateSystem>& transform() const { return transform_; } - //- coordinate system per subsurface + //- Coordinate system per subsurface PtrList<coordinateSystem>& transform() { return transform_; diff --git a/src/meshTools/searchableSurface/searchableSurfaceWithGaps.H b/src/meshTools/searchableSurface/searchableSurfaceWithGaps.H index 1dfe6c8420d..0cd23e807a7 100644 --- a/src/meshTools/searchableSurface/searchableSurfaceWithGaps.H +++ b/src/meshTools/searchableSurface/searchableSurfaceWithGaps.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -65,7 +65,7 @@ private: // Private Member Data - //- gap size in metre + //- Gap size in metre const scalar gap_; //- Underlying geometry (size 1) diff --git a/src/meshTools/sets/cellSources/boxToCell/boxToCell.H b/src/meshTools/sets/cellSources/boxToCell/boxToCell.H index 488ceb934f1..1f100c77f9e 100644 --- a/src/meshTools/sets/cellSources/boxToCell/boxToCell.H +++ b/src/meshTools/sets/cellSources/boxToCell/boxToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -58,7 +58,7 @@ class boxToCell static addToUsageTable usage_; - //- bounding box. + //- Bounding box. treeBoundBoxList bbs_; diff --git a/src/meshTools/sets/cellSources/fieldToCell/fieldToCell.H b/src/meshTools/sets/cellSources/fieldToCell/fieldToCell.H index 0bc525aaa47..fb5a98d2a9b 100644 --- a/src/meshTools/sets/cellSources/fieldToCell/fieldToCell.H +++ b/src/meshTools/sets/cellSources/fieldToCell/fieldToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,10 +61,10 @@ class fieldToCell //- Name of volScalarField word fieldName_; - //- min to subset field values with + //- Min to subset field values with scalar min_; - //- max ,, + //- Max ,, scalar max_; diff --git a/src/meshTools/sets/cellSources/labelToCell/labelToCell.H b/src/meshTools/sets/cellSources/labelToCell/labelToCell.H index 1a6d942ef6e..2be415980c7 100644 --- a/src/meshTools/sets/cellSources/labelToCell/labelToCell.H +++ b/src/meshTools/sets/cellSources/labelToCell/labelToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,7 +56,7 @@ class labelToCell //- Add usage string static addToUsageTable usage_; - //- cell labels read from dictionary + //- Cell labels read from dictionary labelList labels_; diff --git a/src/meshTools/sets/cellSources/nearestToCell/nearestToCell.H b/src/meshTools/sets/cellSources/nearestToCell/nearestToCell.H index 229a3cd890a..0c6c664d7ff 100644 --- a/src/meshTools/sets/cellSources/nearestToCell/nearestToCell.H +++ b/src/meshTools/sets/cellSources/nearestToCell/nearestToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,7 +56,7 @@ class nearestToCell //- Add usage string static addToUsageTable usage_; - //- points to select nearest to + //- Points to select nearest to pointField points_; diff --git a/src/meshTools/sets/cellSources/rotatedBoxToCell/rotatedBoxToCell.H b/src/meshTools/sets/cellSources/rotatedBoxToCell/rotatedBoxToCell.H index d5a6eee6dfb..169b894a011 100644 --- a/src/meshTools/sets/cellSources/rotatedBoxToCell/rotatedBoxToCell.H +++ b/src/meshTools/sets/cellSources/rotatedBoxToCell/rotatedBoxToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -69,7 +69,7 @@ class rotatedBoxToCell static addToUsageTable usage_; - //- skewed box + //- Skewed box const vector origin_; const vector i_; const vector j_; diff --git a/src/meshTools/sets/cellSources/shapeToCell/shapeToCell.H b/src/meshTools/sets/cellSources/shapeToCell/shapeToCell.H index 5b7f18ac598..aa843c1b6fc 100644 --- a/src/meshTools/sets/cellSources/shapeToCell/shapeToCell.H +++ b/src/meshTools/sets/cellSources/shapeToCell/shapeToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -76,7 +76,7 @@ public: // Static data - //- cos of feature angle for polyHedral to be splitHex + //- Cos of feature angle for polyHedral to be splitHex static scalar featureCos; // Constructors diff --git a/src/meshTools/sets/cellSources/surfaceToCell/surfaceToCell.H b/src/meshTools/sets/cellSources/surfaceToCell/surfaceToCell.H index 931f412a2a3..0d46db0504e 100644 --- a/src/meshTools/sets/cellSources/surfaceToCell/surfaceToCell.H +++ b/src/meshTools/sets/cellSources/surfaceToCell/surfaceToCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -87,21 +87,21 @@ class surfaceToCell // (does not allow includeCut) const bool useSurfaceOrientation_; - //- if > 0 : include cells with distance from cellCentre to surface + //- If > 0 : include cells with distance from cellCentre to surface // less than nearDist. const scalar nearDist_; - //- if > -1 : include cells with normals at nearest surface points + //- If > -1 : include cells with normals at nearest surface points // varying more than curvature_. const scalar curvature_; //- triSurface to search on. On pointer since can be external. const triSurface* surfPtr_; - //- search engine on surface. + //- Search engine on surface. const triSurfaceSearch* querySurfPtr_; - //- whether I allocated above surface ptrs or whether they are + //- Whether I allocated above surface ptrs or whether they are // external. const bool IOwnPtrs_; diff --git a/src/meshTools/sets/faceSources/boxToFace/boxToFace.H b/src/meshTools/sets/faceSources/boxToFace/boxToFace.H index 056dbac1187..f3b4d4707d4 100644 --- a/src/meshTools/sets/faceSources/boxToFace/boxToFace.H +++ b/src/meshTools/sets/faceSources/boxToFace/boxToFace.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,7 +57,7 @@ class boxToFace //- Add usage string static addToUsageTable usage_; - //- bounding box. + //- Bounding box. treeBoundBoxList bbs_; diff --git a/src/meshTools/sets/faceSources/labelToFace/labelToFace.H b/src/meshTools/sets/faceSources/labelToFace/labelToFace.H index 2384147eae0..e66ef132f2c 100644 --- a/src/meshTools/sets/faceSources/labelToFace/labelToFace.H +++ b/src/meshTools/sets/faceSources/labelToFace/labelToFace.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,7 +56,7 @@ class labelToFace //- Add usage string static addToUsageTable usage_; - //- cell labels read from dictionary + //- Cell labels read from dictionary labelList labels_; diff --git a/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H b/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H index e5f5cfc5599..121b22017c0 100644 --- a/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H +++ b/src/meshTools/sets/pointSources/boxToPoint/boxToPoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,7 +57,7 @@ class boxToPoint //- Add usage string static addToUsageTable usage_; - //- bounding box. + //- Bounding box. treeBoundBoxList bbs_; diff --git a/src/meshTools/sets/pointSources/labelToPoint/labelToPoint.H b/src/meshTools/sets/pointSources/labelToPoint/labelToPoint.H index 39b627564e5..5604862f9db 100644 --- a/src/meshTools/sets/pointSources/labelToPoint/labelToPoint.H +++ b/src/meshTools/sets/pointSources/labelToPoint/labelToPoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,7 +56,7 @@ class labelToPoint //- Add usage string static addToUsageTable usage_; - //- point labels read from dictionary + //- Point labels read from dictionary labelList labels_; diff --git a/src/meshTools/sets/pointSources/nearestToPoint/nearestToPoint.H b/src/meshTools/sets/pointSources/nearestToPoint/nearestToPoint.H index 849e2b6bb2b..ede08013b02 100644 --- a/src/meshTools/sets/pointSources/nearestToPoint/nearestToPoint.H +++ b/src/meshTools/sets/pointSources/nearestToPoint/nearestToPoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,7 +56,7 @@ class nearestToPoint //- Add usage string static addToUsageTable usage_; - //- points to select nearest to + //- Points to select nearest to pointField points_; diff --git a/src/meshTools/sets/pointSources/surfaceToPoint/surfaceToPoint.H b/src/meshTools/sets/pointSources/surfaceToPoint/surfaceToPoint.H index 8249e8c2ed7..a64138b481a 100644 --- a/src/meshTools/sets/pointSources/surfaceToPoint/surfaceToPoint.H +++ b/src/meshTools/sets/pointSources/surfaceToPoint/surfaceToPoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,13 +67,13 @@ class surfaceToPoint //- Name of surface file fileName surfName_; - //- if > 0 : include points with distance to surface less than nearDist. + //- If > 0 : include points with distance to surface less than nearDist. scalar nearDist_; - //- include all points on opposite sign of normal on nearest surface. + //- Include all points on opposite sign of normal on nearest surface. bool includeInside_; - //- include all points on this sign of normal on nearest surface. + //- Include all points on this sign of normal on nearest surface. bool includeOutside_; diff --git a/src/meshTools/triSurface/booleanOps/booleanSurface/booleanSurface.H b/src/meshTools/triSurface/booleanOps/booleanSurface/booleanSurface.H index ebeca9245b6..4cb538f5cdc 100644 --- a/src/meshTools/triSurface/booleanOps/booleanSurface/booleanSurface.H +++ b/src/meshTools/triSurface/booleanOps/booleanSurface/booleanSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -202,7 +202,7 @@ public: // Member Functions - //- new to old face map. >0: surface 1 face label. <0: surface 2. Negate + //- New to old face map. >0: surface 1 face label. <0: surface 2. Negate // and subtract 1 to get face label on surface 2. const labelList& faceMap() const { diff --git a/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H b/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H index dc2469223d4..3916f352d89 100644 --- a/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H +++ b/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -186,7 +186,7 @@ public: return faceEdges_; } - //- point to edge addressing + //- Point to edge addressing const labelListList& pointEdges() const { return pointEdges_; diff --git a/src/meshTools/triSurface/booleanOps/surfaceIntersection/edgeIntersections.H b/src/meshTools/triSurface/booleanOps/surfaceIntersection/edgeIntersections.H index 4a283b822c3..d1822151f6e 100644 --- a/src/meshTools/triSurface/booleanOps/surfaceIntersection/edgeIntersections.H +++ b/src/meshTools/triSurface/booleanOps/surfaceIntersection/edgeIntersections.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -138,7 +138,7 @@ public: // Static data members - //- cosine between edge and face normal when considered parallel + //- Cosine between edge and face normal when considered parallel // (note: should be private and make access- and set- function) static scalar alignedCos_; diff --git a/src/meshTools/triSurface/surfaceFeatures/surfaceFeatures.H b/src/meshTools/triSurface/surfaceFeatures/surfaceFeatures.H index 24134316606..72d893a779d 100644 --- a/src/meshTools/triSurface/surfaceFeatures/surfaceFeatures.H +++ b/src/meshTools/triSurface/surfaceFeatures/surfaceFeatures.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -81,7 +81,7 @@ public: private: - //- label and scalar; used in path walking + //- Label and scalar; used in path walking class labelScalar { public: @@ -242,13 +242,13 @@ public: return featureEdges_; } - //- start of external edges + //- Start of external edges inline label externalStart() const { return externalStart_; } - //- start of internal edges + //- Start of internal edges inline label internalStart() const { return internalStart_; diff --git a/src/meshTools/triSurface/triSurfaceTools/triSurfaceTools.H b/src/meshTools/triSurface/triSurfaceTools/triSurfaceTools.H index ede548fd834..82a808b1d7f 100644 --- a/src/meshTools/triSurface/triSurfaceTools/triSurfaceTools.H +++ b/src/meshTools/triSurface/triSurfaceTools/triSurfaceTools.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -110,7 +110,7 @@ class triSurfaceTools labelList& faceStatus ); - //- faces to collapse because of edge collapse + //- Faces to collapse because of edge collapse static labelHashSet getCollapsedFaces ( const triSurface& surf, @@ -433,7 +433,7 @@ public: const point& nearestPt ); - //- on which side of surface + //- On which side of surface enum sideType { UNKNOWN, // cannot be determined (e.g. non-manifold) @@ -441,7 +441,7 @@ public: OUTSIDE // outside }; - //- if nearest point is on edgeI, determine on which side of surface + //- If nearest point is on edgeI, determine on which side of surface // sample is. static sideType edgeSide ( diff --git a/src/parallel/decompose/decompositionMethods/hierarchGeomDecomp/hierarchGeomDecomp.H b/src/parallel/decompose/decompositionMethods/hierarchGeomDecomp/hierarchGeomDecomp.H index 86bcc8716de..2df6080f5b5 100644 --- a/src/parallel/decompose/decompositionMethods/hierarchGeomDecomp/hierarchGeomDecomp.H +++ b/src/parallel/decompose/decompositionMethods/hierarchGeomDecomp/hierarchGeomDecomp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -142,7 +142,7 @@ class hierarchGeomDecomp ); //- Recursively sort in x,y,z (or rather acc. to decompOrder_) - //- using weighted points. + //- Using weighted points. void sortComponent ( const label sizeTol, @@ -178,7 +178,7 @@ public: // Member Functions - //- hierarchgeom is aware of processor boundaries + //- Hierarchgeom is aware of processor boundaries virtual bool parallelAware() const { return true; diff --git a/src/parallel/decompose/decompositionMethods/manualDecomp/manualDecomp.H b/src/parallel/decompose/decompositionMethods/manualDecomp/manualDecomp.H index cd2ba9b4302..fe51798096d 100644 --- a/src/parallel/decompose/decompositionMethods/manualDecomp/manualDecomp.H +++ b/src/parallel/decompose/decompositionMethods/manualDecomp/manualDecomp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -78,7 +78,7 @@ public: // Member Functions - //- manual decompose does not care about proc boundaries - is all + //- Manual decompose does not care about proc boundaries - is all // up to the user. virtual bool parallelAware() const { diff --git a/src/parallel/decompose/decompositionMethods/noDecomp/noDecomp.H b/src/parallel/decompose/decompositionMethods/noDecomp/noDecomp.H index 154838d35c6..5c3459f16fa 100644 --- a/src/parallel/decompose/decompositionMethods/noDecomp/noDecomp.H +++ b/src/parallel/decompose/decompositionMethods/noDecomp/noDecomp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -74,7 +74,7 @@ public: // Member Functions - //- manual decompose does not care about proc boundaries - is all + //- Manual decompose does not care about proc boundaries - is all // up to the user. virtual bool parallelAware() const { diff --git a/src/parallel/decompose/scotchDecomp/scotchDecomp.C b/src/parallel/decompose/scotchDecomp/scotchDecomp.C index d24da8ccade..464d12b28fa 100644 --- a/src/parallel/decompose/scotchDecomp/scotchDecomp.C +++ b/src/parallel/decompose/scotchDecomp/scotchDecomp.C @@ -497,7 +497,7 @@ Foam::label Foam::scotchDecomp::decomposeOneProc // "SCOTCH_archVcmplt" //); // - ////- stategy flags: go for quality or load balance (or leave default) + ////- Stategy flags: go for quality or load balance (or leave default) //SCOTCH_Num straval = 0; ////straval |= SCOTCH_STRATQUALITY; ////straval |= SCOTCH_STRATQUALITY; diff --git a/src/parallel/distributed/distributedTriSurfaceMesh/distributedTriSurfaceMesh.H b/src/parallel/distributed/distributedTriSurfaceMesh/distributedTriSurfaceMesh.H index 7e4d27ef0c6..30c559f5172 100644 --- a/src/parallel/distributed/distributedTriSurfaceMesh/distributedTriSurfaceMesh.H +++ b/src/parallel/distributed/distributedTriSurfaceMesh/distributedTriSurfaceMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -101,7 +101,7 @@ private: //- Bounding box settings IOdictionary dict_; - //- bounding boxes of all processors + //- Bounding boxes of all processors List<List<treeBoundBox> > procBb_; //- Global triangle numbering diff --git a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H index 9589304cf31..a60e6f0ead0 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H +++ b/src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -273,7 +273,7 @@ protected: // If operating on sampledSurface - //- underlying sampledSurface + //- Underlying sampledSurface autoPtr<sampledSurface> surfacePtr_; diff --git a/src/postProcessing/functionObjects/field/nearWallFields/findCellParticle.H b/src/postProcessing/functionObjects/field/nearWallFields/findCellParticle.H index 82a430778a2..b3e7b4f90d9 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/findCellParticle.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/findCellParticle.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,10 +55,10 @@ class findCellParticle { // Private data - //- end point to track to + //- End point to track to point end_; - //- passive data + //- Passive data label data_; @@ -158,13 +158,13 @@ public: // Member Functions - //- point to track to + //- Point to track to const point& end() const { return end_; } - //- transported label + //- Transported label label data() const { return data_; diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.C b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.C index 30920a13b5d..6a081fd49f4 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.C +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -36,7 +36,7 @@ namespace Foam { defineTypeNameAndDebug(regionSizeDistribution, 0); - //- plus op for FixedList<scalar> + //- Plus op for FixedList<scalar> template<class T, unsigned Size> class ListPlusEqOp { diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLineParticle.H b/src/postProcessing/functionObjects/field/streamLine/streamLineParticle.H index 2d8e728662a..ca939f96a6f 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLineParticle.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLineParticle.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -119,13 +119,13 @@ private: //- Lifetime of particle. Particle dies when reaches 0. label lifeTime_; - //- sampled positions + //- Sampled positions DynamicList<point> sampledPositions_; - //- sampled scalars + //- Sampled scalars List<DynamicList<scalar> > sampledScalars_; - //- sampled vectors + //- Sampled vectors List<DynamicList<vector> > sampledVectors_; diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticle.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticle.H index 54e6a4760ad..2a8d2f35916 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticle.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLineParticle.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -128,13 +128,13 @@ private: //- Lifetime of particle. Particle dies when reaches 0. label lifeTime_; - //- sampled positions + //- Sampled positions DynamicList<point> sampledPositions_; - //- sampled scalars + //- Sampled scalars List<DynamicList<scalar> > sampledScalars_; - //- sampled vectors + //- Sampled vectors List<DynamicList<vector> > sampledVectors_; diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 7b3f8f57e3f..ae07bb0340e 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -118,10 +118,10 @@ protected: // Protected Member Functions - //- get the loaded dynamic libraries + //- Get the loaded dynamic libraries virtual dlLibraryTable& libs() const; - //- adapt the context for the current object + //- Adapt the context for the current object virtual void prepare(dynamicCode &,const dynamicCodeContext&) const; // Return a description (type + name) for the output diff --git a/src/sampling/cuttingPlane/cuttingPlane.H b/src/sampling/cuttingPlane/cuttingPlane.H index d4f2ebe4bb5..8bb9889262e 100644 --- a/src/sampling/cuttingPlane/cuttingPlane.H +++ b/src/sampling/cuttingPlane/cuttingPlane.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -120,7 +120,7 @@ protected: // Protected Member Functions - //- recut mesh with existing planeDesc, restricted to a list of cells + //- Recut mesh with existing planeDesc, restricted to a list of cells void reCut ( const primitiveMesh&, @@ -128,7 +128,7 @@ protected: const labelUList& cellIdLabels = labelUList::null() ); - //- remap action on triangulation or cleanup + //- Remap action on triangulation or cleanup virtual void remapFaces(const labelUList& faceMap); diff --git a/src/sampling/probes/probesTemplates.C b/src/sampling/probes/probesTemplates.C index 4c2e7379461..6e358f97956 100644 --- a/src/sampling/probes/probesTemplates.C +++ b/src/sampling/probes/probesTemplates.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -34,7 +34,7 @@ License namespace Foam { -//- comparison operator for probes class +//- Comparison operator for probes class template<class T> class isNotEqOp { diff --git a/src/sampling/sampledSet/polyLine/polyLineSet.H b/src/sampling/sampledSet/polyLine/polyLineSet.H index 0c1339ee727..3dc880246a8 100644 --- a/src/sampling/sampledSet/polyLine/polyLineSet.H +++ b/src/sampling/sampledSet/polyLine/polyLineSet.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ class polyLineSet { // Private data - //- sampling points + //- Sampling points List<point> sampleCoords_; diff --git a/src/sampling/sampledSet/sampledSets/sampledSets.H b/src/sampling/sampledSet/sampledSets/sampledSets.H index 54744bbbf85..430039a2cea 100644 --- a/src/sampling/sampledSet/sampledSets/sampledSets.H +++ b/src/sampling/sampledSet/sampledSets/sampledSets.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -147,7 +147,7 @@ class sampledSets // Static data members - //- output verbosity + //- Output verbosity static bool verbose_; @@ -279,7 +279,7 @@ public: return name_; } - //- set verbosity level + //- Set verbosity level void verbose(const bool verbosity = true); //- Execute, currently does nothing diff --git a/src/sampling/sampledSurface/distanceSurface/distanceSurface.H b/src/sampling/sampledSurface/distanceSurface/distanceSurface.H index da4b8d775e7..73cd555e05e 100644 --- a/src/sampling/sampledSurface/distanceSurface/distanceSurface.H +++ b/src/sampling/sampledSurface/distanceSurface/distanceSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -60,10 +60,10 @@ class distanceSurface //- Surface const autoPtr<searchableSurface> surfPtr_; - //- distance value + //- Distance value const scalar distance_; - //- signed distance + //- Signed distance const bool signed_; //- Whether to use isoSurfaceCell or isoSurface @@ -94,7 +94,7 @@ class distanceSurface //- Constructed iso surface autoPtr<isoSurface> isoSurfPtr_; - //- triangles converted to faceList + //- Triangles converted to faceList mutable autoPtr<faceList> facesPtr_; @@ -103,7 +103,7 @@ class distanceSurface //- Create iso surface void createGeometry(); - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -201,62 +201,62 @@ public: } } - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample ( const volScalarField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample ( const volVectorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample ( const volSymmTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sampling/sampledSurface/isoSurface/sampledIsoSurface.H b/src/sampling/sampledSurface/isoSurface/sampledIsoSurface.H index 11b7ea025c6..8cfd14c3c15 100644 --- a/src/sampling/sampledSurface/isoSurface/sampledIsoSurface.H +++ b/src/sampling/sampledSurface/isoSurface/sampledIsoSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -60,7 +60,7 @@ class sampledIsoSurface //- Field to get isoSurface of const word isoField_; - //- iso value + //- Iso value const scalar isoVal_; //- Merge tolerance @@ -72,15 +72,15 @@ class sampledIsoSurface //- Whether to recalculate cell values as average of point values const Switch average_; - //- zone name/index (if restricted to zones) + //- Zone name/index (if restricted to zones) mutable cellZoneID zoneID_; - //- for zones: patch to put exposed faces into + //- For zones: patch to put exposed faces into mutable word exposedPatchName_; mutable autoPtr<isoSurface> surfPtr_; - //- triangles converted to faceList + //- Triangles converted to faceList mutable autoPtr<faceList> facesPtr_; @@ -121,7 +121,7 @@ class sampledIsoSurface // Do nothing (and return false) if no update was needed bool updateGeometry() const; - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -203,62 +203,62 @@ public: void getIsoField(); - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample ( const volScalarField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample ( const volVectorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample ( const volSymmTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.H b/src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.H index ecd6d30e392..7021bf0b97e 100644 --- a/src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.H +++ b/src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -59,7 +59,7 @@ class sampledIsoSurfaceCell //- Field to get isoSurface of const word isoField_; - //- iso value + //- Iso value const scalar isoVal_; //- Whether to coarse @@ -71,7 +71,7 @@ class sampledIsoSurfaceCell //- If restricted to zones, name of this zone or a regular expression keyType zoneKey_; - //- triangles converted to faceList + //- Triangles converted to faceList mutable autoPtr<faceList> facesPtr_; @@ -90,7 +90,7 @@ class sampledIsoSurfaceCell // Do nothing (and return false) if no update was needed bool updateGeometry() const; - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -163,62 +163,62 @@ public: } - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample ( const volScalarField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample ( const volVectorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample ( const volSymmTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.H b/src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.H index ce7182f91c4..a8aa477407f 100644 --- a/src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.H +++ b/src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -69,10 +69,10 @@ class sampledCuttingPlane //- Whether to recalculate cell values as average of point values const Switch average_; - //- zone name/index (if restricted to zones) + //- Zone name/index (if restricted to zones) mutable cellZoneID zoneID_; - //- for zones: patch to put exposed faces into + //- For zones: patch to put exposed faces into mutable word exposedPatchName_; //- Track if the surface needs an update @@ -92,7 +92,7 @@ class sampledCuttingPlane //autoPtr<isoSurfaceCell> isoSurfPtr_; autoPtr<isoSurface> isoSurfPtr_; - //- triangles converted to faceList + //- Triangles converted to faceList mutable autoPtr<faceList> facesPtr_; @@ -101,7 +101,7 @@ class sampledCuttingPlane //- Create iso surface void createGeometry(); - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -179,62 +179,62 @@ public: return isoSurfPtr_(); } - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample ( const volScalarField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample ( const volVectorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample ( const volSymmTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalField.H b/src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalField.H index 05a7ea61a9c..8a423c60e8b 100644 --- a/src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalField.H +++ b/src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -64,7 +64,7 @@ class sampledPatchInternalField // Private Member Functions - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( diff --git a/src/sampling/sampledSurface/sampledPlane/sampledPlane.H b/src/sampling/sampledSurface/sampledPlane/sampledPlane.H index 3b24a09e529..4add35f3f6b 100644 --- a/src/sampling/sampledSurface/sampledPlane/sampledPlane.H +++ b/src/sampling/sampledSurface/sampledPlane/sampledPlane.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -68,7 +68,7 @@ class sampledPlane // Private Member Functions - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -145,64 +145,64 @@ public: return cuttingPlane::cutCells(); } - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample ( const volScalarField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample ( const volVectorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample ( const volSymmTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H index 2659af8f517..bddee49ef91 100644 --- a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H +++ b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -253,7 +253,7 @@ public: return name_; } - //- interpolation requested for surface + //- Interpolation requested for surface bool interpolate() const { return interpolate_; diff --git a/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H b/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H index 3390c003487..5957d1398d7 100644 --- a/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H +++ b/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -83,7 +83,7 @@ class sampledSurfaces // Static data members - //- output verbosity + //- Output verbosity static bool verbose_; //- Tolerance for merging points (fraction of mesh bounding box) @@ -102,7 +102,7 @@ class sampledSurfaces //- Load fields from files (not from objectRegistry) const bool loadFromFiles_; - //- output path + //- Output path fileName outputPath_; @@ -212,7 +212,7 @@ public: return name_; } - //- set verbosity level + //- Set verbosity level void verbose(const bool verbosity = true); //- Execute, currently does nothing diff --git a/src/sampling/sampledSurface/sampledTriSurfaceMesh/sampledTriSurfaceMesh.H b/src/sampling/sampledSurface/sampledTriSurfaceMesh/sampledTriSurfaceMesh.H index 1e7cd4e6ed3..973beb2acbc 100644 --- a/src/sampling/sampledSurface/sampledTriSurfaceMesh/sampledTriSurfaceMesh.H +++ b/src/sampling/sampledSurface/sampledTriSurfaceMesh/sampledTriSurfaceMesh.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -132,7 +132,7 @@ private: //- Get tree of all non-coupled boundary faces const indexedOctree<treeDataFace>& nonCoupledboundaryTree() const; - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -217,63 +217,63 @@ public: } - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample ( const volScalarField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample ( const volVectorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample ( const volSymmTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sampling/sampledSurface/thresholdCellFaces/sampledThresholdCellFaces.H b/src/sampling/sampledSurface/thresholdCellFaces/sampledThresholdCellFaces.H index 13ef2a3e51f..f3758a62390 100644 --- a/src/sampling/sampledSurface/thresholdCellFaces/sampledThresholdCellFaces.H +++ b/src/sampling/sampledSurface/thresholdCellFaces/sampledThresholdCellFaces.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -88,7 +88,7 @@ class sampledThresholdCellFaces // Do nothing (and return false) if no update was needed bool updateGeometry() const; - //- sample field on faces + //- Sample field on faces template<class Type> tmp<Field<Type> > sampleField ( @@ -148,52 +148,52 @@ public: return MeshStorage::faces(); } - //- sample field on surface + //- Sample field on surface virtual tmp<scalarField> sample(const volScalarField&) const; - //- sample field on surface + //- Sample field on surface virtual tmp<vectorField> sample( const volVectorField&) const; - //- sample field on surface + //- Sample field on surface virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField& ) const; - //- sample field on surface + //- Sample field on surface virtual tmp<symmTensorField> sample(const volSymmTensorField&) const; - //- sample field on surface + //- Sample field on surface virtual tmp<tensorField> sample ( const volTensorField& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<scalarField> interpolate ( const interpolation<scalar>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<vectorField> interpolate ( const interpolation<vector>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<sphericalTensorField> interpolate ( const interpolation<sphericalTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<symmTensorField> interpolate ( const interpolation<symmTensor>& ) const; - //- interpolate field on surface + //- Interpolate field on surface virtual tmp<tensorField> interpolate ( const interpolation<tensor>& diff --git a/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/externalPointEdgePoint.H b/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/externalPointEdgePoint.H index 70a66b4ba2d..85871fc5bfc 100644 --- a/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/externalPointEdgePoint.H +++ b/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/externalPointEdgePoint.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,10 +57,10 @@ class externalPointEdgePoint { // Private data - //- position of nearest wall center + //- Position of nearest wall center point origin_; - //- normal distance (squared) from point to origin + //- Normal distance (squared) from point to origin scalar distSqr_; diff --git a/src/surfMesh/MeshedSurface/MeshedSurface.H b/src/surfMesh/MeshedSurface/MeshedSurface.H index 9f2ccebba53..00e25f46e87 100644 --- a/src/surfMesh/MeshedSurface/MeshedSurface.H +++ b/src/surfMesh/MeshedSurface/MeshedSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -121,7 +121,7 @@ protected: //- Transfer points/zones and transcribe face -> triFace void transcribe(MeshedSurface<face>&); - //- basic sanity check on zones + //- Basic sanity check on zones void checkZones(); //- Non-const access to global points @@ -142,7 +142,7 @@ protected: return zones_; } - //- sort faces by zones and store sorted faces + //- Sort faces by zones and store sorted faces void sortFacesAndStore ( const Xfer<List<Face> >& unsortedFaces, diff --git a/src/surfMesh/surfZone/surfZone/surfZone.H b/src/surfMesh/surfZone/surfZone/surfZone.H index 4b620911adb..1f670ee037d 100644 --- a/src/surfMesh/surfZone/surfZone/surfZone.H +++ b/src/surfMesh/surfZone/surfZone/surfZone.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -66,7 +66,7 @@ class surfZone { // Private data - //- size of this group in the face list + //- Size of this group in the face list label size_; //- Start label of this group in the face list diff --git a/src/surfMesh/surfaceFormats/ftr/FTRsurfaceFormat.H b/src/surfMesh/surfaceFormats/ftr/FTRsurfaceFormat.H index e3ddd5788c3..a2829ecc0dc 100644 --- a/src/surfMesh/surfaceFormats/ftr/FTRsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/ftr/FTRsurfaceFormat.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,7 +61,7 @@ class FTRsurfaceFormat { // Private classes - //- read compatibility for ftr patch definitions + //- Read compatibility for ftr patch definitions class ftrPatch { //- Name of patch diff --git a/src/thermophysicalModels/barotropicCompressibilityModel/Chung/Chung.H b/src/thermophysicalModels/barotropicCompressibilityModel/Chung/Chung.H index fd492e14ed3..943ac0a1c54 100644 --- a/src/thermophysicalModels/barotropicCompressibilityModel/Chung/Chung.H +++ b/src/thermophysicalModels/barotropicCompressibilityModel/Chung/Chung.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -70,7 +70,7 @@ public: // Constructors - //- construct from components + //- Construct from components Chung ( const dictionary& compressibilityProperties, diff --git a/src/thermophysicalModels/barotropicCompressibilityModel/Wallis/Wallis.H b/src/thermophysicalModels/barotropicCompressibilityModel/Wallis/Wallis.H index 0519bc3cf19..95c53be92f8 100644 --- a/src/thermophysicalModels/barotropicCompressibilityModel/Wallis/Wallis.H +++ b/src/thermophysicalModels/barotropicCompressibilityModel/Wallis/Wallis.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -70,7 +70,7 @@ public: // Constructors - //- construct from components + //- Construct from components Wallis ( const dictionary& compressibilityProperties, diff --git a/src/thermophysicalModels/barotropicCompressibilityModel/linear/linear.H b/src/thermophysicalModels/barotropicCompressibilityModel/linear/linear.H index 4956c612d8f..d71d4b8236f 100644 --- a/src/thermophysicalModels/barotropicCompressibilityModel/linear/linear.H +++ b/src/thermophysicalModels/barotropicCompressibilityModel/linear/linear.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -67,7 +67,7 @@ public: // Constructors - //- construct from components + //- Construct from components linear ( const dictionary& compressibilityProperties, diff --git a/src/thermophysicalModels/basic/basicThermo/basicThermo.H b/src/thermophysicalModels/basic/basicThermo/basicThermo.H index 8ba800e6612..9d4fc585196 100644 --- a/src/thermophysicalModels/basic/basicThermo/basicThermo.H +++ b/src/thermophysicalModels/basic/basicThermo/basicThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -354,10 +354,10 @@ public: const label patchi ) const = 0; - //- gamma = Cp/Cv [] + //- Gamma = Cp/Cv [] virtual tmp<volScalarField> gamma() const = 0; - //- gamma = Cp/Cv for patch [] + //- Gamma = Cp/Cv for patch [] virtual tmp<scalarField> gamma ( const scalarField& p, diff --git a/src/thermophysicalModels/basic/heThermo/heThermo.H b/src/thermophysicalModels/basic/heThermo/heThermo.H index a07a7ecfeb3..9858f16a31f 100644 --- a/src/thermophysicalModels/basic/heThermo/heThermo.H +++ b/src/thermophysicalModels/basic/heThermo/heThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -220,10 +220,10 @@ public: //- Heat capacity at constant volume [J/kg/K] virtual tmp<volScalarField> Cv() const; - //- gamma = Cp/Cv [] + //- Gamma = Cp/Cv [] virtual tmp<volScalarField> gamma() const; - //- gamma = Cp/Cv for patch [] + //- Gamma = Cp/Cv for patch [] virtual tmp<scalarField> gamma ( const scalarField& p, diff --git a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H index ad1c50abd85..1f5aa7acc8c 100644 --- a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H +++ b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -77,7 +77,7 @@ public: gas }; - //- species element + //- Species element struct specieElement { word elementName; diff --git a/src/thermophysicalModels/specie/thermo/hExponential/hExponentialThermo.H b/src/thermophysicalModels/specie/thermo/hExponential/hExponentialThermo.H index 05ee681ea6b..b9fd88b232c 100644 --- a/src/thermophysicalModels/specie/thermo/hExponential/hExponentialThermo.H +++ b/src/thermophysicalModels/specie/thermo/hExponential/hExponentialThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -172,7 +172,7 @@ public: //- Sensible enthalpy [J/kg] inline scalar hs(const scalar p, const scalar T) const; - //- chemical enthalpy [J/kg] + //- Chemical enthalpy [J/kg] inline scalar hc() const; //- Entropy [J/(kmol K)] diff --git a/src/thermophysicalModels/specie/thermo/thermo/thermo.H b/src/thermophysicalModels/specie/thermo/thermo/thermo.H index b8e73cf2c74..53336e0479b 100644 --- a/src/thermophysicalModels/specie/thermo/thermo/thermo.H +++ b/src/thermophysicalModels/specie/thermo/thermo/thermo.H @@ -131,7 +131,7 @@ public: // Constructors - //- construct from components + //- Construct from components inline thermo(const Thermo& sp); //- Construct from Istream @@ -190,7 +190,7 @@ public: //- Heat capacity at constant pressure/volume [J/(kmol K)] inline scalar cpv(const scalar p, const scalar T) const; - //- gamma = cp/cv [] + //- Gamma = cp/cv [] inline scalar gamma(const scalar p, const scalar T) const; //- Ratio of heat capacity at constant pressure to that at diff --git a/src/transportModels/incompressible/viscosityModels/BirdCarreau/BirdCarreau.H b/src/transportModels/incompressible/viscosityModels/BirdCarreau/BirdCarreau.H index e8d489a4f04..a036f10b8f0 100644 --- a/src/transportModels/incompressible/viscosityModels/BirdCarreau/BirdCarreau.H +++ b/src/transportModels/incompressible/viscosityModels/BirdCarreau/BirdCarreau.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -84,7 +84,7 @@ public: // Constructors - //- construct from components + //- Construct from components BirdCarreau ( const word& name, diff --git a/src/transportModels/incompressible/viscosityModels/Newtonian/Newtonian.H b/src/transportModels/incompressible/viscosityModels/Newtonian/Newtonian.H index 57057e11ab5..d4758756da5 100644 --- a/src/transportModels/incompressible/viscosityModels/Newtonian/Newtonian.H +++ b/src/transportModels/incompressible/viscosityModels/Newtonian/Newtonian.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -69,7 +69,7 @@ public: // Constructors - //- construct from components + //- Construct from components Newtonian ( const word& name, diff --git a/src/triSurface/meshTriangulation/meshTriangulation.H b/src/triSurface/meshTriangulation/meshTriangulation.H index 2b85c2cf048..047ef6480f6 100644 --- a/src/triSurface/meshTriangulation/meshTriangulation.H +++ b/src/triSurface/meshTriangulation/meshTriangulation.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -77,7 +77,7 @@ class meshTriangulation const label faceI ); - //- find boundary faces of subset. + //- Find boundary faces of subset. static void getFaces ( const primitiveMesh&, @@ -127,13 +127,13 @@ public: // Member Functions - //- number of triangles in *this which are internal to the surface + //- Number of triangles in *this which are internal to the surface label nInternalFaces() const { return nInternalFaces_; } - //- from triangle to mesh face + //- From triangle to mesh face const labelList& faceMap() const { return faceMap_; diff --git a/src/triSurface/tools/labelledTri/sortLabelledTri.H b/src/triSurface/tools/labelledTri/sortLabelledTri.H index e184032e286..67ae6ee965b 100644 --- a/src/triSurface/tools/labelledTri/sortLabelledTri.H +++ b/src/triSurface/tools/labelledTri/sortLabelledTri.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -60,7 +60,7 @@ class surfAndLabel // Private Classes - //- scalar comparison function used for sorting + //- Scalar comparison function used for sorting class less { public: diff --git a/src/triSurface/triSurface/surfacePatch/surfacePatch.H b/src/triSurface/triSurface/surfacePatch/surfacePatch.H index c2e94464c44..03f8916d959 100644 --- a/src/triSurface/triSurface/surfacePatch/surfacePatch.H +++ b/src/triSurface/triSurface/surfacePatch/surfacePatch.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,7 +55,7 @@ class surfacePatch { // Private data - //- size of this patch in the triSurface face list + //- Size of this patch in the triSurface face list label size_; //- Start label of this patch in the triSurface face list diff --git a/src/triSurface/triSurface/triSurface.H b/src/triSurface/triSurface/triSurface.H index cb0cf8c760b..a1bc2168670 100644 --- a/src/triSurface/triSurface/triSurface.H +++ b/src/triSurface/triSurface/triSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -192,7 +192,7 @@ class triSurface const label defaultRegion = 0 ); - //- helper function to print triangle info + //- Helper function to print triangle info static void printTriangle ( Ostream&, @@ -201,7 +201,7 @@ class triSurface const pointField& ); - //- read non-comment line + //- Read non-comment line static string getLineNoComment(IFstream&); diff --git a/tutorials/heatTransfer/buoyantBoussinesqSimpleFoam/iglooWithFridges/system/snappyHexMeshDict b/tutorials/heatTransfer/buoyantBoussinesqSimpleFoam/iglooWithFridges/system/snappyHexMeshDict index 1faa6e4939f..1352f96af7d 100644 --- a/tutorials/heatTransfer/buoyantBoussinesqSimpleFoam/iglooWithFridges/system/snappyHexMeshDict +++ b/tutorials/heatTransfer/buoyantBoussinesqSimpleFoam/iglooWithFridges/system/snappyHexMeshDict @@ -356,7 +356,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/snappyMultiRegionHeater/system/snappyHexMeshDict b/tutorials/heatTransfer/chtMultiRegionFoam/snappyMultiRegionHeater/system/snappyHexMeshDict index d4955c77106..b8178bcda61 100644 --- a/tutorials/heatTransfer/chtMultiRegionFoam/snappyMultiRegionHeater/system/snappyHexMeshDict +++ b/tutorials/heatTransfer/chtMultiRegionFoam/snappyMultiRegionHeater/system/snappyHexMeshDict @@ -345,7 +345,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/incompressible/pimpleDyMFoam/propeller/system/snappyHexMeshDict b/tutorials/incompressible/pimpleDyMFoam/propeller/system/snappyHexMeshDict index 13054ce94b8..f6b19068f88 100644 --- a/tutorials/incompressible/pimpleDyMFoam/propeller/system/snappyHexMeshDict +++ b/tutorials/incompressible/pimpleDyMFoam/propeller/system/snappyHexMeshDict @@ -437,7 +437,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.01; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -455,7 +455,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; // Optional : some meshing phases allow usage of relaxed rules. diff --git a/tutorials/incompressible/pimpleDyMFoam/wingMotion/wingMotion_snappyHexMesh/system/snappyHexMeshDict b/tutorials/incompressible/pimpleDyMFoam/wingMotion/wingMotion_snappyHexMesh/system/snappyHexMeshDict index 5baa9a202f3..22aa77e77f0 100644 --- a/tutorials/incompressible/pimpleDyMFoam/wingMotion/wingMotion_snappyHexMesh/system/snappyHexMeshDict +++ b/tutorials/incompressible/pimpleDyMFoam/wingMotion/wingMotion_snappyHexMesh/system/snappyHexMeshDict @@ -288,7 +288,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.05; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -306,7 +306,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/incompressible/pisoFoam/les/motorBike/motorBike/system/snappyHexMeshDict b/tutorials/incompressible/pisoFoam/les/motorBike/motorBike/system/snappyHexMeshDict index 1cb5eacce4d..245cfd7faf6 100644 --- a/tutorials/incompressible/pisoFoam/les/motorBike/motorBike/system/snappyHexMeshDict +++ b/tutorials/incompressible/pisoFoam/les/motorBike/motorBike/system/snappyHexMeshDict @@ -290,7 +290,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.02; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -308,7 +308,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/incompressible/simpleFoam/motorBike/system/snappyHexMeshDict b/tutorials/incompressible/simpleFoam/motorBike/system/snappyHexMeshDict index 5a775021b76..f6632e97e90 100644 --- a/tutorials/incompressible/simpleFoam/motorBike/system/snappyHexMeshDict +++ b/tutorials/incompressible/simpleFoam/motorBike/system/snappyHexMeshDict @@ -304,7 +304,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/incompressible/simpleFoam/pipeCyclic/constant/polyMesh/blockMeshDict b/tutorials/incompressible/simpleFoam/pipeCyclic/constant/polyMesh/blockMeshDict index e8fa4bbb33e..5676059cf12 100644 --- a/tutorials/incompressible/simpleFoam/pipeCyclic/constant/polyMesh/blockMeshDict +++ b/tutorials/incompressible/simpleFoam/pipeCyclic/constant/polyMesh/blockMeshDict @@ -16,7 +16,7 @@ FoamFile convertToMeters 1; -//- half angle of wedge in degrees +//- Half angle of wedge in degrees halfAngle 45.0; //- Radius of pipe [m] diff --git a/tutorials/incompressible/simpleFoam/turbineSiting/system/snappyHexMeshDict b/tutorials/incompressible/simpleFoam/turbineSiting/system/snappyHexMeshDict index 6ce22ecea8a..7c377c3bc1f 100644 --- a/tutorials/incompressible/simpleFoam/turbineSiting/system/snappyHexMeshDict +++ b/tutorials/incompressible/simpleFoam/turbineSiting/system/snappyHexMeshDict @@ -345,7 +345,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.05; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -358,7 +358,7 @@ meshQualityControls //must be >0 for Fluent compatibility minTriangleTwist -1; - //- if >0 : preserve single cells with all points on the surface if the + //- If >0 : preserve single cells with all points on the surface if the // resulting volume after snapping (by approximation) is larger than // minVolCollapseRatio times old volume (i.e. not collapsed to flat cell). // If <0 : delete always. @@ -369,7 +369,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; diff --git a/tutorials/lagrangian/MPPICFoam/cyclone/system/snappyHexMeshDict b/tutorials/lagrangian/MPPICFoam/cyclone/system/snappyHexMeshDict index edaa68f4577..a802754d8db 100644 --- a/tutorials/lagrangian/MPPICFoam/cyclone/system/snappyHexMeshDict +++ b/tutorials/lagrangian/MPPICFoam/cyclone/system/snappyHexMeshDict @@ -276,7 +276,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/mesh/foamyHexMesh/blob/system/meshQualityDict b/tutorials/mesh/foamyHexMesh/blob/system/meshQualityDict index 8eb6a7b4035..43213b09f1d 100644 --- a/tutorials/mesh/foamyHexMesh/blob/system/meshQualityDict +++ b/tutorials/mesh/foamyHexMesh/blob/system/meshQualityDict @@ -48,7 +48,7 @@ minArea -1; // and face centre triangles normal minTwist 0.001; -//- minimum normalised cell determinant +//- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; diff --git a/tutorials/mesh/foamyHexMesh/blob/system/snappyHexMeshDict b/tutorials/mesh/foamyHexMesh/blob/system/snappyHexMeshDict index ee9eaf14dac..de827f55bad 100644 --- a/tutorials/mesh/foamyHexMesh/blob/system/snappyHexMeshDict +++ b/tutorials/mesh/foamyHexMesh/blob/system/snappyHexMeshDict @@ -287,7 +287,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/mesh/foamyHexMesh/flange/system/meshQualityDict b/tutorials/mesh/foamyHexMesh/flange/system/meshQualityDict index cf95fbc5d54..93dac79886b 100644 --- a/tutorials/mesh/foamyHexMesh/flange/system/meshQualityDict +++ b/tutorials/mesh/foamyHexMesh/flange/system/meshQualityDict @@ -48,7 +48,7 @@ minArea -1; // and face centre triangles normal minTwist 0.001; -//- minimum normalised cell determinant +//- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; diff --git a/tutorials/mesh/foamyHexMesh/flange/system/snappyHexMeshDict b/tutorials/mesh/foamyHexMesh/flange/system/snappyHexMeshDict index f4b351452ed..4b7afdb351d 100644 --- a/tutorials/mesh/foamyHexMesh/flange/system/snappyHexMeshDict +++ b/tutorials/mesh/foamyHexMesh/flange/system/snappyHexMeshDict @@ -296,7 +296,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/mesh/foamyHexMesh/simpleShapes/system/meshQualityDict b/tutorials/mesh/foamyHexMesh/simpleShapes/system/meshQualityDict index a49ccdebd8f..ee51c390343 100644 --- a/tutorials/mesh/foamyHexMesh/simpleShapes/system/meshQualityDict +++ b/tutorials/mesh/foamyHexMesh/simpleShapes/system/meshQualityDict @@ -48,7 +48,7 @@ minArea -1; // and face centre triangles normal minTwist 0.001; -//- minimum normalised cell determinant +//- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; diff --git a/tutorials/mesh/snappyHexMesh/flange/system/snappyHexMeshDict b/tutorials/mesh/snappyHexMesh/flange/system/snappyHexMeshDict index 409b18a7811..0d08c6a2546 100644 --- a/tutorials/mesh/snappyHexMesh/flange/system/snappyHexMeshDict +++ b/tutorials/mesh/snappyHexMesh/flange/system/snappyHexMeshDict @@ -294,7 +294,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } diff --git a/tutorials/multiphase/LTSInterFoam/DTCHull/system/meshQualityDict b/tutorials/multiphase/LTSInterFoam/DTCHull/system/meshQualityDict index 4167df1354d..46e33cde63a 100644 --- a/tutorials/multiphase/LTSInterFoam/DTCHull/system/meshQualityDict +++ b/tutorials/multiphase/LTSInterFoam/DTCHull/system/meshQualityDict @@ -48,7 +48,7 @@ minArea -1; // and face centre triangles normal minTwist 0.05; -//- minimum normalised cell determinant +//- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -61,7 +61,7 @@ minVolRatio 0.01; //must be >0 for Fluent compatibility minTriangleTwist -1; -//- if >0 : preserve single cells with all points on the surface if the +//- If >0 : preserve single cells with all points on the surface if the // resulting volume after snapping (by approximation) is larger than // minVolCollapseRatio times old volume (i.e. not collapsed to flat cell). // If <0 : delete always. @@ -72,7 +72,7 @@ minTriangleTwist -1; //- Number of error distribution iterations nSmoothScale 4; -//- amount to scale back displacement at error points +//- Amount to scale back displacement at error points errorReduction 0.75; diff --git a/tutorials/multiphase/interDyMFoam/ras/DTCHull/system/meshQualityDict b/tutorials/multiphase/interDyMFoam/ras/DTCHull/system/meshQualityDict index 4167df1354d..46e33cde63a 100644 --- a/tutorials/multiphase/interDyMFoam/ras/DTCHull/system/meshQualityDict +++ b/tutorials/multiphase/interDyMFoam/ras/DTCHull/system/meshQualityDict @@ -48,7 +48,7 @@ minArea -1; // and face centre triangles normal minTwist 0.05; -//- minimum normalised cell determinant +//- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -61,7 +61,7 @@ minVolRatio 0.01; //must be >0 for Fluent compatibility minTriangleTwist -1; -//- if >0 : preserve single cells with all points on the surface if the +//- If >0 : preserve single cells with all points on the surface if the // resulting volume after snapping (by approximation) is larger than // minVolCollapseRatio times old volume (i.e. not collapsed to flat cell). // If <0 : delete always. @@ -72,7 +72,7 @@ minTriangleTwist -1; //- Number of error distribution iterations nSmoothScale 4; -//- amount to scale back displacement at error points +//- Amount to scale back displacement at error points errorReduction 0.75; diff --git a/tutorials/multiphase/interDyMFoam/ras/mixerVesselAMI/system/snappyHexMeshDict b/tutorials/multiphase/interDyMFoam/ras/mixerVesselAMI/system/snappyHexMeshDict index 21772cfe1a4..641f7f5a52a 100644 --- a/tutorials/multiphase/interDyMFoam/ras/mixerVesselAMI/system/snappyHexMeshDict +++ b/tutorials/multiphase/interDyMFoam/ras/mixerVesselAMI/system/snappyHexMeshDict @@ -533,7 +533,7 @@ meshQualityControls // must be >0 for Fluent compatibility minTriangleTwist -1; - //- if >0 : preserve single cells with all points on the surface if the + //- If >0 : preserve single cells with all points on the surface if the // resulting volume after snapping (by approximation) is larger than // minVolCollapseRatio times old volume (i.e. not collapsed to flat cell). // If <0 : delete always. diff --git a/tutorials/multiphase/interPhaseChangeDyMFoam/propeller/system/snappyHexMeshDict b/tutorials/multiphase/interPhaseChangeDyMFoam/propeller/system/snappyHexMeshDict index 13054ce94b8..f6b19068f88 100644 --- a/tutorials/multiphase/interPhaseChangeDyMFoam/propeller/system/snappyHexMeshDict +++ b/tutorials/multiphase/interPhaseChangeDyMFoam/propeller/system/snappyHexMeshDict @@ -437,7 +437,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.01; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -455,7 +455,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; // Optional : some meshing phases allow usage of relaxed rules. diff --git a/tutorials/multiphase/interPhaseChangeFoam/cavitatingBullet/system/snappyHexMeshDict b/tutorials/multiphase/interPhaseChangeFoam/cavitatingBullet/system/snappyHexMeshDict index e60fc864af9..cbb6ed93fb8 100644 --- a/tutorials/multiphase/interPhaseChangeFoam/cavitatingBullet/system/snappyHexMeshDict +++ b/tutorials/multiphase/interPhaseChangeFoam/cavitatingBullet/system/snappyHexMeshDict @@ -310,7 +310,7 @@ meshQualityControls // and face centre triangles normal minTwist 0.02; - //- minimum normalised cell determinant + //- Minimum normalised cell determinant // 1 = hex, <= 0 = folded or flattened illegal cell minDeterminant 0.001; @@ -328,7 +328,7 @@ meshQualityControls //- Number of error distribution iterations nSmoothScale 4; - //- amount to scale back displacement at error points + //- Amount to scale back displacement at error points errorReduction 0.75; } -- GitLab