-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathERFPC_8H_source.html
More file actions
313 lines (311 loc) · 37.7 KB
/
ERFPC_8H_source.html
File metadata and controls
313 lines (311 loc) · 37.7 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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<!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/Particles/ERFPC.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('ERFPC_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">ERFPC.H</div> </div>
</div><!--header-->
<div class="contents">
<a href="ERFPC_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_PC_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ERF_PC_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">#ifdef ERF_USE_PARTICLES</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <AMReX_Particles.H></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <<a class="code" href="ERF__Constants_8H.html">ERF_Constants.H</a>></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">struct </span>ERFParticlesIntIdx</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  ncomps = 0</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</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>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">struct </span>ERFParticlesRealIdx</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  vx = 0,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  vy,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  vz,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  mass,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  temperature,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  ncomps</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> };</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>ERFParticleInitializations</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">/* list of particle initializations */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">const</span> std::string init_box_uniform = <span class="stringliteral">"box"</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>ERFParticleNames</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">const</span> std::string tracers = <span class="stringliteral">"tracer_particles"</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>ERFPC : <span class="keyword">public</span> amrex::ParticleContainer< 0, <span class="comment">// AoS real attributes</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  0, <span class="comment">// AoS integer attributes</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ERFParticlesRealIdx::ncomps, <span class="comment">// SoA real attributes</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  ERFParticlesIntIdx::ncomps, <span class="comment">// SoA integer attributes</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  amrex::DefaultAllocator ></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /*! Constructor */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  ERFPC ( amrex::ParGDBBase* a_gdb,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> std::string& a_name = <span class="stringliteral">"particles"</span> )</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  : <a class="code" href="namespaceamrex.html">amrex</a>::ParticleContainer< 0, <span class="comment">// AoS real attributes</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  0, <span class="comment">// AoS integer attributes</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  ERFParticlesRealIdx::ncomps, <span class="comment">// SoA real attributes</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  ERFParticlesIntIdx::ncomps, <span class="comment">// SoA integer attributes</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="namespaceamrex.html">amrex</a>::DefaultAllocator> (a_gdb)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  BL_PROFILE(<span class="stringliteral">"ERFPCPC::ERFPC()"</span>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  m_name = a_name;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  readInputs();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /*! Constructor */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  ERFPC ( <span class="keyword">const</span> amrex::Geometry& a_geom,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> amrex::DistributionMapping& a_dmap,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> amrex::BoxArray& a_ba,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">const</span> std::string& a_name = <span class="stringliteral">"particles"</span> )</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  : <a class="code" href="namespaceamrex.html">amrex</a>::ParticleContainer< 0, <span class="comment">// AoS real attributes</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  0, <span class="comment">// AoS integer attributes</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  ERFParticlesRealIdx::ncomps, <span class="comment">// SoA real attributes</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  ERFParticlesIntIdx::ncomps, <span class="comment">// SoA integer attributes</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="namespaceamrex.html">amrex</a>::DefaultAllocator> ( a_geom, a_dmap, a_ba )</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  BL_PROFILE(<span class="stringliteral">"ERFPCPC::ERFPC()"</span>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  m_name = a_name;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  readInputs();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span> </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /*! Initialize particles in domain */</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> InitializeParticles (<span class="keyword">const</span> <a class="code" href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">amrex::Real</a> time, <span class="keyword">const</span> std::unique_ptr<amrex::MultiFab>& a_ptr = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /*! Evolve particles for one time step */</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> EvolveParticles ( <span class="keywordtype">int</span>,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">amrex::Real</a>,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  amrex::Vector<amrex::Vector<amrex::MultiFab>>&,</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">const</span> amrex::Vector<std::unique_ptr<amrex::MultiFab>>& );</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /*! Get real-type particle attribute names */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> amrex::Vector<std::string> varNames ()<span class="keyword"> const</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  BL_PROFILE(<span class="stringliteral">"ERFPCPC::varNames()"</span>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">return</span> {AMREX_D_DECL(<span class="stringliteral">"xvel"</span>,<span class="stringliteral">"yvel"</span>,<span class="stringliteral">"zvel"</span>),<span class="stringliteral">"mass"</span>,<span class="stringliteral">"temperature"</span>};</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /*! Get real-type particle attribute names */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> amrex::Vector<std::string> meshPlotVarNames ()<span class="keyword"> const</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  BL_PROFILE(<span class="stringliteral">"ERFPCPC::varNames()"</span>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> {<span class="stringliteral">"mass_density"</span>};</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  }</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /*! Uses midpoint method to advance particles using flow velocity. */</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> AdvectWithFlow ( amrex::MultiFab*,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">int</span>,</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">amrex::Real</a>,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> std::unique_ptr<amrex::MultiFab>& );</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /*! Uses midpoint method to advance particles falling under gravity. */</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> AdvectWithGravity ( <span class="keywordtype">int</span>,</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">amrex::Real</a>,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> std::unique_ptr<amrex::MultiFab>& );</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /*! Interpolates flow temperature to particles */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ComputeTemperature ( <span class="keyword">const</span> amrex::MultiFab&,</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">int</span>,</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">amrex::Real</a>,</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">const</span> std::unique_ptr<amrex::MultiFab>& );</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> /*! Compute mass density */</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> massDensity ( amrex::MultiFab&,</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> amrex::MultiFab& a_z_phys_nd,</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> <span class="keywordtype">int</span>&, <span class="keyword">const</span> <span class="keywordtype">int</span>& a_comp = 0) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /*! Compute mesh variable from particles */</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> computeMeshVar( <span class="keyword">const</span> std::string& a_var_name,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  amrex::MultiFab& a_mf,</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> amrex::MultiFab& a_z_phys_nd,</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> a_lev)<span class="keyword"> const</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">if</span> (a_var_name == <span class="stringliteral">"mass_density"</span>) {</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  massDensity( a_mf, a_z_phys_nd, a_lev );</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  a_mf.setVal(0.0);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> /*! Specify if particles should advect with flow */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> setAdvectWithFlow (<span class="keywordtype">bool</span> a_flag)</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  {</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  BL_PROFILE(<span class="stringliteral">"ERFPCPC::setAdvectWithFlow()"</span>);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  m_advect_w_flow = a_flag;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }<span class="comment"></span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> /*! Specify if particles fall under gravity */</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> setAdvectWithGravity (<span class="keywordtype">bool</span> a_flag)</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  {</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  BL_PROFILE(<span class="stringliteral">"ERFPCPC::setAdvectWithGravity()"</span>);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  m_advect_w_gravity = a_flag;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  }</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// the following functions should ideally be private or protected, but need to be</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">// public due to CUDA extended lambda capture rules</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> /*! \brief Helper for ParticleToMesh operations on terrain-following grids.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * Generic CIC deposition from particles to a MultiFab. The caller provides</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * a device lambda `value_func(ptd, i)` that returns the per-particle scalar</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * to deposit (e.g. mass, number, flux). Implementation in ERFPCParticleToMesh.H.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">template</span><<span class="keyword">typename</span> ValueFunc></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">void</span> ERFPCParticleToMesh(amrex::MultiFab& a_mf,</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">const</span> amrex::MultiFab& a_z_phys_nd,</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">int</span> a_lev, <span class="keywordtype">int</span> a_comp,</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  ValueFunc&& value_func) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"></span> </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> /*! Default particle initialization */</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">void</span> initializeParticlesUniformDistributionInBox (<span class="keyword">const</span> std::unique_ptr<amrex::MultiFab>& a_ptr,</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">const</span> amrex::RealBox& particle_box);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span> </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> /*! Replace pos(2) (zeta) with the corresponding physical z, in place,</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * on every level. Used around plotfile writes so the on-disk</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * particles are in physical coordinates. */</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">void</span> ConvertZetaToZ (<span class="keyword">const</span> amrex::Vector<std::unique_ptr<amrex::MultiFab>>& a_z_phys_nd);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"></span> </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> /*! Inverse of ConvertZetaToZ: replace pos(2) (physical z) with zeta. */</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">void</span> ConvertZToZeta (<span class="keyword">const</span> amrex::Vector<std::unique_ptr<amrex::MultiFab>>& a_z_phys_nd);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> /*! Route fine-level particles whose position is outside the level's</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * BA down to coarser levels, so per-level Redistribute on the fine</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * level does not assert. */</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">void</span> ExtractAndRouteOORParticles ( <span class="keywordtype">int</span> a_lev );</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"></span> </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> /*! Diagnostic: count particles per level and halo (for AMR) */</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">void</span> CountParticlesPerLevelAndHalo ( <span class="keywordtype">int</span> a_finest_level );</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  </div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">bool</span> m_advect_w_flow; <span class="comment">/*!< advect with flow velocity */</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordtype">bool</span> m_advect_w_gravity; <span class="comment">/*!< advect under gravitational force */</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  </div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  amrex::RealBox m_particle_box; <span class="comment">/*!< box within which to place particles */</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  std::string m_name; <span class="comment">/*!< name of this particle species */</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  std::string m_initialization_type; <span class="comment">/*!< initial particle distribution type */</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordtype">int</span> m_ppc_init; <span class="comment">/*!< initial number of particles per cell */</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">amrex::Real</a> m_inject_start_time; <span class="comment">/*!< particles will only be initialized/injected if time >= m_inject_start_time */</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordtype">bool</span> m_initialized = <span class="keyword">false</span>; <span class="comment">/*!< have the particles been initialized */</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  </div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">bool</span> m_stable_redistribute; <span class="comment">/*!< use stable redistribute for deterministic simulations */</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"></span> </div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> /*! read inputs from file */</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> readInputs ();</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  </div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">bool</span> place_randomly_in_cells; <span class="comment">/*!< place particles at random positions? */</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> };</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  </div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aERF__Constants_8H_html"><div class="ttname"><a href="ERF__Constants_8H.html">ERF_Constants.H</a></div></div>
<div class="ttc" id="aERF__ShocInterface_8H_html_ab8a9d2a7cbf2084043f890c3d0a68f57"><div class="ttname"><a href="ERF__ShocInterface_8H.html#ab8a9d2a7cbf2084043f890c3d0a68f57">Real</a></div><div class="ttdeci">amrex::Real Real</div><div class="ttdef"><b>Definition:</b> ERF_ShocInterface.H:19</div></div>
<div class="ttc" id="anamespaceamrex_html"><div class="ttname"><a href="namespaceamrex.html">amrex</a></div><div class="ttdef"><b>Definition:</b> ERF_ConsoleIO.cpp:12</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_fbd11baa4baa1a8b78c4a3d08373cbc6.html">Particles</a></li><li class="navelem"><a class="el" href="ERFPC_8H.html">ERFPC.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>