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
@ -210,31 +210,31 @@ $(document).ready(function(){initNavTree('Wall_8cpp_source.html',''); initResiza
|
||||
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<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_1Wall_html_a0cfefaab8d0b6d16567956251985ad79"><div class="ttname"><a href="classpFlow_1_1Wall.html#a0cfefaab8d0b6d16567956251985ad79">pFlow::Wall::materialName_</a></div><div class="ttdeci">word materialName_</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8hpp_source.html#l00049">Wall.hpp:49</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#l00046">builtinTypes.hpp:46</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_abfbb7af55004f8113864a4da90c43545"><div class="ttname"><a href="namespacepFlow.html#abfbb7af55004f8113864a4da90c43545">pFlow::smallValue</a></div><div class="ttdeci">const real smallValue</div><div class="ttdef"><b>Definition:</b> <a href="numericConstants_8hpp_source.html#l00033">numericConstants.hpp:33</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="anamespacepFlow_html_abfbb7af55004f8113864a4da90c43545"><div class="ttname"><a href="namespacepFlow.html#abfbb7af55004f8113864a4da90c43545">pFlow::smallValue</a></div><div class="ttdeci">const real smallValue</div><div class="ttdef"><b>Definition:</b> <a href="numericConstants_8hpp_source.html#l00031">numericConstants.hpp:31</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_1Wall_html_ac339bf3cb14b75918394f93ca65ec6bf"><div class="ttname"><a href="classpFlow_1_1Wall.html#ac339bf3cb14b75918394f93ca65ec6bf">pFlow::Wall::readCommon</a></div><div class="ttdeci">bool readCommon(const dictionary &ditc)</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8cpp_source.html#l00024">Wall.cpp:24</a></div></div>
|
||||
<div class="ttc" id="aWall_8hpp_html"><div class="ttname"><a href="Wall_8hpp.html">Wall.hpp</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="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="anamespacepFlow_html_a9c4454c5f18c8245eaaebf2b4832eab0"><div class="ttname"><a href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">pFlow::printKeys</a></div><div class="ttdeci">iOstream & printKeys(iOstream &os, const wordHashMap< T > &m)</div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_addeddcb2e5fbe6fdcc653fefa7106bf5"><div class="ttname"><a href="namespacepFlow.html#addeddcb2e5fbe6fdcc653fefa7106bf5">pFlow::checkNormalVec</a></div><div class="ttdeci">bool checkNormalVec(const realx3 &p1, const realx3 &p2, const realx3 &p3, realx3 &norm)</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8cpp_source.html#l00088">Wall.cpp:88</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="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="atripleFwd_8hpp_html_a7a724b824f9e21a646a965a99fff4b04"><div class="ttname"><a href="tripleFwd_8hpp.html#a7a724b824f9e21a646a965a99fff4b04">cross</a></div><div class="ttdeci">INLINE_FUNCTION_HD triple< T > cross(const triple< T > &v1, const triple< T > &v2)</div></div>
|
||||
<div class="ttc" id="atripleFwd_8hpp_html_ae1449f1d56abab2ec4d0f00b685fc478"><div class="ttname"><a href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length</a></div><div class="ttdeci">INLINE_FUNCTION_HD T length(const triple< T > &v1)</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1Wall_html_aea93e0565c241dc8f5b19f8f094d1f1e"><div class="ttname"><a href="classpFlow_1_1Wall.html#aea93e0565c241dc8f5b19f8f094d1f1e">pFlow::Wall::create</a></div><div class="ttdeci">static uniquePtr< Wall > create(const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8cpp_source.html#l00061">Wall.cpp:61</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1Wall_html_af61424e9d302d40d095b012d7f6bf630"><div class="ttname"><a href="classpFlow_1_1Wall.html#af61424e9d302d40d095b012d7f6bf630">pFlow::Wall::motionName_</a></div><div class="ttdeci">word motionName_</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8hpp_source.html#l00051">Wall.hpp:51</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1Wall_html_a50fd7d13a0f7a6007ca5027b3bb8765a"><div class="ttname"><a href="classpFlow_1_1Wall.html#a50fd7d13a0f7a6007ca5027b3bb8765a">pFlow::Wall::name_</a></div><div class="ttdeci">word name_</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8hpp_source.html#l00047">Wall.hpp:47</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_adfe9ae1313e6913aca3f96d3eb67906e"><div class="ttname"><a href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a></div><div class="ttdeci">#define fatalError</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00036">error.hpp:36</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a73572f70de721e7793f801ae26c5a6c5"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a73572f70de721e7793f801ae26c5a6c5">pFlow::iEntry::name</a></div><div class="ttdeci">virtual word name() const</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00095">iEntry.hpp:95</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_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a></div><div class="ttdef"><b>Definition:</b> <a href="uniquePtr_8hpp_source.html#l00044">uniquePtr.hpp:44</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_adfe9ae1313e6913aca3f96d3eb67906e"><div class="ttname"><a href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a></div><div class="ttdeci">#define fatalError</div><div class="ttdoc">Report a fatal error and exit the applicaiton.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00070">error.hpp:70</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iEntry_html_a73572f70de721e7793f801ae26c5a6c5"><div class="ttname"><a href="classpFlow_1_1iEntry.html#a73572f70de721e7793f801ae26c5a6c5">pFlow::iEntry::name</a></div><div class="ttdeci">virtual word name() const</div><div class="ttdoc">name/keyword of entry</div><div class="ttdef"><b>Definition:</b> <a href="iEntry_8hpp_source.html#l00100">iEntry.hpp:100</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_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a></div><div class="ttdef"><b>Definition:</b> <a href="uniquePtr_8hpp_source.html#l00042">uniquePtr.hpp:42</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1Wall_html_aa8744a61de2fef7a0c4e9e2ff8e03db4"><div class="ttname"><a href="classpFlow_1_1Wall.html#aa8744a61de2fef7a0c4e9e2ff8e03db4">pFlow::Wall::checkTrianlge</a></div><div class="ttdeci">static bool checkTrianlge(const realx3 &p1, const realx3 &p2, const realx3 &p3)</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8cpp_source.html#l00046">Wall.cpp:46</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_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 class="ttc" id="aclasspFlow_1_1Wall_html_a768332f15cfaa85e71811d6b4f6b91c2"><div class="ttname"><a href="classpFlow_1_1Wall.html#a768332f15cfaa85e71811d6b4f6b91c2">pFlow::Wall::Wall</a></div><div class="ttdeci">Wall()</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8hpp_source.html#l00063">Wall.hpp:63</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1triple_html_a386dd44caa78e5884651bd4891674555"><div class="ttname"><a href="classpFlow_1_1triple.html#a386dd44caa78e5884651bd4891674555">pFlow::triple::length</a></div><div class="ttdeci">INLINE_FUNCTION_HD T length() const</div><div class="ttdef"><b>Definition:</b> <a href="tripleI_8hpp_source.html#l00064">tripleI.hpp:64</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1triple_html_a386dd44caa78e5884651bd4891674555"><div class="ttname"><a href="classpFlow_1_1triple.html#a386dd44caa78e5884651bd4891674555">pFlow::triple::length</a></div><div class="ttdeci">INLINE_FUNCTION_HD T length() const</div><div class="ttdoc">Length of the vector.</div><div class="ttdef"><b>Definition:</b> <a href="tripleI_8hpp_source.html#l00056">tripleI.hpp:56</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_df38b2a5d584e0f6066b4518b95c638b.html">utilities</a></li><li class="navelem"><a class="el" href="dir_a6e08d71479fa323a1b05a998d2f3920.html">Utilities</a></li><li class="navelem"><a class="el" href="dir_2c779084d9cebc7fcbe1a2bfbd9e9cb9.html">geometryPhasicFlow</a></li><li class="navelem"><a class="el" href="dir_492ea9b56e8165cfb51e930a4ceda9f8.html">Wall</a></li><li class="navelem"><a class="el" href="Wall_8cpp.html">Wall.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user