From f1911657d1fac9effbf9580881b6196133e2815f Mon Sep 17 00:00:00 2001
From: mattijs <mattijs>
Date: Thu, 8 Dec 2011 16:26:40 +0000
Subject: [PATCH] STYLE: bandCompression: added comment

---
 src/OpenFOAM/meshes/bandCompression/bandCompression.C | 1 +
 src/OpenFOAM/meshes/bandCompression/bandCompression.H | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/src/OpenFOAM/meshes/bandCompression/bandCompression.C b/src/OpenFOAM/meshes/bandCompression/bandCompression.C
index 5c31a2121d..cec9dc9c6c 100644
--- a/src/OpenFOAM/meshes/bandCompression/bandCompression.C
+++ b/src/OpenFOAM/meshes/bandCompression/bandCompression.C
@@ -26,6 +26,7 @@ Description
     matrix is reduced. The algorithm uses a simple search through the
     neighbour list
 
+    See http://en.wikipedia.org/wiki/Cuthill-McKee_algorithm
 
 \*---------------------------------------------------------------------------*/
 
diff --git a/src/OpenFOAM/meshes/bandCompression/bandCompression.H b/src/OpenFOAM/meshes/bandCompression/bandCompression.H
index 25e863fd47..8cbad9fbde 100644
--- a/src/OpenFOAM/meshes/bandCompression/bandCompression.H
+++ b/src/OpenFOAM/meshes/bandCompression/bandCompression.H
@@ -46,6 +46,8 @@ namespace Foam
 
 //- Renumbers the addressing to reduce the band of the matrix.
 //  The algorithm uses a simple search through the neighbour list
+//  Returns the order in which the cells need to be visited (i.e. ordered to
+//  original)
 labelList bandCompression(const labelListList& addressing);
 
 } // End namespace Foam