doc for Geometry

This commit is contained in:
Hamidreza Norouzi
2023-04-13 11:46:41 -07:00
parent 895e48d89f
commit 123023579a
3624 changed files with 83821 additions and 29967 deletions

View File

@ -291,7 +291,7 @@ $(document).ready(function(){initNavTree('iEntry_8cpp_source.html',''); initResi
<div class="line"><a name="l00185"></a><span class="lineno"> 185</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="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00156">IOstream.hpp:156</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#l00190">IOstream.hpp:190</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_ac35c0ab7b3a6a0cdcf8c2bd2bf24de11"><div class="ttname"><a href="classpFlow_1_1iIstream.html#ac35c0ab7b3a6a0cdcf8c2bd2bf24de11">pFlow::iIstream::read</a></div><div class="ttdeci">virtual iIstream &amp; read(token &amp;)=0</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>
@ -300,19 +300,19 @@ $(document).ready(function(){initNavTree('iEntry_8cpp_source.html',''); initResi
<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="apFlowMacros_8hpp_html_a922d2784284e8f6ee4009c3d92ba48b6"><div class="ttname"><a href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a></div><div class="ttdeci">#define FUNCTION_NAME</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00029">pFlowMacros.hpp:29</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00349">dictionary.cpp:349</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="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00312">iOstream.hpp:312</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_1iEntry_html_afa17f5989b1af05e5ed08234f217a59c"><div class="ttname"><a href="classpFlow_1_1iEntry.html#afa17f5989b1af05e5ed08234f217a59c">pFlow::iEntry::write</a></div><div class="ttdeci">virtual bool write(iOstream &amp;os) const =0</div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00033">iIstream.hpp:33</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a70add3b10fc1217ec5b9f30d261bda27"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a70add3b10fc1217ec5b9f30d261bda27">pFlow::iEntry::read</a></div><div class="ttdeci">virtual bool read(iIstream &amp;is)=0</div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a9f7290a5d70f30e1b1b42c8ac4a6082d"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a9f7290a5d70f30e1b1b42c8ac4a6082d">pFlow::IOstream::bad</a></div><div class="ttdeci">bool bad() const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00168">IOstream.hpp:168</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a9f7290a5d70f30e1b1b42c8ac4a6082d"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a9f7290a5d70f30e1b1b42c8ac4a6082d">pFlow::IOstream::bad</a></div><div class="ttdeci">bool bad() const</div><div class="ttdoc">Return true if stream is corrupted.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00202">IOstream.hpp:202</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_1iEntry_html_a133f34e170bc1f28e7439fe87043ce2f"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a133f34e170bc1f28e7439fe87043ce2f">pFlow::iEntry::createEntry</a></div><div class="ttdeci">static bool createEntry(dictionary &amp;parDict, iIstream &amp;is, bool hasBlockToken=false)</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8cpp_source.html#l00064">iEntry.cpp:64</a></div></div>
<div class="ttc" id="adictionary_8hpp_html"><div class="ttname"><a href="dictionary_8hpp.html">dictionary.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html_aeecefbf648ad32c20134e67c4fa35597"><div class="ttname"><a href="classpFlow_1_1iIstream.html#aeecefbf648ad32c20134e67c4fa35597">pFlow::iIstream::putBack</a></div><div class="ttdeci">void putBack(const token &amp;tok)</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8cpp_source.html#l00005">iIstream.cpp:5</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a85ed561d066dae339196cd058783674f"><div class="ttname"><a href="namespacepFlow.html#a85ed561d066dae339196cd058783674f">pFlow::operator&gt;&gt;</a></div><div class="ttdeci">INLINE_FUNCTION iIstream &amp; operator&gt;&gt;(iIstream &amp;str, AB3History &amp;ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00041">AdamsBashforth3.hpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a281bbfd1fe6ab10377d7cb1f5111044d"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a281bbfd1fe6ab10377d7cb1f5111044d">pFlow::IOstream::fatalCheck</a></div><div class="ttdeci">bool fatalCheck(const char *operation) const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00048">IOstream.cpp:48</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a281bbfd1fe6ab10377d7cb1f5111044d"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a281bbfd1fe6ab10377d7cb1f5111044d">pFlow::IOstream::fatalCheck</a></div><div class="ttdeci">bool fatalCheck(const char *operation) const</div><div class="ttdoc">Check IOstream status for given operation.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00048">IOstream.cpp:48</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a148d74ad0977268be8ea8b26a147f619"><div class="ttname"><a href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator&lt;&lt;</a></div><div class="ttdeci">INLINE_FUNCTION iOstream &amp; operator&lt;&lt;(iOstream &amp;str, const AB3History &amp;ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00057">AdamsBashforth3.hpp:57</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_ac9b54653d0ec63ee05f64a185437b335"><div class="ttname"><a href="classpFlow_1_1IOstream.html#ac9b54653d0ec63ee05f64a185437b335">pFlow::IOstream::name</a></div><div class="ttdeci">virtual const word &amp; name() const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00031">IOstream.cpp:31</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_ac9b54653d0ec63ee05f64a185437b335"><div class="ttname"><a href="classpFlow_1_1IOstream.html#ac9b54653d0ec63ee05f64a185437b335">pFlow::IOstream::name</a></div><div class="ttdeci">virtual const word &amp; name() const</div><div class="ttdoc">Return the name of the stream.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00031">IOstream.cpp:31</a></div></div>
<div class="ttc" id="aiEntry_8hpp_html"><div class="ttname"><a href="iEntry_8hpp.html">iEntry.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a41b87eb2ffa631b3685fed7694f2c7ed"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a41b87eb2ffa631b3685fed7694f2c7ed">pFlow::iEntry::writeKeyword</a></div><div class="ttdeci">bool writeKeyword(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8cpp_source.html#l00154">iEntry.cpp:154</a></div></div>
<div class="ttc" id="aclasspFlow_1_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a></div><div class="ttdef"><b>Definition:</b> <a href="uniquePtr_8hpp_source.html#l00044">uniquePtr.hpp:44</a></div></div>
@ -321,11 +321,11 @@ $(document).ready(function(){initNavTree('iEntry_8cpp_source.html',''); initResi
<div class="ttc" id="aerror_8hpp_html_a83efa053dfcfcef04cc0e721c0314ff3"><div class="ttname"><a href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3">ioErrorInFile</a></div><div class="ttdeci">#define ioErrorInFile(fileName, lineNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00049">error.hpp:49</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_adaf3255a26893f538d0e891e77d0d6c7"><div class="ttname"><a href="classpFlow_1_1iEntry.html#adaf3255a26893f538d0e891e77d0d6c7">pFlow::iEntry::readKeyword</a></div><div class="ttdeci">static bool readKeyword(iIstream &amp;is, word &amp;keyword, token &amp;tok)</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8cpp_source.html#l00032">iEntry.cpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html"><div class="ttname"><a href="classpFlow_1_1iEntry.html">pFlow::iEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00038">iEntry.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a607efe5fb94edbe4cfa890c4907e76c3"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a607efe5fb94edbe4cfa890c4907e76c3">pFlow::IOstream::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00187">IOstream.hpp:187</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a607efe5fb94edbe4cfa890c4907e76c3"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a607efe5fb94edbe4cfa890c4907e76c3">pFlow::IOstream::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdoc">Const access to the current stream line number.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00221">IOstream.hpp:221</a></div></div>
<div class="ttc" id="aiOstream_8hpp_html"><div class="ttname"><a href="iOstream_8hpp.html">iOstream.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00053">iOstream.hpp:53</a></div></div>
<div class="ttc" id="aclasspFlow_1_1token_html_a8658f0b0a04ffdb6e74c5af4ca27edf1"><div class="ttname"><a href="classpFlow_1_1token.html#a8658f0b0a04ffdb6e74c5af4ca27edf1">pFlow::token::wordToken</a></div><div class="ttdeci">const word &amp; wordToken() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00600">tokenI.hpp:600</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_af746580dedb817d31f5060ee684b9543"><div class="ttname"><a href="classpFlow_1_1iOstream.html#af746580dedb817d31f5060ee684b9543">pFlow::iOstream::writeWordKeyword</a></div><div class="ttdeci">virtual iOstream &amp; writeWordKeyword(const word &amp;kw)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00041">iOstream.cpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_af746580dedb817d31f5060ee684b9543"><div class="ttname"><a href="classpFlow_1_1iOstream.html#af746580dedb817d31f5060ee684b9543">pFlow::iOstream::writeWordKeyword</a></div><div class="ttdeci">virtual iOstream &amp; writeWordKeyword(const word &amp;kw)</div><div class="ttdoc">Write the keyword followed by an appropriate indentation.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00041">iOstream.cpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00038">dictionary.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1token_html_ace6d5ecd2736d19990a7c12e0fe5a745"><div class="ttname"><a href="classpFlow_1_1token.html#ace6d5ecd2736d19990a7c12e0fe5a745">pFlow::token::isWord</a></div><div class="ttdeci">bool isWord() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00584">tokenI.hpp:584</a></div></div>
<div class="ttc" id="aerror_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div>