mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-07-28 03:27:05 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -130,7 +130,7 @@ $(document).ready(function(){initNavTree('box_8cpp_source.html',''); initResizab
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <a class="code" href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <a class="code" href="classpFlow_1_1box.html#aa2a9a0877ad8125ec95a3c69f6ed88ac">pFlow::box::box</a></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <a class="code" href="classpFlow_1_1box.html#ad19e9cdc10ee2e936945ea8d5dea430e">pFlow::box::box</a></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classpFlow_1_1box.html#adce7742633b229c776b66930923a075d"> 27</a></span> (</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a> & dict</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> )</div>
|
||||
@ -146,7 +146,7 @@ $(document).ready(function(){initNavTree('box_8cpp_source.html',''); initResizab
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {}</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> <a class="code" href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="classpFlow_1_1box.html#aa2a9a0877ad8125ec95a3c69f6ed88ac">pFlow::box::box</a></div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="classpFlow_1_1box.html#ad19e9cdc10ee2e936945ea8d5dea430e">pFlow::box::box</a></div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classpFlow_1_1box.html#afbef9cd91fe90a1d98d27735f6045769"> 43</a></span> (</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classpFlow_1_1iIstream.html">iIstream</a>& is</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> )</div>
|
||||
@ -236,33 +236,33 @@ $(document).ready(function(){initNavTree('box_8cpp_source.html',''); initResizab
|
||||
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> }</div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<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_1box_html_aa2a9a0877ad8125ec95a3c69f6ed88ac"><div class="ttname"><a href="classpFlow_1_1box.html#aa2a9a0877ad8125ec95a3c69f6ed88ac">pFlow::box::box</a></div><div class="ttdeci">INLINE_FUNCTION_HD box()</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00049">box.hpp:49</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1box_html_ad19e9cdc10ee2e936945ea8d5dea430e"><div class="ttname"><a href="classpFlow_1_1box.html#ad19e9cdc10ee2e936945ea8d5dea430e">pFlow::box::box</a></div><div class="ttdeci">INLINE_FUNCTION_HD box()=default</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_1box_html_a4caae70957c688b90b3596656bd20b9e"><div class="ttname"><a href="classpFlow_1_1box.html#a4caae70957c688b90b3596656bd20b9e">pFlow::box::max_</a></div><div class="ttdeci">realx3 max_</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00040">box.hpp:40</a></div></div>
|
||||
<div class="ttc" id="abox_8hpp_html"><div class="ttname"><a href="box_8hpp.html">box.hpp</a></div></div>
|
||||
<div class="ttc" id="apFlowMacros_8hpp_html_a922d2784284e8f6ee4009c3d92ba48b6"><div class="ttname"><a href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a></div><div class="ttdeci">#define FUNCTION_NAME</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00029">pFlowMacros.hpp:29</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00349">dictionary.cpp:349</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a6ae2ea14b8b5e5661c2f207aae2d4bdc"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a6ae2ea14b8b5e5661c2f207aae2d4bdc">pFlow::dictionary::add</a></div><div class="ttdeci">bool add(const word &keyword, const float &v)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00422">dictionary.cpp:422</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="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdoc">global name of entry, separated with dots</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00356">dictionary.cpp:356</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a6ae2ea14b8b5e5661c2f207aae2d4bdc"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a6ae2ea14b8b5e5661c2f207aae2d4bdc">pFlow::dictionary::add</a></div><div class="ttdeci">bool add(const word &keyword, const float &v)</div><div class="ttdoc">add a float dataEntry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00435">dictionary.cpp:435</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="aclasspFlow_1_1IOstream_html_a367eb3425fc4e8270e2aa961df8ac8a5"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a367eb3425fc4e8270e2aa961df8ac8a5">pFlow::IOstream::check</a></div><div class="ttdeci">virtual bool check(const char *operation) const</div><div class="ttdoc">Check IOstream status for given operation.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00042">IOstream.cpp:42</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="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="aclasspFlow_1_1iIstream_html_a2240995351ba90efed8943099847069e"><div class="ttname"><a href="classpFlow_1_1iIstream.html#a2240995351ba90efed8943099847069e">pFlow::iIstream::nextData</a></div><div class="ttdeci">bool nextData(const word &keyword, T &data)</div><div class="ttdef"><b>Definition:</b> <a href="iIstreamI_8hpp_source.html#l00081">iIstreamI.hpp:81</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="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="aclasspFlow_1_1iIstream_html_a2240995351ba90efed8943099847069e"><div class="ttname"><a href="classpFlow_1_1iIstream.html#a2240995351ba90efed8943099847069e">pFlow::iIstream::nextData</a></div><div class="ttdeci">bool nextData(const word &keyword, T &data)</div><div class="ttdoc">read the data next to keword keyword data; check the keyword is correct or not</div><div class="ttdef"><b>Definition:</b> <a href="iIstreamI_8hpp_source.html#l00081">iIstreamI.hpp:81</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a85ed561d066dae339196cd058783674f"><div class="ttname"><a href="namespacepFlow.html#a85ed561d066dae339196cd058783674f">pFlow::operator>></a></div><div class="ttdeci">INLINE_FUNCTION iIstream & operator>>(iIstream &str, AB3History &ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00041">AdamsBashforth3.hpp:41</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1box_html_aa7d820a4dd0777a9a82aee242b83a167"><div class="ttname"><a href="classpFlow_1_1box.html#aa7d820a4dd0777a9a82aee242b83a167">pFlow::box::write</a></div><div class="ttdeci">FUNCTION_H bool write(iOstream &os) const</div><div class="ttdef"><b>Definition:</b> <a href="box_8cpp_source.html#l00065">box.cpp:65</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a148d74ad0977268be8ea8b26a147f619"><div class="ttname"><a href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator<<</a></div><div class="ttdeci">INLINE_FUNCTION iOstream & operator<<(iOstream &str, const AB3History &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="aclasspFlow_1_1IOstream_html_ac9b54653d0ec63ee05f64a185437b335"><div class="ttname"><a href="classpFlow_1_1IOstream.html#ac9b54653d0ec63ee05f64a185437b335">pFlow::IOstream::name</a></div><div class="ttdeci">virtual const word & name() const</div><div class="ttdoc">Return the name of the stream.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00031">IOstream.cpp:31</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &keyword) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00309">dictionary.hpp:309</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &keyword) const</div><div class="ttdoc">get the value of data entry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00379">dictionary.hpp:379</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1box_html"><div class="ttname"><a href="classpFlow_1_1box.html">pFlow::box</a></div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00032">box.hpp:32</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_a83efa053dfcfcef04cc0e721c0314ff3"><div class="ttname"><a href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3">ioErrorInFile</a></div><div class="ttdeci">#define ioErrorInFile(fileName, lineNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00049">error.hpp:49</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a607efe5fb94edbe4cfa890c4907e76c3"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a607efe5fb94edbe4cfa890c4907e76c3">pFlow::IOstream::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdoc">Const access to the current stream line number.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00221">IOstream.hpp:221</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_a83efa053dfcfcef04cc0e721c0314ff3"><div class="ttname"><a href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3">ioErrorInFile</a></div><div class="ttdeci">#define ioErrorInFile(fileName, lineNumber)</div><div class="ttdoc">Report an error in file operation with supplied fileName and lineNumber.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00087">error.hpp:87</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a607efe5fb94edbe4cfa890c4907e76c3"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a607efe5fb94edbe4cfa890c4907e76c3">pFlow::IOstream::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdoc">Const access to the current stream line number.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00223">IOstream.hpp:223</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple< real ></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_1iOstream_html_a21c60a5f3cd7a26eb97fa28923cbaec6"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a21c60a5f3cd7a26eb97fa28923cbaec6">pFlow::iOstream::writeWordEntry</a></div><div class="ttdeci">iOstream & writeWordEntry(const word &key, const T &value)</div><div class="ttdoc">Write a keyword/value entry.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00224">iOstream.hpp:224</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_1iOstream_html_a21c60a5f3cd7a26eb97fa28923cbaec6"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a21c60a5f3cd7a26eb97fa28923cbaec6">pFlow::iOstream::writeWordEntry</a></div><div class="ttdeci">iOstream & writeWordEntry(const word &key, const T &value)</div><div class="ttdoc">Write a keyword/value entry.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00239">iOstream.hpp:239</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1box_html_ae1d42751915e8566dac19658cc498ffa"><div class="ttname"><a href="classpFlow_1_1box.html#ae1d42751915e8566dac19658cc498ffa">pFlow::box::read</a></div><div class="ttdeci">FUNCTION_H bool read(iIstream &is)</div><div class="ttdef"><b>Definition:</b> <a href="box_8cpp_source.html#l00057">box.cpp:57</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1box_html_acaa859f3dc98e5afead6007175a9d47d"><div class="ttname"><a href="classpFlow_1_1box.html#acaa859f3dc98e5afead6007175a9d47d">pFlow::box::min_</a></div><div class="ttdeci">realx3 min_</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00037">box.hpp:37</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_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 id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_0b265ec0eb5bc5fbad75b6fd7b5b024b.html">structuredData</a></li><li class="navelem"><a class="el" href="dir_e8a9bd8d4c80a50a4f7c200c882d5c23.html">box</a></li><li class="navelem"><a class="el" href="box_8cpp.html">box.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user