examples: add example program demonstrating sync entry methods
[charm.git] / examples / charm++ / jacobi2d-iter / README
1 Jacobi iteration with a 2D Array.
2
3 This code uses a 2-D blocked decomposition of a 2-d array with more
4 than one element per chare. The code runs for a specified number of
5 iterations, using a reduction to start each successive iteration.
6
7 A 5-point stencil pattern is used to update the value for each data
8 element. For example, the new value for element X is the current
9 value of X plus the current values of its left, right, top, and
10 bottom neighbors.
11
12      T
13    L X R
14      B
15
16 X'  = (X + L + R + T + B) / 5.0
17
18
19 To run the program with liveviz, run the parallel job as shown in
20 runserver.sh, or just do a "./runserver.sh"
21
22 While the program is running, connect a visualization client to that
23 server. To do this you can run "charm/java/bin/liveViz localhost 1234"
24 Note that port 1234 is the port specified in runserver.sh. You should
25 at this point see a window appear, with a black background, and
26 a red/white grid in the upper left corner. Resize as needed. The parallel
27 server job should also print out a series of lines whenever each worker
28 is requested to provide a portion of the frame. Resizing the client
29 window will cause the image to be requested again, but with a different
30 size. The client can only connect while the server is running. So you may 
31 have to be quick to get to see anything. You may want to make the client 
32 perform more iterations so that you have more time to see things.