-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharrayParticleSet_8hpp_source.html
More file actions
113 lines (111 loc) · 11.9 KB
/
Copy patharrayParticleSet_8hpp_source.html
File metadata and controls
113 lines (111 loc) · 11.9 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
<!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>Pan-Pelagos-Core: src/particle/arrayParticleSet/arrayParticleSet.hpp 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="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">Pan-Pelagos-Core
</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ef4b772e52a9cad7a4172eb446d02024.html">particle</a></li><li class="navelem"><a class="el" href="dir_015f95b4294358f60bd94e093633896a.html">arrayParticleSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">arrayParticleSet.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="arrayParticleSet_8hpp.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">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include "<a class="code" href="particle_8hpp.html">particle/particle/particle.hpp</a>"</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="baseParticleSet_8hpp.html">particle/baseParticleSet/baseParticleSet.hpp</a>"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classArrayParticleSet.html"> 11</a></span> <span class="keyword">class </span><a class="code" href="classArrayParticleSet.html">ArrayParticleSet</a> : <span class="keyword">public</span> <a class="code" href="classBaseParticleSet.html">BaseParticleSet</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  std::vector<ParticleVariant> particles;</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>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="classArrayParticleSet.html#ab10af976cc5c74065a8f35b3fe3233df">ArrayParticleSet</a>(std::shared_ptr<BaseParticleReader> reader, std::shared_ptr<BaseParticleWriter> writer);</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classArrayParticleSet.html#ab10af976cc5c74065a8f35b3fe3233df"> 17</a></span>  <a class="code" href="classArrayParticleSet.html#ab10af976cc5c74065a8f35b3fe3233df">ArrayParticleSet</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classArrayParticleSet.html#a297841a62fbf23dedd745e7af965085c"> 18</a></span>  <a class="code" href="classArrayParticleSet.html#a297841a62fbf23dedd745e7af965085c">~ArrayParticleSet</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> <a class="code" href="classArrayParticleSet.html#a3e62a466bd47f56e8511bb9f2a91d4c0">deleteParticle</a>(<span class="keywordtype">int</span> idx) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">void</span> <a class="code" href="classArrayParticleSet.html#ae96d348287fb993cce7d3fd91ed2c15a">addParticle</a>(<a class="code" href="particleVariant_8hpp.html#a7b3fae86fe2e7c723e8b5fceaef92b1a">ParticleVariant</a> &<a class="code" href="namespacepymain.html#ad0adb6e3f7b0810e0b80a1a86227d6ed">p</a>) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordtype">void</span> <a class="code" href="classArrayParticleSet.html#a7b34ea62bb184519f7cace8604024c9b">write</a>(std::string <span class="keyword">const</span> &path) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">void</span> <a class="code" href="classArrayParticleSet.html#a952153caba3522b6828958a2a3524db8">read</a>(std::string <span class="keyword">const</span> &path) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  std::shared_ptr<BaseIterable> <a class="code" href="classArrayParticleSet.html#ad4c08f4c8f5094397a135d7cdc1eaa2d">getIterable</a>() <span class="keyword">override</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>  </div>
<div class="ttc" id="abaseParticleSet_8hpp_html"><div class="ttname"><a href="baseParticleSet_8hpp.html">baseParticleSet.hpp</a></div></div>
<div class="ttc" id="aclassArrayParticleSet_html"><div class="ttname"><a href="classArrayParticleSet.html">ArrayParticleSet</a></div><div class="ttdoc">Particle set class with std::vector container. Good for random access.</div><div class="ttdef"><b>Definition:</b> arrayParticleSet.hpp:11</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_a297841a62fbf23dedd745e7af965085c"><div class="ttname"><a href="classArrayParticleSet.html#a297841a62fbf23dedd745e7af965085c">ArrayParticleSet::~ArrayParticleSet</a></div><div class="ttdeci">~ArrayParticleSet()=default</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_a3e62a466bd47f56e8511bb9f2a91d4c0"><div class="ttname"><a href="classArrayParticleSet.html#a3e62a466bd47f56e8511bb9f2a91d4c0">ArrayParticleSet::deleteParticle</a></div><div class="ttdeci">void deleteParticle(int idx) override</div><div class="ttdef"><b>Definition:</b> arrayParticleSet.cpp:11</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_a7b34ea62bb184519f7cace8604024c9b"><div class="ttname"><a href="classArrayParticleSet.html#a7b34ea62bb184519f7cace8604024c9b">ArrayParticleSet::write</a></div><div class="ttdeci">void write(std::string const &path) override</div><div class="ttdoc">Creates a directory at path before writing.</div><div class="ttdef"><b>Definition:</b> arrayParticleSet.cpp:19</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_a952153caba3522b6828958a2a3524db8"><div class="ttname"><a href="classArrayParticleSet.html#a952153caba3522b6828958a2a3524db8">ArrayParticleSet::read</a></div><div class="ttdeci">void read(std::string const &path) override</div><div class="ttdoc">Populates the particle container from a std::vector of particles.</div><div class="ttdef"><b>Definition:</b> arrayParticleSet.cpp:25</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_ab10af976cc5c74065a8f35b3fe3233df"><div class="ttname"><a href="classArrayParticleSet.html#ab10af976cc5c74065a8f35b3fe3233df">ArrayParticleSet::ArrayParticleSet</a></div><div class="ttdeci">ArrayParticleSet()=default</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_ad4c08f4c8f5094397a135d7cdc1eaa2d"><div class="ttname"><a href="classArrayParticleSet.html#ad4c08f4c8f5094397a135d7cdc1eaa2d">ArrayParticleSet::getIterable</a></div><div class="ttdeci">std::shared_ptr< BaseIterable > getIterable() override</div><div class="ttdoc">Get an Iterable of the particle container. The particles container is specific to subclass and iterab...</div><div class="ttdef"><b>Definition:</b> arrayParticleSet.cpp:32</div></div>
<div class="ttc" id="aclassArrayParticleSet_html_ae96d348287fb993cce7d3fd91ed2c15a"><div class="ttname"><a href="classArrayParticleSet.html#ae96d348287fb993cce7d3fd91ed2c15a">ArrayParticleSet::addParticle</a></div><div class="ttdeci">void addParticle(ParticleVariant &p) override</div><div class="ttdef"><b>Definition:</b> arrayParticleSet.cpp:15</div></div>
<div class="ttc" id="aclassBaseParticleSet_html"><div class="ttname"><a href="classBaseParticleSet.html">BaseParticleSet</a></div><div class="ttdoc">Abstract base Particle Set class. All particle sets contain a reader and writer but subclasses use di...</div><div class="ttdef"><b>Definition:</b> baseParticleSet.hpp:15</div></div>
<div class="ttc" id="anamespacepymain_html_ad0adb6e3f7b0810e0b80a1a86227d6ed"><div class="ttname"><a href="namespacepymain.html#ad0adb6e3f7b0810e0b80a1a86227d6ed">pymain.p</a></div><div class="ttdeci">p</div><div class="ttdef"><b>Definition:</b> pymain.py:61</div></div>
<div class="ttc" id="aparticleVariant_8hpp_html_a7b3fae86fe2e7c723e8b5fceaef92b1a"><div class="ttname"><a href="particleVariant_8hpp.html#a7b3fae86fe2e7c723e8b5fceaef92b1a">ParticleVariant</a></div><div class="ttdeci">std::variant< CppParticle, FastCppParticle > ParticleVariant</div><div class="ttdef"><b>Definition:</b> particleVariant.hpp:16</div></div>
<div class="ttc" id="aparticle_8hpp_html"><div class="ttname"><a href="particle_8hpp.html">particle.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>