297 lines
41 KiB
HTML
297 lines
41 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/demComponent/demComponent.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>
|
|
<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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('demComponent_8hpp_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">demComponent.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="demComponent_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> O C enter of</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> O O E ngineering and</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> O O M ultiscale modeling of</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> OOOOOOO F luid flow </span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Copyright (C): www.cemf.ir</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">------------------------------------------------------------------------------ </span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Licence:</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This file is part of phasicFlow code. It is a free software for simulating </span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> granular and multiphase flows. You can redistribute it and/or modify it under</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> the terms of GNU General Public License v3 or any other later versions. </span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> phasicFlow is distributed to help others in their research in the field of </span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">-----------------------------------------------------------------------------*/</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef __demComponent_hpp__ </span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define __demComponent_hpp__</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="types_8hpp.html">types.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="typeInfo_8hpp.html">typeInfo.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="timeInfo_8hpp.html">timeInfo.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="Timers_8hpp.html">Timers.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>systemControl;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Time;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classpFlow_1_1demComponent.html">demComponent</a></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// - Protected data members </span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076"> 48</a></span>  <a class="code" href="classpFlow_1_1systemControl.html">systemControl</a>& <a class="code" href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">control_</a>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a97d6a106e35c444e647a69f8a8ba7f9b"> 50</a></span>  <a class="code" href="classpFlow_1_1Time.html">Time</a>& <a class="code" href="classpFlow_1_1demComponent.html#a97d6a106e35c444e647a69f8a8ba7f9b">time_</a>;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c"> 53</a></span>  <a class="code" href="classpFlow_1_1Timers.html">Timers</a> <a class="code" href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">timers_</a>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a3ce96806ed72189c4d9a24e9429d0420"> 56</a></span>  <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> <a class="code" href="classpFlow_1_1demComponent.html#a3ce96806ed72189c4d9a24e9429d0420">componentName_</a>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classpFlow_1_1demComponent.html#a3145c3f3cba34861e279260ada91e0de">TypeInfo</a>(<span class="stringliteral">"demComponent"</span>);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// - Constructors</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">demComponent</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& name, <a class="code" href="classpFlow_1_1systemControl.html">systemControl</a>& <a class="code" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a>);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">demComponent</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1demComponent.html">demComponent</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">demComponent</a>(<a class="code" href="classpFlow_1_1demComponent.html">demComponent</a>&&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classpFlow_1_1demComponent.html">demComponent</a>& <a class="code" href="classpFlow_1_1demComponent.html#a95e1df66e5604c2920686b6a6c4e4c10">operator = </a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1demComponent.html">demComponent</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classpFlow_1_1demComponent.html">demComponent</a>& <a class="code" href="classpFlow_1_1demComponent.html#a95e1df66e5604c2920686b6a6c4e4c10">operator =</a>(<a class="code" href="classpFlow_1_1demComponent.html">demComponent</a>&&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> <a class="code" href="classpFlow_1_1demComponent.html#a9ab4d5fa34944c13f3a07ec25b4fd666">~demComponent</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// - Member functions </span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">inline</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0"> 88</a></span>  <span class="keyword">const</span> <span class="keyword">auto</span>& <a class="code" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a>()<span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">control_</a>;</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">inline</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#ae1afde9cfe19a586522259a33a4931e3"> 95</a></span>  <span class="keyword">auto</span>& <a class="code" href="classpFlow_1_1demComponent.html#ae1afde9cfe19a586522259a33a4931e3">control</a>()</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  {</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">control_</a>;</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> <a class="code" href="classpFlow_1_1demComponent.html#a987c4fc5fe3a75305eede553d3efc279">dt</a>()<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> <a class="code" href="classpFlow_1_1demComponent.html#a78dd57bd659107f17021b099cb853a0e">currentTime</a>()<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> <a class="code" href="classpFlow_1_1demComponent.html#a3fe92d89e0339f3b0ccb505a1aac2182">currentIter</a>()<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="classpFlow_1_1timeInfo.html">timeInfo</a> <a class="code" href="classpFlow_1_1demComponent.html#a71b953704058a7ca76b3056ae9215a64">TimeInfo</a>()<span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">inline</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a40f341a9cb1091ba9e3670f98cd002c3"> 113</a></span>  <span class="keyword">const</span> <span class="keyword">auto</span>& <a class="code" href="classpFlow_1_1demComponent.html#a40f341a9cb1091ba9e3670f98cd002c3">time</a>()<span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1demComponent.html#a97d6a106e35c444e647a69f8a8ba7f9b">time_</a>;</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">inline</span> </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a40e6d687c4d54c66dfe5b1bc5a0d28ce"> 119</a></span>  <span class="keyword">auto</span>& <a class="code" href="classpFlow_1_1demComponent.html#a40e6d687c4d54c66dfe5b1bc5a0d28ce">time</a>()</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  {</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1demComponent.html#a97d6a106e35c444e647a69f8a8ba7f9b">time_</a>;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  }</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">inline</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d"> 127</a></span>  <span class="keyword">const</span> <span class="keyword">auto</span>& <a class="code" href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">timers</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">timers_</a>;</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">inline</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f"> 134</a></span>  <span class="keyword">auto</span>& <a class="code" href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">timers</a>()</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  {</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">timers_</a>;</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#ab272f2a135d95ff17ad06338049a2cd5"> 141</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1demComponent.html#ab272f2a135d95ff17ad06338049a2cd5">beforeTimeLoop</a>()</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  {</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">notImplementedFunction</a>;</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">virtual</span> </div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1demComponent.html#a87d9b39a0e924bb21ed4a165140836de">beforeIteration</a>() = 0;</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">virtual</span> </div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1demComponent.html#ad9e44c3349e7a9a5b6ba72c9db344b96">iterate</a>() = 0;</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">virtual</span> </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1demComponent.html#ac7d2399b393b6dfa6f00ad9bcd524437">afterIteration</a>() = 0;</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a0b82b161f3fd39ee9f534cc2508d97f8"> 162</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1demComponent.html#a0b82b161f3fd39ee9f534cc2508d97f8">afterTimeLoop</a>()</div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  {</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">notImplementedFunction</a>;</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  }</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> };</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  </div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> }</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  </div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a73e3f3cd6a8eca86e6862f02e416dba2"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">pFlow::demComponent::demComponent</a></div><div class="ttdeci">demComponent(const word &name, systemControl &control)</div><div class="ttdoc">construct from components</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8cpp_source.html#l00025">demComponent.cpp:25</a></div></div>
|
|
<div class="ttc" id="aerror_8hpp_html_a6d29ef74f19f6d5a225841705985eb8b"><div class="ttname"><a href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">notImplementedFunction</a></div><div class="ttdeci">#define notImplementedFunction</div><div class="ttdoc">Report that a function is yet not implemented.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00084">error.hpp:84</a></div></div>
|
|
<div class="ttc" id="anamespacepFlow_html_a6192191c0e9c178a44ee1ac350fde476"><div class="ttname"><a href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a></div><div class="ttdeci">float real</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00045">builtinTypes.hpp:45</a></div></div>
|
|
<div class="ttc" id="atimeInfo_8hpp_html"><div class="ttname"><a href="timeInfo_8hpp.html">timeInfo.hpp</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a647786897b3da03fcd415b2ebcf541c0"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">pFlow::demComponent::control</a></div><div class="ttdeci">const auto & control() const</div><div class="ttdoc">Const ref to systemControl.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00088">demComponent.hpp:88</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a71b953704058a7ca76b3056ae9215a64"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a71b953704058a7ca76b3056ae9215a64">pFlow::demComponent::TimeInfo</a></div><div class="ttdeci">timeInfo TimeInfo() const</div><div class="ttdoc">return time info of the simulaiton</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8cpp_source.html#l00048">demComponent.cpp:48</a></div></div>
|
|
<div class="ttc" id="atypes_8hpp_html"><div class="ttname"><a href="types_8hpp.html">types.hpp</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a0b82b161f3fd39ee9f534cc2508d97f8"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a0b82b161f3fd39ee9f534cc2508d97f8">pFlow::demComponent::afterTimeLoop</a></div><div class="ttdeci">virtual bool afterTimeLoop()</div><div class="ttdoc">This is called after the time loop.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00162">demComponent.hpp:162</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a40f341a9cb1091ba9e3670f98cd002c3"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a40f341a9cb1091ba9e3670f98cd002c3">pFlow::demComponent::time</a></div><div class="ttdeci">const auto & time() const</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00113">demComponent.hpp:113</a></div></div>
|
|
<div class="ttc" id="anamespacepFlow_html_abd01e8e67e3d94cab04ecaaf4f85ac1b"><div class="ttname"><a href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">pFlow::uint32</a></div><div class="ttdeci">unsigned int uint32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00056">builtinTypes.hpp:56</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a95e1df66e5604c2920686b6a6c4e4c10"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a95e1df66e5604c2920686b6a6c4e4c10">pFlow::demComponent::operator=</a></div><div class="ttdeci">demComponent & operator=(const demComponent &)=delete</div><div class="ttdoc">No copy assignment.</div></div>
|
|
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1systemControl_html"><div class="ttname"><a href="classpFlow_1_1systemControl.html">pFlow::systemControl</a></div><div class="ttdef"><b>Definition:</b> <a href="systemControl_8hpp_source.html#l00041">systemControl.hpp:41</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1Timers_html"><div class="ttname"><a href="classpFlow_1_1Timers.html">pFlow::Timers</a></div><div class="ttdef"><b>Definition:</b> <a href="Timers_8hpp_source.html#l00032">Timers.hpp:32</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_ac7d2399b393b6dfa6f00ad9bcd524437"><div class="ttname"><a href="classpFlow_1_1demComponent.html#ac7d2399b393b6dfa6f00ad9bcd524437">pFlow::demComponent::afterIteration</a></div><div class="ttdeci">virtual bool afterIteration()=0</div><div class="ttdoc">This is called in time loop, after iterate.</div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_ae69e59e991f33e7d278ff6ad19d2e87d"><div class="ttname"><a href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">pFlow::demComponent::timers</a></div><div class="ttdeci">const auto & timers() const</div><div class="ttdoc">Const ref to timers.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00127">demComponent.hpp:127</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_ae1afde9cfe19a586522259a33a4931e3"><div class="ttname"><a href="classpFlow_1_1demComponent.html#ae1afde9cfe19a586522259a33a4931e3">pFlow::demComponent::control</a></div><div class="ttdeci">auto & control()</div><div class="ttdoc">Ref to systemControl.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00095">demComponent.hpp:95</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1timeInfo_html"><div class="ttname"><a href="classpFlow_1_1timeInfo.html">pFlow::timeInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="timeInfo_8hpp_source.html#l00028">timeInfo.hpp:28</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_abfbc3debb472c661c30cf9fe782bb076"><div class="ttname"><a href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">pFlow::demComponent::control_</a></div><div class="ttdeci">systemControl & control_</div><div class="ttdoc">Reference to systemControl.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00048">demComponent.hpp:48</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_1demComponent_html_a0c29ef9514a77bce5b8f4ece533bcf8c"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">pFlow::demComponent::timers_</a></div><div class="ttdeci">Timers timers_</div><div class="ttdoc">All timers (if any) of this component.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00053">demComponent.hpp:53</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a3fe92d89e0339f3b0ccb505a1aac2182"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a3fe92d89e0339f3b0ccb505a1aac2182">pFlow::demComponent::currentIter</a></div><div class="ttdeci">uint32 currentIter() const</div><div class="ttdoc">return current iteration number</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8cpp_source.html#l00043">demComponent.cpp:43</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a97d6a106e35c444e647a69f8a8ba7f9b"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a97d6a106e35c444e647a69f8a8ba7f9b">pFlow::demComponent::time_</a></div><div class="ttdeci">Time & time_</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00050">demComponent.hpp:50</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html"><div class="ttname"><a href="classpFlow_1_1demComponent.html">pFlow::demComponent</a></div><div class="ttdoc">A base class for every main component of DEM system.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00042">demComponent.hpp:42</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_ab272f2a135d95ff17ad06338049a2cd5"><div class="ttname"><a href="classpFlow_1_1demComponent.html#ab272f2a135d95ff17ad06338049a2cd5">pFlow::demComponent::beforeTimeLoop</a></div><div class="ttdeci">virtual bool beforeTimeLoop()</div><div class="ttdoc">This is called before the start of time loop.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00141">demComponent.hpp:141</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a87d9b39a0e924bb21ed4a165140836de"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a87d9b39a0e924bb21ed4a165140836de">pFlow::demComponent::beforeIteration</a></div><div class="ttdeci">virtual bool beforeIteration()=0</div><div class="ttdoc">This is called in time loop, before iterate.</div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a78dd57bd659107f17021b099cb853a0e"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a78dd57bd659107f17021b099cb853a0e">pFlow::demComponent::currentTime</a></div><div class="ttdeci">real currentTime() const</div><div class="ttdoc">Current simulation time.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8cpp_source.html#l00038">demComponent.cpp:38</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a3ce96806ed72189c4d9a24e9429d0420"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a3ce96806ed72189c4d9a24e9429d0420">pFlow::demComponent::componentName_</a></div><div class="ttdeci">word componentName_</div><div class="ttdoc">Name of the DEM component.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00056">demComponent.hpp:56</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a40e6d687c4d54c66dfe5b1bc5a0d28ce"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a40e6d687c4d54c66dfe5b1bc5a0d28ce">pFlow::demComponent::time</a></div><div class="ttdeci">auto & time()</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00119">demComponent.hpp:119</a></div></div>
|
|
<div class="ttc" id="aTimers_8hpp_html"><div class="ttname"><a href="Timers_8hpp.html">Timers.hpp</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a9ab4d5fa34944c13f3a07ec25b4fd666"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a9ab4d5fa34944c13f3a07ec25b4fd666">pFlow::demComponent::~demComponent</a></div><div class="ttdeci">virtual ~demComponent()=default</div><div class="ttdoc">destructor</div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a3145c3f3cba34861e279260ada91e0de"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a3145c3f3cba34861e279260ada91e0de">pFlow::demComponent::TypeInfo</a></div><div class="ttdeci">TypeInfo("demComponent")</div><div class="ttdoc">Type info.</div></div>
|
|
<div class="ttc" id="atypeInfo_8hpp_html"><div class="ttname"><a href="typeInfo_8hpp.html">typeInfo.hpp</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a987c4fc5fe3a75305eede553d3efc279"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a987c4fc5fe3a75305eede553d3efc279">pFlow::demComponent::dt</a></div><div class="ttdeci">real dt() const</div><div class="ttdoc">Time step of integration.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8cpp_source.html#l00033">demComponent.cpp:33</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a49e56dd259a0f440e947ed17b149f32f"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">pFlow::demComponent::timers</a></div><div class="ttdeci">auto & timers()</div><div class="ttdoc">Ref to timers.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00134">demComponent.hpp:134</a></div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1demComponent_html_ad9e44c3349e7a9a5b6ba72c9db344b96"><div class="ttname"><a href="classpFlow_1_1demComponent.html#ad9e44c3349e7a9a5b6ba72c9db344b96">pFlow::demComponent::iterate</a></div><div class="ttdeci">virtual bool iterate()=0</div><div class="ttdoc">This is called in time loop.</div></div>
|
|
<div class="ttc" id="aclasspFlow_1_1Time_html"><div class="ttname"><a href="classpFlow_1_1Time.html">pFlow::Time</a></div><div class="ttdef"><b>Definition:</b> <a href="Time_8hpp_source.html#l00037">Time.hpp:37</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_29b407a9c788ba2969f3828ab07e1884.html">demComponent</a></li><li class="navelem"><a class="el" href="demComponent_8hpp.html">demComponent.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>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|