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

root/gliderproc/trunk/MATLAB/opnml/html/1/opnml.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 .]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>opnml</H1>
6 <H2>(./opnml.m)</H2>
7 <HR><H3>Help text</H3>
8 <pre>
9   OPNML/matlab Contents list:
10   Last Update: 2 Feb 1999
11   Contact: Brian Blanton
12            Department of Marine Sciences
13            Ocean Processes Numerical Modeling Laboratory
14            15-1A Venable Hall
15            CB# 3300
16            Uni. of North Carolina
17            Chapel Hill, NC
18                  27599-3300
19
20            919-962-4466
21            blanton@marine.unc.edu
22
23   NOTES: Functions designated with (*) were written outside of OPNML.
24          Type &quot;help &lt;function-name&gt;&quot; at the MATLAB prompt &quot;&gt;&gt;&quot; for more
25          information on any function below.
26  
27         <A HREF = "../1../opnmlinit.html">OPNMLINIT</A>  -  initialization function for accesing OPNML routines
28                       and data directories.  This routine calls SETDIRS
29                       to specify the data directories and other FEM
30                       things.  For a Contents list of the OPNML
31                      directory, type &quot;help opnml&quot; at the matlab prompt
32                      &gt;&gt;.  The function <A HREF = "../1../opnmlinit.html">OPNMLINIT</A> must called from
33                      your <A HREF = "../1../startup.html">startup</A>.m file in your local home matlab
34                      directory, $HOME/matlab/<A HREF = "../1../startup.html">startup</A>.m  This file should
35                      atleast look like:
36                      
37                      path(path,'/usr/local/OPNML/matlab');
38                      <A HREF = "../1../opnmlinit.html">opnmlinit</A>
39
40                    
41   Finite-Element specific routines:
42        BWIDTH       - compute bandwidth of an element list (.ele)
43        COLORMESH2D  - draw FEM mesh in 2-D with color scaling
44        COLORMESH3D  - draw FEM mesh in 3-D with color scaling
45        DELCONT      - delete all objects related to LCONTOUR2
46        DELVEC       - delete all objects related to VECPLOT2
47        DETBNDY      - compute a boundary node list from an element and
48                       node list
49         DRAWELEMS    - draw element picture
50        ELGEN        - generate a transect element list
51        ELE2NEI      - build a neighbor list from an element list
52        LABCONT      - label contours drawn with LCONTOUR2
53         LCONTOUR     - plot a contour given mesh data and 1-D vector
54        LOADGRID     - load .ele, .nod, .bat, and .bnd files for a
55                       specified grid and return to workspace
56        MARKCCW      - mark CounterClockWise oriented tidal ellisese
57                       with an asterisk (*)
58         NUMBND       - number boundary nodes within viewing window
59         NUMELEMS     - number elements within viewing window
60         NUMNODES     - number nodes within viewing window
61         NUMSCAL      - number nodes in viewing window with scalar values
62         PLOTDROG     - plot DROG3D or DROG3DDT .pth filetype
63        READ_NEI     - read FEM .nei filetype
64        READ_PTH     - read DROG3D or DROG3DDT .pth filetype
65        READ_S2R     - read FEM .s2r filetype
66        READ_S3C     - read FEM .s3c filetype
67        READ_TRN     - read FEM .trn transect filetype
68        READ_V2C     - read FEM .v2c or .v3r filetypes
69        READ_V2R     - read FEM .v2r, .s2c, or .s3r filetypes
70        READ_V3C     - read FEM .v3c filetype
71        READ_VEL     - read FEM .vel filetype
72        RESCALE      - redraw vector plot with different vector scale
73        STICKPLOT    - high-level vector plotter with sticks and dots
74        TELLIPSE     - draw ellipses based on amp-phase field definition
75         VECPLOT2     - high-level vector plotter with arrowheads
76        WRITE_NEI    - write a FEM neighbor file
77        
78   Atomic routines called by above functions:
79        DRAWSTICK  - compute and draw vectors based on vector origins
80                      and magnitudes with sticks and dots at origins
81         DRAWVEC    - same as DRAWSTICK but with arrowheads
82        ELLIPSE    - draw ellipses based on major, minor axis data
83        ELLSCALE   - include a vector scale on an ellipse picture
84        GET_DEPTHS - load and return 1-column depth vector
85        GET_ELEMS  - load and return 3-column element matrix
86        GET_NODES  - load and return 2-column node matrix
87        MOVETEXT   - move a text object on the current axes
88        PLOTBND    - plot boundary of FEM domain from (x,y) and
89                     boundary list
90        VECSCALE   - draw a vector scale on the current figure with
91                      size equal to the largest vector in the viewing
92                      window multiplied by a scaling factor
93    
94   General routines (not finite-element specific)
95      AZ_EL        - slider(widget)-driven 3-D azimuth and elevation control
96      AMPPHATOSC   - convert amp-pha field to scalar field at time t
97      AP_TO_RI_DEG - convert amp/phase to real/imag, assuming degrees
98      AP_TO_RI_RAD - convert amp/phase to real/imag, assuming radians
99      BLANK        - remove leading and trailing whitespace from string
100      CHAXIS       - button-driven axis editing panel
101      CIRCLES      - plot circles with radii and optional origins
102      COLORMENU2(*)- menu-driven colormap selector
103      DELFIG       - draw a 'delete figure' button in the lower-left
104                      corner of the current figure (window)
105      DELTEXT      - remove all text objects from current axes
106      FULLPAGE     - generate a plotting window that is ~8.5X11 inches
107                     for production-sized plots
108      GEN_DROG_GRID- mouse-driven initial contidion generator for DROG3D
109      GTEXT2       - place text on axes with different font attributes;
110                     an OPNML enhancement of MATLAB's GTEXT
111      HLINE         - draw a horizontal line on current axes
112      ISINT        - determine if input is integer
113      ISOBJ(*)     - determine if given handle is a valid object
114      LANDPAGE     - set up an ~11x8.5 plotting region
115      MOVETEXT     - move text objects on the figure
116      PAN           - move viewing window to a new center; mouse-driven
117      PLOTYY(*)    - plot graphs with Y tick labels on left and right side
118      PRINTFILE    - create a dialog box to print figures to files
119      PRINTSETUP   - create an interactive printed-page layout editor
120      PRMENU       - set up selection menus at top of current figure (window)
121      RGB          - Red/GreenBlue color editor
122      RI_TO_AP_DEG - convert real/imag to amp/phase, assuming degrees
123      RI_TO_AP_RAD - convert real/imag to amp/phase, assuming radians
124      SCRANGE      - compute and return the range (min &amp; max) of a matrix
125      SETALLLIMS   - set all axes limits on the current figure to the
126                     same set of limits
127      TRANSLINES   - plot user-specified lines of current axes and
128                     report end-points
129      VLINE         - draw a vertical line on current axes
130      WYSIWYG(*)   - changes the size of the figure on the screen to equal
131                     the size of the figure that would be printed
132      Y2LABEL(*)   - Y-axis label for second y-axis created using PLOTYY
133                      driven
134 </pre>
135 <HR>
136 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
137 <BR>
138 Cross-Directory links are: OFF<BR>
139 </BODY>
Note: See TracBrowser for help on using the browser.