977 lines
54 KiB
HTML
977 lines
54 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: demComponent 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&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('classpFlow_1_1demComponent.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> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classpFlow_1_1demComponent-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">demComponent Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A base class for every main component of DEM system.
|
|
<a href="classpFlow_1_1demComponent.html#details">More...</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="+"/> Inheritance diagram for demComponent:</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_1demComponent__inherit__graph.png" border="0" usemap="#demComponent_inherit__map" alt="Inheritance graph"/></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for demComponent:</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_1demComponent__coll__graph.png" border="0" usemap="#demComponent_coll__map" alt="Collaboration graph"/></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a3145c3f3cba34861e279260ada91e0de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a3145c3f3cba34861e279260ada91e0de">TypeInfo</a> ("demComponent")</td></tr>
|
|
<tr class="memdesc:a3145c3f3cba34861e279260ada91e0de"><td class="mdescLeft"> </td><td class="mdescRight">Type info. <a href="classpFlow_1_1demComponent.html#a3145c3f3cba34861e279260ada91e0de">More...</a><br /></td></tr>
|
|
<tr class="separator:a3145c3f3cba34861e279260ada91e0de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73e3f3cd6a8eca86e6862f02e416dba2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">demComponent</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &name, <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> &<a class="el" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a>)</td></tr>
|
|
<tr class="memdesc:a73e3f3cd6a8eca86e6862f02e416dba2"><td class="mdescLeft"> </td><td class="mdescRight">construct from components <a href="classpFlow_1_1demComponent.html#a73e3f3cd6a8eca86e6862f02e416dba2">More...</a><br /></td></tr>
|
|
<tr class="separator:a73e3f3cd6a8eca86e6862f02e416dba2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a876cdfe70008c20f9136c8a730c3f71a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a876cdfe70008c20f9136c8a730c3f71a">demComponent</a> (const <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a876cdfe70008c20f9136c8a730c3f71a"><td class="mdescLeft"> </td><td class="mdescRight">No copy constructor. <a href="classpFlow_1_1demComponent.html#a876cdfe70008c20f9136c8a730c3f71a">More...</a><br /></td></tr>
|
|
<tr class="separator:a876cdfe70008c20f9136c8a730c3f71a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff5dda77742aff7e01ae5d1b1ceb38b7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#aff5dda77742aff7e01ae5d1b1ceb38b7">demComponent</a> (<a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> &&)=delete</td></tr>
|
|
<tr class="memdesc:aff5dda77742aff7e01ae5d1b1ceb38b7"><td class="mdescLeft"> </td><td class="mdescRight">No move constructor. <a href="classpFlow_1_1demComponent.html#aff5dda77742aff7e01ae5d1b1ceb38b7">More...</a><br /></td></tr>
|
|
<tr class="separator:aff5dda77742aff7e01ae5d1b1ceb38b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95e1df66e5604c2920686b6a6c4e4c10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a95e1df66e5604c2920686b6a6c4e4c10">operator=</a> (const <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a95e1df66e5604c2920686b6a6c4e4c10"><td class="mdescLeft"> </td><td class="mdescRight">No copy assignment. <a href="classpFlow_1_1demComponent.html#a95e1df66e5604c2920686b6a6c4e4c10">More...</a><br /></td></tr>
|
|
<tr class="separator:a95e1df66e5604c2920686b6a6c4e4c10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a836aaf5b9cd26f2e17faf1626c5448b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a836aaf5b9cd26f2e17faf1626c5448b3">operator=</a> (<a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> &&)=delete</td></tr>
|
|
<tr class="memdesc:a836aaf5b9cd26f2e17faf1626c5448b3"><td class="mdescLeft"> </td><td class="mdescRight">No move assignment. <a href="classpFlow_1_1demComponent.html#a836aaf5b9cd26f2e17faf1626c5448b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a836aaf5b9cd26f2e17faf1626c5448b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ab4d5fa34944c13f3a07ec25b4fd666"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a9ab4d5fa34944c13f3a07ec25b4fd666">~demComponent</a> ()=default</td></tr>
|
|
<tr class="memdesc:a9ab4d5fa34944c13f3a07ec25b4fd666"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classpFlow_1_1demComponent.html#a9ab4d5fa34944c13f3a07ec25b4fd666">More...</a><br /></td></tr>
|
|
<tr class="separator:a9ab4d5fa34944c13f3a07ec25b4fd666"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a647786897b3da03fcd415b2ebcf541c0"><td class="memItemLeft" align="right" valign="top">const auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a> () const</td></tr>
|
|
<tr class="memdesc:a647786897b3da03fcd415b2ebcf541c0"><td class="mdescLeft"> </td><td class="mdescRight">Const ref to <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a>. <a href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a647786897b3da03fcd415b2ebcf541c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1afde9cfe19a586522259a33a4931e3"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ae1afde9cfe19a586522259a33a4931e3">control</a> ()</td></tr>
|
|
<tr class="memdesc:ae1afde9cfe19a586522259a33a4931e3"><td class="mdescLeft"> </td><td class="mdescRight">Ref to <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a>. <a href="classpFlow_1_1demComponent.html#ae1afde9cfe19a586522259a33a4931e3">More...</a><br /></td></tr>
|
|
<tr class="separator:ae1afde9cfe19a586522259a33a4931e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a987c4fc5fe3a75305eede553d3efc279"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a987c4fc5fe3a75305eede553d3efc279">dt</a> () const</td></tr>
|
|
<tr class="memdesc:a987c4fc5fe3a75305eede553d3efc279"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classpFlow_1_1Time.html">Time</a> step of integration. <a href="classpFlow_1_1demComponent.html#a987c4fc5fe3a75305eede553d3efc279">More...</a><br /></td></tr>
|
|
<tr class="separator:a987c4fc5fe3a75305eede553d3efc279"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78dd57bd659107f17021b099cb853a0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a78dd57bd659107f17021b099cb853a0e">currentTime</a> () const</td></tr>
|
|
<tr class="memdesc:a78dd57bd659107f17021b099cb853a0e"><td class="mdescLeft"> </td><td class="mdescRight">Current simulation time. <a href="classpFlow_1_1demComponent.html#a78dd57bd659107f17021b099cb853a0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a78dd57bd659107f17021b099cb853a0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fe92d89e0339f3b0ccb505a1aac2182"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a3fe92d89e0339f3b0ccb505a1aac2182">currentIter</a> () const</td></tr>
|
|
<tr class="memdesc:a3fe92d89e0339f3b0ccb505a1aac2182"><td class="mdescLeft"> </td><td class="mdescRight">return current iteration number <a href="classpFlow_1_1demComponent.html#a3fe92d89e0339f3b0ccb505a1aac2182">More...</a><br /></td></tr>
|
|
<tr class="separator:a3fe92d89e0339f3b0ccb505a1aac2182"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71b953704058a7ca76b3056ae9215a64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1timeInfo.html">timeInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a71b953704058a7ca76b3056ae9215a64">TimeInfo</a> () const</td></tr>
|
|
<tr class="memdesc:a71b953704058a7ca76b3056ae9215a64"><td class="mdescLeft"> </td><td class="mdescRight">return time info of the simulaiton <a href="classpFlow_1_1demComponent.html#a71b953704058a7ca76b3056ae9215a64">More...</a><br /></td></tr>
|
|
<tr class="separator:a71b953704058a7ca76b3056ae9215a64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40f341a9cb1091ba9e3670f98cd002c3"><td class="memItemLeft" align="right" valign="top">const auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a40f341a9cb1091ba9e3670f98cd002c3">time</a> () const</td></tr>
|
|
<tr class="separator:a40f341a9cb1091ba9e3670f98cd002c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40e6d687c4d54c66dfe5b1bc5a0d28ce"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a40e6d687c4d54c66dfe5b1bc5a0d28ce">time</a> ()</td></tr>
|
|
<tr class="separator:a40e6d687c4d54c66dfe5b1bc5a0d28ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae69e59e991f33e7d278ff6ad19d2e87d"><td class="memItemLeft" align="right" valign="top">const auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">timers</a> () const</td></tr>
|
|
<tr class="memdesc:ae69e59e991f33e7d278ff6ad19d2e87d"><td class="mdescLeft"> </td><td class="mdescRight">Const ref to timers. <a href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">More...</a><br /></td></tr>
|
|
<tr class="separator:ae69e59e991f33e7d278ff6ad19d2e87d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49e56dd259a0f440e947ed17b149f32f"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">timers</a> ()</td></tr>
|
|
<tr class="memdesc:a49e56dd259a0f440e947ed17b149f32f"><td class="mdescLeft"> </td><td class="mdescRight">Ref to timers. <a href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">More...</a><br /></td></tr>
|
|
<tr class="separator:a49e56dd259a0f440e947ed17b149f32f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab272f2a135d95ff17ad06338049a2cd5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ab272f2a135d95ff17ad06338049a2cd5">beforeTimeLoop</a> ()</td></tr>
|
|
<tr class="memdesc:ab272f2a135d95ff17ad06338049a2cd5"><td class="mdescLeft"> </td><td class="mdescRight">This is called before the start of time loop. <a href="classpFlow_1_1demComponent.html#ab272f2a135d95ff17ad06338049a2cd5">More...</a><br /></td></tr>
|
|
<tr class="separator:ab272f2a135d95ff17ad06338049a2cd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87d9b39a0e924bb21ed4a165140836de"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a87d9b39a0e924bb21ed4a165140836de">beforeIteration</a> ()=0</td></tr>
|
|
<tr class="memdesc:a87d9b39a0e924bb21ed4a165140836de"><td class="mdescLeft"> </td><td class="mdescRight">This is called in time loop, before iterate. <a href="classpFlow_1_1demComponent.html#a87d9b39a0e924bb21ed4a165140836de">More...</a><br /></td></tr>
|
|
<tr class="separator:a87d9b39a0e924bb21ed4a165140836de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9e44c3349e7a9a5b6ba72c9db344b96"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ad9e44c3349e7a9a5b6ba72c9db344b96">iterate</a> ()=0</td></tr>
|
|
<tr class="memdesc:ad9e44c3349e7a9a5b6ba72c9db344b96"><td class="mdescLeft"> </td><td class="mdescRight">This is called in time loop. <a href="classpFlow_1_1demComponent.html#ad9e44c3349e7a9a5b6ba72c9db344b96">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9e44c3349e7a9a5b6ba72c9db344b96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7d2399b393b6dfa6f00ad9bcd524437"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#ac7d2399b393b6dfa6f00ad9bcd524437">afterIteration</a> ()=0</td></tr>
|
|
<tr class="memdesc:ac7d2399b393b6dfa6f00ad9bcd524437"><td class="mdescLeft"> </td><td class="mdescRight">This is called in time loop, after iterate. <a href="classpFlow_1_1demComponent.html#ac7d2399b393b6dfa6f00ad9bcd524437">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7d2399b393b6dfa6f00ad9bcd524437"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b82b161f3fd39ee9f534cc2508d97f8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a0b82b161f3fd39ee9f534cc2508d97f8">afterTimeLoop</a> ()</td></tr>
|
|
<tr class="memdesc:a0b82b161f3fd39ee9f534cc2508d97f8"><td class="mdescLeft"> </td><td class="mdescRight">This is called after the time loop. <a href="classpFlow_1_1demComponent.html#a0b82b161f3fd39ee9f534cc2508d97f8">More...</a><br /></td></tr>
|
|
<tr class="separator:a0b82b161f3fd39ee9f534cc2508d97f8"><td class="memSeparator" colspan="2"> </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:abfbc3debb472c661c30cf9fe782bb076"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">control_</a></td></tr>
|
|
<tr class="memdesc:abfbc3debb472c661c30cf9fe782bb076"><td class="mdescLeft"> </td><td class="mdescRight">Reference to <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a>. <a href="classpFlow_1_1demComponent.html#abfbc3debb472c661c30cf9fe782bb076">More...</a><br /></td></tr>
|
|
<tr class="separator:abfbc3debb472c661c30cf9fe782bb076"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97d6a106e35c444e647a69f8a8ba7f9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1Time.html">Time</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a97d6a106e35c444e647a69f8a8ba7f9b">time_</a></td></tr>
|
|
<tr class="separator:a97d6a106e35c444e647a69f8a8ba7f9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c29ef9514a77bce5b8f4ece533bcf8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1Timers.html">Timers</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">timers_</a></td></tr>
|
|
<tr class="memdesc:a0c29ef9514a77bce5b8f4ece533bcf8c"><td class="mdescLeft"> </td><td class="mdescRight">All timers (if any) of this component. <a href="classpFlow_1_1demComponent.html#a0c29ef9514a77bce5b8f4ece533bcf8c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c29ef9514a77bce5b8f4ece533bcf8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ce96806ed72189c4d9a24e9429d0420"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1demComponent.html#a3ce96806ed72189c4d9a24e9429d0420">componentName_</a></td></tr>
|
|
<tr class="memdesc:a3ce96806ed72189c4d9a24e9429d0420"><td class="mdescLeft"> </td><td class="mdescRight">Name of the DEM component. <a href="classpFlow_1_1demComponent.html#a3ce96806ed72189c4d9a24e9429d0420">More...</a><br /></td></tr>
|
|
<tr class="separator:a3ce96806ed72189c4d9a24e9429d0420"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A base class for every main component of DEM system. </p>
|
|
<p>This class provides abstraction at a very high level for any solver/utility that forces the derived component (i.e. particles, geometry, and etc) to advance over time when iterate is called in time a loop. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00042">42</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a73e3f3cd6a8eca86e6862f02e416dba2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73e3f3cd6a8eca86e6862f02e416dba2">◆ </a></span>demComponent() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1systemControl.html">systemControl</a> & </td>
|
|
<td class="paramname"><em>control</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>construct from components </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8cpp_source.html#l00025">25</a> of file <a class="el" href="demComponent_8cpp_source.html">demComponent.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a876cdfe70008c20f9136c8a730c3f71a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a876cdfe70008c20f9136c8a730c3f71a">◆ </a></span>demComponent() <span class="overload">[2/3]</span></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_1demComponent.html">demComponent</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No copy constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff5dda77742aff7e01ae5d1b1ceb38b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff5dda77742aff7e01ae5d1b1ceb38b7">◆ </a></span>demComponent() <span class="overload">[3/3]</span></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_1demComponent.html">demComponent</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> && </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No move constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ab4d5fa34944c13f3a07ec25b4fd666"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ab4d5fa34944c13f3a07ec25b4fd666">◆ </a></span>~demComponent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ~<a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>destructor </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3145c3f3cba34861e279260ada91e0de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3145c3f3cba34861e279260ada91e0de">◆ </a></span>TypeInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TypeInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">"demComponent" </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type info. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95e1df66e5604c2920686b6a6c4e4c10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95e1df66e5604c2920686b6a6c4e4c10">◆ </a></span>operator=() <span class="overload">[1/2]</span></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_1demComponent.html">demComponent</a>& operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No copy assignment. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a836aaf5b9cd26f2e17faf1626c5448b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a836aaf5b9cd26f2e17faf1626c5448b3">◆ </a></span>operator=() <span class="overload">[2/2]</span></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_1demComponent.html">demComponent</a>& operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1demComponent.html">demComponent</a> && </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No move assignment. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a647786897b3da03fcd415b2ebcf541c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a647786897b3da03fcd415b2ebcf541c0">◆ </a></span>control() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const auto& control </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>Const ref to <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00088">88</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="demComponent_8hpp_source.html#l00048">demComponent::control_</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="grainParticles_8cpp_source.html#l00143">grainParticles::grainParticles()</a>, <a class="el" href="insertion_8cpp_source.html#l00027">insertion::insertion()</a>, and <a class="el" href="sphereParticles_8cpp_source.html#l00308">sphereParticles::sphereParticles()</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_1demComponent_a647786897b3da03fcd415b2ebcf541c0_icgraph.png" border="0" usemap="#classpFlow_1_1demComponent_a647786897b3da03fcd415b2ebcf541c0_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1afde9cfe19a586522259a33a4931e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1afde9cfe19a586522259a33a4931e3">◆ </a></span>control() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto& control </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Ref to <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00095">95</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="demComponent_8hpp_source.html#l00048">demComponent::control_</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a987c4fc5fe3a75305eede553d3efc279"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a987c4fc5fe3a75305eede553d3efc279">◆ </a></span>dt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a> dt </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="classpFlow_1_1Time.html">Time</a> step of integration. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8cpp_source.html#l00033">33</a> of file <a class="el" href="demComponent_8cpp_source.html">demComponent.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="geometryMotion_8hpp_source.html#l00104">geometryMotion< MotionModelType >::getModel()</a>.</p>
|
|
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-3-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1demComponent_a987c4fc5fe3a75305eede553d3efc279_icgraph.png" border="0" usemap="#classpFlow_1_1demComponent_a987c4fc5fe3a75305eede553d3efc279_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78dd57bd659107f17021b099cb853a0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78dd57bd659107f17021b099cb853a0e">◆ </a></span>currentTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a> currentTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current simulation time. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8cpp_source.html#l00038">38</a> of file <a class="el" href="demComponent_8cpp_source.html">demComponent.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3fe92d89e0339f3b0ccb505a1aac2182"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3fe92d89e0339f3b0ccb505a1aac2182">◆ </a></span>currentIter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">pFlow::uint32</a> currentIter </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return current iteration number </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8cpp_source.html#l00043">43</a> of file <a class="el" href="demComponent_8cpp_source.html">demComponent.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a71b953704058a7ca76b3056ae9215a64"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71b953704058a7ca76b3056ae9215a64">◆ </a></span>TimeInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classpFlow_1_1timeInfo.html">pFlow::timeInfo</a> TimeInfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return time info of the simulaiton </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8cpp_source.html#l00048">48</a> of file <a class="el" href="demComponent_8cpp_source.html">demComponent.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40f341a9cb1091ba9e3670f98cd002c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40f341a9cb1091ba9e3670f98cd002c3">◆ </a></span>time() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const auto& time </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="demComponent_8hpp_source.html#l00113">113</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="demComponent_8hpp_source.html#l00050">demComponent::time_</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="pointStructure_8hpp_source.html#l00128">pointStructure::time()</a>.</p>
|
|
<div id="dynsection-4" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-4-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1demComponent_a40f341a9cb1091ba9e3670f98cd002c3_icgraph.png" border="0" usemap="#classpFlow_1_1demComponent_a40f341a9cb1091ba9e3670f98cd002c3_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40e6d687c4d54c66dfe5b1bc5a0d28ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40e6d687c4d54c66dfe5b1bc5a0d28ce">◆ </a></span>time() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto& time </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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="demComponent_8hpp_source.html#l00119">119</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="demComponent_8hpp_source.html#l00050">demComponent::time_</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae69e59e991f33e7d278ff6ad19d2e87d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae69e59e991f33e7d278ff6ad19d2e87d">◆ </a></span>timers() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const auto& timers </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>Const ref to timers. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00127">127</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="demComponent_8hpp_source.html#l00053">demComponent::timers_</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49e56dd259a0f440e947ed17b149f32f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49e56dd259a0f440e947ed17b149f32f">◆ </a></span>timers() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto& timers </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Ref to timers. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00134">134</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="demComponent_8hpp_source.html#l00053">demComponent::timers_</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab272f2a135d95ff17ad06338049a2cd5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab272f2a135d95ff17ad06338049a2cd5">◆ </a></span>beforeTimeLoop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool beforeTimeLoop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is called before the start of time loop. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00141">141</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="error_8hpp_source.html#l00084">notImplementedFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a87d9b39a0e924bb21ed4a165140836de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a87d9b39a0e924bb21ed4a165140836de">◆ </a></span>beforeIteration()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool beforeIteration </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is called in time loop, before iterate. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classpFlow_1_1grainParticles.html#ada71b97666fe3f66b31690bf12633c32">grainParticles</a>, <a class="el" href="classpFlow_1_1sphereParticles.html#ada71b97666fe3f66b31690bf12633c32">sphereParticles</a>, <a class="el" href="classpFlow_1_1geometry.html#ada71b97666fe3f66b31690bf12633c32">geometry</a>, <a class="el" href="classpFlow_1_1particles.html#ada71b97666fe3f66b31690bf12633c32">particles</a>, <a class="el" href="classpFlow_1_1grainInteraction.html#ada71b97666fe3f66b31690bf12633c32">grainInteraction< contactForceModel, geometryMotionModel, contactListType ></a>, <a class="el" href="classpFlow_1_1sphereInteraction.html#ada71b97666fe3f66b31690bf12633c32">sphereInteraction< contactForceModel, geometryMotionModel, contactListType ></a>, <a class="el" href="classpFlow_1_1pointStructure.html#ada71b97666fe3f66b31690bf12633c32">pointStructure</a>, and <a class="el" href="classpFlow_1_1dynamicPointStructure.html#ada71b97666fe3f66b31690bf12633c32">dynamicPointStructure</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9e44c3349e7a9a5b6ba72c9db344b96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9e44c3349e7a9a5b6ba72c9db344b96">◆ </a></span>iterate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool iterate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is called in time loop. </p>
|
|
<p>Perform the main calculations when the component should evolve along time. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classpFlow_1_1grainParticles.html#afa767bddda52eb71cea18f755e17d559">grainParticles</a>, <a class="el" href="classpFlow_1_1sphereParticles.html#afa767bddda52eb71cea18f755e17d559">sphereParticles</a>, <a class="el" href="classpFlow_1_1geometry.html#afa767bddda52eb71cea18f755e17d559">geometry</a>, <a class="el" href="classpFlow_1_1particles.html#afa767bddda52eb71cea18f755e17d559">particles</a>, <a class="el" href="classpFlow_1_1grainInteraction.html#afa767bddda52eb71cea18f755e17d559">grainInteraction< contactForceModel, geometryMotionModel, contactListType ></a>, <a class="el" href="classpFlow_1_1sphereInteraction.html#afa767bddda52eb71cea18f755e17d559">sphereInteraction< contactForceModel, geometryMotionModel, contactListType ></a>, <a class="el" href="classpFlow_1_1geometryMotion.html#afa767bddda52eb71cea18f755e17d559">geometryMotion< MotionModelType ></a>, <a class="el" href="classpFlow_1_1pointStructure.html#afa767bddda52eb71cea18f755e17d559">pointStructure</a>, and <a class="el" href="classpFlow_1_1dynamicPointStructure.html#afa767bddda52eb71cea18f755e17d559">dynamicPointStructure</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7d2399b393b6dfa6f00ad9bcd524437"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7d2399b393b6dfa6f00ad9bcd524437">◆ </a></span>afterIteration()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool afterIteration </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is called in time loop, after iterate. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classpFlow_1_1geometry.html#a5ab4b6c611c3256e54f51bbfc484d58e">geometry</a>, <a class="el" href="classpFlow_1_1particles.html#a5ab4b6c611c3256e54f51bbfc484d58e">particles</a>, <a class="el" href="classpFlow_1_1grainInteraction.html#a5ab4b6c611c3256e54f51bbfc484d58e">grainInteraction< contactForceModel, geometryMotionModel, contactListType ></a>, <a class="el" href="classpFlow_1_1sphereInteraction.html#a5ab4b6c611c3256e54f51bbfc484d58e">sphereInteraction< contactForceModel, geometryMotionModel, contactListType ></a>, and <a class="el" href="classpFlow_1_1pointStructure.html#a5ab4b6c611c3256e54f51bbfc484d58e">pointStructure</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b82b161f3fd39ee9f534cc2508d97f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b82b161f3fd39ee9f534cc2508d97f8">◆ </a></span>afterTimeLoop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool afterTimeLoop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is called after the time loop. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00162">162</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="error_8hpp_source.html#l00084">notImplementedFunction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="abfbc3debb472c661c30cf9fe782bb076"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abfbc3debb472c661c30cf9fe782bb076">◆ </a></span>control_</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_1systemControl.html">systemControl</a>& control_</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>Reference to <a class="el" href="classpFlow_1_1systemControl.html">systemControl</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00048">48</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="demComponent_8hpp_source.html#l00088">demComponent::control()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97d6a106e35c444e647a69f8a8ba7f9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97d6a106e35c444e647a69f8a8ba7f9b">◆ </a></span>time_</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_1Time.html">Time</a>& time_</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="demComponent_8hpp_source.html#l00050">50</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="demComponent_8hpp_source.html#l00113">demComponent::time()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c29ef9514a77bce5b8f4ece533bcf8c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c29ef9514a77bce5b8f4ece533bcf8c">◆ </a></span>timers_</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_1Timers.html">Timers</a> timers_</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>All timers (if any) of this component. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00053">53</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="demComponent_8hpp_source.html#l00127">demComponent::timers()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ce96806ed72189c4d9a24e9429d0420"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ce96806ed72189c4d9a24e9429d0420">◆ </a></span>componentName_</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#a0ebe792a293e8c717bddf60070c0fe99">word</a> componentName_</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>Name of the DEM component. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="demComponent_8hpp_source.html#l00056">56</a> of file <a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/phasicFlow/demComponent/<a class="el" href="demComponent_8hpp_source.html">demComponent.hpp</a></li>
|
|
<li>src/phasicFlow/demComponent/<a class="el" href="demComponent_8cpp_source.html">demComponent.cpp</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_1demComponent.html">demComponent</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>
|