aboutsummaryrefslogtreecommitdiff
path: root/doc/html/UCDwriter.html
blob: 1dec11c8318456302c9dd085677a57090310c3dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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>