mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -117,11 +117,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1demGeometry.html',''); i
|
||||
</div>
|
||||
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="classpFlow_1_1demGeometry__inherit__graph.png" border="0" usemap="#demGeometry_inherit__map" alt="Inheritance graph"/></div>
|
||||
<map name="demGeometry_inherit__map" id="demGeometry_inherit__map">
|
||||
<area shape="rect" title="base for geometry that manages control" alt="" coords="11,80,127,107"/>
|
||||
<area shape="rect" href="classpFlow_1_1geometry.html" title="Base class for geometry for managing tri-surfaces, geometry motion, and surface physical properties." alt="" coords="26,155,111,181"/>
|
||||
<area shape="rect" href="classpFlow_1_1demComponent.html" title="A base class for every main component of DEM system." alt="" coords="5,5,132,32"/>
|
||||
</map>
|
||||
<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 demGeometry:</div>
|
||||
@ -129,10 +124,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1demGeometry.html',''); i
|
||||
</div>
|
||||
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="classpFlow_1_1demGeometry__coll__graph.png" border="0" usemap="#demGeometry_coll__map" alt="Collaboration graph"/></div>
|
||||
<map name="demGeometry_coll__map" id="demGeometry_coll__map">
|
||||
<area shape="rect" title="base for geometry that manages control" alt="" coords="11,80,127,107"/>
|
||||
<area shape="rect" href="classpFlow_1_1demComponent.html" title="A base class for every main component of DEM system." alt="" coords="5,5,132,32"/>
|
||||
</map>
|
||||
<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>
|
||||
@ -167,12 +158,22 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ae1afde9cfe19a586522259a33a4931e3 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4fc823022c8f0175108f10a42e7b858f inherit pub_methods_classpFlow_1_1demComponent"><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#a4fc823022c8f0175108f10a42e7b858f">dt</a> () const</td></tr>
|
||||
<tr class="memdesc:a4fc823022c8f0175108f10a42e7b858f inherit pub_methods_classpFlow_1_1demComponent"><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#a4fc823022c8f0175108f10a42e7b858f">More...</a><br /></td></tr>
|
||||
<tr class="separator:a4fc823022c8f0175108f10a42e7b858f inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a476763249b99b131d7116430896cd44e inherit pub_methods_classpFlow_1_1demComponent"><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#a476763249b99b131d7116430896cd44e">currentTime</a> () const</td></tr>
|
||||
<tr class="memdesc:a476763249b99b131d7116430896cd44e inherit pub_methods_classpFlow_1_1demComponent"><td class="mdescLeft"> </td><td class="mdescRight">Current simulation time. <a href="classpFlow_1_1demComponent.html#a476763249b99b131d7116430896cd44e">More...</a><br /></td></tr>
|
||||
<tr class="separator:a476763249b99b131d7116430896cd44e inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a987c4fc5fe3a75305eede553d3efc279 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a78dd57bd659107f17021b099cb853a0e inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3fe92d89e0339f3b0ccb505a1aac2182 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a71b953704058a7ca76b3056ae9215a64 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a40f341a9cb1091ba9e3670f98cd002c3 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a40e6d687c4d54c66dfe5b1bc5a0d28ce inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae69e59e991f33e7d278ff6ad19d2e87d inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@ -194,19 +195,6 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a0b82b161f3fd39ee9f534cc2508d97f8 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><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 inherit pub_methods_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
||||
Additional Inherited Members</h2></td></tr>
|
||||
<tr class="inherit_header pro_attribs_classpFlow_1_1demComponent"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classpFlow_1_1demComponent')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classpFlow_1_1demComponent.html">demComponent</a></td></tr>
|
||||
<tr class="memitem:a3ce96806ed72189c4d9a24e9429d0420 inherit pro_attribs_classpFlow_1_1demComponent"><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 inherit pro_attribs_classpFlow_1_1demComponent"><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 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abfbc3debb472c661c30cf9fe782bb076 inherit pro_attribs_classpFlow_1_1demComponent"><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 inherit pro_attribs_classpFlow_1_1demComponent"><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 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0c29ef9514a77bce5b8f4ece533bcf8c inherit pro_attribs_classpFlow_1_1demComponent"><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 inherit pro_attribs_classpFlow_1_1demComponent"><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 inherit pro_attribs_classpFlow_1_1demComponent"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>base for geometry that manages control </p>
|
||||
|
||||
Reference in New Issue
Block a user