Skip to content

Commit

Permalink
Merge pull request #701 from gspetro-NOAA/text/gh-pages
Browse files Browse the repository at this point in the history 
Add htmls for documentation updated in PR #698
  • Loading branch information
@gspetro-NOAA
gspetro-NOAA committed May 9, 2023
2 parents f6f806f + 581da8a commit 420a7b2
Show file tree
Hide file tree
Showing 32 changed files with 2,671 additions and 2,133 deletions.
65 changes: 15 additions & 50 deletions CALHEL2_8f.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>UPP: CALHEL2.f File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
Expand All @@ -30,15 +30,15 @@
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">UPP
&#160;<span id="projectnumber">V11.0.0</span>
&#160;<span id="projectnumber">11.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
Expand Down Expand Up @@ -92,7 +92,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand All @@ -116,21 +116,21 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions/Subroutines</h2></td></tr>
<tr class="memitem:af4c008bab32f1815e5a3aabcc7a93176"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CALHEL2_8f.html#af4c008bab32f1815e5a3aabcc7a93176">CALHEL2</a> (LLOW, LUPP, DEPTH, UST, VST, HELI, CANGLE)</td></tr>
<tr class="memdesc:af4c008bab32f1815e5a3aabcc7a93176"><td class="mdescLeft">&#160;</td><td class="mdescRight">This routine computes estimated storm motion and storm-relative environmental helicity. <a href="#af4c008bab32f1815e5a3aabcc7a93176">More...</a><br/></td></tr>
<tr class="separator:af4c008bab32f1815e5a3aabcc7a93176"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d05f13ed56ac5ef73f92a84782554c1"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CALHEL2_8f.html#a7d05f13ed56ac5ef73f92a84782554c1">calhel2</a> (LLOW, LUPP, DEPTH, UST, VST, HELI, CANGLE)</td></tr>
<tr class="memdesc:a7d05f13ed56ac5ef73f92a84782554c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subroutine that computes storm relative helicity. <a href="#a7d05f13ed56ac5ef73f92a84782554c1">More...</a><br/></td></tr>
<tr class="separator:a7d05f13ed56ac5ef73f92a84782554c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Subroutine that computes storm relative helicity. </p>

