documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -103,7 +103,8 @@ $(document).ready(function(){initNavTree('pointFieldToVTK_8hpp.html',''); initRe
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">pointFieldToVTK.hpp File Reference</div> </div>
</div><!--header-->
@ -114,13 +115,6 @@ $(document).ready(function(){initNavTree('pointFieldToVTK_8hpp.html',''); initRe
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="pointFieldToVTK_8hpp__incl.png" border="0" usemap="#utilities_2pFlowToVTK_2pointFieldToVTK_8hpp" alt=""/></div>
<map name="utilities_2pFlowToVTK_2pointFieldToVTK_8hpp" id="utilities_2pFlowToVTK_2pointFieldToVTK_8hpp">
<area shape="rect" title=" " alt="" coords="122,5,281,47"/>
<area shape="rect" title=" " alt="" coords="5,95,64,121"/>
<area shape="rect" href="vtkFile_8hpp.html" title=" " alt="" coords="89,95,183,121"/>
<area shape="rect" href="pointFields_8hpp.html" title=" " alt="" coords="207,95,329,121"/>
<area shape="rect" href="IOobject_8hpp.html" title=" " alt="" coords="353,95,457,121"/>
</map>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
@ -128,10 +122,6 @@ $(document).ready(function(){initNavTree('pointFieldToVTK_8hpp.html',''); initRe
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="pointFieldToVTK_8hpp__dep__incl.png" border="0" usemap="#utilities_2pFlowToVTK_2pointFieldToVTK_8hppdep" alt=""/></div>
<map name="utilities_2pFlowToVTK_2pointFieldToVTK_8hppdep" id="utilities_2pFlowToVTK_2pointFieldToVTK_8hppdep">
<area shape="rect" title=" " alt="" coords="5,5,164,47"/>
<area shape="rect" href="pFlowToVTK_8cpp.html" title=" " alt="" coords="7,95,162,136"/>
</map>
</div>
</div>
<p><a href="pointFieldToVTK_8hpp_source.html">Go to the source code of this file.</a></p>
@ -145,35 +135,56 @@ Namespaces</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae003423c3937028067d2e2e0628a1be3"><td class="memTemplParams" colspan="2">template&lt;typename IntType , typename IncludeMaskType &gt; </td></tr>
<tr class="memitem:ae003423c3937028067d2e2e0628a1be3"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ae003423c3937028067d2e2e0628a1be3">addIntPointField</a> (iOstream &amp;os, word fieldName, int32 numActivePoints, IntType *field, IncludeMaskType includeMask)</td></tr>
<tr class="separator:ae003423c3937028067d2e2e0628a1be3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a572009305203cb57b4e901247dfae9ba"><td class="memTemplParams" colspan="2">template&lt;typename IncludeMaskType &gt; </td></tr>
<tr class="memitem:a572009305203cb57b4e901247dfae9ba"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#a572009305203cb57b4e901247dfae9ba">addRealPointField</a> (iOstream &amp;os, word fieldName, int32 numActivePoints, real *field, IncludeMaskType includeMask)</td></tr>
<tr class="separator:a572009305203cb57b4e901247dfae9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae537fc84534474c6d7247a36336d174e"><td class="memTemplParams" colspan="2">template&lt;typename IncludeMaskType &gt; </td></tr>
<tr class="memitem:ae537fc84534474c6d7247a36336d174e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ae537fc84534474c6d7247a36336d174e">addRealx3PointField</a> (iOstream &amp;os, word fieldName, int32 numActivePoints, realx3 *field, IncludeMaskType includeMask)</td></tr>
<tr class="separator:ae537fc84534474c6d7247a36336d174e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae023080fbd252680e73d5b2c4132edb2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ae023080fbd252680e73d5b2c4132edb2">regexCheck</a> (word TYPENAME, word fieldType)</td></tr>
<tr class="separator:ae023080fbd252680e73d5b2c4132edb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad730e546f21d51aae51c6129acbe8dcd"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:ad730e546f21d51aae51c6129acbe8dcd"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ad730e546f21d51aae51c6129acbe8dcd">checkFieldType</a> (word objectType)</td></tr>
<tr class="separator:ad730e546f21d51aae51c6129acbe8dcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af01af7b85b0054651af5f4cc164fe316"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:af01af7b85b0054651af5f4cc164fe316"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#af01af7b85b0054651af5f4cc164fe316">convertIntPointField</a> (iOstream &amp;os, const IOfileHeader &amp;header, const pointStructure &amp;<a class="el" href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a>)</td></tr>
<tr class="separator:af01af7b85b0054651af5f4cc164fe316"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7531a0fecc141ba41ccd2d764ec2564"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ab7531a0fecc141ba41ccd2d764ec2564">convertRealTypePointField</a> (iOstream &amp;os, const IOfileHeader &amp;header, const pointStructure &amp;<a class="el" href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a>)</td></tr>
<tr class="separator:ab7531a0fecc141ba41ccd2d764ec2564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a593cdbb62edd04ebb063f7f062c25013"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#a593cdbb62edd04ebb063f7f062c25013">convertRealx3TypePointField</a> (iOstream &amp;os, const IOfileHeader &amp;header, const pointStructure &amp;<a class="el" href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a>)</td></tr>
<tr class="separator:a593cdbb62edd04ebb063f7f062c25013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc2a9ceaed7302116ea37a4d0f23776c"><td class="memTemplParams" colspan="2">template&lt;typename IncludeMaskType &gt; </td></tr>
<tr class="memitem:afc2a9ceaed7302116ea37a4d0f23776c"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#afc2a9ceaed7302116ea37a4d0f23776c">addUndstrcuturedGridField</a> (iOstream &amp;os, int32 numActivePoints, realx3 *position, IncludeMaskType includeMask)</td></tr>
<tr class="separator:afc2a9ceaed7302116ea37a4d0f23776c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43810217a8e7b2859a59b0ea17b02728"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#a43810217a8e7b2859a59b0ea17b02728">convertTimeFolderPointFields</a> (fileSystem timeFolder, real time, fileSystem destPath, word bName)</td></tr>
<tr class="separator:a43810217a8e7b2859a59b0ea17b02728"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afed74f3e8fdc5e63c61b210f8fa1044c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#afed74f3e8fdc5e63c61b210f8fa1044c">convertTimeFolderPointFieldsSelected</a> (fileSystem timeFolder, real time, fileSystem destPath, word bName, wordVector fieldsName, bool mustExist)</td></tr>
<tr class="separator:afed74f3e8fdc5e63c61b210f8fa1044c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2070895c92a60735eedfd09e0275678"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ae2070895c92a60735eedfd09e0275678">convertTimeFolderPointFields</a> (systemControl &amp;control, const fileSystem &amp;destPath, const word &amp;bName, word &amp;filename)</td></tr>
<tr class="separator:ae2070895c92a60735eedfd09e0275678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c61ea6aa5f8ad3c240cc00666ce9d58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#a9c61ea6aa5f8ad3c240cc00666ce9d58">convertTimeFolderPointFieldsSelected</a> (systemControl &amp;control, const fileSystem &amp;destPath, const word &amp;bName, const wordVector &amp;fieldsName, bool mustExist, word &amp;filename)</td></tr>
<tr class="separator:a9c61ea6aa5f8ad3c240cc00666ce9d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcea9c10759746cd50d079d1f189031a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#adcea9c10759746cd50d079d1f189031a">addUndstrcuturedGridField</a> (Ostream &amp;os, realx3 *position, uint32 numPoints)</td></tr>
<tr class="separator:adcea9c10759746cd50d079d1f189031a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89bd592446dc7256a03129e91c70dadd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#a89bd592446dc7256a03129e91c70dadd">convertRealTypePointField</a> (Ostream &amp;os, const IOfileHeader &amp;header, pointStructure &amp;<a class="el" href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a>)</td></tr>
<tr class="separator:a89bd592446dc7256a03129e91c70dadd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8e06689975a027eaaee8fed2a6f5e8f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ad8e06689975a027eaaee8fed2a6f5e8f">convertRealx3TypePointField</a> (Ostream &amp;os, const IOfileHeader &amp;header, pointStructure &amp;<a class="el" href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a>)</td></tr>
<tr class="separator:ad8e06689975a027eaaee8fed2a6f5e8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b8443a53b1bcd24bf694717e107cf8e"><td class="memTemplParams" colspan="2">template&lt;typename IntType &gt; </td></tr>
<tr class="memitem:a3b8443a53b1bcd24bf694717e107cf8e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#a3b8443a53b1bcd24bf694717e107cf8e">addIntPointField</a> (Ostream &amp;os, const word &amp;fieldName, IntType *field, uint32 numData)</td></tr>
<tr class="separator:a3b8443a53b1bcd24bf694717e107cf8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace9a57f2db8073e60ee2ad61a5ed7cc2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ace9a57f2db8073e60ee2ad61a5ed7cc2">addRealPointField</a> (Ostream &amp;os, const word &amp;fieldName, const real *field, uint32 numData)</td></tr>
<tr class="separator:ace9a57f2db8073e60ee2ad61a5ed7cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab85800d6fac87a42282f6d461109bb2c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ab85800d6fac87a42282f6d461109bb2c">addRealx3PointField</a> (Ostream &amp;os, const word &amp;fieldName, const realx3 *field, uint32 numData)</td></tr>
<tr class="separator:ab85800d6fac87a42282f6d461109bb2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada516245a68fc176a71ee7453fe0da98"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:ada516245a68fc176a71ee7453fe0da98"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#ada516245a68fc176a71ee7453fe0da98">checkFieldType</a> (word objectType)</td></tr>
<tr class="separator:ada516245a68fc176a71ee7453fe0da98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaef3f5e5ce4938f29243afeeff7f93eb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#aaef3f5e5ce4938f29243afeeff7f93eb">regexCheck</a> (const word &amp;TYPENAME, const word &amp;fieldType)</td></tr>
<tr class="separator:aaef3f5e5ce4938f29243afeeff7f93eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef8641f32d98c26f1204104237a857d5"><td class="memTemplParams" colspan="2">template&lt;typename IntType &gt; </td></tr>
<tr class="memitem:aef8641f32d98c26f1204104237a857d5"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1PFtoVTK.html#aef8641f32d98c26f1204104237a857d5">convertIntPointField</a> (Ostream &amp;os, const IOfileHeader &amp;header, pointStructure &amp;<a class="el" href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a>)</td></tr>
<tr class="separator:aef8641f32d98c26f1204104237a857d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1c9680e4de75db1127a1cec7964445de"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pointFieldToVTK_8hpp.html#a1c9680e4de75db1127a1cec7964445de">bindaryOutput__</a></td></tr>
<tr class="separator:a1c9680e4de75db1127a1cec7964445de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a1c9680e4de75db1127a1cec7964445de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c9680e4de75db1127a1cec7964445de">&#9670;&nbsp;</a></span>bindaryOutput__</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool bindaryOutput__</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pFlowToVTK_8cpp_source.html#l00033">33</a> of file <a class="el" href="pFlowToVTK_8cpp_source.html">pFlowToVTK.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="pointFieldToVTK_8hpp_source.html#l00127">pFlow::PFtoVTK::addIntPointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00326">pFlow::PFtoVTK::addRealPointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00357">pFlow::PFtoVTK::addRealx3PointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00200">pFlow::PFtoVTK::addUndstrcuturedGridField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00008">pFlow::PFtoVTK::convertTimeFolderPointFields()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00095">pFlow::PFtoVTK::convertTimeFolderPointFieldsSelected()</a>, and <a class="el" href="pFlowToVTK_8cpp_source.html#l00035">main()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->