mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -139,8 +139,8 @@ $(document).ready(function(){initNavTree('planeWall_8cpp_source.html',''); initR
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">auto</span> p3 = dict.<a class="code" href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">getVal</a><<a class="code" href="classpFlow_1_1triple.html">realx3</a>>(<span class="stringliteral">"p3"</span>);</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">auto</span> p4 = dict.<a class="code" href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">getVal</a><<a class="code" href="classpFlow_1_1triple.html">realx3</a>>(<span class="stringliteral">"p4"</span>);</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">auto</span> numDiv12 = <a class="code" href="namespacepFlow_1_1algorithms_1_1KOKKOS.html#a6256cdfd2ba7f02ac8db8f55d05b3ef9">max</a>(dict.<a class="code" href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">getValOrSet</a><<a class="code" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>>(<span class="stringliteral">"numDiv12"</span>,1),1);</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">auto</span> numDiv23 = <a class="code" href="namespacepFlow_1_1algorithms_1_1KOKKOS.html#a6256cdfd2ba7f02ac8db8f55d05b3ef9">max</a>(dict.<a class="code" href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">getValOrSet</a><<a class="code" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>>(<span class="stringliteral">"numDiv23"</span>,1),1);</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">auto</span> numDiv12 = <a class="code" href="namespacepFlow_1_1algorithms_1_1KOKKOS.html#a9d98facac68152ec12bf1483da55c939">max</a>(dict.<a class="code" href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">getValOrSet</a><<a class="code" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>>(<span class="stringliteral">"numDiv12"</span>,1),1);</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">auto</span> numDiv23 = <a class="code" href="namespacepFlow_1_1algorithms_1_1KOKKOS.html#a9d98facac68152ec12bf1483da55c939">max</a>(dict.<a class="code" href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">getValOrSet</a><<a class="code" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>>(<span class="stringliteral">"numDiv23"</span>,1),1);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">if</span>(!checkFlatness(p1,p2,p3,p4))</div>
|
||||
@ -282,28 +282,28 @@ $(document).ready(function(){initNavTree('planeWall_8cpp_source.html',''); initR
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1Wall_html_a852ec327b0c305c9895f4e404c2c9d6b"><div class="ttname"><a href="classpFlow_1_1Wall.html#a852ec327b0c305c9895f4e404c2c9d6b">pFlow::Wall::triangles_</a></div><div class="ttdeci">std::vector< realx3x3 > triangles_</div><div class="ttdef"><b>Definition:</b> <a href="Wall_8hpp_source.html#l00045">Wall.hpp:45</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1planeWall_html_a549697ff2b459d3f6f0d888e6ab32e30"><div class="ttname"><a href="classpFlow_1_1planeWall.html#a549697ff2b459d3f6f0d888e6ab32e30">pFlow::planeWall::readPlaneWall</a></div><div class="ttdeci">bool readPlaneWall(const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="planeWall_8cpp_source.html#l00026">planeWall.cpp:26</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="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="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="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="aclasspFlow_1_1line_html"><div class="ttname"><a href="classpFlow_1_1line.html">pFlow::line</a></div><div class="ttdef"><b>Definition:</b> <a href="line_8hpp_source.html#l00036">line.hpp:36</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="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="anamespacepFlow_1_1algorithms_1_1KOKKOS_html_a9d98facac68152ec12bf1483da55c939"><div class="ttname"><a href="namespacepFlow_1_1algorithms_1_1KOKKOS.html#a9d98facac68152ec12bf1483da55c939">pFlow::algorithms::KOKKOS::max</a></div><div class="ttdeci">INLINE_FUNCTION_H Type max(const Type *first, uint32 numElems)</div><div class="ttdef"><b>Definition:</b> <a href="kokkosAlgorithms_8hpp_source.html#l00104">kokkosAlgorithms.hpp:104</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="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="aplaneWall_8hpp_html"><div class="ttname"><a href="planeWall_8hpp.html">planeWall.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1planeWall_html_acbaf6fa391684ef30020e453d9aaac0e"><div class="ttname"><a href="classpFlow_1_1planeWall.html#acbaf6fa391684ef30020e453d9aaac0e">pFlow::planeWall::addWall4</a></div><div class="ttdeci">bool addWall4(const realx3 &p1, const realx3 &p2, const realx3 &p3, const realx3 &p4)</div><div class="ttdef"><b>Definition:</b> <a href="planeWall_8cpp_source.html#l00058">planeWall.cpp: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_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00053">builtinTypes.hpp:53</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_1_1algorithms_1_1KOKKOS_html_a6256cdfd2ba7f02ac8db8f55d05b3ef9"><div class="ttname"><a href="namespacepFlow_1_1algorithms_1_1KOKKOS.html#a6256cdfd2ba7f02ac8db8f55d05b3ef9">pFlow::algorithms::KOKKOS::max</a></div><div class="ttdeci">INLINE_FUNCTION_H Type max(const Type *first, int32 numElems)</div><div class="ttdef"><b>Definition:</b> <a href="kokkosAlgorithms_8hpp_source.html#l00104">kokkosAlgorithms.hpp:104</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1line_html_a6e9513d0b6634e97d81f0d7a3595248a"><div class="ttname"><a href="classpFlow_1_1line.html#a6e9513d0b6634e97d81f0d7a3595248a">pFlow::line::point</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 point(real t) const</div><div class="ttdef"><b>Definition:</b> <a href="line_8hpp_source.html#l00094">line.hpp:94</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="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00050">builtinTypes.hpp:50</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1line_html_a6e9513d0b6634e97d81f0d7a3595248a"><div class="ttname"><a href="classpFlow_1_1line.html#a6e9513d0b6634e97d81f0d7a3595248a">pFlow::line::point</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 point(real t) const</div><div class="ttdef"><b>Definition:</b> <a href="line_8hpp_source.html#l00102">line.hpp:102</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1planeWall_html_a79ff8be1554af7901ffb5331dea61568"><div class="ttname"><a href="classpFlow_1_1planeWall.html#a79ff8be1554af7901ffb5331dea61568">pFlow::planeWall::addPlaneWall</a></div><div class="ttdeci">bool addPlaneWall(const realx3 &p1, const realx3 &p2, const realx3 &p3, const realx3 &p4, int32 numDiv12=1, int32 numDiv23=1)</div><div class="ttdef"><b>Definition:</b> <a href="planeWall_8cpp_source.html#l00084">planeWall.cpp:84</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1planeWall_html_a7866943a14f2b80380120afa8663cdde"><div class="ttname"><a href="classpFlow_1_1planeWall.html#a7866943a14f2b80380120afa8663cdde">pFlow::planeWall::planeWall</a></div><div class="ttdeci">planeWall()</div><div class="ttdef"><b>Definition:</b> <a href="planeWall_8cpp_source.html#l00133">planeWall.cpp:133</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a1f679e3de3ea62dfad0ac20f7c992277"><div class="ttname"><a href="namespacepFlow.html#a1f679e3de3ea62dfad0ac20f7c992277">pFlow::realx3x3</a></div><div class="ttdeci">triple< realx3 > realx3x3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00054">types.hpp:54</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a1f679e3de3ea62dfad0ac20f7c992277"><div class="ttname"><a href="namespacepFlow.html#a1f679e3de3ea62dfad0ac20f7c992277">pFlow::realx3x3</a></div><div class="ttdeci">triple< realx3 > realx3x3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00047">types.hpp:47</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1planeWall_html_acf2bf4d43b1d6fb755e34daeba7f9500"><div class="ttname"><a href="classpFlow_1_1planeWall.html#acf2bf4d43b1d6fb755e34daeba7f9500">pFlow::planeWall::checkFlatness</a></div><div class="ttdeci">bool checkFlatness(const realx3 &p1, const realx3 &p2, const realx3 &p3, const realx3 &p4)</div><div class="ttdef"><b>Definition:</b> <a href="planeWall_8cpp_source.html#l00073">planeWall.cpp:73</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_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_1Wall_html"><div class="ttname"><a href="classpFlow_1_1Wall.html">pFlow::Wall</a></div><div class="ttdef"><b>Definition:</b> <a href="Wall_8hpp_source.html#l00041">Wall.hpp:41</a></div></div>
|
||||
<div class="ttc" id="aline_8hpp_html"><div class="ttname"><a href="line_8hpp.html">line.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_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_70dec844158c1ebcf23020169f223c1c.html">planeWall</a></li><li class="navelem"><a class="el" href="planeWall_8cpp.html">planeWall.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user