xfygogo/phasicFlow
1
0
Fork 0
mirror of https://github.com/PhasicFlow/phasicFlow.git synced 2025-06-22 16:28:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc for Geometry

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

119
doc/code-documentation/html/IOobject_8cpp_source.html
View File

@ -171,66 +171,83 @@ $(document).ready(function(){initNavTree('IOobject_8cpp_source.html',''); initRe
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">if</span>( implyRead() )</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span>( <span class="keyword">auto</span> ptrIS = inStream(); ptrIS )</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span>( rdHdr )</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; { </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> read( ptrIS(), rdHdr);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a>&lt;&lt;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="stringliteral">&quot;could not open file &quot;</span> &lt;&lt; path() &lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;}</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">if</span>( <span class="keyword">auto</span> ptrIS = inStream(); ptrIS )</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; {</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">if</span>(!readHeader(ptrIS()))<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; ptrIS.reset(<span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a>&lt;&lt;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="stringliteral">&quot;could not open file &quot;</span> &lt;&lt; path() &lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc"> 83</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc">pFlow::IOobject::write</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span>(implyWrite())</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span>(<span class="keyword">auto</span> ptrOS = outStream(); ptrOS )</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">return</span> write(ptrOS());</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a>&lt;&lt; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="stringliteral">&quot;error in opening file &quot;</span>&lt;&lt; path() &lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; }</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">if</span>( <span class="keyword">auto</span> ptrIS = inStream(); ptrIS )</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span>(!read(ptrIS(), rdHdr))<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <a class="code" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a>&lt;&lt;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="stringliteral">&quot;could not open file &quot;</span> &lt;&lt; path() &lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; } </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;}</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOobject.html#af5f483943f4316eef8c34efa82abe4be"> 103</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOobject.html#a475cf52d5a2d15f82e180529de008fd3">pFlow::IOobject::read</a>(<a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>&amp; is, <span class="keywordtype">bool</span> rdHdr)</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;{</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">if</span>(rdHdr)</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">if</span>(!readHeader(is))<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span> object_-&gt;read_object_t(is);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;}</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOobject.html#a6a40de4ceed55b2f78cf3027739dfd91"> 113</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc">pFlow::IOobject::write</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>&amp; os)<span class="keyword"> const</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">if</span>(this-&gt;readWriteHeader())</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; writeHeader(os, typeName());</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">return</span> (object_-&gt;write_object_t(os) &amp;&amp; writeSeparator(os));</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;}</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc"> 100</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc">pFlow::IOobject::write</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">if</span>(implyWrite())</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">if</span>(<span class="keyword">auto</span> ptrOS = outStream(); ptrOS )</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordflow">return</span> write(ptrOS());</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; }</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <a class="code" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a>&lt;&lt; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="stringliteral">&quot;error in opening file &quot;</span>&lt;&lt; path() &lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;}</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOobject.html#af5f483943f4316eef8c34efa82abe4be"> 120</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOobject.html#a475cf52d5a2d15f82e180529de008fd3">pFlow::IOobject::read</a>(<a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>&amp; is, <span class="keywordtype">bool</span> rdHdr)</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;{</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordflow">if</span>(rdHdr)</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">if</span>(!readHeader(is))<span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">return</span> object_-&gt;read_object_t(is);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;}</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classpFlow_1_1IOobject.html#a6a40de4ceed55b2f78cf3027739dfd91"> 130</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc">pFlow::IOobject::write</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>&amp; os)<span class="keyword"> const</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordflow">if</span>(this-&gt;readWriteHeader())</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; writeHeader(os, typeName());</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">return</span> (object_-&gt;write_object_t(os) &amp;&amp; writeSeparator(os));</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1IOobject_html_ad48b7b943e88478c15879659cce7aebc"><div class="ttname"><a href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc">pFlow::IOobject::write</a></div><div class="ttdeci">bool write() const</div><div class="ttdef"><b>Definition:</b> <a href="IOobject_8cpp_source.html#l00083">IOobject.cpp:83</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOobject_html_ad48b7b943e88478c15879659cce7aebc"><div class="ttname"><a href="classpFlow_1_1IOobject.html#ad48b7b943e88478c15879659cce7aebc">pFlow::IOobject::write</a></div><div class="ttdeci">bool write() const</div><div class="ttdef"><b>Definition:</b> <a href="IOobject_8cpp_source.html#l00100">IOobject.cpp:100</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="aIOobject_8hpp_html"><div class="ttname"><a href="IOobject_8hpp.html">IOobject.hpp</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_1IOobject_html_a0abd37e236ec0ec02221cb77c95d7867"><div class="ttname"><a href="classpFlow_1_1IOobject.html#a0abd37e236ec0ec02221cb77c95d7867">pFlow::IOobject::IOobject</a></div><div class="ttdeci">IOobject(const objectFile &amp;objf, const repository *owner, uniquePtr&lt; iObject &gt; &amp;&amp;obj)</div><div class="ttdef"><b>Definition:</b> <a href="IOobject_8cpp_source.html#l00026">IOobject.cpp:26</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_1IOobject_html_a81d6c99fb880c7d7e7c7d4bd107a71bf"><div class="ttname"><a href="classpFlow_1_1IOobject.html#a81d6c99fb880c7d7e7c7d4bd107a71bf">pFlow::IOobject::isObjectValid</a></div><div class="ttdeci">bool isObjectValid() const</div><div class="ttdef"><b>Definition:</b> <a href="IOobject_8cpp_source.html#l00058">IOobject.cpp:58</a></div></div>
<div class="ttc" id="arepository_8hpp_html"><div class="ttname"><a href="repository_8hpp.html">repository.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOobject_html_a175d7232fbc4ea640c3dbe9c0aff17a4"><div class="ttname"><a href="classpFlow_1_1IOobject.html#a175d7232fbc4ea640c3dbe9c0aff17a4">pFlow::IOobject::object_</a></div><div class="ttdeci">uniquePtr&lt; iObject &gt; object_</div><div class="ttdef"><b>Definition:</b> <a href="IOobject_8hpp_source.html#l00110">IOobject.hpp:110</a></div></div>