source: trunk/SRC/Documentation/idldoc_html_output/Grid/romsdepth.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 3.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>romsdepth.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="romsdepth.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Grid//romsdepth.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="restoreboxparam.html">&lt;&lt;prev file</a> | <a href="saveboxparam.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="romsdepth.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Grid/</a></h1>
82      <h2 class="pro_file">romsdepth.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 compute depth of ROMS outputs according to ROMS parameters
91 stored in the common variable (cm_4mesh) romszinfos
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_romsdepth">
106
107          <h2><a class="top" href="#container">top</a>romsdepth <span class="categories">
108 Grid
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>romsdepth()</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 the depth of the points (or -1 if error)
119</div>
120
121         
122
123         
124
125         
126          <h3>Version history</h3>
127         
128          <h4>Version</h4><div class="preformat">
129 $Id: romsdepth.pro 370 2008-08-07 07:59:15Z pinsard $
130</div>
131          <h4>History</h4><div class="preformat">
132 Sept 2006 Sebastien Masson (smasson@lodyc.jussieu.fr)
133</div>
134         
135         
136          <h3>Known issues</h3>
137         
138         
139         
140          <h4>Restrictions</h4><div class="preformat">
141 common variable (<a href="..//Commons/cm_4mesh.html">cm_4mesh</a>) romszinfos must be correctly defined
142</div>
143       
144          <h3>Other attributes</h3>
145         
146         
147          <h4>Uses routines</h4><div class="preformat">
148 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a>
149 <a href="..//Commons/cm_4data.html">cm_4data</a>
150</div>
151         
152         
153         
154       
155          <h3>Statistics</h3>
156          <table class="statistics">
157            <tr><td>McCabe cyclic</td><td>           7</td></tr>
158            <tr><td>McCabe essential</td><td>           1</td></tr>
159            <tr><td>McCabe modular design</td><td>           1</td></tr>
160          </table>
161         
162       
163        </div>
164       
165      </div>
166
167     
168
169      <div id="tagline">Produced by IDLdoc 2.0.</div>
170
171    </div>
172
173  </body>
174</html>
Note: See TracBrowser for help on using the repository browser.