From 624dd9c0dceafe0509fcc161f0a98c47dfa8c1d5 Mon Sep 17 00:00:00 2001
From: Cory Bloor <cgbloor@ucalgary.ca>
Date: Tue, 15 May 2018 14:20:31 -0600
Subject: [PATCH] Move debug helpers into their own file

---
 debug-inl.h | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 main.cxx    | 60 -----------------------------------
 2 files changed, 90 insertions(+), 60 deletions(-)
 create mode 100644 debug-inl.h

diff --git a/debug-inl.h b/debug-inl.h
new file mode 100644
index 0000000..94ff20b
--- /dev/null
+++ b/debug-inl.h
@@ -0,0 +1,90 @@
+#ifndef DEBUG_INL_H
+#define DEBUG_INL_H
+
+/*
+   These debug functions are used to print out the data structures used in the
+   pressure solve. The output format is designed so output can be copy/pasted
+   directly into Matlab / Octave for further analysis.
+
+   The printing functions also handy just to understand how the data structures
+   in memory relate to the matrixes and vectors in the math. The indexing for a
+   lot of matrixes and vectors expect you to ignore fluid cells. I do that by
+   using matrixes large enough to hold all cells and then just skipping over
+   the non-fluid cells. I suspect that compacting and using some kind of
+   mapping between indexes would be more efficient.
+
+   This file doesn't really stand on its own. It expects to be embedded in
+   main.cxx. Just include it right before whatever function is being debugged.
+*/
+
+// Fills q with the dense fluid matrix A.
+void get_dense_a(int q[Y*X][Y*X]) {
+  for (size_t y = 0; y < Y; ++y) {
+    for (size_t x = 0; x < X; ++x) {
+      if (is_water(y, x)) {
+        q[X*y+x][X*y+x] = g_a[y][x].a_diag;
+        if (x > 0)
+          q[X*y+x][X*y+x-1] = get_a_minus_i(y,x);
+        if (x+1 < X)
+          q[X*y+x][X*y+x+1] = g_a[y][x].a_plus_i;
+        if (y > 0)
+          q[X*y+x][X*(y-1)+x] = get_a_minus_j(y,x);
+        if (y+1 < X)
+          q[X*y+x][X*(y+1)+x] = g_a[y][x].a_plus_j;
+      }
+    }
+  }
+}
+
+// Prints a dense fluid matrix. e.g. A
+void print_fluid_matrix(FILE* f, const char* name, int q[Y*X][Y*X]) {
+  fprintf(f, "%s = [", name);
+  for (size_t y0 = 0; y0 < Y; ++y0) {
+    for (size_t x0 = 0; x0 < X; ++x0) {
+      for (size_t y1 = 0; y1 < Y; ++y1) {
+        for (size_t x1 = 0; x1 < X; ++x1) {
+          if (is_water(y0,x0) && is_water(y1,x1)) {
+            fprintf(f, "% 2d ", q[y0*X+x0][y1*X+x1]);
+          }
+        }
+      }
+      if (is_water(y0,x0)) {
+        fprintf(f, "; ");
+      }
+    }
+  }
+  fprintf(f, "]\n");
+}
+
+// Prints a fluid vector
+// Fluid vectors have one value per fluid cell, e.g. pressure, color, etc...
+// Despite its appearance, q is a 1D vector with an index based on y and x.
+// It's not quite as simple as 'idx = y*X + x', because cells that don't
+// contain fluid are not part of the vector.
+void print_fluid_vector(FILE* f, const char* name, double q[Y][X]) {
+  fprintf(f, "%s = [", name);
+  for (size_t y = 0; y < Y; ++y) {
+    for (size_t x = 0; x < X; ++x) {
+      if (is_water(y,x)) {
+        fprintf(f, "%f ", q[y][x]);
+      }
+    }
+  }
+  fprintf(f, "].'\n");
+}
+
+// Prints a matrix
+// This has the function same signature as print_fluid_vector, but in this case
+// q really is a 2D matrix. All cells are part of the matrix, fluid or not.
+void print_matrix(FILE* f, const char* name, float q[Y][X]) {
+  fprintf(f, "%s = [", name);
+  for (size_t y = Y; y--;) {
+    for (size_t x = 0; x < X; ++x) {
+      fprintf(f, "%f ", q[y][x]);
+    }
+    fprintf(f, ";\n");
+  }
+  fprintf(f, "]\n");
+}
+
+#endif
diff --git a/main.cxx b/main.cxx
index 30deff1..524aedb 100644
--- a/main.cxx
+++ b/main.cxx
@@ -801,66 +801,6 @@ void fmadd(double a[Y][X], double b, double c[Y][X]) {
   }
 }
 
-void get_dense_a(int q[Y*X][Y*X]) {
-  for (size_t y = 0; y < Y; ++y) {
-    for (size_t x = 0; x < X; ++x) {
-      if (is_water(y, x)) {
-        q[X*y+x][X*y+x] = g_a[y][x].a_diag;
-        if (x > 0)
-          q[X*y+x][X*y+x-1] = get_a_minus_i(y,x);
-        if (x+1 < X)
-          q[X*y+x][X*y+x+1] = g_a[y][x].a_plus_i;
-        if (y > 0)
-          q[X*y+x][X*(y-1)+x] = get_a_minus_j(y,x);
-        if (y+1 < X)
-          q[X*y+x][X*(y+1)+x] = g_a[y][x].a_plus_j;
-      }
-    }
-  }
-}
-
-void print_fluid_matrix(FILE* f, const char* name, int q[Y*X][Y*X]) {
-  fprintf(f, "%s = [", name);
-  for (size_t y0 = 0; y0 < Y; ++y0) {
-    for (size_t x0 = 0; x0 < X; ++x0) {
-      for (size_t y1 = 0; y1 < Y; ++y1) {
-        for (size_t x1 = 0; x1 < X; ++x1) {
-          if (is_water(y0,x0) && is_water(y1,x1)) {
-            fprintf(f, "% 2d ", q[y0*X+x0][y1*X+x1]);
-          }
-        }
-      }
-      if (is_water(y0,x0)) {
-        fprintf(f, "; ");
-      }
-    }
-  }
-  fprintf(f, "]\n");
-}
-
-void print_fluid_vector(FILE* f, const char* name, double q[Y][X]) {
-  fprintf(f, "%s = [", name);
-  for (size_t y = 0; y < Y; ++y) {
-    for (size_t x = 0; x < X; ++x) {
-      if (is_water(y,x)) {
-        fprintf(f, "%f ", q[y][x]);
-      }
-    }
-  }
-  fprintf(f, "].'\n");
-}
-
-void print_matrix(FILE* f, const char* name, float q[Y][X]) {
-  fprintf(f, "%s = [", name);
-  for (size_t y = Y; y--;) {
-    for (size_t x = 0; x < X; ++x) {
-      fprintf(f, "%f ", q[y][x]);
-    }
-    fprintf(f, ";\n");
-  }
-  fprintf(f, "]\n");
-}
-
 void project(float dt, float u[Y][X], float v[Y][X], float uout[Y][X], float vout[Y][X]) {
   const double c = -k_d*k_s*k_s / dt; // -density * dt^2 / dt
   double d0[Y][X] = {}; // divergence * c