documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -5,7 +5,7 @@
<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: src/phasicFlow/structuredData/peakableRegion/boxRegion/boxRegion.cpp Source File</title>
<title>PhasicFlow: src/phasicFlow/structuredData/peakableRegion/old/boxRegion/boxRegion.cpp Source File</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>
@ -149,7 +149,7 @@ $(document).ready(function(){initNavTree('boxRegion_8cpp_source.html',''); initR
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classpFlow_1_1boxRegion.html#a742999f822100111462c25118a0ce0fe"> 43</a></span>&#160;<a class="code" href="classpFlow_1_1triple.html">pFlow::realx3</a> <a class="code" href="classpFlow_1_1boxRegion.html#a742999f822100111462c25118a0ce0fe">pFlow::boxRegion::peek</a>()<span class="keyword">const</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1boxRegion.html#a809105944d87bd27bb8fa71167a86e14">random_</a>.<a class="code" href="classpFlow_1_1uniformRandomReal.html#adafd9f80ea7071089bd8829bb04cdd14">randomNumber</a>(<a class="code" href="classpFlow_1_1boxRegion.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a>.<a class="code" href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">minPoint</a>(), <a class="code" href="classpFlow_1_1boxRegion.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a>.<a class="code" href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9">maxPoint</a>());</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1boxRegion.html#a809105944d87bd27bb8fa71167a86e14">random_</a>.<a class="code" href="classpFlow_1_1uniformRandomReal.html#adafd9f80ea7071089bd8829bb04cdd14">randomNumber</a>(<a class="code" href="classpFlow_1_1boxRegion.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a>.<a class="code" href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">minPoint</a>(), <a class="code" href="classpFlow_1_1boxRegion.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a>.<a class="code" href="classpFlow_1_1box.html#a0200f1e557cc2585190d623c0a370108">maxPoint</a>());</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
@ -172,20 +172,20 @@ $(document).ready(function(){initNavTree('boxRegion_8cpp_source.html',''); initR
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_a837963842fca9d81a7e2c4845d69a628"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#a837963842fca9d81a7e2c4845d69a628">pFlow::boxRegion::boxRegion</a></div><div class="ttdeci">boxRegion(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8cpp_source.html#l00025">boxRegion.cpp:25</a></div></div>
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_a6964e9f1f100001543fdb044fa7fc896"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#a6964e9f1f100001543fdb044fa7fc896">pFlow::boxRegion::write</a></div><div class="ttdeci">bool write(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8cpp_source.html#l00058">boxRegion.cpp:58</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a22e25e0baa24f79d1fa113c2a84f00f9"><div class="ttname"><a href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9">pFlow::box::maxPoint</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 maxPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00094">box.hpp:94</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a0200f1e557cc2585190d623c0a370108"><div class="ttname"><a href="classpFlow_1_1box.html#a0200f1e557cc2585190d623c0a370108">pFlow::box::maxPoint</a></div><div class="ttdeci">const INLINE_FUNCTION_HD realx3 &amp; maxPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00097">box.hpp:97</a></div></div>
<div class="ttc" id="aboxRegion_8hpp_html"><div class="ttname"><a href="boxRegion_8hpp.html">boxRegion.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a7a3e5e5740e519e910633f5d72bb043b"><div class="ttname"><a href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">pFlow::box::minPoint</a></div><div class="ttdeci">const INLINE_FUNCTION_HD realx3 &amp; minPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00091">box.hpp:91</a></div></div>
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_a809105944d87bd27bb8fa71167a86e14"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#a809105944d87bd27bb8fa71167a86e14">pFlow::boxRegion::random_</a></div><div class="ttdeci">uniformRandomReal random_</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8hpp_source.html#l00036">boxRegion.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_a742999f822100111462c25118a0ce0fe"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#a742999f822100111462c25118a0ce0fe">pFlow::boxRegion::peek</a></div><div class="ttdeci">realx3 peek() const</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8cpp_source.html#l00043">boxRegion.cpp:43</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a67424c452a87ed7ff748b65374f89e54"><div class="ttname"><a href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">pFlow::box::minPoint</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 minPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00088">box.hpp:88</a></div></div>
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_aaa6340380ab7af3599579f49f62308da"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#aaa6340380ab7af3599579f49f62308da">pFlow::boxRegion::isInside</a></div><div class="ttdeci">bool isInside(const realx3 &amp;p) const</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8cpp_source.html#l00036">boxRegion.cpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple&lt; real &gt;</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_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 class="ttc" id="aclasspFlow_1_1boxRegion_html_aefb81f563e3df7617831459d0ab0b5ee"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#aefb81f563e3df7617831459d0ab0b5ee">pFlow::boxRegion::box_</a></div><div class="ttdeci">box box_</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8hpp_source.html#l00034">boxRegion.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_a6ce0c64db98eb6144d363dbfc86104eb"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#a6ce0c64db98eb6144d363dbfc86104eb">pFlow::boxRegion::read</a></div><div class="ttdeci">bool read(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="boxRegion_8cpp_source.html#l00050">boxRegion.cpp:50</a></div></div>
<div class="ttc" id="aclasspFlow_1_1uniformRandomReal_html_adafd9f80ea7071089bd8829bb04cdd14"><div class="ttname"><a href="classpFlow_1_1uniformRandomReal.html#adafd9f80ea7071089bd8829bb04cdd14">pFlow::uniformRandomReal::randomNumber</a></div><div class="ttdeci">real randomNumber(real a, real b)</div><div class="ttdef"><b>Definition:</b> <a href="uniformRandomReal_8hpp_source.html#l00053">uniformRandomReal.hpp:53</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_ca72be8894cc4d069711645476c2def5.html">boxRegion</a></li><li class="navelem"><a class="el" href="boxRegion_8cpp.html">boxRegion.cpp</a></li>
<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_ff4d04a04db2d9da869faf00456dae4a.html">old</a></li><li class="navelem"><a class="el" href="dir_bc52d8277bb3559033e4c611131edd96.html">boxRegion</a></li><li class="navelem"><a class="el" href="boxRegion_8cpp.html">boxRegion.cpp</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>