<p>Definition in file <a class="el" href="CALHEL2_8f_source.html">CALHEL2.f</a>.</p>
</div><h2 class="groupheader">Function/Subroutine Documentation</h2>
<a class="anchor" id="af4c008bab32f1815e5a3aabcc7a93176"></a>
<a class="anchor" id="a7d05f13ed56ac5ef73f92a84782554c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine CALHEL2 </td>
<td class="memname">subroutine calhel2 </td>
<td>(</td>
<td class="paramtype">integer, dimension(ista_2l:iend_2u,jsta_2l:jend_2u), intent(in)&#160;</td>
<td class="paramname"><em>LLOW</em>, </td>
Expand Down Expand Up @@ -179,58 +179,23 @@
</table>
</div><div class="memdoc">

<p>This routine computes estimated storm motion and storm-relative environmental helicity. </p>
<p>(Davies-Jones et al 1990) the algorithm processd as follows.</p>
<p>The storm motion computation no longer employs the Davies and Johns (1993) method which defined storm motion as 30 degress to the right of the 0-6 km mean wind at 75% of the speed for mean speeds less than 15 m/s and 20 degrees to the right for speeds greater than 15 m/s. Instead, we now use the dynamic method (Bunkers et al. 1988) which has been found to do better in cases with 'non-classic' hodographs (such as Northwest-flow events) and do as well or better than the old method in more classic situations.</p>
<p>Subroutine that computes storm relative helicity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">LLOW</td><td>Lower bound CAPE&gt;=100 and CINS&gt;=-250. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">LUPP</td><td>Upper bound CAPE&lt; 100 or CINS&lt; -250; allows one to distinguish 0-3 km and 0-1 km values. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">DPTH</td><td>Depth in meters over whcih helicity should be computed; allows one to distinguish 0-3 km and 0-1 km values. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">DEPTH</td><td>Depth in meters over whcih helicity should be computed; allows one to distinguish 0-3 km and 0-1 km values. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">UST</td><td>Estimated U Component (m/s) Of Storm motion. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">VST</td><td>Estimated V Component (m/s) Of Storm motion. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">HELI</td><td>Storm-relative heliciry (m**2/s**2). </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">CANGLE</td><td>Critical angle. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">USHR1</td><td>U Component (m/s) Of 0-1 km shear. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">VSHR1</td><td>V Component (m/s) Of 0-1 km shear. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">USHR6</td><td>U Component (m/s) Of 0-0.5 to 5.5-6.0 km shear. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">VSHR6</td><td>V Component (m/s) Of 0-0.5 to 5.5-6.0 km shear.</td></tr>
</table>
</dd>
</dl>
<h3>Program history log:</h3>
<table class="doxtable">
<tr>
<th>Date </th><th>Programmer </th><th>Comments </th></tr>
<tr>
<td>1994-08-22 </td><td>Michael Baldwin </td><td>Initial </td></tr>
<tr>
<td>1997-03-27 </td><td>Michael Baldwin </td><td>Speed up code </td></tr>
<tr>
<td>1998-06-15 </td><td>T Black </td><td>Conversion from 1-D to 2-D </td></tr>
<tr>
<td>2000-01-04 </td><td>Jim Tuccillo </td><td>MPI Version </td></tr>
<tr>
<td>2000-01-10 </td><td>G Manikin </td><td>Changed to Bunkers method </td></tr>
<tr>
<td>2002-05-22 </td><td>G Manikin </td><td>Now allow choice of computing helicity over two different (0-1 and 0-3 km) depths </td></tr>
<tr>
<td>2003-03-25 </td><td>G Manikin </td><td>Modified code to compute mean winds using arithmetic averages instead of mass weighting; differences are minor but want to be consistent with the Bunkers method </td></tr>
<tr>
<td>2004-04-16 </td><td>M Pyle </td><td>Minimal modifications but put into NMM WRFPOST code </td></tr>
<tr>
<td>2005-02-25 </td><td>H Chuang </td><td>Add computation for ARW A grid </td></tr>
<tr>
<td>2005-07-07 </td><td>Binbin Zhou </td><td>Add RSM for A grid </td></tr>
<tr>
<td>2019-09-03 </td><td>J Meng </td><td>Modified to compute effective helicity and critical angle </td></tr>
<tr>
<td>2021-09-02 </td><td>Bo Cui </td><td>Decompose UPP in X direction </td></tr>
</table>
<dl class="section author"><dt>Author</dt><dd>Michael Baldwin W/NP2 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>1994-08-22 </dd></dl>

<p>Definition at line <a class="el" href="CALHEL2_8f_source.html#l00045">45</a> of file <a class="el" href="CALHEL2_8f_source.html">CALHEL2.f</a>.</p>
<p>Definition at line <a class="el" href="CALHEL2_8f_source.html#l00057">57</a> of file <a class="el" href="CALHEL2_8f_source.html">CALHEL2.f</a>.</p>

<p>Referenced by <a class="el" href="MISCLN_8f_source.html#l00089">miscln()</a>.</p>

</div>
</div>
Expand All @@ -242,7 +207,7 @@ <h3>Program history log:</h3>
<li class="navelem"><a class="el" href="dir_d8b772108138bf796aaa3f7fe4e09294.html">sorc</a></li><li class="navelem"><a class="el" href="dir_29f0049402def9fd0d109199f2d306c2.html">ncep_post.fd</a></li><li class="navelem"><a class="el" href="CALHEL2_8f.html">CALHEL2.f</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion CALHEL2_8f.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var CALHEL2_8f =
[
[ "CALHEL2", "CALHEL2_8f.html#af4c008bab32f1815e5a3aabcc7a93176", null ]
[ "calhel2", "CALHEL2_8f.html#a7d05f13ed56ac5ef73f92a84782554c1", null ]
];
Loading

0 comments on commit 420a7b2

Please sign in to comment.