aboutsummaryrefslogtreecommitdiff
path: root/doc/html/UCDwriter.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/UCDwriter.html')
-rw-r--r--doc/html/UCDwriter.html57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/html/UCDwriter.html b/doc/html/UCDwriter.html
new file mode 100644
index 0000000..1dec11c
--- /dev/null
+++ b/doc/html/UCDwriter.html
@@ -0,0 +1,57 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<html>
+ <head>
+ <title>UCD Writer</title>
+ </head>
+
+ <body bgcolor="#F0F0F0">
+ <h1>UCD Writer</h1>
+
+ The UCD Writer stores finite-element cell-connectivity data.
+ The UCD format is used by popular FEM simulation packages like
+ ABAQUS and by visualization systems like AVS and Explorer. It
+ is also a useful format to store AMR data into for visualization
+ systems since virtually no visualization system understands
+ heirarchial grids.<p>
+
+ The writer API has a lot of <b>beginSomething()</b> and
+ <b>endSomething()</b> statements. This is because there may
+ be several independent lists of nodes and cells at a given
+ timestep in a completely arbitrary UCD dataset. This
+ interface allows this to be dealt with in pieces.<p>
+
+ <h2>The API</h2>
+ <UL>
+ <LI><a href="#CPP">C++ Interface</a>
+ <LI><a href="#C">C Interface</a>
+ <LI><a href="#F77">F77/F90 Interface</a>
+ </UL>
+ <hr>
+ <a name="CPP">C++ Interface</a>
+ <DL>
+ <DT><i>constructor</i> <b>UCDwriter::UCDWriter(
+ IObase &iofile,
+ IObase::DataType defaultnodetype=IObase::Float32,
+ IObase::DataType defaultcelltype=IObase::Int32
+ )</b>
+ <DD>The <i>filehandle</i> is an already open IEEEIO or HDFIO
+ file. This initializes the reader and attaches it to that
+ datafile. You can optionally set the datatype for the
+ node/vertex coordinates and the cell indices. Normally
+ these would be Float32 and Int32 respectively.
+ <DT><i>destructor</i> <b>UCDwriter::~UCDwriter()</b>
+ <DD>This flushes all of the necessary file buffers and
+ destroys the UCDwriter object.
+ The filehandle that the writer was bound to must be
+ closed separately though.
+ <DT>
+ </DL>
+
+ <hr>
+ <address><a href="mailto:jshalf@suttung.aei-potsdam.mpg.de">John Shalf</a></address>
+<!-- Created: Wed May 7 13:17:28 MDT 1997 -->
+<!-- hhmts start -->
+Last modified: Wed May 7 13:32:18 MDT
+<!-- hhmts end -->
+ </body>
+</html>