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
@ -207,22 +207,22 @@ $(document).ready(function(){initNavTree('multiRotatingAxis_8cpp_source.html',''
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1multiRotatingAxis_html_a8d67252b5aa9aad9090b4b605a393307"><div class="ttname"><a href="classpFlow_1_1multiRotatingAxis.html#a8d67252b5aa9aad9090b4b605a393307">pFlow::multiRotatingAxis::write</a></div><div class="ttdeci">FUNCTION_H bool write(const multiRotatingAxisMotion *axisMotion, dictionary &dict) const</div><div class="ttdoc">Write to dictionary.</div><div class="ttdef"><b>Definition:</b> <a href="multiRotatingAxis_8cpp_source.html#l00080">multiRotatingAxis.cpp:80</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a5585dc9a8b971fbfe2c99fdb75c5d647"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">pFlow::dictionary::getValOrSet</a></div><div class="ttdeci">T getValOrSet(const word &keyword, const T &setVal) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00325">dictionary.hpp:325</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a5585dc9a8b971fbfe2c99fdb75c5d647"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">pFlow::dictionary::getValOrSet</a></div><div class="ttdeci">T getValOrSet(const word &keyword, const T &setVal) const</div><div class="ttdoc">get the value of data entry or if not found, set the value to setVal</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00415">dictionary.hpp:415</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1multiRotatingAxis_html_ac70963b5d795997b3d042e73606604d4"><div class="ttname"><a href="classpFlow_1_1multiRotatingAxis.html#ac70963b5d795997b3d042e73606604d4">pFlow::multiRotatingAxis::read</a></div><div class="ttdeci">FUNCTION_H bool read(multiRotatingAxisMotion *axisMotion, const dictionary &dict)</div><div class="ttdoc">Read from dictionary.</div><div class="ttdef"><b>Definition:</b> <a href="multiRotatingAxis_8cpp_source.html#l00056">multiRotatingAxis.cpp:56</a></div></div>
|
||||
<div class="ttc" id="amultiRotatingAxis_8hpp_html"><div class="ttname"><a href="multiRotatingAxis_8hpp.html">multiRotatingAxis.hpp</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="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_1multiRotatingAxisMotion_html_a25f3d350ed015e91a764c51a6525e139"><div class="ttname"><a href="classpFlow_1_1multiRotatingAxisMotion.html#a25f3d350ed015e91a764c51a6525e139">pFlow::multiRotatingAxisMotion::indexToName</a></div><div class="ttdeci">INLINE_FUNCTION_H word indexToName(label i) const</div><div class="ttdoc">Index of motion component to component name.</div><div class="ttdef"><b>Definition:</b> <a href="multiRotatingAxisMotion_8hpp_source.html#l00224">multiRotatingAxisMotion.hpp:224</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</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="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="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_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</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="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="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_1multiRotatingAxis_html_af0b62abd886361864fbbac72e24f354d"><div class="ttname"><a href="classpFlow_1_1multiRotatingAxis.html#af0b62abd886361864fbbac72e24f354d">pFlow::multiRotatingAxis::multiRotatingAxis</a></div><div class="ttdeci">INLINE_FUNCTION_HD multiRotatingAxis()</div><div class="ttdoc">Empty Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="multiRotatingAxis_8hpp_source.html#l00093">multiRotatingAxis.hpp:93</a></div></div>
|
||||
<div class="ttc" id="adictionary_8hpp_html"><div class="ttname"><a href="dictionary_8hpp.html">dictionary.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1multiRotatingAxisMotion_html"><div class="ttname"><a href="classpFlow_1_1multiRotatingAxisMotion.html">pFlow::multiRotatingAxisMotion</a></div><div class="ttdoc">Rotating axis motion model for walls.</div><div class="ttdef"><b>Definition:</b> <a href="multiRotatingAxisMotion_8hpp_source.html#l00065">multiRotatingAxisMotion.hpp:65</a></div></div>
|
||||
<div class="ttc" id="amultiRotatingAxisMotion_8hpp_html"><div class="ttname"><a href="multiRotatingAxisMotion_8hpp.html">multiRotatingAxisMotion.hpp</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_47ec108d6cccce3c0382fd3240a6cec7.html">MotionModel</a></li><li class="navelem"><a class="el" href="dir_dfffb364e858dce2ad53d04d398ac8d4.html">entities</a></li><li class="navelem"><a class="el" href="dir_7944000ec3aee9d6b5bc9e95e5603559.html">multiRotatingAxis</a></li><li class="navelem"><a class="el" href="multiRotatingAxis_8cpp.html">multiRotatingAxis.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user