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

390 lines
21 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: timeInfo Class Reference</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('classpFlow_1_1timeInfo.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classpFlow_1_1timeInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">timeInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afedafd81a951da8337bce77fdc14f442"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#afedafd81a951da8337bce77fdc14f442">timeInfo</a> (<a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> cIter, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> cTime, <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> <a class="el" href="classpFlow_1_1timeInfo.html#ab27fc2e669d34a0f956786f8000ca284">dt</a>)</td></tr>
<tr class="separator:afedafd81a951da8337bce77fdc14f442"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf39a85732afffe30b0bc9f11f3294cd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#abf39a85732afffe30b0bc9f11f3294cd">t</a> () const</td></tr>
<tr class="separator:abf39a85732afffe30b0bc9f11f3294cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab27fc2e669d34a0f956786f8000ca284"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#ab27fc2e669d34a0f956786f8000ca284">dt</a> () const</td></tr>
<tr class="separator:ab27fc2e669d34a0f956786f8000ca284"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafddac2ca8db0456c5674a914ed28545"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#aafddac2ca8db0456c5674a914ed28545">iter</a> () const</td></tr>
<tr class="separator:aafddac2ca8db0456c5674a914ed28545"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a01b433e58b02666fe5618d951bc859f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#a01b433e58b02666fe5618d951bc859f9">currentIter_</a></td></tr>
<tr class="separator:a01b433e58b02666fe5618d951bc859f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5083b95d767de3c06e191d0b016f209"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#aa5083b95d767de3c06e191d0b016f209">currentTime_</a></td></tr>
<tr class="separator:aa5083b95d767de3c06e191d0b016f209"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7c0e1c754daddef0aa990fccb8ef033"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1timeInfo.html#ab7c0e1c754daddef0aa990fccb8ef033">dt_</a></td></tr>
<tr class="separator:ab7c0e1c754daddef0aa990fccb8ef033"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00028">28</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afedafd81a951da8337bce77fdc14f442"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afedafd81a951da8337bce77fdc14f442">&#9670;&nbsp;</a></span>timeInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1timeInfo.html">timeInfo</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
<td class="paramname"><em>cIter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td>
<td class="paramname"><em>cTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td>
<td class="paramname"><em>dt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00040">40</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abf39a85732afffe30b0bc9f11f3294cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf39a85732afffe30b0bc9f11f3294cd">&#9670;&nbsp;</a></span>t()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&amp; t </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00047">47</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
<p class="reference">References <a class="el" href="timeInfo_8hpp_source.html#l00034">timeInfo::currentTime_</a>.</p>
<p class="reference">Referenced by <a class="el" href="pointStructure_8cpp_source.html#l00175">pointStructure::beforeIteration()</a>, <a class="el" href="ContactSearch_8hpp_source.html#l00080">ContactSearch&lt; searchMethod &gt;::BoundaryBroadSearch()</a>, <a class="el" href="ContactSearch_8hpp_source.html#l00056">ContactSearch&lt; searchMethod &gt;::BroadSearch()</a>, <a class="el" href="sphereInteraction_8cpp_source.html#l00162">sphereInteraction&lt; contactForceModel, geometryMotionModel, contactListType &gt;::iterate()</a>, <a class="el" href="grainInteraction_8cpp_source.html#l00164">grainInteraction&lt; contactForceModel, geometryMotionModel, contactListType &gt;::iterate()</a>, and <a class="el" href="subscriber_8cpp_source.html#l00156">subscriber::notify()</a>.</p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1timeInfo_abf39a85732afffe30b0bc9f11f3294cd_icgraph.png" border="0" usemap="#classpFlow_1_1timeInfo_abf39a85732afffe30b0bc9f11f3294cd_icgraph" alt=""/></div>
</div>
</div>
</div>
<a id="ab27fc2e669d34a0f956786f8000ca284"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab27fc2e669d34a0f956786f8000ca284">&#9670;&nbsp;</a></span>dt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&amp; dt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00051">51</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
<p class="reference">References <a class="el" href="timeInfo_8hpp_source.html#l00036">timeInfo::dt_</a>.</p>
<p class="reference">Referenced by <a class="el" href="pointStructure_8cpp_source.html#l00175">pointStructure::beforeIteration()</a>, <a class="el" href="ContactSearch_8hpp_source.html#l00080">ContactSearch&lt; searchMethod &gt;::BoundaryBroadSearch()</a>, <a class="el" href="ContactSearch_8hpp_source.html#l00056">ContactSearch&lt; searchMethod &gt;::BroadSearch()</a>, <a class="el" href="sphereInteraction_8cpp_source.html#l00162">sphereInteraction&lt; contactForceModel, geometryMotionModel, contactListType &gt;::iterate()</a>, <a class="el" href="grainInteraction_8cpp_source.html#l00164">grainInteraction&lt; contactForceModel, geometryMotionModel, contactListType &gt;::iterate()</a>, and <a class="el" href="subscriber_8cpp_source.html#l00156">subscriber::notify()</a>.</p>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1timeInfo_ab27fc2e669d34a0f956786f8000ca284_icgraph.png" border="0" usemap="#classpFlow_1_1timeInfo_ab27fc2e669d34a0f956786f8000ca284_icgraph" alt=""/></div>
</div>
</div>
</div>
<a id="aafddac2ca8db0456c5674a914ed28545"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafddac2ca8db0456c5674a914ed28545">&#9670;&nbsp;</a></span>iter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&amp; iter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00055">55</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
<p class="reference">References <a class="el" href="timeInfo_8hpp_source.html#l00032">timeInfo::currentIter_</a>.</p>
<p class="reference">Referenced by <a class="el" href="boundaryList_8cpp_source.html#l00252">boundaryList::afterIteration()</a>, <a class="el" href="pointStructure_8cpp_source.html#l00175">pointStructure::beforeIteration()</a>, <a class="el" href="boundaryList_8cpp_source.html#l00186">boundaryList::beforeIteration()</a>, <a class="el" href="ContactSearch_8hpp_source.html#l00080">ContactSearch&lt; searchMethod &gt;::BoundaryBroadSearch()</a>, <a class="el" href="ContactSearch_8hpp_source.html#l00056">ContactSearch&lt; searchMethod &gt;::BroadSearch()</a>, <a class="el" href="contactSearch_8hpp_source.html#l00139">contactSearch::enterBroadSearch()</a>, <a class="el" href="grainInteraction_8cpp_source.html#l00164">grainInteraction&lt; contactForceModel, geometryMotionModel, contactListType &gt;::iterate()</a>, <a class="el" href="sphereInteraction_8cpp_source.html#l00162">sphereInteraction&lt; contactForceModel, geometryMotionModel, contactListType &gt;::iterate()</a>, and <a class="el" href="subscriber_8cpp_source.html#l00156">subscriber::notify()</a>.</p>
<div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1timeInfo_aafddac2ca8db0456c5674a914ed28545_icgraph.png" border="0" usemap="#classpFlow_1_1timeInfo_aafddac2ca8db0456c5674a914ed28545_icgraph" alt=""/></div>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a01b433e58b02666fe5618d951bc859f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01b433e58b02666fe5618d951bc859f9">&#9670;&nbsp;</a></span>currentIter_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> currentIter_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00032">32</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="timeInfo_8hpp_source.html#l00055">timeInfo::iter()</a>.</p>
</div>
</div>
<a id="aa5083b95d767de3c06e191d0b016f209"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5083b95d767de3c06e191d0b016f209">&#9670;&nbsp;</a></span>currentTime_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> currentTime_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00034">34</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="timeInfo_8hpp_source.html#l00047">timeInfo::t()</a>.</p>
</div>
</div>
<a id="ab7c0e1c754daddef0aa990fccb8ef033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7c0e1c754daddef0aa990fccb8ef033">&#9670;&nbsp;</a></span>dt_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timeInfo_8hpp_source.html#l00036">36</a> of file <a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="timeInfo_8hpp_source.html#l00051">timeInfo::dt()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/phasicFlow/repository/Time/<a class="el" href="timeInfo_8hpp_source.html">timeInfo.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1timeInfo.html">timeInfo</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>