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

@ -111,32 +111,37 @@ $(document).ready(function(){initNavTree('classpFlow_1_1AdamsBashforth4.html',''
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a69029aec4bfcd45b781d1cfc65359fcb">AdamsBashforth4</a>(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method)</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a1084909fe2f0dbd8f2af68ab4e94692a">add_vCtor</a>(integration, AdamsBashforth4, word)</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a4e30df3927ef1cdd2490cd85018518f5">baseName</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aa4cf93fd25765a9c0816f3ace4e3b009">baseName_</a></td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a29f8a3197295f0ffa73d24bbacc6228c">clone</a>() const override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#ac755e4bf02c3732d1eb89de9e903ebdb">correct</a>(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy) override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#abdb160904a366a4bf1704ceb1746775a">create</a>(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method)</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a23da7cbc93e6d9968fcbe57cb08f78f3">create_vCtor</a>(integration, word,(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method),(baseName, owner, pStruct, method))</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aa4cf93fd25765a9c0816f3ace4e3b009">baseName_</a></td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a29f8a3197295f0ffa73d24bbacc6228c">clone</a>() const override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#ac755e4bf02c3732d1eb89de9e903ebdb">correct</a>(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy) override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a5bc0f0e6d46b8e773688d1416f545365">pFlow::integration::correct</a>(real dt, realx3PointField_D &amp;y, realx3PointField_D &amp;dy)=0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#ae90a67d2cabadc5ed923c1bd04d5c850">correctPStruct</a>(real dt, pointStructure &amp;pStruct, realx3PointField_D &amp;vel)=0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a293e861f8b422eca2e189e4e28d73fc9">create</a>(const word &amp;baseName, pointStructure &amp;pStruct, const word &amp;method, const realx3Field_D &amp;initialValField)</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a2777231bcfef43151845d16cd1936a03">create_vCtor</a>(integration, word,(const word &amp;baseName, pointStructure &amp;pStruct, const word &amp;method, const realx3Field_D &amp;initialValField),(baseName, pStruct, method, initialValField))</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#afc6b0e49b18c62aa5edca2a8212c1292">history_</a></td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a152b752a6b7b37e70fa5e7c99a484783">intAll</a>(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, range activeRng)</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#ad1193beca9b8485866c972ed9faea6d5">integration</a>(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method)</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#af65ab3c37a54039dda3a3946f6d0004e">integration</a>(const word &amp;baseName, pointStructure &amp;pStruct, const word &amp;method, const realx3Field_D &amp;initialValField)</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a771a76739b176fbb83563986a897dbc6">integration</a>(const integration &amp;)=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a30aa8bdb5ce433dc44c3de44462b3d92">integration</a>(integration &amp;&amp;)=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a191dc9197b587f09bb5ee7989b0ba43e">intRange</a>(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, activeFunctor activeP)</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#aceb0c803bb6e5c46a1695c4e5b6e641f">needSetInitialVals</a>() const override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aa5c3d9b07075b6725eeb15aa37da388a">operator=</a>(const integration &amp;)=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aec2a99ef0f61788bb92c8a2d4dbd51fc">operator=</a>(integration &amp;&amp;)=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a10329e18307a60d3fdb203bcbed2b295">owner</a>()</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#af892b00fd39b71350cc908cd0e608264">owner_</a></td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#afb1938bc6cfc199cbd70f224040d4afc">predict</a>(real UNUSED(dt), realx3Vector_D &amp;UNUSED(y), realx3Vector_D &amp;UNUSED(dy)) override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aee7d33216d5d180758eae4342235822d">pFlow::integration::predict</a>(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy)=0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a05cf94b87db6b7d4b9c2d2eb81592cf3">method</a>() const =0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#aceb0c803bb6e5c46a1695c4e5b6e641f">needSetInitialVals</a>() const override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aa5c3d9b07075b6725eeb15aa37da388a">operator=</a>(const integration &amp;)=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aec2a99ef0f61788bb92c8a2d4dbd51fc">operator=</a>(integration &amp;&amp;)=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a10329e18307a60d3fdb203bcbed2b295">owner</a>()</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#af892b00fd39b71350cc908cd0e608264">owner_</a></td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#afb1938bc6cfc199cbd70f224040d4afc">predict</a>(real UNUSED(dt), realx3Vector_D &amp;UNUSED(y), realx3Vector_D &amp;UNUSED(dy)) override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#ae042a979b0888ee07428760767a7d841">pFlow::integration::predict</a>(real dt, realx3PointField_D &amp;y, realx3PointField_D &amp;dy)=0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a351abea829a5c6aa1f177e48c5c5e2bd">pFlow::integration::predict</a>(real dt, realx3Field_D &amp;y, realx3PointField_D &amp;dy)=0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a5a622149e803f0fa292a95784c12a7b8">pStruct</a>() const</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a5c62d7bde0e3c333317fabe4b8806bef">pStruct_</a></td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a5c62d7bde0e3c333317fabe4b8806bef">pStruct_</a></td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#ace46ff4fbe3c001c816dbc4f9f67606f">rpIntegration</a> typedef</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a8da2088458d635dfa1fbe1823a3bfd6d">setInitialVals</a>(const int32IndexContainer &amp;newIndices, const realx3Vector &amp;y) override</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a7962c8cac5d82d0793dfeaba6c162f4d">TypeInfo</a>(&quot;AdamsBashforth4&quot;)</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#aa44247873627282e4f01578c6bc53426">pFlow::integration::TypeInfo</a>(&quot;integration&quot;)</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a8c3fff8fec7e5ef08cea578fed2e5fae">~AdamsBashforth4</a>()=default</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a9a87be54ea9981257a8149088723c433">~integration</a>()=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#af460543ae3c8e6f3d02b0b1abf705c82">updateBoundariesSlaveToMasterIfRequested</a>()=0</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html#a8c3fff8fec7e5ef08cea578fed2e5fae">~AdamsBashforth4</a>()=default</td><td class="entry"><a class="el" href="classpFlow_1_1AdamsBashforth4.html">AdamsBashforth4</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classpFlow_1_1integration.html#a9a87be54ea9981257a8149088723c433">~integration</a>()=default</td><td class="entry"><a class="el" href="classpFlow_1_1integration.html">integration</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->