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

466 lines
34 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"/>
<meta name="description" content="PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.">
<title>PhasicFlow: InsertionRegion&lt; ShapeType &gt; Class Template 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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" >
<tbody>
<tr>
<td id="projectlogo"><a href="https://github.com/PhasicFlow"><img alt="Logo" src="phasicFlow_logo.png"></a></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>
<tr>
<td id="projectbrief">
<a href="https://https://cemf.ir">www.cemf.ir</a>
</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_1InsertionRegion.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="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classpFlow_1_1InsertionRegion-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">InsertionRegion&lt; ShapeType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This manages insertion of particles from a region based on the ShapeType.
<a href="classpFlow_1_1InsertionRegion.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for InsertionRegion&lt; ShapeType &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1InsertionRegion__inherit__graph.png" border="0" usemap="#InsertionRegion_3_01ShapeType_01_4_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for InsertionRegion&lt; ShapeType &gt;:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1InsertionRegion__coll__graph.png" border="0" usemap="#InsertionRegion_3_01ShapeType_01_4_coll__map" alt="Collaboration graph"/></div>
<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:aa341711c6ff073dcf9a1971499e64b95"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1InsertionRegion.html#aa341711c6ff073dcf9a1971499e64b95">TypeInfoTemplateNV11</a> (&quot;insertionRegion&quot;, ShapeType)</td></tr>
<tr class="memdesc:aa341711c6ff073dcf9a1971499e64b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type info. <a href="classpFlow_1_1InsertionRegion.html#aa341711c6ff073dcf9a1971499e64b95">More...</a><br /></td></tr>
<tr class="separator:aa341711c6ff073dcf9a1971499e64b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a165562ec900ed713e5588950e1e564df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1InsertionRegion.html#a165562ec900ed713e5588950e1e564df">InsertionRegion</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;<a class="el" href="classpFlow_1_1insertionRegion.html#a5a9652837ba1c412a239fec1ff02e88b">name</a>, const <a class="el" href="classpFlow_1_1insertion.html">insertion</a> &amp;instn, const ShapeType &amp;shapes)</td></tr>
<tr class="memdesc:a165562ec900ed713e5588950e1e564df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from dictionary. <a href="classpFlow_1_1InsertionRegion.html#a165562ec900ed713e5588950e1e564df">More...</a><br /></td></tr>
<tr class="separator:a165562ec900ed713e5588950e1e564df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4ade4fda8b1e4e1cac71190d8d4a85a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1InsertionRegion.html#ad4ade4fda8b1e4e1cac71190d8d4a85a">~InsertionRegion</a> ()=default</td></tr>
<tr class="separator:ad4ade4fda8b1e4e1cac71190d8d4a85a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15158008d33c145a2a4f346c797684ed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1InsertionRegion.html#a15158008d33c145a2a4f346c797684ed">insertParticles</a> (<a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> iter, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> t, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="el" href="namespacepFlow.html#a6e76b0fc4f41684b7dd691cb6552384d">wordVector</a> &amp;names, <a class="el" href="namespacepFlow.html#aede0f5a4a44d271e4e260cdb01032a61">realx3Vector</a> &amp;pos, bool &amp;insertionOccured)</td></tr>
<tr class="memdesc:a15158008d33c145a2a4f346c797684ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert particles at current time t Check if currentTime is the right moment for particle insertion. <a href="classpFlow_1_1InsertionRegion.html#a15158008d33c145a2a4f346c797684ed">More...</a><br /></td></tr>
<tr class="separator:a15158008d33c145a2a4f346c797684ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classpFlow_1_1insertionRegion"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpFlow_1_1insertionRegion')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classpFlow_1_1insertionRegion.html">insertionRegion</a></td></tr>
<tr class="memitem:a2f6fa523f8b578780851796118cd1339 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a2f6fa523f8b578780851796118cd1339">TypeInfoNV</a> (&quot;insertionRegion&quot;)</td></tr>
<tr class="memdesc:a2f6fa523f8b578780851796118cd1339 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type info. <a href="classpFlow_1_1insertionRegion.html#a2f6fa523f8b578780851796118cd1339">More...</a><br /></td></tr>
<tr class="separator:a2f6fa523f8b578780851796118cd1339 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14b0f1d26ae509ecdc74746fe58d76cf inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a14b0f1d26ae509ecdc74746fe58d76cf">insertionRegion</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;<a class="el" href="classpFlow_1_1insertionRegion.html#a5a9652837ba1c412a239fec1ff02e88b">name</a>, const <a class="el" href="classpFlow_1_1insertion.html">insertion</a> &amp;instn)</td></tr>
<tr class="memdesc:a14b0f1d26ae509ecdc74746fe58d76cf inherit pub_methods_classpFlow_1_1insertionRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from a dictionary. <a href="classpFlow_1_1insertionRegion.html#a14b0f1d26ae509ecdc74746fe58d76cf">More...</a><br /></td></tr>
<tr class="separator:a14b0f1d26ae509ecdc74746fe58d76cf inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3cf9dd715e172184050bd4b4a5a6051 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#ad3cf9dd715e172184050bd4b4a5a6051">~insertionRegion</a> ()=default</td></tr>
<tr class="memdesc:ad3cf9dd715e172184050bd4b4a5a6051 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="classpFlow_1_1insertionRegion.html#ad3cf9dd715e172184050bd4b4a5a6051">More...</a><br /></td></tr>
<tr class="separator:ad3cf9dd715e172184050bd4b4a5a6051 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a9652837ba1c412a239fec1ff02e88b inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a5a9652837ba1c412a239fec1ff02e88b">name</a> () const</td></tr>
<tr class="memdesc:a5a9652837ba1c412a239fec1ff02e88b inherit pub_methods_classpFlow_1_1insertionRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const ref to name of the region. <a href="classpFlow_1_1insertionRegion.html#a5a9652837ba1c412a239fec1ff02e88b">More...</a><br /></td></tr>
<tr class="separator:a5a9652837ba1c412a239fec1ff02e88b inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab67fc1d3e31af0938ee28d49e7b848ef inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#ab67fc1d3e31af0938ee28d49e7b848ef">type</a> () const</td></tr>
<tr class="memdesc:ab67fc1d3e31af0938ee28d49e7b848ef inherit pub_methods_classpFlow_1_1insertionRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">return type of insertion region <a href="classpFlow_1_1insertionRegion.html#ab67fc1d3e31af0938ee28d49e7b848ef">More...</a><br /></td></tr>
<tr class="separator:ab67fc1d3e31af0938ee28d49e7b848ef inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e81e11944c2000f458fdb15b0b44d1a inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a9e81e11944c2000f458fdb15b0b44d1a">dict</a> () const</td></tr>
<tr class="separator:a9e81e11944c2000f458fdb15b0b44d1a inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b0314bc3fd7745b79bb6a8695b80529 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a1b0314bc3fd7745b79bb6a8695b80529">Insertion</a> () const</td></tr>
<tr class="separator:a1b0314bc3fd7745b79bb6a8695b80529 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae355b601249331cd5c4facb48df43223 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classpFlow_1_1pointStructure.html">pointStructure</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#ae355b601249331cd5c4facb48df43223">pStruct</a> () const</td></tr>
<tr class="separator:ae355b601249331cd5c4facb48df43223 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdb6cd97d8e5679758ebf8161edf1d70 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#afdb6cd97d8e5679758ebf8161edf1d70">insertionTime</a> (<a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> iter, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> t, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt) const</td></tr>
<tr class="separator:afdb6cd97d8e5679758ebf8161edf1d70 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab381dc3f8dadd5cf3ea1ca00167243bb inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#ab381dc3f8dadd5cf3ea1ca00167243bb">numberToBeInserted</a> (<a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> iter, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> t, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt)</td></tr>
<tr class="separator:ab381dc3f8dadd5cf3ea1ca00167243bb inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a07130d03939ed5fa8846c15371d673 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a1a07130d03939ed5fa8846c15371d673">addToNumInserted</a> (<a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> newInserted)</td></tr>
<tr class="separator:a1a07130d03939ed5fa8846c15371d673 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84b3908969b00409076ae0d2f573d16b inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a84b3908969b00409076ae0d2f573d16b">totalInserted</a> () const</td></tr>
<tr class="separator:a84b3908969b00409076ae0d2f573d16b inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7b8db8337aea6bfd4e3a5b69d5d0a6a inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#ab7b8db8337aea6bfd4e3a5b69d5d0a6a">mixture</a> ()</td></tr>
<tr class="separator:ab7b8db8337aea6bfd4e3a5b69d5d0a6a inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a066802e40cc1e667b535479d0263f5f0 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a066802e40cc1e667b535479d0263f5f0">pRegion</a> ()</td></tr>
<tr class="separator:a066802e40cc1e667b535479d0263f5f0 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a039352410860be5593f442d3238c7eef inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">const auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a039352410860be5593f442d3238c7eef">setFieldList</a> () const</td></tr>
<tr class="separator:a039352410860be5593f442d3238c7eef inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6964e9f1f100001543fdb044fa7fc896 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1insertionRegion.html#a6964e9f1f100001543fdb044fa7fc896">write</a> (<a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;<a class="el" href="classpFlow_1_1insertionRegion.html#a9e81e11944c2000f458fdb15b0b44d1a">dict</a>) const</td></tr>
<tr class="memdesc:a6964e9f1f100001543fdb044fa7fc896 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="mdescLeft">&#160;</td><td class="mdescRight">read from dictionary <a href="classpFlow_1_1insertionRegion.html#a6964e9f1f100001543fdb044fa7fc896">More...</a><br /></td></tr>
<tr class="separator:a6964e9f1f100001543fdb044fa7fc896 inherit pub_methods_classpFlow_1_1insertionRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:a7e637e102a6242c3b999828e73d0ea1c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1InsertionRegion.html#a7e637e102a6242c3b999828e73d0ea1c">checkForContact</a> (const <a class="el" href="namespacepFlow.html#aede0f5a4a44d271e4e260cdb01032a61">realx3Vector</a> &amp;pos, const <a class="el" href="namespacepFlow.html#a56fe59023e353f0f237688c06fbfd441">realVector</a> &amp;diams, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;p, const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &amp;d)</td></tr>
<tr class="separator:a7e637e102a6242c3b999828e73d0ea1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2930483c30fb6c335a8a9a70b485f0fc"><td class="memItemLeft" align="right" valign="top">const ShapeType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1InsertionRegion.html#a2930483c30fb6c335a8a9a70b485f0fc">shapes_</a></td></tr>
<tr class="memdesc:a2930483c30fb6c335a8a9a70b485f0fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ref to Shapes. <a href="classpFlow_1_1InsertionRegion.html#a2930483c30fb6c335a8a9a70b485f0fc">More...</a><br /></td></tr>
<tr class="separator:a2930483c30fb6c335a8a9a70b485f0fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename ShapeType&gt;<br />
class pFlow::InsertionRegion&lt; ShapeType &gt;</h3>
<p>This manages insertion of particles from a region based on the ShapeType. </p>
<p class="definition">Definition at line <a class="el" href="InsertionRegion_8hpp_source.html#l00042">42</a> of file <a class="el" href="InsertionRegion_8hpp_source.html">InsertionRegion.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a165562ec900ed713e5588950e1e564df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a165562ec900ed713e5588950e1e564df">&#9670;&nbsp;</a></span>InsertionRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1InsertionRegion.html">InsertionRegion</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1insertion.html">insertion</a> &amp;&#160;</td>
<td class="paramname"><em>instn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ShapeType &amp;&#160;</td>
<td class="paramname"><em>shapes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct from dictionary. </p>
<p class="definition">Definition at line <a class="el" href="InsertionRegion_8cpp_source.html#l00041">41</a> of file <a class="el" href="InsertionRegion_8cpp_source.html">InsertionRegion.cpp</a>.</p>
</div>
</div>
<a id="ad4ade4fda8b1e4e1cac71190d8d4a85a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4ade4fda8b1e4e1cac71190d8d4a85a">&#9670;&nbsp;</a></span>~InsertionRegion()</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_1InsertionRegion.html">InsertionRegion</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7e637e102a6242c3b999828e73d0ea1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e637e102a6242c3b999828e73d0ea1c">&#9670;&nbsp;</a></span>checkForContact()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool checkForContact </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aede0f5a4a44d271e4e260cdb01032a61">realx3Vector</a> &amp;&#160;</td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a56fe59023e353f0f237688c06fbfd441">realVector</a> &amp;&#160;</td>
<td class="paramname"><em>diams</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;&#160;</td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &amp;&#160;</td>
<td class="paramname"><em>d</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InsertionRegion_8cpp_source.html#l00023">23</a> of file <a class="el" href="InsertionRegion_8cpp_source.html">InsertionRegion.cpp</a>.</p>
<p class="reference">References <a class="el" href="pFlowMacros_8hpp_source.html#l00075">ForAll</a>, and <a class="el" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length()</a>.</p>
<div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1InsertionRegion_a7e637e102a6242c3b999828e73d0ea1c_cgraph.png" border="0" usemap="#classpFlow_1_1InsertionRegion_a7e637e102a6242c3b999828e73d0ea1c_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="aa341711c6ff073dcf9a1971499e64b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa341711c6ff073dcf9a1971499e64b95">&#9670;&nbsp;</a></span>TypeInfoTemplateNV11()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TypeInfoTemplateNV11 </td>
<td>(</td>
<td class="paramtype">&quot;insertionRegion&quot;&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ShapeType&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type info. </p>
</div>
</div>
<a id="a15158008d33c145a2a4f346c797684ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15158008d33c145a2a4f346c797684ed">&#9670;&nbsp;</a></span>insertParticles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool insertParticles </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
<td class="paramname"><em>iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td>
<td class="paramname"><em>dt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a6e76b0fc4f41684b7dd691cb6552384d">wordVector</a> &amp;&#160;</td>
<td class="paramname"><em>names</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#aede0f5a4a44d271e4e260cdb01032a61">realx3Vector</a> &amp;&#160;</td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool &amp;&#160;</td>
<td class="paramname"><em>insertionOccured</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert particles at current time t Check if currentTime is the right moment for particle insertion. </p>
<p>Fill the vectors name, pos and signal if particle insertion occured or not. </p>
<p>reserve enough space</p>
<p class="definition">Definition at line <a class="el" href="InsertionRegion_8cpp_source.html#l00054">54</a> of file <a class="el" href="InsertionRegion_8cpp_source.html">InsertionRegion.cpp</a>.</p>
<p class="reference">References <a class="el" href="Vector_8hpp_source.html#l00271">Vector&lt; T, Allocator &gt;::capacity()</a>, <a class="el" href="streams_8hpp_source.html#l00044">END_WARNING</a>, <a class="el" href="kokkosAlgorithms_8hpp_source.html#l00104">pFlow::algorithms::KOKKOS::max()</a>, <a class="el" href="setPointStructure_8hpp_source.html#l00024">pStruct</a>, <a class="el" href="Vector_8hpp_source.html#l00284">Vector&lt; T, Allocator &gt;::reserve()</a>, and <a class="el" href="streams_8hpp_source.html#l00043">WARNING</a>.</p>
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-3-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1InsertionRegion_a15158008d33c145a2a4f346c797684ed_cgraph.png" border="0" usemap="#classpFlow_1_1InsertionRegion_a15158008d33c145a2a4f346c797684ed_cgraph" alt=""/></div>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2930483c30fb6c335a8a9a70b485f0fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2930483c30fb6c335a8a9a70b485f0fc">&#9670;&nbsp;</a></span>shapes_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ShapeType&amp; shapes_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Ref to Shapes. </p>
<p class="definition">Definition at line <a class="el" href="InsertionRegion_8hpp_source.html#l00048">48</a> of file <a class="el" href="InsertionRegion_8hpp_source.html">InsertionRegion.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/Particles/Insertion/InsertionRegion/<a class="el" href="InsertionRegion_8hpp_source.html">InsertionRegion.hpp</a></li>
<li>src/Particles/Insertion/InsertionRegion/<a class="el" href="InsertionRegion_8cpp_source.html">InsertionRegion.cpp</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_1InsertionRegion.html">InsertionRegion</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>