Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub CI Documentation builder committed Mar 15, 2024
1 parent 0ee6dbe commit 1ddd33b
Show file tree
Hide file tree
Showing 41 changed files with 464 additions and 524 deletions.
63 changes: 31 additions & 32 deletions Lagrange__interpolator_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,45 +142,44 @@
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; evaluator(m_degree, inout_data, m_domain, m_ghost);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; ddc::for_each(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; ddc::policies::serial_host,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; coordinates.domain(),</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; KOKKOS_LAMBDA(ddc::DiscreteElement&lt;DDim&gt; <span class="keyword">const</span> ix) {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; inout_data(ix) = evaluator.<a class="code" href="classLagrange.html#ad527b811b643d250343f3cf19de2be7d">evaluate</a>(coordinates(ix));</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; });</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> inout_data;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;};</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> DDim, BCond BcMin, BCond BcMax&gt;</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classPreallocatableLagrangeInterpolator.html"> 78</a></span>&#160;<span class="keyword">class </span><a class="code" href="classPreallocatableLagrangeInterpolator.html">PreallocatableLagrangeInterpolator</a> : <span class="keyword">public</span> <a class="code" href="classIPreallocatableInterpolator.html">IPreallocatableInterpolator</a>&lt;DDim&gt;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;{</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="classLagrangeInterpolator.html">LagrangeInterpolator&lt;DDim, BcMin, BcMax&gt;</a> <span class="keyword">const</span>&amp; evaluator;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classPreallocatableLagrangeInterpolator.html#a2875304d00ef92acbb66192cabec23be"> 87</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classPreallocatableLagrangeInterpolator.html#a2875304d00ef92acbb66192cabec23be">PreallocatableLagrangeInterpolator</a>(</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="code" href="classLagrangeInterpolator.html">LagrangeInterpolator&lt;DDim, BcMin, BcMax&gt;</a> <span class="keyword">const</span>&amp; evaluator)</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; : evaluator(evaluator)</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; ~<a class="code" href="classPreallocatableLagrangeInterpolator.html">PreallocatableLagrangeInterpolator</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classPreallocatableLagrangeInterpolator.html#ace73aa45a5d4d50e1665b1b9b47490eb"> 100</a></span>&#160; std::unique_ptr&lt;IInterpolator&lt;DDim&gt;&gt; <a class="code" href="classPreallocatableLagrangeInterpolator.html#ace73aa45a5d4d50e1665b1b9b47490eb">preallocate</a>()<span class="keyword"> const override</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;LagrangeInterpolator&lt;DDim, BcMin, BcMax&gt;&gt;(evaluator);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;};</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; coordinates.domain(),</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; KOKKOS_LAMBDA(ddc::DiscreteElement&lt;DDim&gt; <span class="keyword">const</span> ix) {</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; inout_data(ix) = evaluator.<a class="code" href="classLagrange.html#ad527b811b643d250343f3cf19de2be7d">evaluate</a>(coordinates(ix));</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; });</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> inout_data;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> DDim, BCond BcMin, BCond BcMax&gt;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classPreallocatableLagrangeInterpolator.html"> 77</a></span>&#160;<span class="keyword">class </span><a class="code" href="classPreallocatableLagrangeInterpolator.html">PreallocatableLagrangeInterpolator</a> : <span class="keyword">public</span> <a class="code" href="classIPreallocatableInterpolator.html">IPreallocatableInterpolator</a>&lt;DDim&gt;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;{</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="classLagrangeInterpolator.html">LagrangeInterpolator&lt;DDim, BcMin, BcMax&gt;</a> <span class="keyword">const</span>&amp; evaluator;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classPreallocatableLagrangeInterpolator.html#a2875304d00ef92acbb66192cabec23be"> 86</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classPreallocatableLagrangeInterpolator.html#a2875304d00ef92acbb66192cabec23be">PreallocatableLagrangeInterpolator</a>(</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="classLagrangeInterpolator.html">LagrangeInterpolator&lt;DDim, BcMin, BcMax&gt;</a> <span class="keyword">const</span>&amp; evaluator)</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; : evaluator(evaluator)</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; ~<a class="code" href="classPreallocatableLagrangeInterpolator.html">PreallocatableLagrangeInterpolator</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classPreallocatableLagrangeInterpolator.html#ace73aa45a5d4d50e1665b1b9b47490eb"> 99</a></span>&#160; std::unique_ptr&lt;IInterpolator&lt;DDim&gt;&gt; <a class="code" href="classPreallocatableLagrangeInterpolator.html#ace73aa45a5d4d50e1665b1b9b47490eb">preallocate</a>()<span class="keyword"> const override</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;LagrangeInterpolator&lt;DDim, BcMin, BcMax&gt;&gt;(evaluator);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; }</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;};</div>
<div class="ttc" id="aclassIInterpolator_html"><div class="ttname"><a href="classIInterpolator.html">IInterpolator</a></div><div class="ttdoc">A class which provides an interpolating function.</div><div class="ttdef"><b>Definition:</b> i_interpolator.hpp:18</div></div>
<div class="ttc" id="aclassIPreallocatableInterpolator_html"><div class="ttname"><a href="classIPreallocatableInterpolator.html">IPreallocatableInterpolator</a></div><div class="ttdoc">A class which provides access to an interpolating function which can be preallocated where useful.</div><div class="ttdef"><b>Definition:</b> i_interpolator.hpp:63</div></div>
<div class="ttc" id="aclassLagrangeInterpolator_html"><div class="ttname"><a href="classLagrangeInterpolator.html">LagrangeInterpolator</a></div><div class="ttdoc">A class for interpolating a function using Lagrange polynomials.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:15</div></div>
<div class="ttc" id="aclassLagrangeInterpolator_html_aa0e69b47983499b2162abb976f3230fe"><div class="ttname"><a href="classLagrangeInterpolator.html#aa0e69b47983499b2162abb976f3230fe">LagrangeInterpolator::LagrangeInterpolator</a></div><div class="ttdeci">LagrangeInterpolator(int degree, ddc::DiscreteDomain&lt; DDim &gt; domain, ddc::DiscreteVector&lt; DDim &gt; ghost)</div><div class="ttdoc">Create a Lagrange interpolator object.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:30</div></div>
<div class="ttc" id="aclassLagrangeInterpolator_html_aa2b8c007e3706d20b3bef94413b2b03c"><div class="ttname"><a href="classLagrangeInterpolator.html#aa2b8c007e3706d20b3bef94413b2b03c">LagrangeInterpolator::operator()</a></div><div class="ttdeci">ddc::ChunkSpan&lt; double, ddc::DiscreteDomain&lt; DDim &gt; &gt; operator()(ddc::ChunkSpan&lt; double, ddc::DiscreteDomain&lt; DDim &gt;&gt; const inout_data, ddc::ChunkSpan&lt; const ddc::Coordinate&lt; CDim &gt;, ddc::DiscreteDomain&lt; DDim &gt;&gt; const coordinates) const override</div><div class="ttdoc">Approximate the value of a function at a set of coordinates using the current values at a known set o...</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:52</div></div>
<div class="ttc" id="aclassLagrange_html"><div class="ttname"><a href="classLagrange.html">Lagrange</a></div><div class="ttdoc">A class which implements Lagrange polynomials.</div><div class="ttdef"><b>Definition:</b> Lagrange.hpp:20</div></div>
<div class="ttc" id="aclassLagrange_html_ad527b811b643d250343f3cf19de2be7d"><div class="ttname"><a href="classLagrange.html#ad527b811b643d250343f3cf19de2be7d">Lagrange::evaluate</a></div><div class="ttdeci">KOKKOS_FUNCTION double evaluate(double x_interp) const</div><div class="ttdoc">Evaluates the approximated value of a function on a point current values at a known set of interpolat...</div><div class="ttdef"><b>Definition:</b> Lagrange.hpp:166</div></div>
<div class="ttc" id="aclassPreallocatableLagrangeInterpolator_html"><div class="ttname"><a href="classPreallocatableLagrangeInterpolator.html">PreallocatableLagrangeInterpolator</a></div><div class="ttdoc">A class which stores information necessary to create an instance of the LagrangeInterpolator class.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:79</div></div>
<div class="ttc" id="aclassPreallocatableLagrangeInterpolator_html_a2875304d00ef92acbb66192cabec23be"><div class="ttname"><a href="classPreallocatableLagrangeInterpolator.html#a2875304d00ef92acbb66192cabec23be">PreallocatableLagrangeInterpolator::PreallocatableLagrangeInterpolator</a></div><div class="ttdeci">PreallocatableLagrangeInterpolator(LagrangeInterpolator&lt; DDim, BcMin, BcMax &gt; const &amp;evaluator)</div><div class="ttdoc">Create an object capable of creating LagrangeInterpolator objects.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:87</div></div>
<div class="ttc" id="aclassPreallocatableLagrangeInterpolator_html_ace73aa45a5d4d50e1665b1b9b47490eb"><div class="ttname"><a href="classPreallocatableLagrangeInterpolator.html#ace73aa45a5d4d50e1665b1b9b47490eb">PreallocatableLagrangeInterpolator::preallocate</a></div><div class="ttdeci">std::unique_ptr&lt; IInterpolator&lt; DDim &gt; &gt; preallocate() const override</div><div class="ttdoc">Create an instance of the LagrangeInterpolator class.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:100</div></div>
<div class="ttc" id="aclassPreallocatableLagrangeInterpolator_html"><div class="ttname"><a href="classPreallocatableLagrangeInterpolator.html">PreallocatableLagrangeInterpolator</a></div><div class="ttdoc">A class which stores information necessary to create an instance of the LagrangeInterpolator class.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:78</div></div>
<div class="ttc" id="aclassPreallocatableLagrangeInterpolator_html_a2875304d00ef92acbb66192cabec23be"><div class="ttname"><a href="classPreallocatableLagrangeInterpolator.html#a2875304d00ef92acbb66192cabec23be">PreallocatableLagrangeInterpolator::PreallocatableLagrangeInterpolator</a></div><div class="ttdeci">PreallocatableLagrangeInterpolator(LagrangeInterpolator&lt; DDim, BcMin, BcMax &gt; const &amp;evaluator)</div><div class="ttdoc">Create an object capable of creating LagrangeInterpolator objects.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:86</div></div>
<div class="ttc" id="aclassPreallocatableLagrangeInterpolator_html_ace73aa45a5d4d50e1665b1b9b47490eb"><div class="ttname"><a href="classPreallocatableLagrangeInterpolator.html#ace73aa45a5d4d50e1665b1b9b47490eb">PreallocatableLagrangeInterpolator::preallocate</a></div><div class="ttdeci">std::unique_ptr&lt; IInterpolator&lt; DDim &gt; &gt; preallocate() const override</div><div class="ttdoc">Create an instance of the LagrangeInterpolator class.</div><div class="ttdef"><b>Definition:</b> Lagrange_interpolator.hpp:99</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
4 changes: 2 additions & 2 deletions Lagrange__interpolator__batched_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">auto</span> inout_data_tmp = inout_data_tmp_alloc.span_view();</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">auto</span> batch_domain</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; = ddc::remove_dims_of(inout_data.domain(), inout_data.template domain&lt;DDimI&gt;());</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; ddc::for_each(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; ddc::policies::parallel_device,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; ddc::parallel_for_each(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; Kokkos::DefaultExecutionSpace(),</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; batch_domain,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; KOKKOS_LAMBDA(<span class="keyword">typename</span> decltype(batch_domain)::discrete_element_type <span class="keyword">const</span> i) {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="classLagrange.html">Lagrange&lt;Kokkos::DefaultExecutionSpace, DDimI, BcMin, BcMax&gt;</a> evaluator(</div>
Expand Down
4 changes: 2 additions & 2 deletions advection__domain_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,10 @@
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> rp_dom = advection_field.domain();</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; ddc::deepcopy(</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; ddc::parallel_deepcopy(</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; ddcHelper::get&lt;RDimX_adv&gt;(advection_field_physical),</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; ddcHelper::get&lt;RDimX&gt;(advection_field));</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; ddc::deepcopy(</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; ddc::parallel_deepcopy(</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; ddcHelper::get&lt;RDimY_adv&gt;(advection_field_physical),</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; ddcHelper::get&lt;RDimY&gt;(advection_field));</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; ;</div>
Expand Down
Loading

0 comments on commit 1ddd33b

Please sign in to comment.