New I/O thorn for 1D/2D/3D output of datasets in SDF file format.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusIO/IOSDF/trunk@2 3af55ef0-e5e4-43b4-b020-ca5761ff09b2

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c300c69
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+Cactus Code Thorn IOSDF
+Authors    : Thomas Radke (tradke@aei.mpg.de)
+CVS info   : $Header$
+--------------------------------------------------------------------------
+
+1. Purpose of the thorn
+
+This thorn does 1D, 2D, and 3D output of grid variables in SDF file format.
+
+1D output slices through the edge (in octant mode) or center
+(in all origin-centered modes) of the grid in the x,y, and z directions.
+If the grid is cubed it will also slice in the diagonal direction.
+
+2D output is done for the xy, xz, and yz plane.
+
+3D output is simply done for the full 3D grid variables.
+
+The IO methods "IOSDF_1D", "IOSDF_2D", and "IOSDF_3D" are registered 
+which can be called by other thorns via CCTK_OutputVarAsByMethod()
+to output a variable without specifying it in the parameter file.
+
+
+2. Additional information
+
+See the thorn documentation and check out the "Data Visualization with DV and
+xvs" webpage http://localhost/CactusWebSite/VizTools/DataVaultXVSutils.html.
+
+
+3. Acknowledgements
+
+Thanks to Luis Lehner who had the idea for this thorn.