-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathERF__ForestDrag_8H_source.html
154 lines (152 loc) · 16 KB
/
ERF__ForestDrag_8H_source.html
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ERF: Source/SourceTerms/ERF_ForestDrag.H Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ERF
</div>
<div id="projectbrief">Energy Research and Forecasting: An Atmospheric Modeling Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('ERF__ForestDrag_8H_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">ERF_ForestDrag.H</div> </div>
</div><!--header-->
<div class="contents">
<a href="ERF__ForestDrag_8H.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef ERF_FORESTDRAG_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ERF_FORESTDRAG_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <AMReX_MultiFab.H></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> ForestDrag flow physics adapted from:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Lalic & Mihailovic (2004)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> https://doi.org/10.1175/1520-0450(2004)043<0641:AERDLD>2.0.CO;2</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classForestDrag.html"> 12</a></span> <span class="keyword">class </span><a class="code" href="classForestDrag.html">ForestDrag</a></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">explicit</span> <a class="code" href="classForestDrag.html#a122891e509293a8cce46fe26ef94caca">ForestDrag</a> (std::string forestfile);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classForestDrag.html#acf2562ce29faa67b57b82a5998df3a95"> 18</a></span>  <a class="code" href="classForestDrag.html#acf2562ce29faa67b57b82a5998df3a95">~ForestDrag</a> () = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">void</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="classForestDrag.html#a3fcd26d6f5274c804db6bebceb267c2b">define_drag_field</a> (<span class="keyword">const</span> amrex::BoxArray& ba,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">const</span> amrex::DistributionMapping& dm,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  amrex::Geometry& geom,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  amrex::MultiFab* z_phys_cc,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  amrex::MultiFab* z_phys_nd);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  amrex::MultiFab*</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classForestDrag.html#abbfaec28be888963879442d65e61839c"> 28</a></span>  <a class="code" href="classForestDrag.html#abbfaec28be888963879442d65e61839c">get_drag_field</a> () { <span class="keywordflow">return</span> <a class="code" href="classForestDrag.html#acb32d6e1088af2621a723601500db7b3">m_forest_drag</a>.get(); }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classForestDrag.html#ad8061afe4ea0b11059a6094ae07243cf"> 31</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#ad8061afe4ea0b11059a6094ae07243cf">m_type_forest</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classForestDrag.html#a6f6067a4f71428c8ab3039240a3207e4"> 32</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#a6f6067a4f71428c8ab3039240a3207e4">m_x_forest</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classForestDrag.html#af1a72c6ce2a773a31ae0d6f84aa2aa71"> 33</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#af1a72c6ce2a773a31ae0d6f84aa2aa71">m_y_forest</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classForestDrag.html#a70219f7646623030f5eca622c0467f7a"> 34</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#a70219f7646623030f5eca622c0467f7a">m_height_forest</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classForestDrag.html#a17d88d33ff5abbdd20b28e2e841b09b7"> 35</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#a17d88d33ff5abbdd20b28e2e841b09b7">m_diameter_forest</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classForestDrag.html#ab8c2ba2f9e1a82a5e1b116df64dfb0f0"> 36</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#ab8c2ba2f9e1a82a5e1b116df64dfb0f0">m_cd_forest</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classForestDrag.html#a6b967bb106243fd365ca0aa2cd9aa457"> 37</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#a6b967bb106243fd365ca0aa2cd9aa457">m_lai_forest</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classForestDrag.html#a24d15eda91f5abc361c3c5b37fb45efd"> 38</a></span>  amrex::Vector<amrex::Real> <a class="code" href="classForestDrag.html#a24d15eda91f5abc361c3c5b37fb45efd">m_laimax_forest</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classForestDrag.html#acb32d6e1088af2621a723601500db7b3"> 39</a></span>  std::unique_ptr<amrex::MultiFab> <a class="code" href="classForestDrag.html#acb32d6e1088af2621a723601500db7b3">m_forest_drag</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassForestDrag_html"><div class="ttname"><a href="classForestDrag.html">ForestDrag</a></div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:13</div></div>
<div class="ttc" id="aclassForestDrag_html_a122891e509293a8cce46fe26ef94caca"><div class="ttname"><a href="classForestDrag.html#a122891e509293a8cce46fe26ef94caca">ForestDrag::ForestDrag</a></div><div class="ttdeci">ForestDrag(std::string forestfile)</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.cpp:9</div></div>
<div class="ttc" id="aclassForestDrag_html_a17d88d33ff5abbdd20b28e2e841b09b7"><div class="ttname"><a href="classForestDrag.html#a17d88d33ff5abbdd20b28e2e841b09b7">ForestDrag::m_diameter_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_diameter_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:35</div></div>
<div class="ttc" id="aclassForestDrag_html_a24d15eda91f5abc361c3c5b37fb45efd"><div class="ttname"><a href="classForestDrag.html#a24d15eda91f5abc361c3c5b37fb45efd">ForestDrag::m_laimax_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_laimax_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:38</div></div>
<div class="ttc" id="aclassForestDrag_html_a3fcd26d6f5274c804db6bebceb267c2b"><div class="ttname"><a href="classForestDrag.html#a3fcd26d6f5274c804db6bebceb267c2b">ForestDrag::define_drag_field</a></div><div class="ttdeci">void define_drag_field(const amrex::BoxArray &ba, const amrex::DistributionMapping &dm, amrex::Geometry &geom, amrex::MultiFab *z_phys_cc, amrex::MultiFab *z_phys_nd)</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.cpp:32</div></div>
<div class="ttc" id="aclassForestDrag_html_a6b967bb106243fd365ca0aa2cd9aa457"><div class="ttname"><a href="classForestDrag.html#a6b967bb106243fd365ca0aa2cd9aa457">ForestDrag::m_lai_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_lai_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:37</div></div>
<div class="ttc" id="aclassForestDrag_html_a6f6067a4f71428c8ab3039240a3207e4"><div class="ttname"><a href="classForestDrag.html#a6f6067a4f71428c8ab3039240a3207e4">ForestDrag::m_x_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_x_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:32</div></div>
<div class="ttc" id="aclassForestDrag_html_a70219f7646623030f5eca622c0467f7a"><div class="ttname"><a href="classForestDrag.html#a70219f7646623030f5eca622c0467f7a">ForestDrag::m_height_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_height_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:34</div></div>
<div class="ttc" id="aclassForestDrag_html_ab8c2ba2f9e1a82a5e1b116df64dfb0f0"><div class="ttname"><a href="classForestDrag.html#ab8c2ba2f9e1a82a5e1b116df64dfb0f0">ForestDrag::m_cd_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_cd_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:36</div></div>
<div class="ttc" id="aclassForestDrag_html_abbfaec28be888963879442d65e61839c"><div class="ttname"><a href="classForestDrag.html#abbfaec28be888963879442d65e61839c">ForestDrag::get_drag_field</a></div><div class="ttdeci">amrex::MultiFab * get_drag_field()</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:28</div></div>
<div class="ttc" id="aclassForestDrag_html_acb32d6e1088af2621a723601500db7b3"><div class="ttname"><a href="classForestDrag.html#acb32d6e1088af2621a723601500db7b3">ForestDrag::m_forest_drag</a></div><div class="ttdeci">std::unique_ptr< amrex::MultiFab > m_forest_drag</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:39</div></div>
<div class="ttc" id="aclassForestDrag_html_acf2562ce29faa67b57b82a5998df3a95"><div class="ttname"><a href="classForestDrag.html#acf2562ce29faa67b57b82a5998df3a95">ForestDrag::~ForestDrag</a></div><div class="ttdeci">~ForestDrag()=default</div></div>
<div class="ttc" id="aclassForestDrag_html_ad8061afe4ea0b11059a6094ae07243cf"><div class="ttname"><a href="classForestDrag.html#ad8061afe4ea0b11059a6094ae07243cf">ForestDrag::m_type_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_type_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:31</div></div>
<div class="ttc" id="aclassForestDrag_html_af1a72c6ce2a773a31ae0d6f84aa2aa71"><div class="ttname"><a href="classForestDrag.html#af1a72c6ce2a773a31ae0d6f84aa2aa71">ForestDrag::m_y_forest</a></div><div class="ttdeci">amrex::Vector< amrex::Real > m_y_forest</div><div class="ttdef"><b>Definition:</b> ERF_ForestDrag.H:33</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_74389ed8173ad57b461b9d623a1f3867.html">Source</a></li><li class="navelem"><a class="el" href="dir_7c1c0d2e2a0285e12a54f57a60f809aa.html">SourceTerms</a></li><li class="navelem"><a class="el" href="ERF__ForestDrag_8H.html">ERF_ForestDrag.H</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>