phasicFlow/doc/code-documentation/html/classpFlow_1_1demParticles....

210 lines
17 KiB
HTML

<!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.17"/>
<title>PhasicFlow: demParticles Class Reference</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classpFlow_1_1demParticles.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classpFlow_1_1demParticles-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">demParticles Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for demParticles:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1demParticles__inherit__graph.png" border="0" usemap="#demParticles_inherit__map" alt="Inheritance graph"/></div>
<map name="demParticles_inherit__map" id="demParticles_inherit__map">
<area shape="rect" title=" " alt="" coords="15,80,122,107"/>
<area shape="rect" href="classpFlow_1_1particles.html" title=" " alt="" coords="29,155,108,181"/>
<area shape="rect" href="classpFlow_1_1demComponent.html" title=" " alt="" coords="5,5,132,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for demParticles:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1demParticles__coll__graph.png" border="0" usemap="#demParticles_coll__map" alt="Collaboration graph"/></div>
<map name="demParticles_coll__map" id="demParticles_coll__map">
<area shape="rect" title=" " alt="" coords="15,80,122,107"/>
<area shape="rect" href="classpFlow_1_1demComponent.html" title=" " alt="" coords="5,5,132,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8c1c091fd33ba565c919cc8624a89345"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demParticles.html#a8c1c091fd33ba565c919cc8624a89345">demParticles</a> (<a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> &amp;<a class="el" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a>)</td></tr>
<tr class="separator:a8c1c091fd33ba565c919cc8624a89345"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classpFlow_1_1demComponent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpFlow_1_1demComponent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a></td></tr>
<tr class="memitem:a3145c3f3cba34861e279260ada91e0de inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a3145c3f3cba34861e279260ada91e0de">TypeInfo</a> (&quot;demComponent&quot;)</td></tr>
<tr class="separator:a3145c3f3cba34861e279260ada91e0de inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73e3f3cd6a8eca86e6862f02e416dba2 inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">demComponent</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;name, <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> &amp;<a class="el" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a>)</td></tr>
<tr class="separator:a73e3f3cd6a8eca86e6862f02e416dba2 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ab4d5fa34944c13f3a07ec25b4fd666 inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a9ab4d5fa34944c13f3a07ec25b4fd666">~demComponent</a> ()=default</td></tr>
<tr class="separator:a9ab4d5fa34944c13f3a07ec25b4fd666 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a647786897b3da03fcd415b2ebcf541c0 inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a> () const</td></tr>
<tr class="separator:a647786897b3da03fcd415b2ebcf541c0 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1afde9cfe19a586522259a33a4931e3 inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ae1afde9cfe19a586522259a33a4931e3">control</a> ()</td></tr>
<tr class="separator:ae1afde9cfe19a586522259a33a4931e3 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fc823022c8f0175108f10a42e7b858f inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a4fc823022c8f0175108f10a42e7b858f">dt</a> () const</td></tr>
<tr class="separator:a4fc823022c8f0175108f10a42e7b858f inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a476763249b99b131d7116430896cd44e inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a476763249b99b131d7116430896cd44e">currentTime</a> () const</td></tr>
<tr class="separator:a476763249b99b131d7116430896cd44e inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49e56dd259a0f440e947ed17b149f32f inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">timers</a> ()</td></tr>
<tr class="separator:a49e56dd259a0f440e947ed17b149f32f inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae69e59e991f33e7d278ff6ad19d2e87d inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">timers</a> () const</td></tr>
<tr class="separator:ae69e59e991f33e7d278ff6ad19d2e87d inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87d9b39a0e924bb21ed4a165140836de inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a87d9b39a0e924bb21ed4a165140836de">beforeIteration</a> ()=0</td></tr>
<tr class="separator:a87d9b39a0e924bb21ed4a165140836de inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9e44c3349e7a9a5b6ba72c9db344b96 inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ad9e44c3349e7a9a5b6ba72c9db344b96">iterate</a> ()=0</td></tr>
<tr class="separator:ad9e44c3349e7a9a5b6ba72c9db344b96 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7d2399b393b6dfa6f00ad9bcd524437 inherit pub_methods_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ac7d2399b393b6dfa6f00ad9bcd524437">afterIteration</a> ()=0</td></tr>
<tr class="separator:ac7d2399b393b6dfa6f00ad9bcd524437 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classpFlow_1_1demComponent"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classpFlow_1_1demComponent')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a></td></tr>
<tr class="memitem:a3ce96806ed72189c4d9a24e9429d0420 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a3ce96806ed72189c4d9a24e9429d0420">componentName_</a></td></tr>
<tr class="separator:a3ce96806ed72189c4d9a24e9429d0420 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfbc3debb472c661c30cf9fe782bb076 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">control_</a></td></tr>
<tr class="separator:abfbc3debb472c661c30cf9fe782bb076 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c29ef9514a77bce5b8f4ece533bcf8c inherit pro_attribs_classpFlow_1_1demComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1Timers.html">Timers</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">timers_</a></td></tr>
<tr class="separator:a0c29ef9514a77bce5b8f4ece533bcf8c inherit pro_attribs_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="demParticles_8hpp_source.html#l00031">31</a> of file <a class="el" href="demParticles_8hpp_source.html">demParticles.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8c1c091fd33ba565c919cc8624a89345"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c1c091fd33ba565c919cc8624a89345">&#9670;&nbsp;</a></span>demParticles()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1demParticles.html">demParticles</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> &amp;&#160;</td>
<td class="paramname"><em>control</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="demParticles_8hpp_source.html#l00038">38</a> of file <a class="el" href="demParticles_8hpp_source.html">demParticles.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Particles/particles/<a class="el" href="demParticles_8hpp_source.html">demParticles.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1demParticles.html">demParticles</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>