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

@ -228,20 +228,20 @@ $(document).ready(function(){initNavTree('readControlDict_8cpp_source.html','');
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="anamespacepFlow_html_a010be5a80d29fca6b0ac9a68d9c94d32"><div class="ttname"><a href="namespacepFlow.html#a010be5a80d29fca6b0ac9a68d9c94d32">pFlow::fixed</a></div><div class="ttdeci">IOstream &amp; fixed(IOstream &amp;io)</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00327">IOstream.hpp:327</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_ae74a624bbb0665ed381b67cbda681031"><div class="ttname"><a href="classpFlow_1_1iIstream.html#ae74a624bbb0665ed381b67cbda681031">pFlow::iIstream::findTokenAndNextSilent</a></div><div class="ttdeci">virtual bool findTokenAndNextSilent(const word &amp;w, word &amp;nextW, int32 limitLine=100)</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8cpp_source.html#l00176">iIstream.cpp:176</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a4333d7bd717697fd94a3425351e1e4f2"><div class="ttname"><a href="namespacepFlow.html#a4333d7bd717697fd94a3425351e1e4f2">pFlow::scientific</a></div><div class="ttdeci">IOstream &amp; scientific(IOstream &amp;io)</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00333">IOstream.hpp:333</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_a6b741dd8443f554f5de5b98897f2eb77"><div class="ttname"><a href="classpFlow_1_1iIstream.html#a6b741dd8443f554f5de5b98897f2eb77">pFlow::iIstream::lookupDataOrSet</a></div><div class="ttdeci">T lookupDataOrSet(const word &amp;keyword, const T &amp;setVal)</div><div class="ttdef"><b>Definition:</b> <a href="iIstreamI_8hpp_source.html#l00068">iIstreamI.hpp:68</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a6192191c0e9c178a44ee1ac350fde476"><div class="ttname"><a href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a></div><div class="ttdeci">float real</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00046">builtinTypes.hpp:46</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00057">error.hpp:57</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_afb1243cec5833e96e8446abed4e3656c"><div class="ttname"><a href="classpFlow_1_1iIstream.html#afb1243cec5833e96e8446abed4e3656c">pFlow::iIstream::findKeywordAndVal</a></div><div class="ttdeci">bool findKeywordAndVal(const word &amp;keyword, T &amp;val, bool checkEndStatement=true)</div><div class="ttdef"><b>Definition:</b> <a href="iIstreamI_8hpp_source.html#l00024">iIstreamI.hpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iFstream_html"><div class="ttname"><a href="classpFlow_1_1iFstream.html">pFlow::iFstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iFstream_8hpp_source.html#l00035">iFstream.hpp:35</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a010be5a80d29fca6b0ac9a68d9c94d32"><div class="ttname"><a href="namespacepFlow.html#a010be5a80d29fca6b0ac9a68d9c94d32">pFlow::fixed</a></div><div class="ttdeci">IOstream &amp; fixed(IOstream &amp;io)</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00329">IOstream.hpp:329</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_ae74a624bbb0665ed381b67cbda681031"><div class="ttname"><a href="classpFlow_1_1iIstream.html#ae74a624bbb0665ed381b67cbda681031">pFlow::iIstream::findTokenAndNextSilent</a></div><div class="ttdeci">virtual bool findTokenAndNextSilent(const word &amp;w, word &amp;nextW, int32 limitLine=100)</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8cpp_source.html#l00203">iIstream.cpp:203</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a4333d7bd717697fd94a3425351e1e4f2"><div class="ttname"><a href="namespacepFlow.html#a4333d7bd717697fd94a3425351e1e4f2">pFlow::scientific</a></div><div class="ttdeci">IOstream &amp; scientific(IOstream &amp;io)</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00335">IOstream.hpp:335</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_a6b741dd8443f554f5de5b98897f2eb77"><div class="ttname"><a href="classpFlow_1_1iIstream.html#a6b741dd8443f554f5de5b98897f2eb77">pFlow::iIstream::lookupDataOrSet</a></div><div class="ttdeci">T lookupDataOrSet(const word &amp;keyword, const T &amp;setVal)</div><div class="ttdoc">lookup for keyword and data; set to setVal if lookup fails.</div><div class="ttdef"><b>Definition:</b> <a href="iIstreamI_8hpp_source.html#l00068">iIstreamI.hpp:68</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a6192191c0e9c178a44ee1ac350fde476"><div class="ttname"><a href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a></div><div class="ttdeci">float real</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00045">builtinTypes.hpp:45</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_afb1243cec5833e96e8446abed4e3656c"><div class="ttname"><a href="classpFlow_1_1iIstream.html#afb1243cec5833e96e8446abed4e3656c">pFlow::iIstream::findKeywordAndVal</a></div><div class="ttdeci">bool findKeywordAndVal(const word &amp;keyword, T &amp;val, bool checkEndStatement=true)</div><div class="ttdoc">find a pair of keyword and data terminated by ; keyword data; return false if keyword does not exist ...</div><div class="ttdef"><b>Definition:</b> <a href="iIstreamI_8hpp_source.html#l00024">iIstreamI.hpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iFstream_html"><div class="ttname"><a href="classpFlow_1_1iFstream.html">pFlow::iFstream</a></div><div class="ttdoc">Input file stream for reading binary or ascii data from a file.</div><div class="ttdef"><b>Definition:</b> <a href="iFstream_8hpp_source.html#l00037">iFstream.hpp:37</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeFolder_html_aaff3f438097803be5fef5cd29cd8985d"><div class="ttname"><a href="classpFlow_1_1timeFolder.html#aaff3f438097803be5fef5cd29cd8985d">pFlow::timeFolder::startTime</a></div><div class="ttdeci">real startTime() const</div><div class="ttdef"><b>Definition:</b> <a href="timeFolder_8hpp_source.html#l00105">timeFolder.hpp:105</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileSystem_html"><div class="ttname"><a href="classpFlow_1_1fileSystem.html">pFlow::fileSystem</a></div><div class="ttdef"><b>Definition:</b> <a href="fileSystem_8hpp_source.html#l00063">fileSystem.hpp:63</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00042">error.hpp:42</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00053">builtinTypes.hpp:53</a></div></div>
<div class="ttc" id="aclasspFlow_1_1fileSystem_html"><div class="ttname"><a href="classpFlow_1_1fileSystem.html">pFlow::fileSystem</a></div><div class="ttdoc">Manages file pathes, manupulate and combines them.</div><div class="ttdef"><b>Definition:</b> <a href="fileSystem_8hpp_source.html#l00071">fileSystem.hpp:71</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdoc">Report a fatal error and function name and exit the application.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00077">error.hpp:77</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00050">builtinTypes.hpp:50</a></div></div>
<div class="ttc" id="aclasspFlow_1_1readControlDict_html_a7d7d9ab257a71b8cbcd38af750103c07"><div class="ttname"><a href="classpFlow_1_1readControlDict.html#a7d7d9ab257a71b8cbcd38af750103c07">pFlow::readControlDict::formatType_</a></div><div class="ttdeci">word formatType_</div><div class="ttdef"><b>Definition:</b> <a href="readControlDict_8hpp_source.html#l00045">readControlDict.hpp:45</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeFolder_html_a2aafefc5248e595246d11de0587524f3"><div class="ttname"><a href="classpFlow_1_1timeFolder.html#a2aafefc5248e595246d11de0587524f3">pFlow::timeFolder::endTime</a></div><div class="ttdeci">real endTime() const</div><div class="ttdef"><b>Definition:</b> <a href="timeFolder_8hpp_source.html#l00111">timeFolder.hpp:111</a></div></div>
<div class="ttc" id="areadControlDict_8hpp_html"><div class="ttname"><a href="readControlDict_8hpp.html">readControlDict.hpp</a></div></div>