xfygogo
/
phasicFlow
mirror of https://github.com/PhasicFlow/phasicFlow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
phasicFlow/doc/code-documentation/html/classpFlow_1_1PeakableRegio...

633 lines
37 KiB
HTML
Raw Blame History

<!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: PeakableRegion&lt; GeomType &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_1PeakableRegion.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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classpFlow_1_1PeakableRegion-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PeakableRegion&lt; GeomType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<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 PeakableRegion&lt; GeomType &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_1PeakableRegion__inherit__graph.png" border="0" usemap="#PeakableRegion_3_01GeomType_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 PeakableRegion&lt; GeomType &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_1PeakableRegion__coll__graph.png" border="0" usemap="#PeakableRegion_3_01GeomType_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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad4822cdd9fb639a9a694a2f1c10bebf7"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#ad4822cdd9fb639a9a694a2f1c10bebf7">RegionType</a> = <a class="el" href="classpFlow_1_1geometricRegion.html">geometricRegion</a>&lt; GeomType &gt;</td></tr>
<tr class="separator:ad4822cdd9fb639a9a694a2f1c10bebf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3392a825e643a244a8020db390b4b3a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#ad3392a825e643a244a8020db390b4b3a">GeometryType</a> = typename <a class="el" href="classpFlow_1_1geometricRegion.html#a639da8e329957ecc9cb0bc5532289933">RegionType::GeometryType</a></td></tr>
<tr class="separator:ad3392a825e643a244a8020db390b4b3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a24a82b91202521434e045c66b82a2be2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a24a82b91202521434e045c66b82a2be2">TypeInfoTemplate11</a> (&quot;peakable&quot;, GeometryType)</td></tr>
<tr class="separator:a24a82b91202521434e045c66b82a2be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accb41c4146e4871063d4163ed838dd97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#accb41c4146e4871063d4163ed838dd97">PeakableRegion</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;type, const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="separator:accb41c4146e4871063d4163ed838dd97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe18bc437d6d79cd5071e97d9133ae7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#abfe18bc437d6d79cd5071e97d9133ae7">add_vCtor</a> (<a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a>, <a class="el" href="classpFlow_1_1PeakableRegion.html">PeakableRegion</a>, <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>)</td></tr>
<tr class="separator:abfe18bc437d6d79cd5071e97d9133ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a645ae0ea826d85b0ee035476fd7ece76"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt; <a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a645ae0ea826d85b0ee035476fd7ece76">clone</a> () const override</td></tr>
<tr class="separator:a645ae0ea826d85b0ee035476fd7ece76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9874989bb976db6081e543158ac47b85"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a9874989bb976db6081e543158ac47b85">clonePtr</a> () const override</td></tr>
<tr class="separator:a9874989bb976db6081e543158ac47b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2303ac8487ac7bec46a027338fccc448"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a2303ac8487ac7bec46a027338fccc448">~PeakableRegion</a> ()=default</td></tr>
<tr class="separator:a2303ac8487ac7bec46a027338fccc448"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbdd281687ac228919695d6c259f1590"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">isInside</a> (const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;point) const override</td></tr>
<tr class="separator:abbdd281687ac228919695d6c259f1590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66dadfa799c9079c53ec6bd664dcfb51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">peek</a> () const override</td></tr>
<tr class="separator:a66dadfa799c9079c53ec6bd664dcfb51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51d8dc912f614bd0db5ec327e503ddf3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a51d8dc912f614bd0db5ec327e503ddf3">minPoint</a> () const override</td></tr>
<tr class="separator:a51d8dc912f614bd0db5ec327e503ddf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a120bb47e73c855a5ba9c1b43aae68b85"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a120bb47e73c855a5ba9c1b43aae68b85">maxPoint</a> () const override</td></tr>
<tr class="separator:a120bb47e73c855a5ba9c1b43aae68b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8bf04caa102276f5d5e365998cd1df"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df">read</a> (const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict) override</td></tr>
<tr class="separator:a9b8bf04caa102276f5d5e365998cd1df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a775ec4956e0bf2b80153403e4db10910"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910">write</a> (<a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict) const override</td></tr>
<tr class="separator:a775ec4956e0bf2b80153403e4db10910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classpFlow_1_1peakableRegion"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpFlow_1_1peakableRegion')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a></td></tr>
<tr class="memitem:aedacec9945ee088771ad35c29bf8f7f9 inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#aedacec9945ee088771ad35c29bf8f7f9">TypeInfo</a> (&quot;peakableRegion&quot;)</td></tr>
<tr class="separator:aedacec9945ee088771ad35c29bf8f7f9 inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf43b56be2edb758022e5748d0adc983 inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#abf43b56be2edb758022e5748d0adc983">peakableRegion</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;type, const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="separator:abf43b56be2edb758022e5748d0adc983 inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a1b3492ffa7d02882ef2242a2066e18 inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#a7a1b3492ffa7d02882ef2242a2066e18">create_vCtor</a> (<a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a>, <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>,(const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;type, const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict),(type, dict))</td></tr>
<tr class="separator:a7a1b3492ffa7d02882ef2242a2066e18 inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3baed48aad1c9e654cd8caa55dfcb18a inherit pub_methods_classpFlow_1_1peakableRegion"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#a3baed48aad1c9e654cd8caa55dfcb18a">~peakableRegion</a> ()=default</td></tr>
<tr class="separator:a3baed48aad1c9e654cd8caa55dfcb18a inherit pub_methods_classpFlow_1_1peakableRegion"><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:ac3c9c4fbf78fa4fec1ce1a58bcb0a26a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1PeakableRegion.html#ad4822cdd9fb639a9a694a2f1c10bebf7">RegionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1PeakableRegion.html#ac3c9c4fbf78fa4fec1ce1a58bcb0a26a">region_</a></td></tr>
<tr class="separator:ac3c9c4fbf78fa4fec1ce1a58bcb0a26a"><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 pub_static_methods_classpFlow_1_1peakableRegion"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classpFlow_1_1peakableRegion')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a></td></tr>
<tr class="memitem:a7c89091eec63fb3273bfeac98f38343f inherit pub_static_methods_classpFlow_1_1peakableRegion"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt; <a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#a7c89091eec63fb3273bfeac98f38343f">create</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;type, const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="separator:a7c89091eec63fb3273bfeac98f38343f inherit pub_static_methods_classpFlow_1_1peakableRegion"><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 GeomType&gt;<br />
class pFlow::PeakableRegion&lt; GeomType &gt;</h3>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00032">32</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ad4822cdd9fb639a9a694a2f1c10bebf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4822cdd9fb639a9a694a2f1c10bebf7">&#9670;&nbsp;</a></span>RegionType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classpFlow_1_1PeakableRegion.html#ad4822cdd9fb639a9a694a2f1c10bebf7">RegionType</a> = <a class="el" href="classpFlow_1_1geometricRegion.html">geometricRegion</a>&lt;GeomType&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00036">36</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
</div>
</div>
<a id="ad3392a825e643a244a8020db390b4b3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3392a825e643a244a8020db390b4b3a">&#9670;&nbsp;</a></span>GeometryType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classpFlow_1_1PeakableRegion.html#ad3392a825e643a244a8020db390b4b3a">GeometryType</a> = typename <a class="el" href="classpFlow_1_1geometricRegion.html#a639da8e329957ecc9cb0bc5532289933">RegionType::GeometryType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00038">38</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="accb41c4146e4871063d4163ed838dd97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accb41c4146e4871063d4163ed838dd97">&#9670;&nbsp;</a></span>PeakableRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1PeakableRegion.html">PeakableRegion</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;&#160;</td>
<td class="paramname"><em>dict</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8cpp_source.html#l00024">24</a> of file <a class="el" href="PeakableRegion_8cpp_source.html">PeakableRegion.cpp</a>.</p>
</div>
</div>
<a id="a2303ac8487ac7bec46a027338fccc448"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2303ac8487ac7bec46a027338fccc448">&#9670;&nbsp;</a></span>~PeakableRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classpFlow_1_1PeakableRegion.html">PeakableRegion</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">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a24a82b91202521434e045c66b82a2be2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24a82b91202521434e045c66b82a2be2">&#9670;&nbsp;</a></span>TypeInfoTemplate11()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TypeInfoTemplate11 </td>
<td>(</td>
<td class="paramtype">&quot;peakable&quot;&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classpFlow_1_1PeakableRegion.html#ad3392a825e643a244a8020db390b4b3a">GeometryType</a>&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abfe18bc437d6d79cd5071e97d9133ae7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe18bc437d6d79cd5071e97d9133ae7">&#9670;&nbsp;</a></span>add_vCtor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">add_vCtor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classpFlow_1_1PeakableRegion.html">PeakableRegion</a>&lt; GeomType &gt;&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a645ae0ea826d85b0ee035476fd7ece76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a645ae0ea826d85b0ee035476fd7ece76">&#9670;&nbsp;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt;<a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a>&gt; clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#a18e6c12a267c131c5ca646b31f880db1">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00054">54</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
</div>
</div>
<a id="a9874989bb976db6081e543158ac47b85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9874989bb976db6081e543158ac47b85">&#9670;&nbsp;</a></span>clonePtr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classpFlow_1_1peakableRegion.html">peakableRegion</a>* clonePtr </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#af9c4a9d23ff76f301b0ba34ef8070c3e">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00059">59</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
</div>
</div>
<a id="abbdd281687ac228919695d6c259f1590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbdd281687ac228919695d6c259f1590">&#9670;&nbsp;</a></span>isInside()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool isInside </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;&#160;</td>
<td class="paramname"><em>point</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#adcb491106ace62f312e9ed9931c72b12">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8cpp_source.html#l00037">37</a> of file <a class="el" href="PeakableRegion_8cpp_source.html">PeakableRegion.cpp</a>.</p>
</div>
</div>
<a id="a66dadfa799c9079c53ec6bd664dcfb51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66dadfa799c9079c53ec6bd664dcfb51">&#9670;&nbsp;</a></span>peek()</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="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">pFlow::realx3</a> peek</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#a4934f4544d2ebe36ad5ee2a1a53529ab">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8cpp_source.html#l00046">46</a> of file <a class="el" href="PeakableRegion_8cpp_source.html">PeakableRegion.cpp</a>.</p>
</div>
</div>
<a id="a51d8dc912f614bd0db5ec327e503ddf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51d8dc912f614bd0db5ec327e503ddf3">&#9670;&nbsp;</a></span>minPoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>&amp; minPoint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#adb36f5cd7901e4cc0a7d6c4aab29a5f4">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00072">72</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
<p class="reference">References <a class="el" href="geometricRegion_8hpp_source.html#l00065">geometricRegion&lt; GeomType &gt;::minPoint()</a>, and <a class="el" href="PeakableRegion_8hpp_source.html#l00042">PeakableRegion&lt; GeomType &gt;::region_</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_1PeakableRegion_a51d8dc912f614bd0db5ec327e503ddf3_cgraph.png" border="0" usemap="#classpFlow_1_1PeakableRegion_a51d8dc912f614bd0db5ec327e503ddf3_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a120bb47e73c855a5ba9c1b43aae68b85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a120bb47e73c855a5ba9c1b43aae68b85">&#9670;&nbsp;</a></span>maxPoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>&amp; maxPoint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#a6bfab59d0e8a27bacfb9cd85dd1cc184">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00077">77</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
<p class="reference">References <a class="el" href="geometricRegion_8hpp_source.html#l00070">geometricRegion&lt; GeomType &gt;::maxPoint()</a>, and <a class="el" href="PeakableRegion_8hpp_source.html#l00042">PeakableRegion&lt; GeomType &gt;::region_</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_1PeakableRegion_a120bb47e73c855a5ba9c1b43aae68b85_cgraph.png" border="0" usemap="#classpFlow_1_1PeakableRegion_a120bb47e73c855a5ba9c1b43aae68b85_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a9b8bf04caa102276f5d5e365998cd1df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b8bf04caa102276f5d5e365998cd1df">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;&#160;</td>
<td class="paramname"><em>dict</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#af5f2d605171cd6bcbf8c0d59d1aa3832">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8cpp_source.html#l00052">52</a> of file <a class="el" href="PeakableRegion_8cpp_source.html">PeakableRegion.cpp</a>.</p>
</div>
</div>
<a id="a775ec4956e0bf2b80153403e4db10910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a775ec4956e0bf2b80153403e4db10910">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;&#160;</td>
<td class="paramname"><em>dict</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1peakableRegion.html#aa713a4038669cc59eadaab3279aaac00">peakableRegion</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeakableRegion_8cpp_source.html#l00058">58</a> of file <a class="el" href="PeakableRegion_8cpp_source.html">PeakableRegion.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac3c9c4fbf78fa4fec1ce1a58bcb0a26a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3c9c4fbf78fa4fec1ce1a58bcb0a26a">&#9670;&nbsp;</a></span>region_</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_1PeakableRegion.html#ad4822cdd9fb639a9a694a2f1c10bebf7">RegionType</a> region_</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 class="definition">Definition at line <a class="el" href="PeakableRegion_8hpp_source.html#l00042">42</a> of file <a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="PeakableRegion_8hpp_source.html#l00077">PeakableRegion&lt; GeomType &gt;::maxPoint()</a>, and <a class="el" href="PeakableRegion_8hpp_source.html#l00072">PeakableRegion&lt; GeomType &gt;::minPoint()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/phasicFlow/structuredData/peakableRegion/PeakableRegion/<a class="el" href="PeakableRegion_8hpp_source.html">PeakableRegion.hpp</a></li>
<li>src/phasicFlow/structuredData/peakableRegion/PeakableRegion/<a class="el" href="PeakableRegion_8cpp_source.html">PeakableRegion.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_1PeakableRegion.html">PeakableRegion</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>
Reference in New Issue View Git Blame Copy Permalink