mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-07-28 03:27:05 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -126,8 +126,8 @@ $(document).ready(function(){initNavTree('PeakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">-----------------------------------------------------------------------------*/</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">template</span><<span class="keyword">typename</span> RegionType></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#accb41c4146e4871063d4163ed838dd97">pFlow::PeakableRegion<RegionType>::PeakableRegion</a></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">template</span><<span class="keyword">typename</span> GeomType></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#accb41c4146e4871063d4163ed838dd97">pFlow::PeakableRegion<GeomType>::PeakableRegion</a></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#accb41c4146e4871063d4163ed838dd97"> 24</a></span> (</div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& type, </div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict</div>
|
||||
@ -139,8 +139,8 @@ $(document).ready(function(){initNavTree('PeakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">template</span><<span class="keyword">typename</span> RegionType></div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">pFlow::PeakableRegion<RegionType>::isInside</a></div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">template</span><<span class="keyword">typename</span> GeomType></div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">pFlow::PeakableRegion<GeomType>::isInside</a></div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590"> 37</a></span> (</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1triple.html">realx3</a>& point</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> )<span class="keyword">const</span></div>
|
||||
@ -149,20 +149,20 @@ $(document).ready(function(){initNavTree('PeakableRegion_8cpp_source.html','');
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">template</span><<span class="keyword">typename</span> RegionType></div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51"> 46</a></span> <a class="code" href="classpFlow_1_1triple.html">pFlow::realx3</a> <a class="code" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">pFlow::PeakableRegion<RegionType>::peek</a>()<span class="keyword">const</span></div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">template</span><<span class="keyword">typename</span> GeomType></div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51"> 46</a></span> <a class="code" href="classpFlow_1_1triple.html">pFlow::realx3</a> <a class="code" href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">pFlow::PeakableRegion<GeomType>::peek</a>()<span class="keyword">const</span></div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword"></span>{</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> region_.peek();</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> }</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span><<span class="keyword">typename</span> RegionType></div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df"> 52</a></span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df">pFlow::PeakableRegion<RegionType>::read</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict)</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span><<span class="keyword">typename</span> GeomType></div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df"> 52</a></span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df">pFlow::PeakableRegion<GeomType>::read</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict)</div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> region_.read(dict);</div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">template</span><<span class="keyword">typename</span> RegionType></div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910"> 58</a></span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910">pFlow::PeakableRegion<RegionType>::write</a>(<a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict)<span class="keyword">const</span></div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">template</span><<span class="keyword">typename</span> GeomType></div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910"> 58</a></span> <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910">pFlow::PeakableRegion<GeomType>::write</a>(<a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict)<span class="keyword">const</span></div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword"></span>{</div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> region_.write(dict);</div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> }</div>
|
||||
@ -171,14 +171,14 @@ $(document).ready(function(){initNavTree('PeakableRegion_8cpp_source.html','');
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_a9b8bf04caa102276f5d5e365998cd1df"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#a9b8bf04caa102276f5d5e365998cd1df">pFlow::PeakableRegion::read</a></div><div class="ttdeci">virtual bool read(const dictionary &dict) override</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00052">PeakableRegion.cpp:52</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_accb41c4146e4871063d4163ed838dd97"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#accb41c4146e4871063d4163ed838dd97">pFlow::PeakableRegion::PeakableRegion</a></div><div class="ttdeci">PeakableRegion(const word &type, const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00024">PeakableRegion.cpp:24</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_abbdd281687ac228919695d6c259f1590"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">pFlow::PeakableRegion::isInside</a></div><div class="ttdeci">virtual bool isInside(const realx3 &point) const override</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00037">PeakableRegion.cpp:37</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_abbdd281687ac228919695d6c259f1590"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#abbdd281687ac228919695d6c259f1590">pFlow::PeakableRegion::isInside</a></div><div class="ttdeci">bool isInside(const realx3 &point) const override</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00037">PeakableRegion.cpp:37</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple< real ></a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_a775ec4956e0bf2b80153403e4db10910"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#a775ec4956e0bf2b80153403e4db10910">pFlow::PeakableRegion::write</a></div><div class="ttdeci">virtual bool write(dictionary &dict) const override</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00058">PeakableRegion.cpp:58</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_a66dadfa799c9079c53ec6bd664dcfb51"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">pFlow::PeakableRegion::peek</a></div><div class="ttdeci">virtual realx3 peek() const override</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00046">PeakableRegion.cpp:46</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1peakableRegion_html"><div class="ttname"><a href="classpFlow_1_1peakableRegion.html">pFlow::peakableRegion</a></div><div class="ttdef"><b>Definition:</b> <a href="peakableRegion_8hpp_source.html#l00035">peakableRegion.hpp:35</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00038">dictionary.hpp:38</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1PeakableRegion_html_a66dadfa799c9079c53ec6bd664dcfb51"><div class="ttname"><a href="classpFlow_1_1PeakableRegion.html#a66dadfa799c9079c53ec6bd664dcfb51">pFlow::PeakableRegion::peek</a></div><div class="ttdeci">realx3 peek() const override</div><div class="ttdef"><b>Definition:</b> <a href="PeakableRegion_8cpp_source.html#l00046">PeakableRegion.cpp:46</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1peakableRegion_html"><div class="ttname"><a href="classpFlow_1_1peakableRegion.html">pFlow::peakableRegion</a></div><div class="ttdef"><b>Definition:</b> <a href="peakableRegion_8hpp_source.html#l00032">peakableRegion.hpp:32</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_0b265ec0eb5bc5fbad75b6fd7b5b024b.html">structuredData</a></li><li class="navelem"><a class="el" href="dir_4f9e597021b90228ccac48345da86dec.html">peakableRegion</a></li><li class="navelem"><a class="el" href="dir_9cf3a7061932aac86787f9c3f802c5f2.html">PeakableRegion</a></li><li class="navelem"><a class="el" href="PeakableRegion_8cpp.html">PeakableRegion.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user