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

@ -180,6 +180,10 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a2c4e952d46d447c08664eeba4e791854 inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1921a7f20c43d1438221946e607c488 inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#ae1921a7f20c43d1438221946e607c488">path</a> () const</td></tr>
<tr class="separator:ae1921a7f20c43d1438221946e607c488 inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefb380f32e3c6839d26dbc93ff4eb00a inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aefb380f32e3c6839d26dbc93ff4eb00a">outFileBinary</a> () const</td></tr>
<tr class="separator:aefb380f32e3c6839d26dbc93ff4eb00a inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e04bca1658d3c571a38d8ac1d62462e inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a6e04bca1658d3c571a38d8ac1d62462e">inFileBinary</a> () const</td></tr>
<tr class="separator:a6e04bca1658d3c571a38d8ac1d62462e inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a248aa0488b774d5160449992ad31e5 inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a1a248aa0488b774d5160449992ad31e5">headerOk</a> (bool silent=false)</td></tr>
<tr class="separator:a1a248aa0488b774d5160449992ad31e5 inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac13e923e67df5e79d9a75f592b97da3 inherit pub_methods_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aac13e923e67df5e79d9a75f592b97da3">implyRead</a> () const</td></tr>
@ -256,6 +260,9 @@ Protected Attributes</h2></td></tr>
<tr class="separator:a0fc09585fc6fa997b81807dff8b8236d inherit pro_attribs_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf7afc3ea2cc179930f4e4f4ca48797c inherit pro_attribs_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#adf7afc3ea2cc179930f4e4f4ca48797c">objectType_</a></td></tr>
<tr class="separator:adf7afc3ea2cc179930f4e4f4ca48797c inherit pro_attribs_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4df46db2aad0395fac9c0522d8c409a9 inherit pro_attribs_classpFlow_1_1IOfileHeader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a4df46db2aad0395fac9c0522d8c409a9">fileFormat_</a> = &quot;ASCII&quot;</td></tr>
<tr class="memdesc:a4df46db2aad0395fac9c0522d8c409a9 inherit pro_attribs_classpFlow_1_1IOfileHeader"><td class="mdescLeft">&#160;</td><td class="mdescRight">file format read from file <a href="classpFlow_1_1IOfileHeader.html#a4df46db2aad0395fac9c0522d8c409a9">More...</a><br /></td></tr>
<tr class="separator:a4df46db2aad0395fac9c0522d8c409a9 inherit pro_attribs_classpFlow_1_1IOfileHeader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classpFlow_1_1objectFile"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classpFlow_1_1objectFile')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a></td></tr>
<tr class="memitem:a50fd7d13a0f7a6007ca5027b3bb8765a inherit pro_attribs_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a50fd7d13a0f7a6007ca5027b3bb8765a">name_</a></td></tr>
<tr class="separator:a50fd7d13a0f7a6007ca5027b3bb8765a inherit pro_attribs_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -324,7 +331,7 @@ Additional Inherited Members</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00026">26</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, and <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, and <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>.</p>
<div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
@ -333,7 +340,7 @@ Additional Inherited Members</h2></td></tr>
<div class="center"><img src="classpFlow_1_1IOobject_a0abd37e236ec0ec02221cb77c95d7867_cgraph.png" border="0" usemap="#classpFlow_1_1IOobject_a0abd37e236ec0ec02221cb77c95d7867_cgraph" alt=""/></div>
<map name="classpFlow_1_1IOobject_a0abd37e236ec0ec02221cb77c95d7867_cgraph" id="classpFlow_1_1IOobject_a0abd37e236ec0ec02221cb77c95d7867_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,81,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title=" " alt="" coords="129,5,225,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="129,5,227,32"/>
</map>
</div>
@ -558,7 +565,7 @@ Additional Inherited Members</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="IOobjectTemplates_8cpp_source.html#l00042">42</a> of file <a class="el" href="IOobjectTemplates_8cpp_source.html">IOobjectTemplates.cpp</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>, <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, and <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>, <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, and <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>.</p>
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-3-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
@ -567,7 +574,7 @@ Additional Inherited Members</h2></td></tr>
<div class="center"><img src="classpFlow_1_1IOobject_a4cb27dedd5c3df0ca20847c584620480_cgraph.png" border="0" usemap="#classpFlow_1_1IOobject_a4cb27dedd5c3df0ca20847c584620480_cgraph" alt=""/></div>
<map name="classpFlow_1_1IOobject_a4cb27dedd5c3df0ca20847c584620480_cgraph" id="classpFlow_1_1IOobject_a4cb27dedd5c3df0ca20847c584620480_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,91,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title=" " alt="" coords="139,5,235,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="139,5,236,32"/>
</map>
</div>
@ -587,7 +594,7 @@ Additional Inherited Members</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="IOobjectTemplates_8cpp_source.html#l00055">55</a> of file <a class="el" href="IOobjectTemplates_8cpp_source.html">IOobjectTemplates.cpp</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>, <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, and <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>, <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, and <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>.</p>
<div id="dynsection-4" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-4-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
@ -596,7 +603,7 @@ Additional Inherited Members</h2></td></tr>
<div class="center"><img src="classpFlow_1_1IOobject_a0d8c1b9b6f6dd3ab7b3160e95bea32af_cgraph.png" border="0" usemap="#classpFlow_1_1IOobject_a0d8c1b9b6f6dd3ab7b3160e95bea32af_cgraph" alt=""/></div>
<map name="classpFlow_1_1IOobject_a0d8c1b9b6f6dd3ab7b3160e95bea32af_cgraph" id="classpFlow_1_1IOobject_a0d8c1b9b6f6dd3ab7b3160e95bea32af_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,91,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title=" " alt="" coords="139,5,235,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="139,5,236,32"/>
</map>
</div>
@ -620,7 +627,7 @@ Additional Inherited Members</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00063">63</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, and <a class="el" href="error_8hpp_source.html#l00055">warningInFunction</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, and <a class="el" href="error_8hpp_source.html#l00055">warningInFunction</a>.</p>
<div id="dynsection-5" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-5-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
@ -629,7 +636,7 @@ Additional Inherited Members</h2></td></tr>
<div class="center"><img src="classpFlow_1_1IOobject_a475cf52d5a2d15f82e180529de008fd3_cgraph.png" border="0" usemap="#classpFlow_1_1IOobject_a475cf52d5a2d15f82e180529de008fd3_cgraph" alt=""/></div>
<map name="classpFlow_1_1IOobject_a475cf52d5a2d15f82e180529de008fd3_cgraph" id="classpFlow_1_1IOobject_a475cf52d5a2d15f82e180529de008fd3_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,56,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title=" " alt="" coords="104,5,200,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="104,5,201,32"/>
</map>
</div>
@ -650,9 +657,9 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00083">83</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00100">100</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, and <a class="el" href="error_8hpp_source.html#l00055">warningInFunction</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00320">pFlow::endl()</a>, and <a class="el" href="error_8hpp_source.html#l00055">warningInFunction</a>.</p>
<div id="dynsection-6" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-6-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
@ -661,7 +668,7 @@ Additional Inherited Members</h2></td></tr>
<div class="center"><img src="classpFlow_1_1IOobject_ad48b7b943e88478c15879659cce7aebc_cgraph.png" border="0" usemap="#classpFlow_1_1IOobject_ad48b7b943e88478c15879659cce7aebc_cgraph" alt=""/></div>
<map name="classpFlow_1_1IOobject_ad48b7b943e88478c15879659cce7aebc_cgraph" id="classpFlow_1_1IOobject_ad48b7b943e88478c15879659cce7aebc_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,60,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title=" " alt="" coords="108,5,204,32"/>
<area shape="rect" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189" title="Add newline and flush stream." alt="" coords="108,5,205,32"/>
</map>
</div>
@ -693,7 +700,7 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00103">103</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00120">120</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
</div>
</div>
@ -713,7 +720,7 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00113">113</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8cpp_source.html#l00130">130</a> of file <a class="el" href="IOobject_8cpp_source.html">IOobject.cpp</a>.</p>
</div>
</div>