phasicFlow/doc/code-documentation/html/initialize__Control_8hpp.html

268 lines
15 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"/>
<title>PhasicFlow: src/setHelpers/initialize_Control.hpp File 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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</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>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('initialize__Control_8hpp.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="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">initialize_Control.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
Include dependency graph for initialize_Control.hpp:</div>
<div class="dyncontent">
<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 class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<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=" " alt="" coords="921,95,1103,136"/>
<area shape="rect" href="sphereGranFlow_8cpp.html" title=" " 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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="initialize__Control_8hpp.html#ade8c9f01a0d3b64030083276b6b23dc5">REPORT</a> (0)&lt;&lt;&quot;\nCreating <a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a> repository . . .&quot;&lt;&lt; endREPORT</td></tr>
<tr class="separator:ade8c9f01a0d3b64030083276b6b23dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1523b33abc50381afdaf093a953c6fa6"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</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>&lt; <a class="el" href="classpFlow_1_1systemControl.html">pFlow::systemControl</a> &gt;&#160;</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">&#160;</td></tr>
<tr class="memitem:a0544c3fe466e421738dae463968b70ba"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td></tr>
<tr class="memitem:a4f5e4e852648762473ecd75a907417ca"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</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="separator:a4f5e4e852648762473ecd75a907417ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ade8c9f01a0d3b64030083276b6b23dc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8c9f01a0d3b64030083276b6b23dc5">&#9670;&nbsp;</a></span>REPORT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">REPORT </td>
<td>(</td>
<td class="paramtype">0&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1523b33abc50381afdaf093a953c6fa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1523b33abc50381afdaf093a953c6fa6">&#9670;&nbsp;</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&#160;</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 class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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">&#9670;&nbsp;</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>&lt;<a class="el" href="classpFlow_1_1systemControl.html">pFlow::systemControl</a>&gt; 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">&#9670;&nbsp;</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&lt;pFlow::systemControl&gt;()</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>
<h2 class="memtitle"><span class="permalink"><a href="#a4f5e4e852648762473ecd75a907417ca">&#9670;&nbsp;</a></span>Control</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto&amp; Control = <a class="el" href="initialize__Control_8hpp.html#a07d85a0914cbf91a000f993a3e62117b">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#l00028">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&lt; pFlow::systemControl &gt; 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>
<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>