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

@ -318,9 +318,9 @@ $(document).ready(function(){initNavTree('sphereShape_8cpp_source.html',''); ini
<div class="ttc" id="anamespacepFlow_html_abd01e8e67e3d94cab04ecaaf4f85ac1b"><div class="ttname"><a href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">pFlow::uint32</a></div><div class="ttdeci">unsigned int uint32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00059">builtinTypes.hpp:59</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="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_1Vector_html_a10efdf47ffedbdc720f71c2f72b98d98"><div class="ttname"><a href="classpFlow_1_1Vector.html#a10efdf47ffedbdc720f71c2f72b98d98">pFlow::Vector::size</a></div><div class="ttdeci">auto size() const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00299">Vector.hpp:299</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a10efdf47ffedbdc720f71c2f72b98d98"><div class="ttname"><a href="classpFlow_1_1Vector.html#a10efdf47ffedbdc720f71c2f72b98d98">pFlow::Vector::size</a></div><div class="ttdeci">auto size() const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00301">Vector.hpp:301</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="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_1sphereShape_html_aff8e92ab47032ae811d1271161cb9b22"><div class="ttname"><a href="classpFlow_1_1sphereShape.html#aff8e92ab47032ae811d1271161cb9b22">pFlow::sphereShape::read</a></div><div class="ttdeci">bool read(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="sphereShape_8cpp_source.html#l00166">sphereShape.cpp:166</a></div></div>
<div class="ttc" id="asphereShape_8hpp_html"><div class="ttname"><a href="sphereShape_8hpp.html">sphereShape.hpp</a></div></div>
<div class="ttc" id="aNBSCrossLoop_8hpp_html_aad8b608072a1b6dcd9e91de38ee2925f"><div class="ttname"><a href="NBSCrossLoop_8hpp.html#aad8b608072a1b6dcd9e91de38ee2925f">n</a></div><div class="ttdeci">int32 n</div><div class="ttdef"><b>Definition:</b> <a href="NBSCrossLoop_8hpp_source.html#l00024">NBSCrossLoop.hpp:24</a></div></div>
@ -329,7 +329,7 @@ $(document).ready(function(){initNavTree('sphereShape_8cpp_source.html',''); ini
<div class="ttc" id="aclasspFlow_1_1sphereShape_html_a5ff3b9c9e439388497056ffbc8fd27f5"><div class="ttname"><a href="classpFlow_1_1sphereShape.html#a5ff3b9c9e439388497056ffbc8fd27f5">pFlow::sphereShape::sphereShape</a></div><div class="ttdeci">sphereShape()</div><div class="ttdef"><b>Definition:</b> <a href="sphereShape_8hpp_source.html#l00060">sphereShape.hpp:60</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_1sphereShape_html_ad55987c0647186d3e7acad9cc4166034"><div class="ttname"><a href="classpFlow_1_1sphereShape.html#ad55987c0647186d3e7acad9cc4166034">pFlow::sphereShape::writeDictionary</a></div><div class="ttdeci">bool writeDictionary(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="sphereShape_8cpp_source.html#l00085">sphereShape.cpp:85</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="astreams_8hpp_html"><div class="ttname"><a href="streams_8hpp.html">streams.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &amp;keyword) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00309">dictionary.hpp:309</a></div></div>
<div class="ttc" id="aclasspFlow_1_1property_html"><div class="ttname"><a href="classpFlow_1_1property.html">pFlow::property</a></div><div class="ttdoc">property holds the pure properties of materials.</div><div class="ttdef"><b>Definition:</b> <a href="property_8hpp_source.html#l00040">property.hpp:40</a></div></div>
@ -337,7 +337,7 @@ $(document).ready(function(){initNavTree('sphereShape_8cpp_source.html',''); ini
<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_1sphereShape_html_aa4bf56a0baa8e23b866f1e7e45b142b6"><div class="ttname"><a href="classpFlow_1_1sphereShape.html#aa4bf56a0baa8e23b866f1e7e45b142b6">pFlow::sphereShape::insertNames</a></div><div class="ttdeci">bool insertNames(const wordVector &amp;names)</div><div class="ttdef"><b>Definition:</b> <a href="sphereShape_8cpp_source.html#l00028">sphereShape.cpp:28</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a39f5f71474553bc78726494fa09dd0fb"><div class="ttname"><a href="namespacepFlow.html#a39f5f71474553bc78726494fa09dd0fb">pFlow::label</a></div><div class="ttdeci">std::size_t label</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00061">builtinTypes.hpp:61</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_1sphereShape_html_a3ee94dd32f4df1490653290d2919dc52"><div class="ttname"><a href="classpFlow_1_1sphereShape.html#a3ee94dd32f4df1490653290d2919dc52">pFlow::sphereShape::readDictionary</a></div><div class="ttdeci">bool readDictionary(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="sphereShape_8cpp_source.html#l00053">sphereShape.cpp:53</a></div></div>
<div class="ttc" id="avocabs_8hpp_html"><div class="ttname"><a href="vocabs_8hpp.html">vocabs.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html"><div class="ttname"><a href="classpFlow_1_1Vector.html">pFlow::Vector&lt; word &gt;</a></div></div>