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 Dec 18, 2024
1 parent 0438f3d commit ac53c88
Show file tree
Hide file tree
Showing 24 changed files with 603 additions and 272 deletions.
33 changes: 17 additions & 16 deletions annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -476,22 +476,23 @@
<tr id="row_219_0_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classTriangularBernsteinPolynomialBasis_1_1Impl.html" target="_self">Impl</a></td><td class="desc">The <a class="el" href="classTriangularBernsteinPolynomialBasis_1_1Impl.html" title="The Impl class holds the implementation of the TriangularBernsteinPolynomialBasis.">Impl</a> class holds the implementation of the <a class="el" href="classTriangularBernsteinPolynomialBasis.html" title="A class which evaluates the triangular Bernstein polynomials.">TriangularBernsteinPolynomialBasis</a> </td></tr>
<tr id="row_220_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtuple__to__types.html" target="_self">tuple_to_types</a></td><td class="desc">Transform a std::tuple&lt;Args...&gt; to a testing::Types&lt;Args...&gt;, identity otherwise </td></tr>
<tr id="row_221_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtuple__to__types_3_01std_1_1tuple_3_01Args_8_8_8_01_4_01_4.html" target="_self">tuple_to_types&lt; std::tuple&lt; Args... &gt; &gt;</a></td><td class="desc"></td></tr>
<tr id="row_222_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorField.html" target="_self">VectorField</a></td><td class="desc">A class which holds multiple (scalar) fields in order to represent a vector field </td></tr>
<tr id="row_223_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorFieldCommon.html" target="_self">VectorFieldCommon</a></td><td class="desc"></td></tr>
<tr id="row_224_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorFieldMem.html" target="_self">VectorFieldMem</a></td><td class="desc">Pre-declaration of <a class="el" href="classVectorFieldMem.html" title="Pre-declaration of VectorFieldMem.">VectorFieldMem</a> </td></tr>
<tr id="row_225_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorMapper.html" target="_self">VectorMapper</a></td><td class="desc">The general predeclaration of <a class="el" href="classVectorMapper.html" title="The general predeclaration of VectorMapper.">VectorMapper</a> </td></tr>
<tr id="row_226_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorMapper_3_01NDTag_3_01XIn_00_01YIn_01_4_00_01NDTag_3_01XOut_00_01YOut_01_4_00_01Mapping_00_01ExecSpace_01_4.html" target="_self">VectorMapper&lt; NDTag&lt; XIn, YIn &gt;, NDTag&lt; XOut, YOut &gt;, Mapping, ExecSpace &gt;</a></td><td class="desc">A class to map vector fields from one coordinate system to another </td></tr>
<tr id="row_227_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVortexMergerDensitySolution.html" target="_self">VortexMergerDensitySolution</a></td><td class="desc">Initial condition for the vortex merger simulation </td></tr>
<tr id="row_228_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVortexMergerEquilibria.html" target="_self">VortexMergerEquilibria</a></td><td class="desc">Equilibrium solution of a Vlasov-Poissson equations system in polar coordinates </td></tr>
<tr id="row_229_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVpar.html" target="_self">Vpar</a></td><td class="desc">Define non periodic parallel velocity \(v_\parallel\) </td></tr>
<tr id="row_230_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVr.html" target="_self">Vr</a></td><td class="desc">Define non periodic real <a class="el" href="structR.html" title="Define non periodic real R dimension.">R</a> velocity dimension </td></tr>
<tr id="row_231_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVtheta.html" target="_self">Vtheta</a></td><td class="desc">Define periodic real <a class="el" href="structTheta.html" title="Define periodic real Theta dimension.">Theta</a> velocity dimension </td></tr>
<tr id="row_232_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVx.html" target="_self">Vx</a></td><td class="desc">Define non periodic real <a class="el" href="structX.html" title="Define non periodic real X dimension.">X</a> velocity dimension </td></tr>
<tr id="row_233_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVy.html" target="_self">Vy</a></td><td class="desc">Define non periodic real <a class="el" href="structY.html" title="Define non periodic real Y dimension.">Y</a> velocity dimension </td></tr>
<tr id="row_234_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structX.html" target="_self">X</a></td><td class="desc">Define non periodic real <a class="el" href="structX.html" title="Define non periodic real X dimension.">X</a> dimension </td></tr>
<tr id="row_235_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structX__pC.html" target="_self">X_pC</a></td><td class="desc">Tag the first non periodic dimension in the pseudo_Cartesian index range </td></tr>
<tr id="row_236_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structY.html" target="_self">Y</a></td><td class="desc">Define non periodic real <a class="el" href="structY.html" title="Define non periodic real Y dimension.">Y</a> dimension </td></tr>
<tr id="row_237_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structY__pC.html" target="_self">Y_pC</a></td><td class="desc">Tag the second non periodic dimension in the pseudo_Cartesian index range </td></tr>
<tr id="row_222_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVector.html" target="_self">Vector</a></td><td class="desc">A type describing a vector e.g. (E_x, E_y) </td></tr>
<tr id="row_223_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorField.html" target="_self">VectorField</a></td><td class="desc">A class which holds multiple (scalar) fields in order to represent a vector field </td></tr>
<tr id="row_224_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorFieldCommon.html" target="_self">VectorFieldCommon</a></td><td class="desc"></td></tr>
<tr id="row_225_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorFieldMem.html" target="_self">VectorFieldMem</a></td><td class="desc">Pre-declaration of <a class="el" href="classVectorFieldMem.html" title="Pre-declaration of VectorFieldMem.">VectorFieldMem</a> </td></tr>
<tr id="row_226_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorMapper.html" target="_self">VectorMapper</a></td><td class="desc">The general predeclaration of <a class="el" href="classVectorMapper.html" title="The general predeclaration of VectorMapper.">VectorMapper</a> </td></tr>
<tr id="row_227_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVectorMapper_3_01NDTag_3_01XIn_00_01YIn_01_4_00_01NDTag_3_01XOut_00_01YOut_01_4_00_01Mapping_00_01ExecSpace_01_4.html" target="_self">VectorMapper&lt; NDTag&lt; XIn, YIn &gt;, NDTag&lt; XOut, YOut &gt;, Mapping, ExecSpace &gt;</a></td><td class="desc">A class to map vector fields from one coordinate system to another </td></tr>
<tr id="row_228_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVortexMergerDensitySolution.html" target="_self">VortexMergerDensitySolution</a></td><td class="desc">Initial condition for the vortex merger simulation </td></tr>
<tr id="row_229_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVortexMergerEquilibria.html" target="_self">VortexMergerEquilibria</a></td><td class="desc">Equilibrium solution of a Vlasov-Poissson equations system in polar coordinates </td></tr>
<tr id="row_230_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVpar.html" target="_self">Vpar</a></td><td class="desc">Define non periodic parallel velocity \(v_\parallel\) </td></tr>
<tr id="row_231_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVr.html" target="_self">Vr</a></td><td class="desc">Define non periodic real <a class="el" href="structR.html" title="Define non periodic real R dimension.">R</a> velocity dimension </td></tr>
<tr id="row_232_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVtheta.html" target="_self">Vtheta</a></td><td class="desc">Define periodic real <a class="el" href="structTheta.html" title="Define periodic real Theta dimension.">Theta</a> velocity dimension </td></tr>
<tr id="row_233_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVx.html" target="_self">Vx</a></td><td class="desc">Define non periodic real <a class="el" href="structX.html" title="Define non periodic real X dimension.">X</a> velocity dimension </td></tr>
<tr id="row_234_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVy.html" target="_self">Vy</a></td><td class="desc">Define non periodic real <a class="el" href="structY.html" title="Define non periodic real Y dimension.">Y</a> velocity dimension </td></tr>
<tr id="row_235_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structX.html" target="_self">X</a></td><td class="desc">Define non periodic real <a class="el" href="structX.html" title="Define non periodic real X dimension.">X</a> dimension </td></tr>
<tr id="row_236_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structX__pC.html" target="_self">X_pC</a></td><td class="desc">Tag the first non periodic dimension in the pseudo_Cartesian index range </td></tr>
<tr id="row_237_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structY.html" target="_self">Y</a></td><td class="desc">Define non periodic real <a class="el" href="structY.html" title="Define non periodic real Y dimension.">Y</a> dimension </td></tr>
<tr id="row_238_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structY__pC.html" target="_self">Y_pC</a></td><td class="desc">Tag the second non periodic dimension in the pseudo_Cartesian index range </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
1 change: 1 addition & 0 deletions annotated.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

122 changes: 122 additions & 0 deletions classVector-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gyselalib++: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<div id="projectname">Gyselalib++
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classVector.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="headertitle"><div class="title">Vector&lt; ElementType, Dims &gt; Member List</div></div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classVector.html">Vector&lt; ElementType, Dims &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classVector.html#a712a2fb11d84244a5ba7ea8fa90d4f2a">Vector</a>(Params... p)</td><td class="entry"><a class="el" href="classVector.html">Vector&lt; ElementType, Dims &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit ac53c88

Please sign in to comment.