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.hpp Source File</title>
<title>PhasicFlow: src/phasicFlow/structuredData/peakableRegion/old/boxRegion/boxRegion.hpp 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>
@ -172,7 +172,7 @@ $(document).ready(function(){initNavTree('boxRegion_8hpp_source.html',''); initR
<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="abox_8hpp_html"><div class="ttname"><a href="box_8hpp.html">box.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</a></div></div>
<div class="ttc" id="aclasspFlow_1_1uniformRandomReal_html"><div class="ttname"><a href="classpFlow_1_1uniformRandomReal.html">pFlow::uniformRandomReal</a></div><div class="ttdef"><b>Definition:</b> <a href="uniformRandomReal_8hpp_source.html#l00032">uniformRandomReal.hpp:32</a></div></div>
<div class="ttc" id="auniformRandomReal_8hpp_html"><div class="ttname"><a href="uniformRandomReal_8hpp.html">uniformRandomReal.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1boxRegion_html_a66c49023a41a748e1f69ca1954186c06"><div class="ttname"><a href="classpFlow_1_1boxRegion.html#a66c49023a41a748e1f69ca1954186c06">pFlow::boxRegion::~boxRegion</a></div><div class="ttdeci">~boxRegion()=default</div></div>
@ -181,12 +181,12 @@ $(document).ready(function(){initNavTree('boxRegion_8hpp_source.html',''); initR
<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_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 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_8hpp.html">boxRegion.hpp</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_8hpp.html">boxRegion.hpp</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>