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
@ -181,7 +181,7 @@ $(document).ready(function(){initNavTree('sphere_8hpp_source.html',''); initResi
|
||||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword"> </span>{</div>
|
||||
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">auto</span> cPoint = point-<a class="code" href="classpFlow_1_1sphere.html#a58519a7039bfcaa45de84489becc4ad2">center_</a>;</div>
|
||||
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">auto</span> dist2 = <a class="code" href="quadrupleFwd_8hpp.html#a6b8bdd44e6ac0d39b65ebd0eef5d4600">dot</a>(cPoint,cPoint);</div>
|
||||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> dist2 < <a class="code" href="classpFlow_1_1sphere.html#a498f87a6a3bd75c3036c49da59c964a8">radius2_</a>;</div>
|
||||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> dist2 <= <a class="code" href="classpFlow_1_1sphere.html#a498f87a6a3bd75c3036c49da59c964a8">radius2_</a>;</div>
|
||||
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
||||
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
|
||||
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
||||
@ -207,7 +207,7 @@ $(document).ready(function(){initNavTree('sphere_8hpp_source.html',''); initResi
|
||||
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a></div>
|
||||
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classpFlow_1_1sphere.html#a4611c0bbd5b552873706e6d361f8b43f"> 103</a></span>  <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> <a class="code" href="classpFlow_1_1sphere.html#a4611c0bbd5b552873706e6d361f8b43f">radius</a>()<span class="keyword">const</span></div>
|
||||
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword"> </span>{</div>
|
||||
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> <a class="code" href="namespacepFlow.html#aedf0e44e92e0f7a18c7c724daf0f52fa">sqrt</a>(<a class="code" href="classpFlow_1_1sphere.html#a498f87a6a3bd75c3036c49da59c964a8">radius2_</a>);</div>
|
||||
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> <a class="code" href="namespacepFlow.html#a496bce895c9a3f6202f9272233be5cb3">sqrt</a>(<a class="code" href="classpFlow_1_1sphere.html#a498f87a6a3bd75c3036c49da59c964a8">radius2_</a>);</div>
|
||||
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div>
|
||||
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
|
||||
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div>
|
||||
@ -237,22 +237,23 @@ $(document).ready(function(){initNavTree('sphere_8hpp_source.html',''); initResi
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_af62a3e07c6f230fc63639ad004e40c7e"><div class="ttname"><a href="classpFlow_1_1sphere.html#af62a3e07c6f230fc63639ad004e40c7e">pFlow::sphere::center</a></div><div class="ttdeci">const INLINE_FUNCTION_HD realx3 & center() const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00084">sphere.hpp:84</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_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="aclasspFlow_1_1sphere_html_aa7d820a4dd0777a9a82aee242b83a167"><div class="ttname"><a href="classpFlow_1_1sphere.html#aa7d820a4dd0777a9a82aee242b83a167">pFlow::sphere::write</a></div><div class="ttdeci">FUNCTION_H bool write(iOstream &os) const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8cpp_source.html#l00077">sphere.cpp:77</a></div></div>
|
||||
<div class="ttc" id="aiIstream_8hpp_html"><div class="ttname"><a href="iIstream_8hpp.html">iIstream.hpp</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a496bce895c9a3f6202f9272233be5cb3"><div class="ttname"><a href="namespacepFlow.html#a496bce895c9a3f6202f9272233be5cb3">pFlow::sqrt</a></div><div class="ttdeci">Vector< T, Allocator > sqrt(const Vector< T, Allocator > &v)</div><div class="ttdef"><b>Definition:</b> <a href="VectorMath_8hpp_source.html#l00090">VectorMath.hpp:90</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_1sphere_html_a22e25e0baa24f79d1fa113c2a84f00f9"><div class="ttname"><a href="classpFlow_1_1sphere.html#a22e25e0baa24f79d1fa113c2a84f00f9">pFlow::sphere::maxPoint</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 maxPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00097">sphere.hpp:97</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a5164661f6974ad24fa90bf19433e6116"><div class="ttname"><a href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">pFlow::realx3</a></div><div class="ttdeci">triple< real > realx3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00048">types.hpp:48</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="anamespacepFlow_html_a5164661f6974ad24fa90bf19433e6116"><div class="ttname"><a href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">pFlow::realx3</a></div><div class="ttdeci">triple< real > realx3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00043">types.hpp:43</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="aquadrupleFwd_8hpp_html_a6b8bdd44e6ac0d39b65ebd0eef5d4600"><div class="ttname"><a href="quadrupleFwd_8hpp.html#a6b8bdd44e6ac0d39b65ebd0eef5d4600">dot</a></div><div class="ttdeci">INLINE_FUNCTION_HD T dot(const quadruple< T > &oprnd1, const quadruple< T > &oprnd2)</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a58519a7039bfcaa45de84489becc4ad2"><div class="ttname"><a href="classpFlow_1_1sphere.html#a58519a7039bfcaa45de84489becc4ad2">pFlow::sphere::center_</a></div><div class="ttdeci">realx3 center_</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00037">sphere.hpp:37</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="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_1sphere_html_ae1d42751915e8566dac19658cc498ffa"><div class="ttname"><a href="classpFlow_1_1sphere.html#ae1d42751915e8566dac19658cc498ffa">pFlow::sphere::read</a></div><div class="ttdeci">FUNCTION_H bool read(iIstream &is)</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8cpp_source.html#l00067">sphere.cpp:67</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="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="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="apFlowMacros_8hpp_html_a33a666cbe329b9d3d1d607ac93fc12b7"><div class="ttname"><a href="pFlowMacros_8hpp.html#a33a666cbe329b9d3d1d607ac93fc12b7">FUNCTION_HD</a></div><div class="ttdeci">#define FUNCTION_HD</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00057">pFlowMacros.hpp:57</a></div></div>
|
||||
<div class="ttc" id="apFlowMacros_8hpp_html_a33a666cbe329b9d3d1d607ac93fc12b7"><div class="ttname"><a href="pFlowMacros_8hpp.html#a33a666cbe329b9d3d1d607ac93fc12b7">FUNCTION_HD</a></div><div class="ttdeci">#define FUNCTION_HD</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00061">pFlowMacros.hpp:61</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_ad4624379ed2bc52a9ba133c561c9e623"><div class="ttname"><a href="classpFlow_1_1sphere.html#ad4624379ed2bc52a9ba133c561c9e623">pFlow::sphere::~sphere</a></div><div class="ttdeci">~sphere()=default</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a67424c452a87ed7ff748b65374f89e54"><div class="ttname"><a href="classpFlow_1_1sphere.html#a67424c452a87ed7ff748b65374f89e54">pFlow::sphere::minPoint</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 minPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00091">sphere.hpp:91</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a019421bc01ed94462147dfb3d0dae238"><div class="ttname"><a href="classpFlow_1_1sphere.html#a019421bc01ed94462147dfb3d0dae238">pFlow::sphere::sphere</a></div><div class="ttdeci">FUNCTION_H sphere(const realx3 &center, const real radius)</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8cpp_source.html#l00026">sphere.cpp:26</a></div></div>
|
||||
@ -260,11 +261,10 @@ $(document).ready(function(){initNavTree('sphere_8hpp_source.html',''); initResi
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html"><div class="ttname"><a href="classpFlow_1_1sphere.html">pFlow::sphere</a></div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00032">sphere.hpp:32</a></div></div>
|
||||
<div class="ttc" id="aiOstream_8hpp_html"><div class="ttname"><a href="iOstream_8hpp.html">iOstream.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_aebf283683e10db418c6a31fb2dec0515"><div class="ttname"><a href="classpFlow_1_1sphere.html#aebf283683e10db418c6a31fb2dec0515">pFlow::sphere::TypeInfoNV</a></div><div class="ttdeci">TypeInfoNV("sphere")</div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aedf0e44e92e0f7a18c7c724daf0f52fa"><div class="ttname"><a href="namespacepFlow.html#aedf0e44e92e0f7a18c7c724daf0f52fa">pFlow::sqrt</a></div><div class="ttdeci">INLINE_FUNCTION_HD real sqrt(real x)</div><div class="ttdef"><b>Definition:</b> <a href="math_8hpp_source.html#l00148">math.hpp:148</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="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_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_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_1sphere_html_a4611c0bbd5b552873706e6d361f8b43f"><div class="ttname"><a href="classpFlow_1_1sphere.html#a4611c0bbd5b552873706e6d361f8b43f">pFlow::sphere::radius</a></div><div class="ttdeci">INLINE_FUNCTION_HD real radius() const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00103">sphere.hpp:103</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a27012a3b79658a7bed448393d1c9627e"><div class="ttname"><a href="classpFlow_1_1sphere.html#a27012a3b79658a7bed448393d1c9627e">pFlow::sphere::operator=</a></div><div class="ttdeci">FUNCTION_HD sphere & operator=(const sphere &)=default</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1sphere_html_a898603c1e4e433d2f304d86f1a22c53c"><div class="ttname"><a href="classpFlow_1_1sphere.html#a898603c1e4e433d2f304d86f1a22c53c">pFlow::sphere::isInside</a></div><div class="ttdeci">INLINE_FUNCTION_HD bool isInside(const realx3 &point) const</div><div class="ttdef"><b>Definition:</b> <a href="sphere_8hpp_source.html#l00075">sphere.hpp:75</a></div></div>
|
||||
|
||||
Reference in New Issue
Block a user