1 files changed, 28 insertions, 0 deletions
diff --git a/src/AMRHierLib/README b/src/AMRHierLib/README
new file mode 100644
index 0000000..011d37d
--- /dev/null
+++ b/src/AMRHierLib/README
@@ -0,0 +1,28 @@
+These classes are intended to give a higher level access to AMR hierarchies in
+FlexIO format. Unfortunately they grew as I just became accustomed to the AMR
+format and still contain provisions due to some initial misconceptions on my
+part (i.e. trying to handle incompletely refined grid cells being the severest
+example). They were left in the library because they sometimes come in handy
+when experimenting with AMR data (e.g. throwing away boundary cells for higher
+order interpolation, etc.). Ultimately they should be discarded.
+
+All this is work in progress and still needs to be tweaked to work. It was
+sufficient to generate the images in the papers I wrote, but I may have broken
+one thing or the other when I made changes. So take these sources as they are
+and expect some problems when using them.
+
+The grid stitching code can be found in AMRGridStitcher.hh and AMRGridStitcher.cc.
+WriteStitchCells.cc and StitchCellWriter.hh, StitchCellWriter.cc is an example
+for using it to write the stitch cells to a file. A description of the grid
+stitching can be found in:
+
+Weber, G.H., Kreylos, O., Ligocki, T.J., Shalf, J.M., Hagen, H., Hamann, B.
+and Joy, K.I. (2002), "Extraction of crack-free isosurfaces from adaptive
+mesh refinement data," to appear in: Farin, G., Hagen, H. and Hamann, B.,
+eds., Hierarchical and Geometrical Methods in Scientific Visualization,
+Springer-Verlag, Heidelberg, Germany.
+
+A pdf version of the paper is available at
+http://graphics.cs.ucdavis.edu/~hamann/WeberKreylosLigockiShalfHagenHamannJoy2002.pdf
+
+Gunther H Weber (weber@informatik.uni-kl.de)