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
@ -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/sphereRegion/sphereRegion.cpp Source File</title>
|
||||
<title>PhasicFlow: src/phasicFlow/structuredData/peakableRegion/old/sphereRegion/sphereRegion.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>
|
||||
@ -192,20 +192,20 @@ $(document).ready(function(){initNavTree('sphereRegion_8cpp_source.html',''); in
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_af62a3e07c6f230fc63639ad004e40c7e"><div class="ttname"><a href="classpFlow_1_1sphere.html#af62a3e07c6f230fc63639ad004e40c7e">pFlow::sphere::center</a></div><div class="ttdeci">const INLINE_FUNCTION_HD realx3 & center() const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00084">sphere.hpp:84</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00057">error.hpp:57</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00349">dictionary.cpp:349</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdoc">global name of entry, separated with dots</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00356">dictionary.cpp:356</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphereRegion_html_a256801ded70af260d2660fb42c6de353"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#a256801ded70af260d2660fb42c6de353">pFlow::sphereRegion::sphere_</a></div><div class="ttdeci">sphere sphere_</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8hpp_source.html#l00037">sphereRegion.hpp:37</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphereRegion_html_aaa6340380ab7af3599579f49f62308da"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#aaa6340380ab7af3599579f49f62308da">pFlow::sphereRegion::isInside</a></div><div class="ttdeci">bool isInside(const realx3 &p) const</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8cpp_source.html#l00036">sphereRegion.cpp:36</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphereRegion_html_a6964e9f1f100001543fdb044fa7fc896"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#a6964e9f1f100001543fdb044fa7fc896">pFlow::sphereRegion::write</a></div><div class="ttdeci">bool write(dictionary &dict) const</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8cpp_source.html#l00072">sphereRegion.cpp:72</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00042">error.hpp:42</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00053">builtinTypes.hpp:53</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdoc">Report a fatal error and function name and exit the application.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00077">error.hpp:77</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00050">builtinTypes.hpp:50</a></div></div>
|
||||
<div class="ttc" id="adictionary_8hpp_html"><div class="ttname"><a href="dictionary_8hpp.html">dictionary.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphereRegion_html_a809105944d87bd27bb8fa71167a86e14"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#a809105944d87bd27bb8fa71167a86e14">pFlow::sphereRegion::random_</a></div><div class="ttdeci">uniformRandomReal random_</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8hpp_source.html#l00039">sphereRegion.hpp:39</a></div></div>
|
||||
<div class="ttc" id="asphereRegion_8hpp_html"><div class="ttname"><a href="sphereRegion_8hpp.html">sphereRegion.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphereRegion_html_a742999f822100111462c25118a0ce0fe"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#a742999f822100111462c25118a0ce0fe">pFlow::sphereRegion::peek</a></div><div class="ttdeci">realx3 peek() const</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8cpp_source.html#l00043">sphereRegion.cpp:43</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_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_1sphereRegion_html_a6ce0c64db98eb6144d363dbfc86104eb"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#a6ce0c64db98eb6144d363dbfc86104eb">pFlow::sphereRegion::read</a></div><div class="ttdeci">bool read(const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8cpp_source.html#l00062">sphereRegion.cpp:62</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a4611c0bbd5b552873706e6d361f8b43f"><div class="ttname"><a href="classpFlow_1_1sphere.html#a4611c0bbd5b552873706e6d361f8b43f">pFlow::sphere::radius</a></div><div class="ttdeci">INLINE_FUNCTION_HD real radius() const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00103">sphere.hpp:103</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphereRegion_html_aed469d8de2a8ec4c52770d425984590e"><div class="ttname"><a href="classpFlow_1_1sphereRegion.html#aed469d8de2a8ec4c52770d425984590e">pFlow::sphereRegion::sphereRegion</a></div><div class="ttdeci">sphereRegion(const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="sphereRegion_8cpp_source.html#l00025">sphereRegion.cpp:25</a></div></div>
|
||||
@ -213,7 +213,7 @@ $(document).ready(function(){initNavTree('sphereRegion_8cpp_source.html',''); in
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a898603c1e4e433d2f304d86f1a22c53c"><div class="ttname"><a href="classpFlow_1_1sphere.html#a898603c1e4e433d2f304d86f1a22c53c">pFlow::sphere::isInside</a></div><div class="ttdeci">INLINE_FUNCTION_HD bool isInside(const realx3 &point) const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00075">sphere.hpp:75</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_fb2432dbf0f69477b9490b647f01f2fa.html">sphereRegion</a></li><li class="navelem"><a class="el" href="sphereRegion_8cpp.html">sphereRegion.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_b3c077fec41f6d1e5a3abf0dbabe286b.html">sphereRegion</a></li><li class="navelem"><a class="el" href="sphereRegion_8cpp.html">sphereRegion.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>
|
||||
|
||||
Reference in New Issue
Block a user