STYLE: formatting consistency for class declarations

src/catalyst/areaMesh/catalystFaMesh.H

@@ -99,7 +99,7 @@ class faMeshInput
 {
 protected:
 
-    // Protected data
+    // Protected Data
 
         //- Reference to the time database
         const Time& time_;
@@ -133,7 +133,7 @@ protected:
 
 public:
 
-    //- Runtime type information
+    //- Declare type-name (with debug switch)
     ClassName("catalyst::faMesh");
 
 

src/catalyst/areaMesh/foamVtkFaMeshAdaptor.H

@@ -67,7 +67,7 @@ class vtkIndent;
 namespace Foam
 {
 
-// Forward declarations
+// Forward Declarations
 class Time;
 class faMesh;
 template<class Type> class Field;
@@ -83,7 +83,7 @@ class faMeshAdaptor
 {
 public:
 
-        //- Public Data Members
+    // Public Data Members
 
         //- Name for internal mesh ("internal")
         static const word internalName;
@@ -91,6 +91,8 @@ public:
 
 private:
 
+    // Private Classes
+
         //- Bookkeeping for vtkPolyData
         struct foamVtpData
         :
@@ -160,15 +162,14 @@ private:
 
 public:
 
-    //- Static Data Members
-
-        ClassName("vtk::faMeshAdaptor");
+    //- Declare type-name (with debug switch)
+    ClassName("vtk::faMeshAdaptor");
 
 
     // Constructors
 
-        //- Construct from components
-        faMeshAdaptor(const faMesh& mesh);
+        //- Construct for mesh region
+        explicit faMeshAdaptor(const faMesh& mesh);
 
 
     //- Destructor

src/catalyst/catalystCoprocess.H

@@ -56,8 +56,6 @@ namespace catalyst
 
 class coprocess
 {
-private:
-
     // Private Data
 
         //- The currently active ParaView Catalyst co-process
@@ -76,13 +74,13 @@ private:
 
 public:
 
-    //- Define class name and debug
+    //- Declare type-name (with debug switch)
     ClassName("catalyst");
 
 
     // Constructors
 
-        //- Construct null. Does not initialize catalyst.
+        //- Default construct. Does not initialize catalyst.
         constexpr coprocess() noexcept
         :
             coproc_(nullptr)
@@ -129,7 +127,6 @@ public:
 
         //- Finalize
         void stop();
-
 };
 
 

src/catalyst/catalystFunctionObject.H

@@ -119,7 +119,7 @@ class catalystFunctionObject
 :
     public functionObject
 {
-    // Private data
+    // Private Data
 
         //- Reference to the time database
         const Time& time_;
@@ -148,16 +148,16 @@ class catalystFunctionObject
 
 public:
 
+    //- Declare type-name (with debug switch)
+    TypeName("catalyst");
+
+
     // Static Methods
 
         //- Expand strings as filenames, retaining only those that exist
         static label expand(List<string>& scripts, const dictionary& dict);
 
 
-    //- Runtime type information
-    TypeName("catalyst");
-
-
     // Constructors
 
         //- Construct from Time and dictionary

src/catalyst/catalystInput.H

@@ -52,7 +52,7 @@ SourceFiles
 namespace Foam
 {
 
-// Forward declarations
+// Forward Declarations
 class dictionary;
 class mapPolyMesh;
 class Time;
@@ -66,13 +66,17 @@ namespace catalyst
 
 class catalystInput
 {
-    // Private data
+    // Private Data
 
         //- The Catalyst input channel name
         word name_;
 
 public:
 
+    //- Declare type-name (with debug switch)
+    ClassName("catalyst::input");
+
+
     // Declare run-time constructor selection table
 
         declareRunTimeSelectionTable
@@ -100,10 +104,6 @@ public:
         );
 
 
-    //- Runtime type information
-    ClassName("catalyst::input");
-
-
     // Constructors
 
         //- Construct with given Catalyst input channel name

src/catalyst/catalystTools.H

@@ -43,7 +43,7 @@ SourceFiles
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-// Forward declarations
+// Forward Declarations
 class vtkCPDataDescription;
 class vtkCPProcessor;
 class vtkMultiBlockDataSet;
@@ -52,7 +52,7 @@ template<class T> class vtkSmartPointer;
 namespace Foam
 {
 
-// Forward declarations
+// Forward Declarations
 class Ostream;
 class Time;
 
@@ -64,7 +64,6 @@ namespace catalyst
 //- Container holding VTK outputs per Catalyst channel name
 typedef HashTable<vtkSmartPointer<vtkMultiBlockDataSet>> outputChannels;
 
-
 //- Print information about data description
 void printInfo(Ostream& os, vtkCPDataDescription* descrip);
 
@@ -133,7 +132,7 @@ public:
     // Constructors
 
         //- Construct query for given time. Add channels later
-        dataQuery(const Foam::Time& when);
+        explicit dataQuery(const Foam::Time& when);
 
 
     //- Destructor

src/catalyst/cloud/catalystCloud.H

@@ -98,7 +98,7 @@ class cloudInput
 {
 protected:
 
-    // Protected data
+    // Protected Data
 
         //- Reference to the time database
         const Time& time_;
@@ -123,7 +123,7 @@ protected:
 
 public:
 
-    //- Runtime type information
+    //- Declare type-name (with debug switch)
     ClassName("catalyst::cloud");
 
 

src/catalyst/cloud/foamVtkCloudAdaptor.H

@@ -65,7 +65,7 @@ namespace vtk
 
 class cloudAdaptor
 {
-    // Private data
+    // Private Data
 
         const fvMesh& mesh_;
 
@@ -95,6 +95,7 @@ class cloudAdaptor
             const UnaryPredicate& pred
         );
 
+
     // Constructors
 
         //- No copy construct
@@ -106,15 +107,14 @@ class cloudAdaptor
 
 public:
 
-    //- Static Data Members
-
-        ClassName("vtk::cloudAdaptor");
+    //- Declare type-name (with debug switch)
+    ClassName("vtk::cloudAdaptor");
 
 
     // Constructors
 
         //- Construct for a particular mesh region
-        cloudAdaptor(const fvMesh& mesh);
+        explicit cloudAdaptor(const fvMesh& mesh);
 
 
     //- Destructor

src/catalyst/volMesh/catalystFvMesh.H

@@ -126,7 +126,7 @@ class fvMeshInput
 {
 protected:
 
-    // Protected data
+    // Protected Data
 
         //- Channel enumeration from vtk::fvMeshAdaptor
         using channelType = vtk::fvMeshAdaptor::channelType;
@@ -169,7 +169,7 @@ protected:
 
 public:
 
-    //- Runtime type information
+    //- Declare type-name (with debug switch)
     ClassName("catalyst::fvMesh");
 
 

src/catalyst/volMesh/foamVtkFvMeshAdaptor.H

@@ -74,7 +74,7 @@ class vtkIndent;
 namespace Foam
 {
 
-// Forward declarations
+// Forward Declarations
 class fvMesh;
 template<class Type> class Field;
 
@@ -89,7 +89,7 @@ class fvMeshAdaptor
 {
 public:
 
-        //- Public Data Members
+    // Public Data Members
 
         //- The types of output blocks. Defined as a bitmask.
         enum channelType : unsigned
@@ -255,15 +255,14 @@ private:
 
 public:
 
-    //- Static Data Members
-
-        ClassName("vtk::fvMeshAdaptor");
+    //- Declare type-name (with debug switch)
+    ClassName("vtk::fvMeshAdaptor");
 
 
     // Constructors
 
         //- Construct from components
-        fvMeshAdaptor
+        explicit fvMeshAdaptor
         (
             const fvMesh& mesh,
             const channelType channelsOpt = channelType::DEFAULT,

src/paraview-plugins/blockMeshReader/library/vtkPVblockMesh.H

@@ -153,9 +153,8 @@ class vtkPVblockMesh
 
 public:
 
-    //- Static data members
-
-        ClassName("vtkPVblockMesh");
+    //- Declare type-name (with debug switch)
+    ClassName("vtkPVblockMesh");
 
 
     // Constructors
@@ -189,6 +188,8 @@ public:
         void renderPointNumbers(vtkRenderer* renderer, const bool show);
 
 
+    // Access
+
         //- Debug information
         void PrintSelf(ostream&, vtkIndent) const;
 };

src/paraview-plugins/blockMeshReader/plugin/pqFoamBlockMeshControls.h

@@ -40,7 +40,7 @@ SourceFiles
 
 #include "pqPropertyWidget.h"
 
-// Forward declarations (ParaView)
+// Forward Declarations (ParaView)
 class vtkSMProperty;
 class vtkSMIntVectorProperty;
 
@@ -56,7 +56,7 @@ class pqFoamBlockMeshControls
     Q_OBJECT;
     typedef pqPropertyWidget Superclass;
 
-    // Private data
+    // Private Data
 
         //- Refresh (push button)
         vtkSMProperty* refresh_;
@@ -114,7 +114,6 @@ public:
 
     //- Destructor
     virtual ~pqFoamBlockMeshControls();
-
 };
 
 

src/paraview-plugins/blockMeshReader/plugin/reader/vtkPVblockMeshReader.h

@@ -118,7 +118,7 @@ public:
 
 protected:
 
-    //- Construct null
+    //- Default construct
     vtkPVblockMeshReader();
 
     //- Destructor

src/paraview-plugins/common/foamPvCore.H

@@ -62,6 +62,7 @@ template<class T> class vtkSmartPointer;
 namespace Foam
 {
 
+// Forward Declarations
 class IOobjectList;
 
 /*---------------------------------------------------------------------------*\
@@ -165,13 +166,12 @@ public:
 
             return indices;
         }
-
     }; // End class arrayRange
 
 
 public:
 
-    //- Construct null
+    //- Default construct
     constexpr foamPvCore() noexcept {}
 
 
@@ -293,12 +293,11 @@ public:
 
     //- Simple memory used debugging information
     static void printMemory();
+};
 
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-}; // End class foamPvCore
-
 } // End namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/paraview-plugins/foamReader/library/vtkPVFoam.H

@@ -93,7 +93,7 @@ class vtkTextActor;
 namespace Foam
 {
 
-// Forward declarations (OpenFOAM)
+// Forward Declarations (OpenFOAM)
 class argList;
 class Time;
 class faMesh;
@@ -209,6 +209,7 @@ class vtkPVFoam
         //- Reset data counters
         void resetCounters();
 
+
     // Update information helper functions
 
         //- Internal mesh info
@@ -430,9 +431,8 @@ class vtkPVFoam
 
 public:
 
-    //- Static data members
-
-        ClassName("vtkPVFoam");
+    //- Declare type-name (with debug switch)
+    ClassName("vtkPVFoam");
 
 
     // Constructors
@@ -475,12 +475,16 @@ public:
         //  sets to "constant" on error
         int setTime(const std::vector<double>& requestTimes);
 
+
         //- The current time index
         int timeIndex() const
         {
            return timeIndex_;
         }
 
+
+    // Access
+
         //- Debug information
         void PrintSelf(ostream&, vtkIndent) const;
 

src/paraview-plugins/foamReader/library/vtkPVFoamUpdateInfo.C

@@ -59,7 +59,6 @@ class zonesEntries
     public regIOobject,
     public PtrList<entry>
 {
-
 public:
 
     // Constructors
@@ -72,7 +71,7 @@ public:
             close();
         }
 
-   // Member functions
+    // Member Functions
 
         bool writeData(Ostream&) const
         {

src/paraview-plugins/foamReader/plugin/pqFoamReaderControls.h

@@ -38,7 +38,7 @@ SourceFiles
 
 #include "pqPropertyWidget.h"
 
-// Forward declarations
+// Forward Declarations
 class vtkSMProperty;
 class vtkSMIntVectorProperty;
 
@@ -54,7 +54,7 @@ class pqFoamReaderControls
     Q_OBJECT;
     typedef pqPropertyWidget Superclass;
 
-    // Private data
+    // Private Data
 
         //- Refresh (push button)
         vtkSMProperty* refresh_;
@@ -123,7 +123,6 @@ public:
 
     //- Destructor
     virtual ~pqFoamReaderControls();
-
 };
 
 

src/paraview-plugins/foamReader/plugin/reader/vtkPVFoamReader.h

@@ -191,7 +191,7 @@ public:
 
 protected:
 
-    //- Construct null
+    //- Default construct
     vtkPVFoamReader();
 
     //- Destructor

src/runTimePostProcessing/contourFilter.H

@@ -89,7 +89,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("isoSurface");
 
 

src/runTimePostProcessing/cuttingPlaneFilter.H

@@ -109,7 +109,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("plane");
 
 

src/runTimePostProcessing/fieldVisualisationBase.H

@@ -146,7 +146,7 @@ public:
             unsigned association_;
             scalarMinMax range_;
 
-            //- Construct null
+            //- Default construct
             fieldSummary()
             :
                 nComponents_(0),

src/runTimePostProcessing/functionObjectCloud.H

@@ -96,7 +96,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("functionObjectCloud");
 
 

src/runTimePostProcessing/functionObjectLine.H

@@ -83,7 +83,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("functionObjectLine");
 
 

src/runTimePostProcessing/functionObjectSurface.H

@@ -86,7 +86,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("functionObjectSurface");
 
 

src/runTimePostProcessing/geometryBase.H

@@ -69,7 +69,6 @@ class runTimePostProcessing;
 namespace runTimePostPro
 {
 
-
 /*---------------------------------------------------------------------------*\
                         Class geometryBase Declaration
 \*---------------------------------------------------------------------------*/
@@ -94,7 +93,7 @@ public:
 
 protected:
 
-    // Protected data
+    // Protected Data
 
         //- Reference to the parent function object
         const runTimePostProcessing& parent_;

src/runTimePostProcessing/geometryCloud.H

@@ -141,7 +141,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("geometryCloud");
 
 

src/runTimePostProcessing/geometryPatches.H

@@ -118,7 +118,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("patches");
 
 

src/runTimePostProcessing/geometrySurface.H

@@ -97,7 +97,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (with debug switch)
     TypeName("geometry");
 
 

src/runTimePostProcessing/pathline.H

@@ -51,7 +51,7 @@ SourceFiles
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-// Forward declarations
+// Forward Declarations
 class vtkActor;
 class vtkPolyData;
 class vtkPolyDataMapper;
@@ -90,7 +90,7 @@ public:
 
 protected:
 
-    // Protected data
+    // Protected Data
 
         //- Representation type
         representationType representation_;
@@ -121,7 +121,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("pathline");
 
 

src/runTimePostProcessing/pointData.H

@@ -120,7 +120,7 @@ protected:
 
 public:
 
-    //- Run-time type information
+    //- Declare type-name, virtual type (without debug switch)
     TypeNameNoDebug("pointData");
 
 

src/runTimePostProcessing/runTimePostProcessing.H

@@ -132,12 +132,12 @@ namespace Foam
 {
 namespace functionObjects
 {
-// Forward declarations
+// Forward Declarations
 class runTimePostProcessing;
 
 namespace runTimePostPro
 {
-// Forward declarations
+// Forward Declarations
 class pointData;
 class pathline;
 class surface;
@@ -202,7 +202,7 @@ class runTimePostProcessing
 
 public:
 
-    //- Runtime type information
+    //- Declare type-name, virtual type (with debug switch)
     TypeName("runTimePostProcessing");
 
 

src/runTimePostProcessing/scalarBar.H

@@ -122,7 +122,7 @@ class scalarBar
 
 public:
 
-    //- Construct with sensible defaults
+    //- Default construct with sensible defaults
     scalarBar();
 
     //- Reset to sensible defaults

src/runTimePostProcessing/scene.H

@@ -76,7 +76,7 @@ SourceFiles
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-// Forward declarations
+// Forward Declarations
 class vtkActor;
 class vtkRenderer;
 class vtkRenderWindow;
@@ -94,7 +94,7 @@ namespace runTimePostPro
 
 class scene
 {
-    // Private data
+    // Private Data
 
         //- Reference to the object registry
         const objectRegistry& obr_;
@@ -127,7 +127,7 @@ class scene
 
 protected:
 
-    // Protected data
+    // Protected Data
 
         //- Colours
         HashPtrTable<Function1<vector>> colours_;

src/runTimePostProcessing/surface.H

@@ -324,7 +324,7 @@ protected:
 
 public: