Cleaned up the example for the tutorial book
authorIsaac Dooley <idooley2@illinois.edu>
Mon, 24 Nov 2008 22:26:21 +0000 (22:26 +0000)
committerIsaac Dooley <idooley2@illinois.edu>
Mon, 24 Nov 2008 22:26:21 +0000 (22:26 +0000)
examples/charm++/wave2d/Makefile
examples/charm++/wave2d/paper.pdf
examples/charm++/wave2d/paper.tex
examples/charm++/wave2d/screenshot.png
examples/charm++/wave2d/wave2d.C
examples/charm++/wave2d/wave2d.ci

index a2913eb1152c9c9aa79fa3970bc827a7f60d18f2..42e06d802489ecca5a987c6481c57cc5e036ee63 100644 (file)
@@ -1,4 +1,4 @@
-CHARMC=../../../bin/charmc -module liveViz $(OPTS)
+CHARMC=../../../bin/charmc -module liveViz $(OPTS) -g
 
 OBJS = wave2d.o
 
index abe5d800f9aed6f87de5d23fb9f5007434fe95eb..9a17083766dad92f8c14c93fb7b3ac31dc78bf24 100644 (file)
Binary files a/examples/charm++/wave2d/paper.pdf and b/examples/charm++/wave2d/paper.pdf differ
index d2073897f1d6803b38167892ee47ed5f2515c5fe..0ca172c191fd1b4f70e00f4036a2e2e2df49ccf2 100644 (file)
@@ -6,7 +6,7 @@
 %-------------------------------------------------------------------------
 \begin{document}
 
-\title{2-D Wave Equation}
+\title{2-D Wave Equation Program:  \texttt{wave2d}}
 \author{ Isaac Dooley }
 
 
@@ -17,25 +17,23 @@ The wave equation can be stated in the following form,
 \begin{equation}
 \frac{\partial^2p}{\partial p^2}=c^2 \nabla^2 p ,\label{PDE}
 \end{equation}
-where p is a physical measure such as a pressure, or the height of the water in a tub. This equation can be discretized over a 2d grid using a finite differencing scheme. Assume the pressures are located across a rectangular 2-D grid in x and y dimensions. We call the value of the pressure $p_{x,y}^{t}$ for time $t$ at location $\left(x,y\right)$ in the grid. One solution to the differential equation (\ref{PDE}) is the following:
-
+where p is a physical measure such as pressure or the depth of a body of water in a container. This equation can be discretized over a 2d grid using a finite differencing scheme. Assume the pressures are located across a rectangular 2-D grid in x and y dimensions. We call the value of the pressure $p_{x,y}^{t}$ for time $t$ at location $\left(x,y\right)$ in the grid. One solution to the differential equation (\ref{PDE}) over a grid is 
 \begin{equation}
 p_{x,y}^{t+1} + p_{x,y}^{t-1} -2 p_{x,y}^{t} = c^2 \left(p_{x+1,y}^{t}+p_{x-1,y}^{t}+p_{x,y+1}^{t}+p_{x,y-1}^{t}-4p_{x,y}^{t}\right).\label{DISC}
 \end{equation}
 
 The left hand side term $\frac{\partial^2p}{\partial p^2}$ is represented in terms of the values of $p$ at three consecutive timesteps at grid location $\left(x,y\right)$. The right hand side terms are discretized using the $p$ values for the 4 locations adjacent to $\left(x,y\right)$ in the grid. One can simply solve for $p_{x,y}^{t+1}$ in equation (\ref{DISC}) to produce an update rule, 
-
 \begin{equation}
 p_{x,y}^{t+1} = c^2 \left(p_{x+1,y}^{t}+p_{x-1,y}^{t}+p_{x,y+1}^{t}+p_{x,y-1}^{t}-4p_{x,y}^{t}\right)- p_{x,y}^{t-1} +2 p_{x,y}^{t} .
 \end{equation}
 
-This update rule specifies how the $p$ value for each location in the grid should be computed, using $p$ values from the two previous time steps. This update rule is easy to code in an application. The application simply maintains two timesteps' worth of $p$ grids, and using these, the next timestep's $p$ grid can be computed. The $c$ term determines the wave speed. This value must be small enough such that the wave cannot move across more than one grid square in a single timestep. Smaller values for $c$ will make the simulation take longer to propagate a wave by a fixed distance, but larger values for $c$ can introduce dispersive and diffusive errors.
+This update rule specifies how the $p$ value for each location in the grid should be computed, using values on the grid from the two previous time steps. This update rule is easy to code in an application. The application simply maintains two timesteps' worth of $p$ grids, and using these, the next timestep's $p$ grid can be computed. The $c$ term determines the wave speed. This value must be small enough such that the wave cannot move across more than one grid square in a single timestep. Smaller values for $c$ will make the simulation take longer to propagate a wave by a fixed distance, but larger values for $c$ can introduce dispersive and diffusive errors.
 
 
 \begin{figure}
 \begin{center}
 \includegraphics[width=5in]{screenshot}
-\caption{A screenshot of the wave2d program. Positive values of $p$ on the grid are colored red, while negative values are colored blue. The green lines show the parallel decomposition of the problem onto a 4x4 chare array.
+\caption{A screenshot of the \texttt{wave2d} program. Positive values of $p$ on the grid are colored red, while negative values are colored blue. The green lines show the parallel decomposition of the problem onto a $4\times3$ chare array. The grid domain logically wraps around from left to right and top to bottom.
 \label{screenshot}}
 \end{center}
 \end{figure} 
index 17a7890300b5a9faadf92ec56139bb9970d1b2af..d009216538363e9f860598b3c4e95d6e1fe428b1 100644 (file)
Binary files a/examples/charm++/wave2d/screenshot.png and b/examples/charm++/wave2d/screenshot.png differ
index 1af20e6d3b30914ce866d6242659d343eada2094..9a1545b90b03c000b19ea20f1d5920bdd731f860 100644 (file)
@@ -1,44 +1,41 @@
 #include "liveViz.h"
 #include "wave2d.decl.h"
 
-// Author: Isaac Dooley 2008
-
 // This program solves the 2-d wave equation over a grid, displaying pretty results through liveViz
-// The discretization used below is described in the accompanying pdf paper.pdf
+// The discretization used below is described in the accompanying paper.pdf
+// Author: Isaac Dooley 2008
 
 /*readonly*/ CProxy_Main mainProxy;
 /*readonly*/ CProxy_Wave arrayProxy;
 
 #define TotalDataWidth  800
-#define TotalDataHeight 800
-
+#define TotalDataHeight 700
 #define chareArrayWidth  4
-#define chareArrayHeight  4
-#define num_chares ((chareArrayWidth)*(chareArrayHeight))
-
+#define chareArrayHeight  3
 #define total_iterations 5000
-
 #define numInitialPertubations 5
 
+#define mod(a,b)  (((a)+b)%b)
+
+enum {
+  right,
+  left,
+  up,
+  down,
+};
 
-// A modulo operator that works for a==-1
-#define wrap(a,b)  (((a)+b)%b)
 
 class Main : public CBase_Main
 {
 public:
-  int recieve_count;
-  int iterations;
+  int iteration;
+  int count;
 
   Main(CkArgMsg* m) {
-
-    // set iteration counter to zero
-    iterations=0;
-
-    // store the main proxy
-    mainProxy = thisProxy;
-
-    // print info
+    iteration = 0;
+    count = 0;
+    mainProxy = thisProxy; // store the main proxy
+    
     CkPrintf("Running wave2d on %d processors\n", CkNumPes());
 
     // Create new array of worker chares
@@ -47,41 +44,30 @@ public:
     // setup liveviz
     CkCallback c(CkIndex_Wave::requestNextFrame(0),arrayProxy);
     liveVizConfig cfg(liveVizConfig::pix_color,true);
-
-    CkArrayID a; // unused???
-    liveVizInit(cfg,a,c);
+    liveVizInit(cfg,arrayProxy,c);
 
     //Start the computation
-    recieve_count = 0;
     arrayProxy.begin_iteration();
   }
 
-
-
-  // Each worker reports back to here when it completes an iteration
-  void report(int row, int col) {
-
-    recieve_count++;
-
-    if (num_chares == recieve_count) {
-
-      if (iterations == total_iterations) {
+  // Each worker calls this method
+  void iterationCompleted() {
+    count++;
+    if(count == chareArrayWidth*chareArrayHeight){
+      if (iteration == total_iterations) {
        CkPrintf("Program Done!\n");
        CkExit();
-      } else {
-
+      } else { 
        // Start the next iteration
-       recieve_count=0;
-       iterations++;
-       CkPrintf("Completed %d iterations\n", iterations);
-
+       count = 0;
+       iteration++;
+       if(iteration % 20 == 0) CkPrintf("Completed %d iterations\n", iteration);    
        arrayProxy.begin_iteration();
-                         
       }
     }
   }
-
-
+  
+  
 };
 
 class Wave: public CBase_Wave {
@@ -121,12 +107,10 @@ public:
 
   // Setup some Initial pressure pertubations
   void InitialConditions(){
-    srand(0);
+    srand(0); // ensure that the same random numbers are used for each chare array element
 
-    for(int i=0;i<myheight*mywidth;i++){
-        pressure[i] = 0.0;
-        pressure_old[i] = 0.0;
-    }
+    for(int i=0;i<myheight*mywidth;i++)
+      pressure[i] = pressure_old[i] = 0.0;
     
     for(int s=0; s<numInitialPertubations; s++){    
       // Randomly place a circle within the 2-d data array (without wrapping around)
@@ -139,27 +123,18 @@ public:
          int globaly = thisIndex.y*myheight + i;
          double distanceToCenter = sqrt((globalx-xcenter)*(globalx-xcenter) + (globaly-ycenter)*(globaly-ycenter));
          if (distanceToCenter < radius) {
-           double rscaled = distanceToCenter / radius; // ranges from 0 to 1
-           double rscaled2 = rscaled*3.0*3.14159/2.0; // ranges from 0 to 3pi/2                                                
-           double t = 400.0 * cos(rscaled2) ; // Range not to exceed -400 to 400
-           pressure[i*mywidth+j] = t;
-           pressure_old[i*mywidth+j] = t;
+           double rscaled = (distanceToCenter/radius)*3.0*3.14159/2.0; // ranges from 0 to 3pi/2                                               
+           double t = 700.0 * cos(rscaled) ; // Range won't exceed -700 to 700
+           pressure[i*mywidth+j] = pressure_old[i*mywidth+j] = t;
          }
        }                                               
       }
     }
   }
 
+  Wave(CkMigrateMessage* m) { } // Migration is not supported in this example
 
-
-  Wave(CkMigrateMessage* m) {
-    CkAbort("Migration of this class is not supported yet. Write PUP function if migration is used\n"); 
-  }
-
-  ~Wave() { 
-    delete [] pressure; 
-    delete [] pressure_old;
-  }
+  ~Wave() { }
 
   void begin_iteration(void) {
 
@@ -179,13 +154,13 @@ public:
     }
 
     // Send my left edge
-    thisProxy(wrap(thisIndex.x-1,chareArrayWidth), thisIndex.y).ghostsFromRight(myheight, left_edge);
+    thisProxy(mod(thisIndex.x-1, chareArrayWidth), thisIndex.y).recvGhosts(right, myheight, left_edge);
     // Send my right edge
-    thisProxy(wrap(thisIndex.x+1,chareArrayWidth), thisIndex.y).ghostsFromLeft(myheight, right_edge);
+    thisProxy(mod(thisIndex.x+1, chareArrayWidth), thisIndex.y).recvGhosts(left, myheight, right_edge);
     // Send my top edge
-    thisProxy(thisIndex.x, wrap(thisIndex.y-1,chareArrayHeight)).ghostsFromBottom(mywidth, top_edge);
+    thisProxy(thisIndex.x, mod(thisIndex.y-1, chareArrayHeight)).recvGhosts(down, mywidth, top_edge);
     // Send my bottom edge
-    thisProxy(thisIndex.x, wrap(thisIndex.y+1,chareArrayHeight)).ghostsFromTop(mywidth, bottom_edge);
+    thisProxy(thisIndex.x, mod(thisIndex.y+1, chareArrayHeight)).recvGhosts(up, mywidth, bottom_edge);
 
     delete [] right_edge;
     delete [] left_edge;
@@ -193,31 +168,24 @@ public:
     delete [] bottom_edge;
   }
 
-  void ghostsFromRight(int width, double ghost_values[]) {
-    for(int i=0;i<width;++i){
-      buffer_right[i] = ghost_values[i];
-    }
-    check_and_compute();
-  }
-
-  void ghostsFromLeft(int width, double ghost_values[]) {
-    for(int i=0;i<width;++i){
-      buffer_left[i] = ghost_values[i];
-    }
-    check_and_compute();
-  }
-
-  void ghostsFromBottom(int width, double ghost_values[]) {
-    for(int i=0;i<width;++i){
-      buffer_down[i] = ghost_values[i];
-    }
-    check_and_compute();
-  }
+  void recvGhosts(int whichSide, int size, double ghost_values[]) {
+    
+    if(whichSide == right)
+      for(int i=0;i<size;++i)
+       buffer_right[i] = ghost_values[i];
 
-  void ghostsFromTop(int width, double ghost_values[]) {
-    for(int i=0;i<width;++i){
-      buffer_up[i] = ghost_values[i];
-    }
+    else if(whichSide == left)
+      for(int i=0;i<size;++i)
+       buffer_left[i] = ghost_values[i];
+    
+    else if(whichSide == down)
+      for(int i=0;i<size;++i)
+       buffer_down[i] = ghost_values[i];
+    
+    else if(whichSide == up)    
+      for(int i=0;i<size;++i)
+       buffer_up[i] = ghost_values[i];
+        
     check_and_compute();
   }
 
@@ -231,76 +199,72 @@ public:
       for(int i=0;i<myheight;++i){
        for(int j=0;j<mywidth;++j){
 
-         // Current step's values for neighboring array elements
+         // Current time's pressures for neighboring array locations
          double left  = (j==0          ? buffer_left[i]  : pressure[i*mywidth+j-1] );
          double right = (j==mywidth-1  ? buffer_right[i] : pressure[i*mywidth+j+1] );
          double up    = (i==0          ? buffer_up[j]    : pressure[(i-1)*mywidth+j] );
          double down  = (i==myheight-1 ? buffer_down[j]  : pressure[(i+1)*mywidth+j] );
 
-         // Current values for this array element
+         // Current time's pressure for this array location
          double curr = pressure[i*mywidth+j];
 
-         // Previous step's value for this array element
+         // Previous time's pressure for this array location
          double old  = pressure_old[i*mywidth+j];
 
-         // Compute the new value
+         // Compute the future time's pressure for this array location
          pressure_new[i*mywidth+j] = 0.4*0.4*(left+right+up+down - 4.0*curr)-old+2.0*curr;
 
        }
       }
                
       // Advance to next step by copying values to the arrays for the previous steps
-      for(int i=0;i<myheight;++i){
+      for(int i=0;i<myheight;++i)
        for(int j=0;j<mywidth;++j){
          pressure_old[i*mywidth+j] = pressure[i*mywidth+j];
          pressure[i*mywidth+j] = pressure_new[i*mywidth+j];
        }
-      }
-
+      
       delete[] pressure_new;
-
       messages_due = 4;
-      mainProxy.report(thisIndex.x, thisIndex.y);
+      mainProxy.iterationCompleted();
     }
   }
 
 
-
   // provide my portion of the image to the graphical liveViz client                           
   void requestNextFrame(liveVizRequestMsg *m){
+
     // Draw my part of the image, plus a nice 1px border along my right/bottom boundary
-    int sx=thisIndex.x*mywidth; // where to deposit
+    int sx=thisIndex.x*mywidth; // where my portion of the image is located
     int sy=thisIndex.y*myheight;
-    int w=mywidth; // Size of my rectangular part of the image
+    int w=mywidth; // Size of my rectangular portion of the image
     int h=myheight;
     
     // set the output pixel values for my rectangle
-    // Each component is a char which can have 256 possible values.
+    // Each RGB component is a char which can have 256 possible values.
     unsigned char *intensity= new unsigned char[3*w*h];
     for(int i=0;i<myheight;++i){
       for(int j=0;j<mywidth;++j){
-        double t = pressure[i*mywidth+j];
-        if(t > 255.0){
-          t = 255.0;
-        } else if (t < -255.0){
-          t = -255.0;
-        }
-       
-        if(t > 0) { // Positive values are red
+
+        double p = pressure[i*mywidth+j];
+        if(p > 255.0) p = 255.0;    // Keep values in valid range
+        if(p < -255.0) p = -255.0;  // Keep values in valid range
+               
+        if(p > 0) { // Positive values are red
           intensity[3*(i*w+j)+0] = 255; // RED component
-          intensity[3*(i*w+j)+1] = 255-t; // GREEN component
-          intensity[3*(i*w+j)+2] = 255-t; // BLUE component
+          intensity[3*(i*w+j)+1] = 255-p; // GREEN component
+          intensity[3*(i*w+j)+2] = 255-p; // BLUE component
         } else { // Negative values are blue
-          intensity[3*(i*w+j)+0] = 255+t; // RED component
-          intensity[3*(i*w+j)+1] = 255+t; // GREEN component
+          intensity[3*(i*w+j)+0] = 255+p; // RED component
+          intensity[3*(i*w+j)+1] = 255+p; // GREEN component
           intensity[3*(i*w+j)+2] = 255; // BLUE component
         }
        
       }
     }
     
-    
-    // Draw a green border on right and bottom, overwrites data being plotted
+    // Draw a green border on right and bottom of this chare array's pixel buffer. 
+    // This will overwrite some pressure values at these pixels.
     for(int i=0;i<h;++i){
       intensity[3*(i*w+w-1)+0] = 0;     // RED component
       intensity[3*(i*w+w-1)+1] = 255;   // GREEN component
@@ -314,10 +278,9 @@ public:
 
     liveVizDeposit(m, sx,sy, w,h, intensity, this);
     delete[] intensity;
-  }
-
-
 
+  }
+  
 };
 
 #include "wave2d.def.h"
index 4c0caf962b3f2f67f75c3f84b33fa62163d2e33d..8ec02c5568bbacd53dcf7631ca78c2235b3a4407 100644 (file)
@@ -5,16 +5,13 @@ mainmodule wave2d {
 
   mainchare Main {
     entry Main(CkArgMsg *m);
-    entry void report(int, int);
+    entry void iterationCompleted();
   };
 
   array [2D] Wave {
     entry Wave(void);
-    entry void begin_iteration(void);
-    entry void ghostsFromLeft(int width, double s[width]);
-    entry void ghostsFromRight(int width, double s[width]);
-    entry void ghostsFromTop(int width, double s[width]);
-    entry void ghostsFromBottom(int width, double s[width]);
+    entry void begin_iteration();
+    entry void recvGhosts(int whichSide, int height, double s[height]);
 
     // A method for requesting data to be displayed graphically to the user
     entry void requestNextFrame(liveVizRequestMsg *m);