Corrected class names in the file descriptions

1e2832fd · Henry · dd578179 · 1e2832fd · 1e2832fd · 1e2832fd
Commit 1e2832fd authored Jul 19, 2011 by Henry
--- a/applications/solvers/multiphase/interMixingFoam/incompressibleThreePhaseMixture/threePhaseMixture.C
+++ b/applications/solvers/multiphase/interMixingFoam/incompressibleThreePhaseMixture/threePhaseMixture.C
@@ -21,9 +21,6 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

-Class
-    threePhaseMixture
-
 \*---------------------------------------------------------------------------*/

 #include "threePhaseMixture.H"

--- a/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
+++ b/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,9 +21,6 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

-Class
-    meshDualiser
-
 \*---------------------------------------------------------------------------*/

 #include "meshDualiser.H"

--- a/applications/utilities/mesh/manipulation/setSet/writeFuns.H
+++ b/applications/utilities/mesh/manipulation/setSet/writeFuns.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,18 +22,18 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::writeFunctions
+    Foam::writeFuns

 Description
    Various functions for collecting and writing binary data.

 SourceFiles
-    writeFunctions.C
+    writeFuns.C

 \*---------------------------------------------------------------------------*/

-#ifndef writeFunctions_H
-#define writeFunctions_H
+#ifndef writeFuns_H
+#define writeFuns_H

 #include "labelList.H"
 #include "floatScalar.H"

--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.H
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,18 +22,18 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::writeFunctions
+    Foam::writeFuns

 Description
    Various functions for collecting and writing binary data.

 SourceFiles
-    writeFunctions.C
+    writeFuns.C

 \*---------------------------------------------------------------------------*/

-#ifndef writeFunctions_H
-#define writeFunctions_H
+#ifndef writeFuns_H
+#define writeFuns_H

 #include "floatScalar.H"
 #include "DynamicList.H"

--- a/src/OSspecific/POSIX/fileMonitor.C
+++ b/src/OSspecific/POSIX/fileMonitor.C
@@ -21,9 +21,6 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

-Class
-    fileMonitor
-
 \*----------------------------------------------------------------------------*/

 #include "fileMonitor.H"

--- a/src/OpenFOAM/db/error/StaticAssert.H
+++ b/src/OpenFOAM/db/error/StaticAssert.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::StaticAssertFailed
+    Foam::StaticAssertionFailed

 Description
    Macros and classes to provide static (compile-time) assertions.

--- a/src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H
+++ b/src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::GeometricField
+    Foam::geometricOneField

 Description
    A class representing the concept of a GeometricField of 1 used to avoid

--- a/src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H
+++ b/src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::GeometricField
+    Foam::geometricZeroField

 Description
    A class representing the concept of a GeometricField of 1 used to avoid

--- a/src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReaders.H
+++ b/src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReaders.H
@@ -21,9 +21,6 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

-Class
-    Foam::tableReader
-
 SourceFiles
    tableReaders.C


--- a/src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::cellZone
+    Foam::zone

 Description
    Base class for zones

--- a/src/finiteVolume/cfdTools/general/fieldSources/basicSource/basicSource/basicSourceList.H
+++ b/src/finiteVolume/cfdTools/general/fieldSources/basicSource/basicSource/basicSourceList.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::basicsourceList
+    Foam::basicSourceList

 Description
    List of explict sources

--- a/src/finiteVolume/fvMatrices/fvMatricesFwd.H
+++ b/src/finiteVolume/fvMatrices/fvMatricesFwd.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -21,14 +21,8 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

-Class
-    Foam::fvMatrix
-
 Description
-    A special matrix type and solver, designed for finite volume
-    solutions of scalar equations.
-    Face addressing is used to make all matrix assembly
-    and solution loops vectorise.
+    Forward declarations of fvMatrix specializations.

 \*---------------------------------------------------------------------------*/


--- a/src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
+++ b/src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
@@ -25,7 +25,10 @@ Class
    Foam::fvMatrix

 Description
-    Finite-Volume matrix.
+    A special matrix type and solver, designed for finite volume
+    solutions of scalar equations.
+    Face addressing is used to make all matrix assembly
+    and solution loops vectorise.

 SourceFiles
    fvMatrix.C

--- a/src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/pureUpwindCFCCellToFaceStencilObject.H
+++ b/src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/pureUpwindCFCCellToFaceStencilObject.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2008-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::upwindCFCCellToFaceStencilObject
+    Foam::pureUpwindCFCCellToFaceStencilObject

 Description


--- a/src/finiteVolume/interpolation/interpolation/interpolationCellPointWallModified/interpolationCellPointWallModified.H
+++ b/src/finiteVolume/interpolation/interpolation/interpolationCellPointWallModified/interpolationCellPointWallModified.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::interpolationCellPoint
+    Foam::interpolationCellPointWallModified

 Description
    Same as interpolationCellPoint, but if interpolating a wall face, uses

--- a/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H
+++ b/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::MapFvSurfaceField
+    Foam::MapInternalField

 Description
    Map Surface internal field on topology change.  This is a partial

--- a/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H
+++ b/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::MapFvVolField
+    Foam::MapInternalField

 Description
    Map volume internal field on topology change.  This is a partial

--- a/src/fvMotionSolver/fvMotionSolvers/displacement/displacementFvMotionSolver/displacementFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/displacementFvMotionSolver/displacementFvMotionSolver.H
@@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::displacementFvMotionSolver.H
+    Foam::displacementFvMotionSolver

 Description
    Base class for fvMotionSolvers which calculate displacement.

--- a/src/lagrangian/coalCombustion/coalCloud/coalCloud.H
+++ b/src/lagrangian/coalCombustion/coalCloud/coalCloud.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    CoalCloud
+    coalCloud

 Description
    Cloud class to introduce coal parcels

--- a/src/lagrangian/intermediate/parcels/derived/basicReactingMultiphaseParcel/basicReactingMultiphaseParcel.H
+++ b/src/lagrangian/intermediate/parcels/derived/basicReactingMultiphaseParcel/basicReactingMultiphaseParcel.H
@@ -22,7 +22,7 @@ License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

 Class
-    Foam::BasicReactingMultiphaseParcel
+    Foam::basicReactingMultiphaseParcel

 Description
    Definition of basic reacting parcel