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

@ -223,17 +223,17 @@ $(document).ready(function(){initNavTree('timeInterval_8hpp_source.html',''); in
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="preprocessor">#endif </span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="anamespacepFlow_html_a6192191c0e9c178a44ee1ac350fde476"><div class="ttname"><a href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a></div><div class="ttdeci">float real</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00046">builtinTypes.hpp:46</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="anamespacepFlow_html_a6192191c0e9c178a44ee1ac350fde476"><div class="ttname"><a href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a></div><div class="ttdeci">float real</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00045">builtinTypes.hpp:45</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="atypes_8hpp_html"><div class="ttname"><a href="types_8hpp.html">types.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a1f76f3cab93a628ecd4cf0db9b9a6dcb"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a1f76f3cab93a628ecd4cf0db9b9a6dcb">pFlow::timeInterval::startTime</a></div><div class="ttdeci">INLINE_FUNCTION_HD auto startTime() const</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00045">timeInterval.hpp:45</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a279dae2ee3345fbb2b31e5af9ec0a5b4"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a279dae2ee3345fbb2b31e5af9ec0a5b4">pFlow::timeInterval::write</a></div><div class="ttdeci">FUNCTION_H bool write(dictionary &amp;dict) const</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8cpp_source.html#l00026">timeInterval.cpp:26</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a1cf7f793f9be291ce83223ac82c3dbdc"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a1cf7f793f9be291ce83223ac82c3dbdc">pFlow::timeInterval::operator=</a></div><div class="ttdeci">INLINE_FUNCTION_HD timeInterval &amp; operator=(const timeInterval &amp;)=default</div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a1d0ac3630b0565fb36d27c941bb5db69"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a1d0ac3630b0565fb36d27c941bb5db69">pFlow::timeInterval::~timeInterval</a></div><div class="ttdeci">INLINE_FUNCTION_HD ~timeInterval()=default</div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_ab25b05023549e7fec0ee1d0f6ce239dd"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#ab25b05023549e7fec0ee1d0f6ce239dd">pFlow::timeInterval::read</a></div><div class="ttdeci">FUNCTION_H bool read(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8cpp_source.html#l00017">timeInterval.cpp:17</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="apFlowMacros_8hpp_html_a4a0e2a760ea30cb5fe3d40c0cb3fe4a9"><div class="ttname"><a href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div><div class="ttdeci">#define FUNCTION_H</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00058">pFlowMacros.hpp:58</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00033">iIstream.hpp:33</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="apFlowMacros_8hpp_html_a4a0e2a760ea30cb5fe3d40c0cb3fe4a9"><div class="ttname"><a href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div><div class="ttdeci">#define FUNCTION_H</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00062">pFlowMacros.hpp:62</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdoc">Interface class for any input stream</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00037">iIstream.hpp:37</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_ad14a6af4583f1c85a17a40ff5ccb8794"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#ad14a6af4583f1c85a17a40ff5ccb8794">pFlow::timeInterval::time</a></div><div class="ttdeci">INLINE_FUNCTION_HD auto time() const</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00057">timeInterval.hpp:57</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html"><div class="ttname"><a href="pFlowMacros_8hpp.html">pFlowMacros.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a6ec0044a45c5a6a4ef306b8a00240051"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a6ec0044a45c5a6a4ef306b8a00240051">pFlow::timeInterval::timeInterval</a></div><div class="ttdeci">INLINE_FUNCTION_HD timeInterval()</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00030">timeInterval.hpp:30</a></div></div>
@ -244,11 +244,11 @@ $(document).ready(function(){initNavTree('timeInterval_8hpp_source.html',''); in
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a9da50a81b9da4200db555ac368c98ea1"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a9da50a81b9da4200db555ac368c98ea1">pFlow::timeInterval::startTime_</a></div><div class="ttdeci">real startTime_</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00019">timeInterval.hpp:19</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html"><div class="ttname"><a href="classpFlow_1_1timeInterval.html">pFlow::timeInterval</a></div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00016">timeInterval.hpp:16</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a148d74ad0977268be8ea8b26a147f619"><div class="ttname"><a href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator&lt;&lt;</a></div><div class="ttdeci">INLINE_FUNCTION iOstream &amp; operator&lt;&lt;(iOstream &amp;str, const AB3History &amp;ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00057">AdamsBashforth3.hpp:57</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a66263d59f896f4b8524b0a1f0181f8b9"><div class="ttname"><a href="namespacepFlow.html#a66263d59f896f4b8524b0a1f0181f8b9">pFlow::largeValue</a></div><div class="ttdeci">const real largeValue</div><div class="ttdef"><b>Definition:</b> <a href="numericConstants_8hpp_source.html#l00035">numericConstants.hpp:35</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html_a8e2f73fa5c113f21c9c9edb67a974f5e"><div class="ttname"><a href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a></div><div class="ttdeci">#define INLINE_FUNCTION_HD</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00051">pFlowMacros.hpp:51</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a66263d59f896f4b8524b0a1f0181f8b9"><div class="ttname"><a href="namespacepFlow.html#a66263d59f896f4b8524b0a1f0181f8b9">pFlow::largeValue</a></div><div class="ttdeci">const real largeValue</div><div class="ttdef"><b>Definition:</b> <a href="numericConstants_8hpp_source.html#l00033">numericConstants.hpp:33</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html_a8e2f73fa5c113f21c9c9edb67a974f5e"><div class="ttname"><a href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a></div><div class="ttdeci">#define INLINE_FUNCTION_HD</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00055">pFlowMacros.hpp:55</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a0c0f53f98461312b9cf461aa83d3de51"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a0c0f53f98461312b9cf461aa83d3de51">pFlow::timeInterval::setTime</a></div><div class="ttdeci">INLINE_FUNCTION_HD void setTime(real t)</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00063">timeInterval.hpp:63</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="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00038">dictionary.hpp:38</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_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a01b25d5afba0d2d8b20f4428a3810933"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a01b25d5afba0d2d8b20f4428a3810933">pFlow::timeInterval::time_</a></div><div class="ttdeci">real time_</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00023">timeInterval.hpp:23</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a2ce3cd3ca04a0e8bffa563b527d9e746"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a2ce3cd3ca04a0e8bffa563b527d9e746">pFlow::timeInterval::isInInterval_</a></div><div class="ttdeci">bool isInInterval_</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00025">timeInterval.hpp:25</a></div></div>
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_aec7a9ba664af18fb17da1eb822b1ee14"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#aec7a9ba664af18fb17da1eb822b1ee14">pFlow::timeInterval::endTime_</a></div><div class="ttdeci">real endTime_</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8hpp_source.html#l00021">timeInterval.hpp:21</a></div></div>