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

@ -168,19 +168,19 @@ $(document).ready(function(){initNavTree('twoPartEntry_8cpp_source.html',''); in
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1IOstream_html_af3418ac60d0d7a303478f29a387feb3c"><div class="ttname"><a href="classpFlow_1_1IOstream.html#af3418ac60d0d7a303478f29a387feb3c">pFlow::IOstream::eof</a></div><div class="ttdeci">bool eof() const</div><div class="ttdoc">Return true if end of input seen.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00190">IOstream.hpp:190</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_af3418ac60d0d7a303478f29a387feb3c"><div class="ttname"><a href="classpFlow_1_1IOstream.html#af3418ac60d0d7a303478f29a387feb3c">pFlow::IOstream::eof</a></div><div class="ttdeci">bool eof() const</div><div class="ttdoc">Return true if end of input seen.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00192">IOstream.hpp:192</a></div></div>
<div class="ttc" id="atwoPartEntry_8hpp_html"><div class="ttname"><a href="twoPartEntry_8hpp.html">twoPartEntry.hpp</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="aclasspFlow_1_1token_html"><div class="ttname"><a href="classpFlow_1_1token.html">pFlow::token</a></div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00042">token.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_aec6909dffed34a3c8c286c344e4cf656"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aec6909dffed34a3c8c286c344e4cf656">pFlow::dataEntry::stream</a></div><div class="ttdeci">virtual iTstream &amp; stream()</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00261">dataEntry.cpp:261</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="aclasspFlow_1_1token_html"><div class="ttname"><a href="classpFlow_1_1token.html">pFlow::token</a></div><div class="ttdoc">Token class based on OpenFOAM stream, with some modifications/simplifications to be tailored to our n...</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00044">token.hpp:44</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_aec6909dffed34a3c8c286c344e4cf656"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#aec6909dffed34a3c8c286c344e4cf656">pFlow::dataEntry::stream</a></div><div class="ttdeci">virtual iTstream &amp; stream()</div><div class="ttdoc">access to token stream</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8cpp_source.html#l00265">dataEntry.cpp:265</a></div></div>
<div class="ttc" id="aclasspFlow_1_1twoPartEntry_html"><div class="ttname"><a href="classpFlow_1_1twoPartEntry.html">pFlow::twoPartEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="twoPartEntry_8hpp_source.html#l00036">twoPartEntry.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iTstream_html_a259cb5a711406a8c3e5d937eb9350cca"><div class="ttname"><a href="classpFlow_1_1iTstream.html#a259cb5a711406a8c3e5d937eb9350cca">pFlow::iTstream::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8cpp_source.html#l00336">iTstream.cpp:336</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a7c88d41e6cee4f2ba2bfa06e3078373a"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">pFlow::iEntry::keyword</a></div><div class="ttdeci">virtual const word &amp; keyword() const</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00084">iEntry.hpp:84</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iTstream_html_a259cb5a711406a8c3e5d937eb9350cca"><div class="ttname"><a href="classpFlow_1_1iTstream.html#a259cb5a711406a8c3e5d937eb9350cca">pFlow::iTstream::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">size</div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8cpp_source.html#l00336">iTstream.cpp:336</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a7c88d41e6cee4f2ba2bfa06e3078373a"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a7c88d41e6cee4f2ba2bfa06e3078373a">pFlow::iEntry::keyword</a></div><div class="ttdeci">virtual const word &amp; keyword() const</div><div class="ttdoc">return keyword</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00088">iEntry.hpp:88</a></div></div>
<div class="ttc" id="aclasspFlow_1_1twoPartEntry_html_a00ad076e871627b9717719b5d1082e71"><div class="ttname"><a href="classpFlow_1_1twoPartEntry.html#a00ad076e871627b9717719b5d1082e71">pFlow::twoPartEntry::secondPart</a></div><div class="ttdeci">iTstream &amp; secondPart()</div><div class="ttdef"><b>Definition:</b> <a href="twoPartEntry_8hpp_source.html#l00056">twoPartEntry.hpp:56</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html"><div class="ttname"><a href="classpFlow_1_1dataEntry.html">pFlow::dataEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00040">dataEntry.hpp:40</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="aclasspFlow_1_1iTstream_html_a2927b1d2adfb79cfbe30374f02109ac5"><div class="ttname"><a href="classpFlow_1_1iTstream.html#a2927b1d2adfb79cfbe30374f02109ac5">pFlow::iTstream::read</a></div><div class="ttdeci">virtual iIstream &amp; read(token &amp;t) override</div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8cpp_source.html#l00111">iTstream.cpp:111</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iTstream_html"><div class="ttname"><a href="classpFlow_1_1iTstream.html">pFlow::iTstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8hpp_source.html#l00021">iTstream.hpp:21</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html"><div class="ttname"><a href="classpFlow_1_1dataEntry.html">pFlow::dataEntry</a></div><div class="ttdoc">Data entry to be used in dictionries.</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00048">dataEntry.hpp:48</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="aclasspFlow_1_1iTstream_html_a2927b1d2adfb79cfbe30374f02109ac5"><div class="ttname"><a href="classpFlow_1_1iTstream.html#a2927b1d2adfb79cfbe30374f02109ac5">pFlow::iTstream::read</a></div><div class="ttdeci">virtual iIstream &amp; read(token &amp;t) override</div><div class="ttdoc">Return next token from stream.</div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8cpp_source.html#l00111">iTstream.cpp:111</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iTstream_html"><div class="ttname"><a href="classpFlow_1_1iTstream.html">pFlow::iTstream</a></div><div class="ttdoc">Input token stream.</div><div class="ttdef"><b>Definition:</b> <a href="iTstream_8hpp_source.html#l00027">iTstream.hpp:27</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a70a0d5a242b0aeaf4399e556a1b74828"><div class="ttname"><a href="namespacepFlow.html#a70a0d5a242b0aeaf4399e556a1b74828">pFlow::isTwoPartEntry</a></div><div class="ttdeci">bool isTwoPartEntry(dataEntry entry)</div><div class="ttdef"><b>Definition:</b> <a href="twoPartEntry_8cpp_source.html#l00056">twoPartEntry.cpp:56</a></div></div>
<div class="ttc" id="aclasspFlow_1_1twoPartEntry_html_a7ce6240a421692d112846f31793bcd85"><div class="ttname"><a href="classpFlow_1_1twoPartEntry.html#a7ce6240a421692d112846f31793bcd85">pFlow::twoPartEntry::twoPartEntry</a></div><div class="ttdeci">twoPartEntry(dataEntry entry)</div><div class="ttdef"><b>Definition:</b> <a href="twoPartEntry_8cpp_source.html#l00028">twoPartEntry.cpp:28</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->