mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -115,10 +115,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1peakableRegion.html','')
|
||||
</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_inherit__map" alt="Inheritance graph"/></div>
|
||||
<map name="peakableRegion_inherit__map" id="peakableRegion_inherit__map">
|
||||
<area shape="rect" title=" " alt="" coords="57,5,184,32"/>
|
||||
<area shape="rect" href="classpFlow_1_1PeakableRegion.html" title=" " alt="" coords="5,80,236,107"/>
|
||||
</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>
|
||||
@ -139,6 +135,10 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="separator:adcb491106ace62f312e9ed9931c72b12"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4934f4544d2ebe36ad5ee2a1a53529ab"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#a4934f4544d2ebe36ad5ee2a1a53529ab">peek</a> () const =0</td></tr>
|
||||
<tr class="separator:a4934f4544d2ebe36ad5ee2a1a53529ab"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:adb36f5cd7901e4cc0a7d6c4aab29a5f4"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#adb36f5cd7901e4cc0a7d6c4aab29a5f4">minPoint</a> () const =0</td></tr>
|
||||
<tr class="separator:adb36f5cd7901e4cc0a7d6c4aab29a5f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6bfab59d0e8a27bacfb9cd85dd1cc184"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#a6bfab59d0e8a27bacfb9cd85dd1cc184">maxPoint</a> () const =0</td></tr>
|
||||
<tr class="separator:a6bfab59d0e8a27bacfb9cd85dd1cc184"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af5f2d605171cd6bcbf8c0d59d1aa3832"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#af5f2d605171cd6bcbf8c0d59d1aa3832">read</a> (const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &dict)=0</td></tr>
|
||||
<tr class="separator:af5f2d605171cd6bcbf8c0d59d1aa3832"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa713a4038669cc59eadaab3279aaac00"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1peakableRegion.html#aa713a4038669cc59eadaab3279aaac00">write</a> (<a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &dict) const =0</td></tr>
|
||||
@ -151,7 +151,7 @@ Static Public Member Functions</h2></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="peakableRegion_8hpp_source.html#l00035">35</a> of file <a class="el" href="peakableRegion_8hpp_source.html">peakableRegion.hpp</a>.</p>
|
||||
<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">Constructor & Destructor Documentation</h2>
|
||||
<a id="abf43b56be2edb758022e5748d0adc983"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#abf43b56be2edb758022e5748d0adc983">◆ </a></span>peakableRegion()</h2>
|
||||
@ -179,7 +179,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="peakableRegion_8cpp_source.html#l00026">26</a> of file <a class="el" href="peakableRegion_8cpp_source.html">peakableRegion.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="peakableRegion_8cpp_source.html#l00025">25</a> of file <a class="el" href="peakableRegion_8cpp_source.html">peakableRegion.cpp</a>.</p>
|
||||
|
||||
<p class="reference">References <a class="el" href="pFlowMacros_8hpp_source.html#l00038">CONSUME_PARAM</a>.</p>
|
||||
|
||||
@ -292,7 +292,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a645ae0ea826d85b0ee035476fd7ece76">PeakableRegion< RegionType ></a>.</p>
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a645ae0ea826d85b0ee035476fd7ece76">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -319,7 +319,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a9874989bb976db6081e543158ac47b85">PeakableRegion< RegionType ></a>.</p>
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a9874989bb976db6081e543158ac47b85">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -347,7 +347,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">PeakableRegion< RegionType ></a>.</p>
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -374,7 +374,61 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">PeakableRegion< RegionType ></a>.</p>
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="adb36f5cd7901e4cc0a7d6c4aab29a5f4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#adb36f5cd7901e4cc0a7d6c4aab29a5f4">◆ </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">virtual const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>& 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">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a51d8dc912f614bd0db5ec327e503ddf3">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6bfab59d0e8a27bacfb9cd85dd1cc184"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6bfab59d0e8a27bacfb9cd85dd1cc184">◆ </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">virtual const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>& 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">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a120bb47e73c855a5ba9c1b43aae68b85">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -402,7 +456,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df">PeakableRegion< RegionType ></a>.</p>
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -430,7 +484,7 @@ Static Public Member Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910">PeakableRegion< RegionType ></a>.</p>
|
||||
<p>Implemented in <a class="el" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910">PeakableRegion< GeomType ></a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@ -470,18 +524,22 @@ Static Public Member Functions</h2></td></tr>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="peakableRegion_8cpp_source.html#l00036">36</a> of file <a class="el" href="peakableRegion_8cpp_source.html">peakableRegion.cpp</a>.</p>
|
||||
|
||||
<p class="reference">References <a class="el" href="bTypesFunctions_8cpp_source.html#l00131">pFlow::angleBracketsNames()</a>, <a class="el" href="error_8hpp_source.html#l00036">fatalError</a>, <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>, and <a class="el" href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">pFlow::printKeys()</a>.</p>
|
||||
<p class="reference">References <a class="el" href="bTypesFunctions_8cpp_source.html#l00156">pFlow::angleBracketsNames()</a>, <a class="el" href="error_8hpp_source.html#l00070">fatalError</a>, <a class="el" href="error_8hpp_source.html#l00098">fatalExit</a>, and <a class="el" href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">pFlow::printKeys()</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="positionParticles_8cpp_source.html#l00075">positionParticles::positionParticles()</a>, and <a class="el" href="insertionRegion_8cpp_source.html#l00067">insertionRegion::readInsertionRegion()</a>.</p>
|
||||
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||||
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</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_a7c89091eec63fb3273bfeac98f38343f_cgraph.png" border="0" usemap="#classpFlow_1_1peakableRegion_a7c89091eec63fb3273bfeac98f38343f_cgraph" alt=""/></div>
|
||||
<map name="classpFlow_1_1peakableRegion_a7c89091eec63fb3273bfeac98f38343f_cgraph" id="classpFlow_1_1peakableRegion_a7c89091eec63fb3273bfeac98f38343f_cgraph">
|
||||
<area shape="rect" title=" " alt="" coords="5,31,68,57"/>
|
||||
<area shape="rect" href="namespacepFlow.html#af4e1df8908797640749fa02e2f5db7a7" title=" " alt="" coords="116,5,323,32"/>
|
||||
<area shape="rect" href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0" title=" " alt="" coords="155,56,284,83"/>
|
||||
</map>
|
||||
</div>
|
||||
<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 caller 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_a7c89091eec63fb3273bfeac98f38343f_icgraph.png" border="0" usemap="#classpFlow_1_1peakableRegion_a7c89091eec63fb3273bfeac98f38343f_icgraph" alt=""/></div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user