184 lines
18 KiB
HTML
184 lines
18 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.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&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_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">demComponent.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="demComponent_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> <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">#include "<a class="code" href="demComponent_8hpp.html">demComponent.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="systemControl_8hpp.html">systemControl.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="Time_8hpp.html">Time.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2"> 25</a></span> <a class="code" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">pFlow::demComponent::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>& control)</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> :</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  control_(control),</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  time_(control.time()),</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  timers_(name, &control.timers()),</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  componentName_(name)</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>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a987c4fc5fe3a75305eede553d3efc279"> 33</a></span> <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a> <a class="code" href="classpFlow_1_1demComponent.html#a987c4fc5fe3a75305eede553d3efc279">pFlow::demComponent::dt</a>()<span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">return</span> time_.dt();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> }</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a78dd57bd659107f17021b099cb853a0e"> 38</a></span> <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a> <a class="code" href="classpFlow_1_1demComponent.html#a78dd57bd659107f17021b099cb853a0e">pFlow::demComponent::currentTime</a>()<span class="keyword">const</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> time_.currentTime();</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a3fe92d89e0339f3b0ccb505a1aac2182"> 43</a></span> <a class="code" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">pFlow::uint32</a> <a class="code" href="classpFlow_1_1demComponent.html#a3fe92d89e0339f3b0ccb505a1aac2182">pFlow::demComponent::currentIter</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> time_.currentIter();</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classpFlow_1_1demComponent.html#a71b953704058a7ca76b3056ae9215a64"> 48</a></span> <a class="code" href="classpFlow_1_1timeInfo.html">pFlow::timeInfo</a> <a class="code" href="classpFlow_1_1demComponent.html#a71b953704058a7ca76b3056ae9215a64">pFlow::demComponent::TimeInfo</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword"></span>{</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> time_.TimeInfo();</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</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="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="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="asystemControl_8hpp_html"><div class="ttname"><a href="systemControl_8hpp.html">systemControl.hpp</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="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_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_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="aTime_8hpp_html"><div class="ttname"><a href="Time_8hpp.html">Time.hpp</a></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="ademComponent_8hpp_html"><div class="ttname"><a href="demComponent_8hpp.html">demComponent.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 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_8cpp.html">demComponent.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>
|