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
@ -114,10 +114,6 @@ $(document).ready(function(){initNavTree('initialize__Control_8hpp.html',''); in
|
||||
</div>
|
||||
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="initialize__Control_8hpp__incl.png" border="0" usemap="#src_2setHelpers_2initialize__Control_8hpp" alt=""/></div>
|
||||
<map name="src_2setHelpers_2initialize__Control_8hpp" id="src_2setHelpers_2initialize__Control_8hpp">
|
||||
<area shape="rect" title=" " alt="" coords="5,5,180,47"/>
|
||||
<area shape="rect" href="initialize_8hpp.html" title=" " alt="" coords="39,95,146,121"/>
|
||||
</map>
|
||||
</div>
|
||||
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||||
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
|
||||
@ -125,38 +121,25 @@ $(document).ready(function(){initNavTree('initialize__Control_8hpp.html',''); in
|
||||
</div>
|
||||
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="initialize__Control_8hpp__dep__incl.png" border="0" usemap="#src_2setHelpers_2initialize__Control_8hppdep" alt=""/></div>
|
||||
<map name="src_2setHelpers_2initialize__Control_8hppdep" id="src_2setHelpers_2initialize__Control_8hppdep">
|
||||
<area shape="rect" title=" " alt="" coords="583,5,758,47"/>
|
||||
<area shape="rect" href="geometryPhasicFlow_8cpp.html" title=" " alt="" coords="5,95,224,136"/>
|
||||
<area shape="rect" href="particlesPhasicFlow_8cpp.html" title=" " alt="" coords="249,95,461,136"/>
|
||||
<area shape="rect" href="pFlowToVTK_8cpp.html" title=" " alt="" coords="484,95,639,136"/>
|
||||
<area shape="rect" href="postprocessPhasicFlow_8cpp.html" title=" " alt="" coords="663,95,897,136"/>
|
||||
<area shape="rect" href="iterateGeometry_8cpp.html" title="iterateGeometry solver" alt="" coords="921,95,1103,136"/>
|
||||
<area shape="rect" href="sphereGranFlow_8cpp.html" title="sphereGranFlow solver" alt="" coords="1127,95,1305,136"/>
|
||||
</map>
|
||||
</div>
|
||||
</div>
|
||||
<p><a href="initialize__Control_8hpp_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ade8c9f01a0d3b64030083276b6b23dc5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#ade8c9f01a0d3b64030083276b6b23dc5">REPORT</a> (0)<<"\nCreating <a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a> repository . . ."<< endREPORT</td></tr>
|
||||
<tr class="separator:ade8c9f01a0d3b64030083276b6b23dc5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1523b33abc50381afdaf093a953c6fa6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#a1523b33abc50381afdaf093a953c6fa6">if</a> (isCoupling)</td></tr>
|
||||
<tr class="separator:a1523b33abc50381afdaf093a953c6fa6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8e0ce4fe1b8fadbb4d4c368b27dbfc9b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#a8e0ce4fe1b8fadbb4d4c368b27dbfc9b">REPORT</a> (0)<<"\nCreating <a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a> repository . . ."<< END_REPORT</td></tr>
|
||||
<tr class="separator:a8e0ce4fe1b8fadbb4d4c368b27dbfc9b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
||||
Variables</h2></td></tr>
|
||||
<tr class="memitem:a07d85a0914cbf91a000f993a3e62117b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a>< <a class="el" href="classpFlow_1_1systemControl.html">pFlow::systemControl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#a07d85a0914cbf91a000f993a3e62117b">ControlPtr</a> = nullptr</td></tr>
|
||||
<tr class="separator:a07d85a0914cbf91a000f993a3e62117b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0544c3fe466e421738dae463968b70ba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#a0544c3fe466e421738dae463968b70ba">else</a></td></tr>
|
||||
<tr class="separator:a0544c3fe466e421738dae463968b70ba"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4f5e4e852648762473ecd75a907417ca"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a> = <a class="el" href="initialize__Control_8hpp.html#a07d85a0914cbf91a000f993a3e62117b">ControlPtr</a>()</td></tr>
|
||||
<tr class="memitem:ab751310ebeb5b84ea62361d7d7e69c1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a>< <a class="el" href="classpFlow_1_1systemControl.html">pFlow::systemControl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#ab751310ebeb5b84ea62361d7d7e69c1d">ControlPtr</a> = nullptr</td></tr>
|
||||
<tr class="separator:ab751310ebeb5b84ea62361d7d7e69c1d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4f5e4e852648762473ecd75a907417ca"><td class="memItemLeft" align="right" valign="top">auto & </td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a> = <a class="el" href="initialize__Control_8hpp.html#ab751310ebeb5b84ea62361d7d7e69c1d">ControlPtr</a>()</td></tr>
|
||||
<tr class="separator:a4f5e4e852648762473ecd75a907417ca"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="ade8c9f01a0d3b64030083276b6b23dc5"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ade8c9f01a0d3b64030083276b6b23dc5">◆ </a></span>REPORT()</h2>
|
||||
<a id="a8e0ce4fe1b8fadbb4d4c368b27dbfc9b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a8e0ce4fe1b8fadbb4d4c368b27dbfc9b">◆ </a></span>REPORT()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@ -171,81 +154,23 @@ Variables</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1523b33abc50381afdaf093a953c6fa6"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1523b33abc50381afdaf093a953c6fa6">◆ </a></span>if()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">if </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">isCoupling </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="initialize__Control_8hpp_source.html#l00030">30</a> of file <a class="el" href="initialize__Control_8hpp_source.html">initialize_Control.hpp</a>.</p>
|
||||
|
||||
<p class="reference">References <a class="el" href="initialize__Control_8hpp_source.html#l00028">ControlPtr</a>, <a class="el" href="readControlDict_8hpp_source.html#l00067">readControlDict::endTime()</a>, <a class="el" href="readControlDict_8hpp_source.html#l00072">readControlDict::saveInterval()</a>, <a class="el" href="readControlDict_8hpp_source.html#l00062">readControlDict::startTime()</a>, and <a class="el" href="readControlDict_8hpp_source.html#l00077">readControlDict::startTimeName()</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 call 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="initialize__Control_8hpp_a1523b33abc50381afdaf093a953c6fa6_cgraph.png" border="0" usemap="#initialize__Control_8hpp_a1523b33abc50381afdaf093a953c6fa6_cgraph" alt=""/></div>
|
||||
<map name="initialize__Control_8hpp_a1523b33abc50381afdaf093a953c6fa6_cgraph" id="initialize__Control_8hpp_a1523b33abc50381afdaf093a953c6fa6_cgraph">
|
||||
<area shape="rect" title=" " alt="" coords="5,111,44,138"/>
|
||||
<area shape="rect" href="classpFlow_1_1readControlDict.html#a9f960d8e9ef573c7aab1a933ddccb844" title=" " alt="" coords="92,5,263,47"/>
|
||||
<area shape="rect" href="classpFlow_1_1readControlDict.html#a948735c16bd010922637d8e9c5a0b558" title=" " alt="" coords="92,71,263,112"/>
|
||||
<area shape="rect" href="classpFlow_1_1readControlDict.html#a7f4d44b8a4c8e166c725c48eb44e6b97" title=" " alt="" coords="92,136,263,177"/>
|
||||
<area shape="rect" href="classpFlow_1_1readControlDict.html#ae24c046ff18d5f5b50185e1cbfd983d1" title=" " alt="" coords="92,201,263,243"/>
|
||||
</map>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Variable Documentation</h2>
|
||||
<a id="a07d85a0914cbf91a000f993a3e62117b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a07d85a0914cbf91a000f993a3e62117b">◆ </a></span>ControlPtr</h2>
|
||||
<a id="ab751310ebeb5b84ea62361d7d7e69c1d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab751310ebeb5b84ea62361d7d7e69c1d">◆ </a></span>ControlPtr</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a><<a class="el" href="classpFlow_1_1systemControl.html">pFlow::systemControl</a>> ControlPtr = nullptr</td>
|
||||
<td class="memname">ControlPtr = nullptr</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="initialize__Control_8hpp_source.html#l00028">28</a> of file <a class="el" href="initialize__Control_8hpp_source.html">initialize_Control.hpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="initialize__Control_8hpp_source.html#l00030">if()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a0544c3fe466e421738dae463968b70ba"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a0544c3fe466e421738dae463968b70ba">◆ </a></span>else</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">else</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
|
||||
<div class="line"> <a class="code" href="initialize__Control_8hpp.html#a07d85a0914cbf91a000f993a3e62117b">ControlPtr</a> = pFlow::makeUnique<pFlow::systemControl>()</div>
|
||||
</div><!-- fragment -->
|
||||
<p class="definition">Definition at line <a class="el" href="initialize__Control_8hpp_source.html#l00043">43</a> of file <a class="el" href="initialize__Control_8hpp_source.html">initialize_Control.hpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="Timer_8cpp_source.html#l00052">Timer::write()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a4f5e4e852648762473ecd75a907417ca"></a>
|
||||
@ -255,20 +180,19 @@ Variables</h2></td></tr>
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">auto& Control = <a class="el" href="initialize__Control_8hpp.html#a07d85a0914cbf91a000f993a3e62117b">ControlPtr</a>()</td>
|
||||
<td class="memname">auto& Control = <a class="el" href="initialize__Control_8hpp.html#ab751310ebeb5b84ea62361d7d7e69c1d">ControlPtr</a>()</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="initialize__Control_8hpp_source.html#l00047">47</a> of file <a class="el" href="initialize__Control_8hpp_source.html">initialize_Control.hpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="iterateGeometry_8cpp_source.html#l00039">main()</a>.</p>
|
||||
<p class="reference">Referenced by <a class="el" href="grainGranFlow_8cpp_source.html#l00054">main()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="ainitialize__Control_8hpp_html_a07d85a0914cbf91a000f993a3e62117b"><div class="ttname"><a href="initialize__Control_8hpp.html#a07d85a0914cbf91a000f993a3e62117b">ControlPtr</a></div><div class="ttdeci">pFlow::uniquePtr< pFlow::systemControl > ControlPtr</div><div class="ttdef"><b>Definition:</b> <a href="initialize__Control_8hpp_source.html#l00028">initialize_Control.hpp:28</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_8d255b47af8e1044c4e2364257c8fb8f.html">setHelpers</a></li><li class="navelem"><a class="el" href="initialize__Control_8hpp.html">initialize_Control.hpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user