-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathProcessRoutingGR6J_8h_source.html
More file actions
195 lines (193 loc) · 18.4 KB
/
Copy pathProcessRoutingGR6J_8h_source.html
File metadata and controls
195 lines (193 loc) · 18.4 KB
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<!-- HTML header for doxygen 1.9.5-->
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hydrobricks: /github/workspace/core/src/processes/ProcessRoutingGR6J.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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">hydrobricks
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('ProcessRoutingGR6J_8h_source.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">ProcessRoutingGR6J.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef HYDROBRICKS_PROCESS_ROUTING_GR6J_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HYDROBRICKS_PROCESS_ROUTING_GR6J_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "Includes.h"</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "ProcessOutflow.h"</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="foldopen" id="foldopen00031" data-start="{" data-end="};">
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classProcessRoutingGR6J.html"> 31</a></span><span class="keyword">class </span><a class="code hl_class" href="classProcessRoutingGR6J.html">ProcessRoutingGR6J</a> : <span class="keyword">public</span> <a class="code hl_class" href="classProcessOutflow.html">ProcessOutflow</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classProcessRoutingGR6J.html">ProcessRoutingGR6J</a>(<a class="code hl_class" href="classWaterContainer.html">WaterContainer</a>* container);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_class" href="classProcessRoutingGR6J.html">~ProcessRoutingGR6J</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classProcessRoutingGR6J.html#ac5905325b5600fe1e78dba8064fa55ca">RegisterProcessSettings</a>(<a class="code hl_class" href="classSettingsModel.html">SettingsModel</a>* modelSettings);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classProcessRoutingGR6J.html#a3b1f9aa0bdde30dec796d048cf706abc">SetParameters</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structProcessSettings.html">ProcessSettings</a>& processSettings) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classProcessRoutingGR6J.html#ae37b027539ac7ca1e68fcf2217c05a95">Reset</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classProcessRoutingGR6J.html#ac179cb8b5741a826c00950a02380f012">Finalize</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">double</span>* <a class="code hl_function" href="classProcessRoutingGR6J.html#af0699035dd02f987250fbadfba6bb5eb">GetValuePointer</a>(std::string_view name) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> [[nodiscard]] <span class="keyword">const</span> vecDouble& <a class="code hl_function" href="classProcessRoutingGR6J.html#a451a043fdc2213ec183d01a99fe65911">GetChangeRates</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> <span class="keywordtype">float</span>* _exchangeFactor; <span class="comment">// X2 [mm/d]</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">const</span> <span class="keywordtype">float</span>* _routingCapacity; <span class="comment">// X3 [mm]</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">const</span> <span class="keywordtype">float</span>* _uhBaseTime; <span class="comment">// X4 [d]</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">const</span> <span class="keywordtype">float</span>* _exchangeThreshold; <span class="comment">// X5 [-]</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">const</span> <span class="keywordtype">float</span>* _expStoreCoeff; <span class="comment">// X6 [mm]</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// Unit-hydrograph convolution buffers (length changes with X4)</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> vecDouble _stuh1;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> vecDouble _stuh2;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// Pre-computed UH ordinates</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> vecDouble _uh1Ord;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> vecDouble _uh2Ord;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// Store levels [mm] — updated in Finalize()</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">double</span> _r; <span class="comment">// power routing store</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">double</span> _rexp; <span class="comment">// exponential store (may be negative)</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// Logged discharge components exposed via GetValuePointer</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">double</span> _qr;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">double</span> _qrexp;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">double</span> _qd;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// Cached total process-internal water storage for water balance logging</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">double</span> _processStorage;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">const</span> vecDouble& <a class="code hl_function" href="classProcessRoutingGR6J.html#a78a9de207d95726693674a7e1eafc7cf">GetRates</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classProcessRoutingGR6J.html#a22490f135117f29dc4a4050edd3cab17">_recomputeUH</a>();</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>};</div>
</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="preprocessor">#endif </span><span class="comment">// HYDROBRICKS_PROCESS_ROUTING_GR6J_H</span></div>
<div class="ttc" id="aclassProcessOutflow_html"><div class="ttname"><a href="classProcessOutflow.html">ProcessOutflow</a></div><div class="ttdef"><b>Definition</b> ProcessOutflow.h:8</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html"><div class="ttname"><a href="classProcessRoutingGR6J.html">ProcessRoutingGR6J</a></div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.h:31</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_a22490f135117f29dc4a4050edd3cab17"><div class="ttname"><a href="classProcessRoutingGR6J.html#a22490f135117f29dc4a4050edd3cab17">ProcessRoutingGR6J::_recomputeUH</a></div><div class="ttdeci">void _recomputeUH()</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:220</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_a3b1f9aa0bdde30dec796d048cf706abc"><div class="ttname"><a href="classProcessRoutingGR6J.html#a3b1f9aa0bdde30dec796d048cf706abc">ProcessRoutingGR6J::SetParameters</a></div><div class="ttdeci">void SetParameters(const ProcessSettings &processSettings) override</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:42</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_a451a043fdc2213ec183d01a99fe65911"><div class="ttname"><a href="classProcessRoutingGR6J.html#a451a043fdc2213ec183d01a99fe65911">ProcessRoutingGR6J::GetChangeRates</a></div><div class="ttdeci">const vecDouble & GetChangeRates() override</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:91</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_a78a9de207d95726693674a7e1eafc7cf"><div class="ttname"><a href="classProcessRoutingGR6J.html#a78a9de207d95726693674a7e1eafc7cf">ProcessRoutingGR6J::GetRates</a></div><div class="ttdeci">const vecDouble & GetRates() override</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:98</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_ac179cb8b5741a826c00950a02380f012"><div class="ttname"><a href="classProcessRoutingGR6J.html#ac179cb8b5741a826c00950a02380f012">ProcessRoutingGR6J::Finalize</a></div><div class="ttdeci">void Finalize() override</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:155</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_ac5905325b5600fe1e78dba8064fa55ca"><div class="ttname"><a href="classProcessRoutingGR6J.html#ac5905325b5600fe1e78dba8064fa55ca">ProcessRoutingGR6J::RegisterProcessSettings</a></div><div class="ttdeci">static void RegisterProcessSettings(SettingsModel *modelSettings)</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:31</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_ae37b027539ac7ca1e68fcf2217c05a95"><div class="ttname"><a href="classProcessRoutingGR6J.html#ae37b027539ac7ca1e68fcf2217c05a95">ProcessRoutingGR6J::Reset</a></div><div class="ttdeci">void Reset() override</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:52</div></div>
<div class="ttc" id="aclassProcessRoutingGR6J_html_af0699035dd02f987250fbadfba6bb5eb"><div class="ttname"><a href="classProcessRoutingGR6J.html#af0699035dd02f987250fbadfba6bb5eb">ProcessRoutingGR6J::GetValuePointer</a></div><div class="ttdeci">double * GetValuePointer(std::string_view name) override</div><div class="ttdef"><b>Definition</b> ProcessRoutingGR6J.cpp:65</div></div>
<div class="ttc" id="aclassSettingsModel_html"><div class="ttname"><a href="classSettingsModel.html">SettingsModel</a></div><div class="ttdef"><b>Definition</b> SettingsModel.h:70</div></div>
<div class="ttc" id="aclassWaterContainer_html"><div class="ttname"><a href="classWaterContainer.html">WaterContainer</a></div><div class="ttdef"><b>Definition</b> WaterContainer.h:9</div></div>
<div class="ttc" id="astructProcessSettings_html"><div class="ttname"><a href="structProcessSettings.html">ProcessSettings</a></div><div class="ttdef"><b>Definition</b> SettingsModel.h:30</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c330bf96caf2ae7a48d1d88aea65ed18.html">processes</a></li><li class="navelem"><b>ProcessRoutingGR6J.h</b></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.12.0 </li>
</ul>
</div>
</body>
</html>