documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -117,10 +117,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1readControlDict.html',''
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict__coll__graph.png" border="0" usemap="#readControlDict_coll__map" alt="Collaboration graph"/></div>
<map name="readControlDict_coll__map" id="readControlDict_coll__map">
<area shape="rect" title=" " alt="" coords="5,139,129,165"/>
<area shape="rect" href="classpFlow_1_1fileSystem.html" title=" " alt="" coords="22,5,113,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>
@ -162,9 +158,9 @@ Protected Attributes</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a9e179fbe03114ea3ecbf83671c51d92a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1readControlDict.html#a9e179fbe03114ea3ecbf83671c51d92a">defaultRootPath</a> = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">CWD</a>()</td></tr>
<tr class="memitem:a9e179fbe03114ea3ecbf83671c51d92a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1readControlDict.html#a9e179fbe03114ea3ecbf83671c51d92a">defaultRootPath</a> = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">pFlow::CWD</a>()</td></tr>
<tr class="separator:a9e179fbe03114ea3ecbf83671c51d92a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5789840fc1f86cb3d2c4910610e3dbd4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1readControlDict.html#a5789840fc1f86cb3d2c4910610e3dbd4">defaultCDPath</a> = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">CWD</a>()/&quot;system&quot;+&quot;controlDict&quot;</td></tr>
<tr class="memitem:a5789840fc1f86cb3d2c4910610e3dbd4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1readControlDict.html#a5789840fc1f86cb3d2c4910610e3dbd4">defaultCDPath</a> = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">pFlow::CWD</a>()/<a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>(&quot;system&quot;)+word(&quot;controlDict&quot;)</td></tr>
<tr class="separator:a5789840fc1f86cb3d2c4910610e3dbd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@ -199,17 +195,13 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8cpp_source.html#l00109">109</a> of file <a class="el" href="readControlDict_8cpp_source.html">readControlDict.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>, and <a class="el" href="readControlDict_8cpp_source.html#l00047">readControlDict::read()</a>.</p>
<p class="reference">References <a class="el" href="error_8hpp_source.html#l00098">fatalExit</a>, and <a class="el" href="readControlDict_8cpp_source.html#l00047">readControlDict::read()</a>.</p>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</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_1readControlDict_a63fd760fecd548c2c55dc66eb5478574_cgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_a63fd760fecd548c2c55dc66eb5478574_cgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_a63fd760fecd548c2c55dc66eb5478574_cgraph" id="classpFlow_1_1readControlDict_a63fd760fecd548c2c55dc66eb5478574_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,129,32"/>
<area shape="rect" href="classpFlow_1_1readControlDict.html#af816873151ddb0126e98bb2f914d8ed5" title=" " alt="" coords="177,5,228,32"/>
</map>
</div>
</div>
@ -251,19 +243,13 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8cpp_source.html#l00024">24</a> of file <a class="el" href="readControlDict_8cpp_source.html">readControlDict.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>, <a class="el" href="IOstream_8hpp_source.html#l00327">pFlow::fixed()</a>, <a class="el" href="readControlDict_8hpp_source.html#l00045">readControlDict::formatType_</a>, and <a class="el" href="IOstream_8hpp_source.html#l00333">pFlow::scientific()</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00341">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00077">fatalErrorInFunction</a>, <a class="el" href="error_8hpp_source.html#l00098">fatalExit</a>, <a class="el" href="IOstream_8hpp_source.html#l00329">pFlow::fixed()</a>, <a class="el" href="readControlDict_8hpp_source.html#l00045">readControlDict::formatType_</a>, and <a class="el" href="IOstream_8hpp_source.html#l00335">pFlow::scientific()</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="classpFlow_1_1readControlDict_a85be57df4a63c3add72f0133ea42e76c_cgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_a85be57df4a63c3add72f0133ea42e76c_cgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_a85be57df4a63c3add72f0133ea42e76c_cgraph" id="classpFlow_1_1readControlDict_a85be57df4a63c3add72f0133ea42e76c_cgraph">
<area shape="rect" title=" " alt="" coords="5,56,161,83"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="225,5,322,32"/>
<area shape="rect" href="namespacepFlow.html#a010be5a80d29fca6b0ac9a68d9c94d32" title=" " alt="" coords="222,56,325,83"/>
<area shape="rect" href="namespacepFlow.html#a4333d7bd717697fd94a3425351e1e4f2" title=" " alt="" coords="209,107,337,133"/>
</map>
</div>
</div>
@ -293,7 +279,7 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8cpp_source.html#l00047">47</a> of file <a class="el" href="readControlDict_8cpp_source.html">readControlDict.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, <a class="el" href="timeFolder_8hpp_source.html#l00111">timeFolder::endTime()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="iIstreamI_8hpp_source.html#l00024">iIstream::findKeywordAndVal()</a>, <a class="el" href="iIstream_8cpp_source.html#l00176">iIstream::findTokenAndNextSilent()</a>, <a class="el" href="iIstreamI_8hpp_source.html#l00068">iIstream::lookupDataOrSet()</a>, and <a class="el" href="timeFolder_8hpp_source.html#l00105">timeFolder::startTime()</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00341">pFlow::endl()</a>, <a class="el" href="timeFolder_8hpp_source.html#l00111">timeFolder::endTime()</a>, <a class="el" href="error_8hpp_source.html#l00077">fatalErrorInFunction</a>, <a class="el" href="iIstreamI_8hpp_source.html#l00024">iIstream::findKeywordAndVal()</a>, <a class="el" href="iIstream_8cpp_source.html#l00203">iIstream::findTokenAndNextSilent()</a>, <a class="el" href="iIstreamI_8hpp_source.html#l00068">iIstream::lookupDataOrSet()</a>, and <a class="el" href="timeFolder_8hpp_source.html#l00105">timeFolder::startTime()</a>.</p>
<p class="reference">Referenced by <a class="el" href="readControlDict_8cpp_source.html#l00109">readControlDict::readControlDict()</a>.</p>
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
@ -302,15 +288,6 @@ Static Protected Attributes</h2></td></tr>
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_cgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_cgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_cgraph" id="classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_cgraph">
<area shape="rect" title=" " alt="" coords="5,163,56,189"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="161,5,259,32"/>
<area shape="rect" href="classpFlow_1_1timeFolder.html#a2aafefc5248e595246d11de0587524f3" title=" " alt="" coords="137,57,283,98"/>
<area shape="rect" href="classpFlow_1_1iIstream.html#afb1243cec5833e96e8446abed4e3656c" title=" " alt="" coords="104,122,316,163"/>
<area shape="rect" href="classpFlow_1_1iIstream.html#ae74a624bbb0665ed381b67cbda681031" title=" " alt="" coords="113,187,307,229"/>
<area shape="rect" href="classpFlow_1_1iIstream.html#a6b741dd8443f554f5de5b98897f2eb77" title=" " alt="" coords="107,253,313,294"/>
<area shape="rect" href="classpFlow_1_1timeFolder.html#aaff3f438097803be5fef5cd29cd8985d" title=" " alt="" coords="137,318,283,359"/>
</map>
</div>
<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>
@ -318,10 +295,6 @@ Static Protected Attributes</h2></td></tr>
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_icgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_icgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_icgraph" id="classpFlow_1_1readControlDict_af816873151ddb0126e98bb2f914d8ed5_icgraph">
<area shape="rect" title=" " alt="" coords="177,5,228,32"/>
<area shape="rect" href="classpFlow_1_1readControlDict.html#a63fd760fecd548c2c55dc66eb5478574" title=" " alt="" coords="5,5,129,32"/>
</map>
</div>
</div>
@ -351,19 +324,6 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8hpp_source.html#l00062">62</a> of file <a class="el" href="readControlDict_8hpp_source.html">readControlDict.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="initialize__Control_8hpp_source.html#l00030">if()</a>.</p>
<div id="dynsection-5" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-5-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict_a7f4d44b8a4c8e166c725c48eb44e6b97_icgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_a7f4d44b8a4c8e166c725c48eb44e6b97_icgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_a7f4d44b8a4c8e166c725c48eb44e6b97_icgraph" id="classpFlow_1_1readControlDict_a7f4d44b8a4c8e166c725c48eb44e6b97_icgraph">
<area shape="rect" title=" " alt="" coords="92,5,177,32"/>
<area shape="rect" href="initialize__Control_8hpp.html#a1523b33abc50381afdaf093a953c6fa6" title=" " alt="" coords="5,5,44,32"/>
</map>
</div>
</div>
</div>
<a id="a9f960d8e9ef573c7aab1a933ddccb844"></a>
@ -391,19 +351,6 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8hpp_source.html#l00067">67</a> of file <a class="el" href="readControlDict_8hpp_source.html">readControlDict.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="initialize__Control_8hpp_source.html#l00030">if()</a>.</p>
<div id="dynsection-6" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-6-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict_a9f960d8e9ef573c7aab1a933ddccb844_icgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_a9f960d8e9ef573c7aab1a933ddccb844_icgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_a9f960d8e9ef573c7aab1a933ddccb844_icgraph" id="classpFlow_1_1readControlDict_a9f960d8e9ef573c7aab1a933ddccb844_icgraph">
<area shape="rect" title=" " alt="" coords="92,5,171,32"/>
<area shape="rect" href="initialize__Control_8hpp.html#a1523b33abc50381afdaf093a953c6fa6" title=" " alt="" coords="5,5,44,32"/>
</map>
</div>
</div>
</div>
<a id="a948735c16bd010922637d8e9c5a0b558"></a>
@ -431,19 +378,6 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8hpp_source.html#l00072">72</a> of file <a class="el" href="readControlDict_8hpp_source.html">readControlDict.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="initialize__Control_8hpp_source.html#l00030">if()</a>.</p>
<div id="dynsection-7" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-7-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-7-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict_a948735c16bd010922637d8e9c5a0b558_icgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_a948735c16bd010922637d8e9c5a0b558_icgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_a948735c16bd010922637d8e9c5a0b558_icgraph" id="classpFlow_1_1readControlDict_a948735c16bd010922637d8e9c5a0b558_icgraph">
<area shape="rect" title=" " alt="" coords="92,5,195,32"/>
<area shape="rect" href="initialize__Control_8hpp.html#a1523b33abc50381afdaf093a953c6fa6" title=" " alt="" coords="5,5,44,32"/>
</map>
</div>
</div>
</div>
<a id="ae24c046ff18d5f5b50185e1cbfd983d1"></a>
@ -471,19 +405,6 @@ Static Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="readControlDict_8hpp_source.html#l00077">77</a> of file <a class="el" href="readControlDict_8hpp_source.html">readControlDict.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="initialize__Control_8hpp_source.html#l00030">if()</a>.</p>
<div id="dynsection-8" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-8-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-8-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1readControlDict_ae24c046ff18d5f5b50185e1cbfd983d1_icgraph.png" border="0" usemap="#classpFlow_1_1readControlDict_ae24c046ff18d5f5b50185e1cbfd983d1_icgraph" alt=""/></div>
<map name="classpFlow_1_1readControlDict_ae24c046ff18d5f5b50185e1cbfd983d1_icgraph" id="classpFlow_1_1readControlDict_ae24c046ff18d5f5b50185e1cbfd983d1_icgraph">
<area shape="rect" title=" " alt="" coords="92,5,216,32"/>
<area shape="rect" href="initialize__Control_8hpp.html#a1523b33abc50381afdaf093a953c6fa6" title=" " alt="" coords="5,5,44,32"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
@ -667,7 +588,7 @@ Static Protected Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> defaultRootPath = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">CWD</a>()</td>
<td class="memname"><a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> defaultRootPath = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">pFlow::CWD</a>()</td>
</tr>
</table>
</td>
@ -691,7 +612,7 @@ Static Protected Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> defaultCDPath = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">CWD</a>()/&quot;system&quot;+&quot;controlDict&quot;</td>
<td class="memname"><a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> defaultCDPath = <a class="el" href="namespacepFlow.html#a869d7b21ba981c374dcf8542f4ce2144">pFlow::CWD</a>()/<a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>(&quot;system&quot;)+word(&quot;controlDict&quot;)</td>
</tr>
</table>
</td>