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

@ -925,16 +925,16 @@ $(document).ready(function(){initNavTree('dictionary_8cpp_source.html',''); init
<div class="line"><a name="l00819"></a><span class="lineno"> 819</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_ab440fa44645864fa1f9595b19d77bed0"><div class="ttname"><a href="classpFlow_1_1iOstream.html#ab440fa44645864fa1f9595b19d77bed0">pFlow::iOstream::beginBlock</a></div><div class="ttdeci">virtual iOstream &amp; beginBlock(const word &amp;kw)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00070">iOstream.cpp:70</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_1iOstream_html_ab440fa44645864fa1f9595b19d77bed0"><div class="ttname"><a href="classpFlow_1_1iOstream.html#ab440fa44645864fa1f9595b19d77bed0">pFlow::iOstream::beginBlock</a></div><div class="ttdeci">virtual iOstream &amp; beginBlock(const word &amp;kw)</div><div class="ttdoc">Write begin block group with a name Increments indentation, adds newline.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00070">iOstream.cpp:70</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a8a0ae40ed4ddfc34371027fff32a0659"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a8a0ae40ed4ddfc34371027fff32a0659">pFlow::dictionary::orderedEntries_</a></div><div class="ttdeci">List&lt; iEntry * &gt; orderedEntries_</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00053">dictionary.hpp:53</a></div></div>
<div class="ttc" id="aclasspFlow_1_1List_html"><div class="ttname"><a href="classpFlow_1_1List.html">pFlow::List&lt; word &gt;</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a8da7514808d6493ccfd30582fc945aa1"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a8da7514808d6493ccfd30582fc945aa1">pFlow::iOstream::write</a></div><div class="ttdeci">virtual bool write(const token &amp;tok)=0</div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a8da7514808d6493ccfd30582fc945aa1"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a8da7514808d6493ccfd30582fc945aa1">pFlow::iOstream::write</a></div><div class="ttdeci">virtual bool write(const token &amp;tok)=0</div><div class="ttdoc">Write Functions.</div></div>
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a1dd6f0d658bf5328665bab3afa9d773a"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a1dd6f0d658bf5328665bab3afa9d773a">pFlow::iEntry::clone</a></div><div class="ttdeci">virtual uniquePtr&lt; iEntry &gt; clone() const =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>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a6a40de4ceed55b2f78cf3027739dfd91"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a6a40de4ceed55b2f78cf3027739dfd91">pFlow::dictionary::write</a></div><div class="ttdeci">virtual bool write(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00780">dictionary.cpp:780</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a1850a128366512b2539de09dc0622358"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a1850a128366512b2539de09dc0622358">pFlow::iOstream::endBlock</a></div><div class="ttdeci">virtual iOstream &amp; endBlock()</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00088">iOstream.cpp:88</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a1850a128366512b2539de09dc0622358"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a1850a128366512b2539de09dc0622358">pFlow::iOstream::endBlock</a></div><div class="ttdeci">virtual iOstream &amp; endBlock()</div><div class="ttdoc">Write end block group Decrements indentation, adds newline.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8cpp_source.html#l00088">iOstream.cpp:88</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a013d55c9f22dfd9bbe81bd8890ea5929"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a013d55c9f22dfd9bbe81bd8890ea5929">pFlow::dictionary::allKeywords</a></div><div class="ttdeci">wordList allKeywords() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00695">dictionary.cpp:695</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a889d5e8bf195a24964ffb883bcb2fc3b"><div class="ttname"><a href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a></div><div class="ttdeci">#define warningInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00055">error.hpp:55</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_aa7381535b14d85e166f4fd9f522b9e88"><div class="ttname"><a href="classpFlow_1_1dictionary.html#aa7381535b14d85e166f4fd9f522b9e88">pFlow::dictionary::findEntry</a></div><div class="ttdeci">iEntry * findEntry(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00106">dictionary.cpp:106</a></div></div>
@ -944,12 +944,12 @@ $(document).ready(function(){initNavTree('dictionary_8cpp_source.html',''); init
<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_a94809bdb48183ff3ef62935d56f5c1e0"><div class="ttname"><a href="namespacepFlow.html#a94809bdb48183ff3ef62935d56f5c1e0">pFlow::int64</a></div><div class="ttdeci">long long int int64</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00055">builtinTypes.hpp:55</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="aclasspFlow_1_1Istream_html_a754ce9966caae1ee331378bf4a87269b"><div class="ttname"><a href="classpFlow_1_1Istream.html#a754ce9966caae1ee331378bf4a87269b">pFlow::Istream::name</a></div><div class="ttdeci">virtual const word &amp; name() const</div><div class="ttdef"><b>Definition:</b> <a href="Istream_8hpp_source.html#l00078">Istream.hpp:78</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Istream_html_a754ce9966caae1ee331378bf4a87269b"><div class="ttname"><a href="classpFlow_1_1Istream.html#a754ce9966caae1ee331378bf4a87269b">pFlow::Istream::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="Istream_8hpp_source.html#l00077">Istream.hpp:77</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_aa4d7322eaead3c887a9283546628de96"><div class="ttname"><a href="classpFlow_1_1dictionary.html#aa4d7322eaead3c887a9283546628de96">pFlow::dictionary::subDictOrCreate</a></div><div class="ttdeci">dictionary &amp; subDictOrCreate(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00634">dictionary.cpp:634</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a6ae2ea14b8b5e5661c2f207aae2d4bdc"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a6ae2ea14b8b5e5661c2f207aae2d4bdc">pFlow::dictionary::add</a></div><div class="ttdeci">bool add(const word &amp;keyword, const float &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00422">dictionary.cpp:422</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_1dictionary_html_aed15599ef76092b99a4f4241816eff02"><div class="ttname"><a href="classpFlow_1_1dictionary.html#aed15599ef76092b99a4f4241816eff02">pFlow::dictionary::isDictionary</a></div><div class="ttdeci">virtual bool isDictionary() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00344">dictionary.cpp:344</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_1dictionary_html_a547cb1f4ce564ef3a22a8942ab7bf88a"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a547cb1f4ce564ef3a22a8942ab7bf88a">pFlow::dictionary::nullDict</a></div><div class="ttdeci">static dictionary nullDict</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00085">dictionary.hpp:85</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="aclasspFlow_1_1dictionary_html_afc71ebfe0388847de8017552d16e4c90"><div class="ttname"><a href="classpFlow_1_1dictionary.html#afc71ebfe0388847de8017552d16e4c90">pFlow::dictionary::clonePtr</a></div><div class="ttdeci">virtual iEntry * clonePtr() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00797">dictionary.cpp:797</a></div></div>
@ -976,10 +976,10 @@ $(document).ready(function(){initNavTree('dictionary_8cpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a84ad7f4914a81375bf795a459911e26d"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a84ad7f4914a81375bf795a459911e26d">pFlow::dictionary::numDataEntries</a></div><div class="ttdeci">size_t numDataEntries() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00669">dictionary.cpp:669</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a713abeb5a65a5982d48bebb237e19722"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a713abeb5a65a5982d48bebb237e19722">pFlow::dictionary::dataEntryRef</a></div><div class="ttdeci">dataEntry &amp; dataEntryRef(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00600">dictionary.cpp:600</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_ac2e8b8b4980850686b61c0e9755d7bf9"><div class="ttname"><a href="classpFlow_1_1dictionary.html#ac2e8b8b4980850686b61c0e9755d7bf9">pFlow::dictionary::subDictPtr</a></div><div class="ttdeci">dictionary * subDictPtr(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00529">dictionary.cpp:529</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="aclasspFlow_1_1dictionary_html_a630c840647a3ebefe33336cc25a8b15d"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a630c840647a3ebefe33336cc25a8b15d">pFlow::dictionary::subDict</a></div><div class="ttdeci">dictionary &amp; subDict(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00547">dictionary.cpp:547</a></div></div>
<div class="ttc" id="astreams_8hpp_html"><div class="ttname"><a href="streams_8hpp.html">streams.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_abdcc7f96f487faadc7769afcf58fe992"><div class="ttname"><a href="classpFlow_1_1IOstream.html#abdcc7f96f487faadc7769afcf58fe992">pFlow::IOstream::good</a></div><div class="ttdeci">bool good() const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00150">IOstream.hpp:150</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_abdcc7f96f487faadc7769afcf58fe992"><div class="ttname"><a href="classpFlow_1_1IOstream.html#abdcc7f96f487faadc7769afcf58fe992">pFlow::IOstream::good</a></div><div class="ttdeci">bool good() const</div><div class="ttdoc">Return true if next operation might succeed.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00184">IOstream.hpp:184</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dataEntry_html_a69b422672deb33016b466d4f7ac204ba"><div class="ttname"><a href="classpFlow_1_1dataEntry.html#a69b422672deb33016b466d4f7ac204ba">pFlow::dataEntry::nullDataEntry</a></div><div class="ttdeci">static dataEntry nullDataEntry</div><div class="ttdef"><b>Definition:</b> <a href="dataEntry_8hpp_source.html#l00066">dataEntry.hpp:66</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>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a855a11e053a7beb86f8f23b2efc3de9e"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a855a11e053a7beb86f8f23b2efc3de9e">pFlow::dictionary::addPtr</a></div><div class="ttdeci">bool addPtr(const word &amp;keyword, uniquePtr&lt; iEntry &gt; &amp;etry)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00379">dictionary.cpp:379</a></div></div>
@ -990,7 +990,7 @@ $(document).ready(function(){initNavTree('dictionary_8cpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a4cea470990d165a35c1b2333a569b586"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a4cea470990d165a35c1b2333a569b586">pFlow::dictionary::dictionary</a></div><div class="ttdeci">dictionary()</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00135">dictionary.cpp:135</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_ac8bb3912a3ce86b15842e79d0b421204"><div class="ttname"><a href="classpFlow_1_1dictionary.html#ac8bb3912a3ce86b15842e79d0b421204">pFlow::dictionary::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00522">dictionary.cpp:522</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a07fb256c1077eea7a7726e948cc8ff0e"><div class="ttname"><a href="namespacepFlow.html#a07fb256c1077eea7a7726e948cc8ff0e">pFlow::int8</a></div><div class="ttdeci">signed char int8</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00049">builtinTypes.hpp:49</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="aclasspFlow_1_1fileSystem_html_ad7cad1b82e1afeea66c2f0649de5d93f"><div class="ttname"><a href="classpFlow_1_1fileSystem.html#ad7cad1b82e1afeea66c2f0649de5d93f">pFlow::fileSystem::wordPath</a></div><div class="ttdeci">word wordPath() const</div><div class="ttdef"><b>Definition:</b> <a href="fileSystem_8hpp_source.html#l00126">fileSystem.hpp:126</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a884a981ad2a220efcd7f6e8bf6cd94e2"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a884a981ad2a220efcd7f6e8bf6cd94e2">pFlow::dictionary::addDict</a></div><div class="ttdeci">bool addDict(const word &amp;keyword, const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00513">dictionary.cpp:513</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_aec915adbf764f8fa9e30fbc16299b3da"><div class="ttname"><a href="classpFlow_1_1dictionary.html#aec915adbf764f8fa9e30fbc16299b3da">pFlow::dictionary::numDictionaries</a></div><div class="ttdeci">size_t numDictionaries() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00682">dictionary.cpp:682</a></div></div>