phasicFlow/doc/code-documentation/html/subSurface_8cpp_source.html

163 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<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/triSurface/subSurface.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" >
<tbody>
<tr>
<td id="projectlogo"><a href="https://github.com/PhasicFlow"><img alt="Logo" src="phasicFlow_logo.png"></a></td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
<tr>
<td id="projectbrief">
<a href="https://https://cemf.ir">www.cemf.ir</a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('subSurface_8cpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">subSurface.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="subSurface_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="subSurface_8hpp.html">subSurface.hpp</a>&quot;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a5430767ea17f2334227f4a14f2be73d5"> 3</a></span>&#160;<a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; <a class="code" href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator&lt;&lt;</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a> &amp;str, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1subSurface.html">subSurface</a> &amp;sub)</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;{</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; str.<a class="code" href="classpFlow_1_1iOstream.html#a05e38ce82900bb8c51d86ae214898e2d">beginSquare</a>()&lt;&lt;sub.<a class="code" href="classpFlow_1_1subSurface.html#a50fd7d13a0f7a6007ca5027b3bb8765a">name_</a>&lt;&lt;token::SPACE&lt;&lt;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; sub.<a class="code" href="classpFlow_1_1subSurface.html#aa62798cebd6037dc7ffc92455cc4fa57">start_</a>&lt;&lt;token::SPACE&lt;&lt;sub.<a class="code" href="classpFlow_1_1subSurface.html#a81efe340d7f84623947165c02bca0123">end_</a>&lt;&lt;token::SPACE&lt;&lt;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; sub.<a class="code" href="classpFlow_1_1subSurface.html#aad5eff5944ed14362e5b021c4cd47c2b">pointStart_</a>&lt;&lt;token::SPACE&lt;&lt;sub.<a class="code" href="classpFlow_1_1subSurface.html#a38db2b2beabb0767bf850b7ec0d119fa">pointEnd_</a>;</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; str.<a class="code" href="classpFlow_1_1iOstream.html#a63bdc1079581492459ced30d6e523d17">endSquare</a>(); </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; str.<a class="code" href="classpFlow_1_1IOstream.html#a367eb3425fc4e8270e2aa961df8ac8a5">check</a>(<a class="code" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>);</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keywordflow">return</span> str;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;}</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a476746f624b8d3b8680f931419b9e2d1"> 15</a></span>&#160;<a class="code" href="classpFlow_1_1iIstream.html">pFlow::iIstream</a>&amp; <a class="code" href="namespacepFlow.html#a85ed561d066dae339196cd058783674f">pFlow::operator&gt;&gt;</a>(<a class="code" href="classpFlow_1_1iIstream.html">iIstream</a> &amp;str, <a class="code" href="classpFlow_1_1subSurface.html">subSurface</a> &amp;sub)</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; str.<a class="code" href="classpFlow_1_1iIstream.html#a82106c627eb5a496726f0829a62e38bb">readBeginSquare</a>(<span class="stringliteral">&quot;subSurface&quot;</span>);</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; str &gt;&gt; sub.<a class="code" href="classpFlow_1_1subSurface.html#a50fd7d13a0f7a6007ca5027b3bb8765a">name_</a>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; str &gt;&gt; sub.<a class="code" href="classpFlow_1_1subSurface.html#aa62798cebd6037dc7ffc92455cc4fa57">start_</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; str &gt;&gt; sub.<a class="code" href="classpFlow_1_1subSurface.html#a81efe340d7f84623947165c02bca0123">end_</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; str &gt;&gt; sub.<a class="code" href="classpFlow_1_1subSurface.html#aad5eff5944ed14362e5b021c4cd47c2b">pointStart_</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; str &gt;&gt; sub.<a class="code" href="classpFlow_1_1subSurface.html#a38db2b2beabb0767bf850b7ec0d119fa">pointEnd_</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; str.<a class="code" href="classpFlow_1_1iIstream.html#a17598aa2666f2552b651085a5c6dfb23">readEndSquare</a>(<span class="stringliteral">&quot;subSurface&quot;</span>);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; str.<a class="code" href="classpFlow_1_1IOstream.html#a367eb3425fc4e8270e2aa961df8ac8a5">check</a>(<a class="code" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">return</span> str;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="apFlowMacros_8hpp_html_a922d2784284e8f6ee4009c3d92ba48b6"><div class="ttname"><a href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a></div><div class="ttdeci">#define FUNCTION_NAME</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00029">pFlowMacros.hpp:29</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a367eb3425fc4e8270e2aa961df8ac8a5"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a367eb3425fc4e8270e2aa961df8ac8a5">pFlow::IOstream::check</a></div><div class="ttdeci">virtual bool check(const char *operation) const</div><div class="ttdoc">Check IOstream status for given operation.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00042">IOstream.cpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdoc">Interface class for any input stream</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00037">iIstream.hpp:37</a></div></div>
<div class="ttc" id="aclasspFlow_1_1subSurface_html_a38db2b2beabb0767bf850b7ec0d119fa"><div class="ttname"><a href="classpFlow_1_1subSurface.html#a38db2b2beabb0767bf850b7ec0d119fa">pFlow::subSurface::pointEnd_</a></div><div class="ttdeci">uint32 pointEnd_</div><div class="ttdef"><b>Definition:</b> <a href="subSurface_8hpp_source.html#l00036">subSurface.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1subSurface_html_a81efe340d7f84623947165c02bca0123"><div class="ttname"><a href="classpFlow_1_1subSurface.html#a81efe340d7f84623947165c02bca0123">pFlow::subSurface::end_</a></div><div class="ttdeci">uint32 end_</div><div class="ttdef"><b>Definition:</b> <a href="subSurface_8hpp_source.html#l00032">subSurface.hpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a05e38ce82900bb8c51d86ae214898e2d"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a05e38ce82900bb8c51d86ae214898e2d">pFlow::iOstream::beginSquare</a></div><div class="ttdeci">virtual iOstream &amp; beginSquare()</div><div class="ttdoc">Write begin list &quot;[&quot;.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00160">iOstream.cpp:160</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a85ed561d066dae339196cd058783674f"><div class="ttname"><a href="namespacepFlow.html#a85ed561d066dae339196cd058783674f">pFlow::operator&gt;&gt;</a></div><div class="ttdeci">INLINE_FUNCTION iIstream &amp; operator&gt;&gt;(iIstream &amp;str, AB3History &amp;ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00041">AdamsBashforth3.hpp:41</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a148d74ad0977268be8ea8b26a147f619"><div class="ttname"><a href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator&lt;&lt;</a></div><div class="ttdeci">INLINE_FUNCTION iOstream &amp; operator&lt;&lt;(iOstream &amp;str, const AB3History &amp;ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00057">AdamsBashforth3.hpp:57</a></div></div>
<div class="ttc" id="asubSurface_8hpp_html"><div class="ttname"><a href="subSurface_8hpp.html">subSurface.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1subSurface_html_a50fd7d13a0f7a6007ca5027b3bb8765a"><div class="ttname"><a href="classpFlow_1_1subSurface.html#a50fd7d13a0f7a6007ca5027b3bb8765a">pFlow::subSurface::name_</a></div><div class="ttdeci">word name_</div><div class="ttdef"><b>Definition:</b> <a href="subSurface_8hpp_source.html#l00038">subSurface.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1subSurface_html_aa62798cebd6037dc7ffc92455cc4fa57"><div class="ttname"><a href="classpFlow_1_1subSurface.html#aa62798cebd6037dc7ffc92455cc4fa57">pFlow::subSurface::start_</a></div><div class="ttdeci">uint32 start_</div><div class="ttdef"><b>Definition:</b> <a href="subSurface_8hpp_source.html#l00030">subSurface.hpp:30</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_a82106c627eb5a496726f0829a62e38bb"><div class="ttname"><a href="classpFlow_1_1iIstream.html#a82106c627eb5a496726f0829a62e38bb">pFlow::iIstream::readBeginSquare</a></div><div class="ttdeci">bool readBeginSquare(const char *funcName)</div><div class="ttdoc">Begin read of data chunk, starts with '('.</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8cpp_source.html#l00277">iIstream.cpp:277</a></div></div>
<div class="ttc" id="aclasspFlow_1_1subSurface_html_aad5eff5944ed14362e5b021c4cd47c2b"><div class="ttname"><a href="classpFlow_1_1subSurface.html#aad5eff5944ed14362e5b021c4cd47c2b">pFlow::subSurface::pointStart_</a></div><div class="ttdeci">uint32 pointStart_</div><div class="ttdef"><b>Definition:</b> <a href="subSurface_8hpp_source.html#l00034">subSurface.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a63bdc1079581492459ced30d6e523d17"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a63bdc1079581492459ced30d6e523d17">pFlow::iOstream::endSquare</a></div><div class="ttdeci">virtual iOstream &amp; endSquare()</div><div class="ttdoc">Write end list &quot;]&quot;.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00179">iOstream.cpp:179</a></div></div>
<div class="ttc" id="aclasspFlow_1_1subSurface_html"><div class="ttname"><a href="classpFlow_1_1subSurface.html">pFlow::subSurface</a></div><div class="ttdef"><b>Definition:</b> <a href="subSurface_8hpp_source.html#l00027">subSurface.hpp:27</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdoc">Interface class for any output stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00059">iOstream.hpp:59</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_a17598aa2666f2552b651085a5c6dfb23"><div class="ttname"><a href="classpFlow_1_1iIstream.html#a17598aa2666f2552b651085a5c6dfb23">pFlow::iIstream::readEndSquare</a></div><div class="ttdeci">bool readEndSquare(const char *funcName)</div><div class="ttdoc">Begin read of data chunk, starts with '('.</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8cpp_source.html#l00296">iIstream.cpp:296</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_38cf8104b99597e1233d708542fdeb18.html">triSurface</a></li><li class="navelem"><a class="el" href="subSurface_8cpp.html">subSurface.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>
</ul>
</div>
</body>
</html>