mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -133,17 +133,17 @@ $(document).ready(function(){initNavTree('rectMeshFieldToVTK_8hpp_source.html','
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a2cc56628262e60f83d60f9a7fc2a4de0"> 29</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a2cc56628262e60f83d60f9a7fc2a4de0">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<T></a>& field)</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a924173ea7cdde03283bf81509224002b"> 29</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a924173ea7cdde03283bf81509224002b">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<T></a>& field)</div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a><< <span class="stringliteral">"this type is not supported "</span><<</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  field.typeName()<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  field.<a class="code" href="classpFlow_1_1IOobject.html#a9521838a2604fc381c2b4d8227615246">typeName</a>()<<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a>;</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">template</span><></div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a420d4451c5c23d605de153b2aa8c5ef8"> 39</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a2cc56628262e60f83d60f9a7fc2a4de0">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<real></a>& field)</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespacepFlow.html#aa5e881b5887bb61b840711d7b9b63f6c"> 39</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a924173ea7cdde03283bf81509224002b">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<real></a>& field)</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  os<<<span class="stringliteral">"FIELD FieldData 1 "</span> << field.<a class="code" href="classpFlow_1_1rectMeshField.html#ae31a8c88742fc0246179d320cee3863d">name</a>() << <span class="stringliteral">" 1 "</span><< field.<a class="code" href="classpFlow_1_1rectMeshField.html#abf3bc0d1aa6f6cedfde5da544f6613a0">size</a>() << <span class="stringliteral">" float\n"</span>;</div>
|
||||
@ -162,7 +162,7 @@ $(document).ready(function(){initNavTree('rectMeshFieldToVTK_8hpp_source.html','
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">template</span><></div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a9af7937490c62c08d69fe5397b60a580"> 58</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a2cc56628262e60f83d60f9a7fc2a4de0">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<realx3></a>& field)</div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a06e79f24a34614a2b9d9a2ace8468abb"> 58</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a924173ea7cdde03283bf81509224002b">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<realx3></a>& field)</div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> {</div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  os<<<span class="stringliteral">"FIELD FieldData 1 "</span> << field.<a class="code" href="classpFlow_1_1rectMeshField.html#ae31a8c88742fc0246179d320cee3863d">name</a>() << <span class="stringliteral">" 3 "</span><< field.<a class="code" href="classpFlow_1_1rectMeshField.html#abf3bc0d1aa6f6cedfde5da544f6613a0">size</a>() << <span class="stringliteral">" float\n"</span>;</div>
|
||||
@ -181,7 +181,7 @@ $(document).ready(function(){initNavTree('rectMeshFieldToVTK_8hpp_source.html','
|
||||
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div>
|
||||
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
||||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">template</span><></div>
|
||||
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="namespacepFlow.html#a2e92da2e617c68d8781c02ea84224bae"> 77</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a2cc56628262e60f83d60f9a7fc2a4de0">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<int32></a>& field)</div>
|
||||
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="namespacepFlow.html#ad6cc8fd683afd7a1e2d0eaf4c6cdf161"> 77</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#a924173ea7cdde03283bf81509224002b">convertRectMeshField</a>(<a class="code" href="classpFlow_1_1iOstream.html">iOstream</a>& os, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1rectMeshField.html">rectMeshField_H<int32></a>& field)</div>
|
||||
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div>
|
||||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
||||
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  os<<<span class="stringliteral">"FIELD FieldData 1 "</span> << field.<a class="code" href="classpFlow_1_1rectMeshField.html#ae31a8c88742fc0246179d320cee3863d">name</a>() << <span class="stringliteral">" 1 "</span><< field.<a class="code" href="classpFlow_1_1rectMeshField.html#abf3bc0d1aa6f6cedfde5da544f6613a0">size</a>() << <span class="stringliteral">" int\n"</span>;</div>
|
||||
@ -205,19 +205,20 @@ $(document).ready(function(){initNavTree('rectMeshFieldToVTK_8hpp_source.html','
|
||||
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif</span></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_abf3bc0d1aa6f6cedfde5da544f6613a0"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#abf3bc0d1aa6f6cedfde5da544f6613a0">pFlow::rectMeshField::size</a></div><div class="ttdeci">INLINE_FUNCTION_HD int64 size() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00100">rectMeshField.hpp: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="aclasspFlow_1_1rectMeshField_html_abf3bc0d1aa6f6cedfde5da544f6613a0"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#abf3bc0d1aa6f6cedfde5da544f6613a0">pFlow::rectMeshField::size</a></div><div class="ttdeci">INLINE_FUNCTION_HD int64 size() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00129">rectMeshField.hpp:129</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="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html">pFlow::rectMeshField</a></div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00031">rectMeshField.hpp:31</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 & endl(iOstream &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="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a2cc56628262e60f83d60f9a7fc2a4de0"><div class="ttname"><a href="namespacepFlow.html#a2cc56628262e60f83d60f9a7fc2a4de0">pFlow::convertRectMeshField</a></div><div class="ttdeci">bool convertRectMeshField(iOstream &os, rectMeshField_H< T > &field)</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshFieldToVTK_8hpp_source.html#l00029">rectMeshFieldToVTK.hpp:29</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_af440784b205b09406dc469703e3a938f"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#af440784b205b09406dc469703e3a938f">pFlow::rectMeshField::nx</a></div><div class="ttdeci">auto nx() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00105">rectMeshField.hpp:105</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_a6598c3e94535b183bee776f94914d29b"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#a6598c3e94535b183bee776f94914d29b">pFlow::rectMeshField::ny</a></div><div class="ttdeci">auto ny() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00110">rectMeshField.hpp:110</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="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00053">builtinTypes.hpp:53</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_ae31a8c88742fc0246179d320cee3863d"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#ae31a8c88742fc0246179d320cee3863d">pFlow::rectMeshField::name</a></div><div class="ttdeci">const INLINE_FUNCTION_H word & name() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00094">rectMeshField.hpp:94</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_ae57e25510b3a28583eb4df07f8fad08b"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#ae57e25510b3a28583eb4df07f8fad08b">pFlow::rectMeshField::nz</a></div><div class="ttdeci">auto nz() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00115">rectMeshField.hpp:115</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="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_af440784b205b09406dc469703e3a938f"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#af440784b205b09406dc469703e3a938f">pFlow::rectMeshField::nx</a></div><div class="ttdeci">auto nx() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00134">rectMeshField.hpp:134</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_a6598c3e94535b183bee776f94914d29b"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#a6598c3e94535b183bee776f94914d29b">pFlow::rectMeshField::ny</a></div><div class="ttdeci">auto ny() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00139">rectMeshField.hpp:139</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="ttdoc">Report a fatal error and function name and exit the application.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00077">error.hpp:77</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00050">builtinTypes.hpp:50</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_ae31a8c88742fc0246179d320cee3863d"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#ae31a8c88742fc0246179d320cee3863d">pFlow::rectMeshField::name</a></div><div class="ttdeci">const INLINE_FUNCTION_H word & name() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00123">rectMeshField.hpp:123</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a924173ea7cdde03283bf81509224002b"><div class="ttname"><a href="namespacepFlow.html#a924173ea7cdde03283bf81509224002b">pFlow::convertRectMeshField</a></div><div class="ttdeci">bool convertRectMeshField(iOstream &os, const rectMeshField_H< T > &field)</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshFieldToVTK_8hpp_source.html#l00029">rectMeshFieldToVTK.hpp:29</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1rectMeshField_html_ae57e25510b3a28583eb4df07f8fad08b"><div class="ttname"><a href="classpFlow_1_1rectMeshField.html#ae57e25510b3a28583eb4df07f8fad08b">pFlow::rectMeshField::nz</a></div><div class="ttdeci">auto nz() const</div><div class="ttdef"><b>Definition:</b> <a href="rectMeshField_8hpp_source.html#l00144">rectMeshField.hpp:144</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="ttdoc">Interface class for any output stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00059">iOstream.hpp:59</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1IOobject_html_a9521838a2604fc381c2b4d8227615246"><div class="ttname"><a href="classpFlow_1_1IOobject.html#a9521838a2604fc381c2b4d8227615246">pFlow::IOobject::typeName</a></div><div class="ttdeci">virtual word typeName() const =0</div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_df38b2a5d584e0f6066b4518b95c638b.html">utilities</a></li><li class="navelem"><a class="el" href="dir_3104238dba096c99a27b6bccac80df1f.html">postprocessPhasicFlow</a></li><li class="navelem"><a class="el" href="rectMeshFieldToVTK_8hpp.html">rectMeshFieldToVTK.hpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user