Tidying up and comments

src/OpenFOAM/containers/HashTables/Map/Distribution/Distribution.C

@@ -45,17 +45,6 @@ Foam::Distribution<Type>::Distribution(const Type& binWidth)
 {}
 
 
-// template<class Type>
-// Foam::Distribution<Type>::Distribution
-// (
-//     const cmptType& binWidth
-// )
-// :
-//     List< Map<scalar> >(pTraits<Type>::nComponents),
-//     binWidth_(binWidth*pTraits<Type>::one)
-// {}
-
-
 template<class Type>
 Foam::Distribution<Type>::Distribution(const Distribution<Type>& d)
 :
@@ -71,10 +60,6 @@ Foam::Distribution<Type>::~Distribution()
 {}
 
 
-// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
-
-
-
 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
 
 template<class Type>
@@ -131,9 +116,7 @@ inline Type Foam::Distribution<Type>::median()
 
     for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
     {
-        List<Pair<scalar> >& normDist = normDistribution[cmpt];
+        List< Pair<scalar> >& normDist = normDistribution[cmpt];
-
-        scalar cumulative = 0.0;
 
         if (normDist.size())
         {
@@ -164,6 +147,8 @@ inline Type Foam::Distribution<Type>::median()
             {
                 label lastNonZeroIndex = 0;
 
+                scalar cumulative = 0.0;
+
                 forAll(normDist,nD)
                 {
                     if
@@ -188,7 +173,7 @@ inline Type Foam::Distribution<Type>::median()
 
                         break;
                     }
-                    else if (normDist[nD].second() > 0.0)
+                    else if (mag(normDist[nD].second()) > VSMALL)
                     {
                         cumulative +=
                             normDist[nD].second()*component(binWidth_, cmpt);
@@ -232,17 +217,6 @@ void Foam::Distribution<Type>::add
         {
             cmptDistribution[n] += component(weight, cmpt);
         }
-
-        // if (cmptDistribution[n] < 0)
-        // {
-        //     FatalErrorIn("Distribution::add(const scalar valueToAdd)")
-        //         << "Accumulated Distribution value has become negative: "
-        //         << "bin = " << (0.5 + scalar(n))*component(binWidth_, cmpt)
-        //         << ", value = " << cmptDistribution[n]
-        //         << ". This is most likely to be because too many samples "
-        //         << "have been added to a bin and the weight has 'rolled round'"
-        //         << abort(FatalError);
-        // }
     }
 }
 
@@ -290,7 +264,7 @@ Distribution<Type>::normalised()
 
         List<label> keys = cmptDistribution.sortedToc();
 
-        List<Pair<scalar> >& normDist = normDistribution[cmpt];
+        List< Pair<scalar> >& normDist = normDistribution[cmpt];
 
         normDist.setSize(keys.size());
 
@@ -326,7 +300,7 @@ Distribution<Type>::raw()
 
         List<label> keys = cmptDistribution.sortedToc();
 
-        List<Pair<scalar> >& rawDist = rawDistribution[cmpt];
+        List< Pair<scalar> >& rawDist = rawDistribution[cmpt];
 
         rawDist.setSize(keys.size());
 
@@ -348,7 +322,7 @@ template<class Type>
 void Foam::Distribution<Type>::write
 (
     const fileName& filePrefix,
-    const List< List<Pair<scalar> > >& pairs
+    const List< List< Pair<scalar> > >& pairs
 ) const
 {
     if (pairs.size() != pTraits<Type>::nComponents)
@@ -358,7 +332,7 @@ void Foam::Distribution<Type>::write
             "Distribution::write"
             "("
                 "const fileName& filePrefix,"
-                "const List< List<Pair<scalar> > >& pairs"
+                "const List< List< Pair<scalar> > >& pairs"
             ")"
         )
             << "List of pairs (" << pairs.size()
@@ -369,7 +343,7 @@ void Foam::Distribution<Type>::write
 
     for (direction cmpt = 0; cmpt < pTraits<Type>::nComponents; cmpt++)
     {
-        const List<Pair<scalar> >& cmptPairs = pairs[cmpt];
+        const List< Pair<scalar> >& cmptPairs = pairs[cmpt];
 
         OFstream os(filePrefix + '_' + pTraits<Type>::componentNames[cmpt]);
 

src/OpenFOAM/containers/HashTables/Map/Distribution/Distribution.H

@@ -81,9 +81,6 @@ public:
         //- Construct from separate binWidth for each component
         Distribution(const Type& binWidth);
 
-        //- Construct from single binWidth for each component
-        // Distribution(const cmptType& binWidth);
-
         //- Construct as copy
         Distribution(const Distribution& d);
 
@@ -93,6 +90,8 @@ public:
 
     // Member Functions
 
+        //- Sum the total weight added to the component in the
+        //  argument
         scalar totalWeight(direction cmpt) const;
 
         Type mean() const;
@@ -102,28 +101,31 @@ public:
         // variable where the cumulative Distribution = 0.5.
         Type median();
 
+        //- Add a value to the distribution, optionally specifying a weight
         void add
         (
             const Type& valueToAdd,
             const Type& weight = pTraits<Type>::one
         );
 
+        //- Add the missing keys to the Maps to fill any gaps
         void insertMissingKeys();
 
+        //- Return the normalised distribution and bins
         List< List<Pair<scalar> > > normalised();
 
-        // List<Pair<scalar> > normalisedMinusMean();
+        //- Return the distribution of the total bin weights
-
-        // List<Pair<scalar> > normalisedShifted(scalar shift Value);
-
         List< List < Pair<scalar> > > raw();
 
     // Access
 
+        //- Return the bin width
         inline const Type& binWidth() const;
 
     // Write
 
+        //- Write the distribution to file.  Produces a separate file
+        //  for each component.
         void write
         (
             const fileName& filePrefix,