Homec4science
Diffusion SP4E Homework (master) Browse

SP4EHW_IM/HW3/html/particles__factory__interface_8hh_source.html
aad874266798master

Last Change
Raw File

particles__factory__interface_8hh_source.html
View Options

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>particles: particles_factory_interface.hh 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">particles
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">particles_factory_interface.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="particles__factory__interface_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __PARTICLES_FACTORY_INTERFACE__HH__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __PARTICLES_FACTORY_INTERFACE__HH__</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">/* -------------------------------------------------------------------------- */</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="system__evolution_8hh.html">system_evolution.hh</a>&quot;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">/* -------------------------------------------------------------------------- */</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="class_particles_factory_interface.html"> 9</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_particles_factory_interface.html">ParticlesFactoryInterface</a> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="comment">// Constructors/Destructors</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <a class="code" href="class_particles_factory_interface.html#a9938996df4b575e0ad2a12d4df18c602">ParticlesFactoryInterface</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_particles_factory_interface.html#a15cd55ffe2a6aa5d2cadeac48ce051d6">~ParticlesFactoryInterface</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// Methods</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_system_evolution.html">SystemEvolution</a>&amp; <a class="code" href="class_particles_factory_interface.html#abdca99efbdc5b383fe6d0c6f8f6de8da">createSimulation</a>(<span class="keyword">const</span> std::string&amp; fname,</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="my__types_8hh.html#a4b04262b81aa7d31eb5d2f607e2a35de">Real</a> timestep) = 0;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">virtual</span> std::unique_ptr&lt;Particle&gt; <a class="code" href="class_particles_factory_interface.html#a2e7fbd7b8e00f7cbd02885ebc19b7a6c">createParticle</a>() = 0;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">static</span> <a class="code" href="class_particles_factory_interface.html">ParticlesFactoryInterface</a>&amp; <a class="code" href="class_particles_factory_interface.html#af61f368236fe292fb2f2c1bdb79ec7d2">getInstance</a>();</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// Members</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="class_particles_factory_interface.html#a99aa7ac6268839cc2f50893932fd3a11"> 31</a></span>&#160; std::vector&lt;Particle*&gt; <a class="code" href="class_particles_factory_interface.html#a99aa7ac6268839cc2f50893932fd3a11">list_particles</a>;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_particles_factory_interface.html#a908b578a9e7d00bc269eac4f186a6c67"> 32</a></span>&#160; std::unique_ptr&lt;SystemEvolution&gt; <a class="code" href="class_particles_factory_interface.html#a908b578a9e7d00bc269eac4f186a6c67">system_evolution</a> = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// Standard pointer because constructor is protected (cannot use make_unique)</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_particles_factory_interface.html#a0f02e33a49874537af42fbe5326f61fa"> 35</a></span>&#160; <span class="keyword">static</span> <a class="code" href="class_particles_factory_interface.html">ParticlesFactoryInterface</a>* <a class="code" href="class_particles_factory_interface.html#a0f02e33a49874537af42fbe5326f61fa">factory</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;};</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment">/* -------------------------------------------------------------------------- */</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#endif //__PARTICLES_FACTORY_INTERFACE__HH__</span></div><div class="ttc" id="class_particles_factory_interface_html_a0f02e33a49874537af42fbe5326f61fa"><div class="ttname"><a href="class_particles_factory_interface.html#a0f02e33a49874537af42fbe5326f61fa">ParticlesFactoryInterface::factory</a></div><div class="ttdeci">static ParticlesFactoryInterface * factory</div><div class="ttdef"><b>Definition:</b> particles_factory_interface.hh:35</div></div>
<div class="ttc" id="class_particles_factory_interface_html_a9938996df4b575e0ad2a12d4df18c602"><div class="ttname"><a href="class_particles_factory_interface.html#a9938996df4b575e0ad2a12d4df18c602">ParticlesFactoryInterface::ParticlesFactoryInterface</a></div><div class="ttdeci">ParticlesFactoryInterface()=default</div><div class="ttdoc">Instance constructor (protected) </div></div>
<div class="ttc" id="class_particles_factory_interface_html_a2e7fbd7b8e00f7cbd02885ebc19b7a6c"><div class="ttname"><a href="class_particles_factory_interface.html#a2e7fbd7b8e00f7cbd02885ebc19b7a6c">ParticlesFactoryInterface::createParticle</a></div><div class="ttdeci">virtual std::unique_ptr&lt; Particle &gt; createParticle()=0</div><div class="ttdoc">Create a new particle. </div></div>
<div class="ttc" id="class_particles_factory_interface_html_af61f368236fe292fb2f2c1bdb79ec7d2"><div class="ttname"><a href="class_particles_factory_interface.html#af61f368236fe292fb2f2c1bdb79ec7d2">ParticlesFactoryInterface::getInstance</a></div><div class="ttdeci">static ParticlesFactoryInterface &amp; getInstance()</div><div class="ttdoc">Get singleton instance. </div><div class="ttdef"><b>Definition:</b> particles_factory_interface.cc:4</div></div>
<div class="ttc" id="class_particles_factory_interface_html_abdca99efbdc5b383fe6d0c6f8f6de8da"><div class="ttname"><a href="class_particles_factory_interface.html#abdca99efbdc5b383fe6d0c6f8f6de8da">ParticlesFactoryInterface::createSimulation</a></div><div class="ttdeci">virtual SystemEvolution &amp; createSimulation(const std::string &amp;fname, Real timestep)=0</div><div class="ttdoc">Create a whole simulation from file. </div></div>
<div class="ttc" id="system__evolution_8hh_html"><div class="ttname"><a href="system__evolution_8hh.html">system_evolution.hh</a></div></div>
<div class="ttc" id="class_particles_factory_interface_html_a15cd55ffe2a6aa5d2cadeac48ce051d6"><div class="ttname"><a href="class_particles_factory_interface.html#a15cd55ffe2a6aa5d2cadeac48ce051d6">ParticlesFactoryInterface::~ParticlesFactoryInterface</a></div><div class="ttdeci">virtual ~ParticlesFactoryInterface()=default</div></div>
<div class="ttc" id="class_particles_factory_interface_html_a99aa7ac6268839cc2f50893932fd3a11"><div class="ttname"><a href="class_particles_factory_interface.html#a99aa7ac6268839cc2f50893932fd3a11">ParticlesFactoryInterface::list_particles</a></div><div class="ttdeci">std::vector&lt; Particle * &gt; list_particles</div><div class="ttdef"><b>Definition:</b> particles_factory_interface.hh:31</div></div>
<div class="ttc" id="class_system_evolution_html"><div class="ttname"><a href="class_system_evolution.html">SystemEvolution</a></div><div class="ttdoc">Manager for system evolution. </div><div class="ttdef"><b>Definition:</b> system_evolution.hh:10</div></div>
<div class="ttc" id="class_particles_factory_interface_html_a908b578a9e7d00bc269eac4f186a6c67"><div class="ttname"><a href="class_particles_factory_interface.html#a908b578a9e7d00bc269eac4f186a6c67">ParticlesFactoryInterface::system_evolution</a></div><div class="ttdeci">std::unique_ptr&lt; SystemEvolution &gt; system_evolution</div><div class="ttdef"><b>Definition:</b> particles_factory_interface.hh:32</div></div>
<div class="ttc" id="class_particles_factory_interface_html"><div class="ttname"><a href="class_particles_factory_interface.html">ParticlesFactoryInterface</a></div><div class="ttdoc">Abstract factory defining interface. </div><div class="ttdef"><b>Definition:</b> particles_factory_interface.hh:9</div></div>
<div class="ttc" id="my__types_8hh_html_a4b04262b81aa7d31eb5d2f607e2a35de"><div class="ttname"><a href="my__types_8hh.html#a4b04262b81aa7d31eb5d2f607e2a35de">Real</a></div><div class="ttdeci">double Real</div><div class="ttdef"><b>Definition:</b> my_types.hh:9</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
c4science · Help