NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/gliderproc/trunk/MATLAB/opnml/html/4.IO_Functions/read_ucd.html

Revision 495 (checked in by cbc, 11 years ago)

Initial import of Stark code.

Line 
1 <TITLE>/</TITLE>
2 <BODY>
3 <A HREF = "index.html">[Index for ./IO_Functions]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>read_ucd</H1>
6 <H2>(./IO_Functions/read_ucd.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>ret_struct=read_ucd(inpname);</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 READ_UCD read an .inp file, an AVS-Unstructured Cell Data file with
12          uniform cell topology of type TRI.
13
14          For an unknown reason, AVS uses the suffix '.inp' to indicate
15          a input file for a UCD structure and not the obvious '.ucd',
16          even though the AVS routines which use UCD structures are called
17          UCD routines.  OPNML will adhere to this convention as well.
18          This unfortunately conflicts with the filename suffix for
19          the FUNDY series of FEM models.
20
21          This routine is provided as an &quot;interface&quot; between the
22          AVS-UCD datatype and OPNML/MATLAB in the loosest sense.
23          Currently, only the TRANSECT code and the transect routines
24          in QUODDY3.3 and later output a UCD-structure file.
25          The .trn (transect) filetype is obsolete.
26
27  Input:   If inpname is omitted, READ_UCD enables a file browser
28           with which the user can specify the .inp file.
29
30           Otherwise, READ_UCD takes as input the filename of the
31           transect data file, including the .inp suffix.
32
33  Output:  The output of READ_UCD is a fem_grid_struct containing the
34           transect information.  The output structure can be passed
35           directly to OPNML routines like COLORMESH2D, LCONTOUR, etc.
36           The actual data for the transect is attached to the structure
37           in the field .data.  This .data field  is as wide
38           as the number of columns in the node-data specification
39           part of the .inp file.  Vector components will be returned
40           as three scalars, NOT 1 vector.
41
42           Read the &quot;man&quot; page for TRANSECT (type &quot;man transect&quot; at a UNIX
43           prompt) for more information on the transect output formats.
44
45           Make sure a semi-colon is used at the end of the command;
46           otherwise READ_UCD will return the output arrays to the screen.
47
48           Since OPNML/MATLAB routines are based on linear triangular
49           finite elements in 2-D, READ_UCD only reads UCD structures
50           with cell-topologies of type TRI.  No other cell-types, or
51           mixtures of cell-types, are allowed into OPNML/MATLAB through
52           this routine.  THIS CLEARLY DOES NOT APPLY TO AVS.
53
54  Call as: transdata=read_ucd(inpname);         
55
56  Written by : Brian O. Blanton (Jun 98)
57
58 </pre>
59 <HR>
60 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
61 <BR>
62 Cross-Directory links are: OFF<BR>
63 </BODY>
Note: See TracBrowser for help on using the browser.