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 Oct 20, 2023
1 parent 5f97d45 commit a9eced2
Show file tree
Hide file tree
Showing 131 changed files with 4,418 additions and 1,537 deletions.
164 changes: 84 additions & 80 deletions annotated.html

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions annotated.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ var annotated =
[ "IPreallocatableInterpolatorRP", "classIPreallocatableInterpolatorRP.html", "classIPreallocatableInterpolatorRP" ],
[ "IRightHandSide", "classIRightHandSide.html", "classIRightHandSide" ],
[ "ITimeSolver", "classITimeSolver.html", "classITimeSolver" ],
[ "ITimeStepper", "classITimeStepper.html", null ],
[ "IVlasovSolver", "classIVlasovSolver.html", "classIVlasovSolver" ],
[ "KineticSource", "classKineticSource.html", "classKineticSource" ],
[ "KnotsAsInterpolationPoints", "classKnotsAsInterpolationPoints.html", "classKnotsAsInterpolationPoints" ],
Expand Down Expand Up @@ -105,6 +106,9 @@ var annotated =
[ "RDimVy", "structRDimVy.html", null ],
[ "RDimX", "structRDimX.html", null ],
[ "RDimY", "structRDimY.html", null ],
[ "RK2", "classRK2.html", "classRK2" ],
[ "RK3", "classRK3.html", "classRK3" ],
[ "RK4", "classRK4.html", "classRK4" ],
[ "SingleModePerturbInitialization", "classSingleModePerturbInitialization.html", "classSingleModePerturbInitialization" ],
[ "SpeciesInformation", "classSpeciesInformation.html", "classSpeciesInformation" ],
[ "SplineBoundaryValue", "classSplineBoundaryValue.html", "classSplineBoundaryValue" ],
Expand Down
6 changes: 3 additions & 3 deletions classCollisionsInter-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@

<p>This is the complete list of members for <a class="el" href="classCollisionsInter.html">CollisionsInter</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>CollisionsInter</b>(IDomainSpXVx const &amp;mesh, double nustar0) (defined in <a class="el" href="classCollisionsInter.html">CollisionsInter</a>)</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>get_nustar0</b>() const (defined in <a class="el" href="classCollisionsInter.html">CollisionsInter</a>)</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator()</b>(DSpanSpXVx allfdistribu, double dt) const override (defined in <a class="el" href="classCollisionsInter.html">CollisionsInter</a>)</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classCollisionsInter.html#a17b3fd2997376d30a7d7474bf675b647">CollisionsInter</a>(IDomainSpXVx const &amp;mesh, double nustar0)</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classCollisionsInter.html#a0de983fd5f398b17fc7b5c6137f8e8ac">get_nustar0</a>() const</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classCollisionsInter.html#a3675918e984dedb1d536be00a20d398b">operator()</a>(DSpanSpXVx allfdistribu, double dt) const override</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~CollisionsInter</b>()=default (defined in <a class="el" href="classCollisionsInter.html">CollisionsInter</a>)</td><td class="entry"><a class="el" href="classCollisionsInter.html">CollisionsInter</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~IRightHandSide</b>()=default (defined in <a class="el" href="classIRightHandSide.html">IRightHandSide</a>)</td><td class="entry"><a class="el" href="classIRightHandSide.html">IRightHandSide</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
Expand Down
125 changes: 119 additions & 6 deletions classCollisionsInter.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@
<div class="title">CollisionsInter Class Reference</div> </div>
</div><!--header-->
<div class="contents">

<p>Class describing the inter-species collision operator.
<a href="classCollisionsInter.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for CollisionsInter:</div>
<div class="dyncontent">
Expand All @@ -118,16 +121,126 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a17b3fd2997376d30a7d7474bf675b647"><td class="memItemLeft" align="right" valign="top"><a id="a17b3fd2997376d30a7d7474bf675b647"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>CollisionsInter</b> (IDomainSpXVx const &amp;mesh, double nustar0)</td></tr>
<tr class="memitem:a17b3fd2997376d30a7d7474bf675b647"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCollisionsInter.html#a17b3fd2997376d30a7d7474bf675b647">CollisionsInter</a> (IDomainSpXVx const &amp;mesh, double nustar0)</td></tr>
<tr class="memdesc:a17b3fd2997376d30a7d7474bf675b647"><td class="mdescLeft">&#160;</td><td class="mdescRight">The constructor for the operator. <a href="classCollisionsInter.html#a17b3fd2997376d30a7d7474bf675b647">More...</a><br /></td></tr>
<tr class="separator:a17b3fd2997376d30a7d7474bf675b647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3675918e984dedb1d536be00a20d398b"><td class="memItemLeft" align="right" valign="top"><a id="a3675918e984dedb1d536be00a20d398b"></a>
DSpanSpXVx&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (DSpanSpXVx allfdistribu, double dt) const override</td></tr>
<tr class="memitem:a3675918e984dedb1d536be00a20d398b"><td class="memItemLeft" align="right" valign="top">DSpanSpXVx&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCollisionsInter.html#a3675918e984dedb1d536be00a20d398b">operator()</a> (DSpanSpXVx allfdistribu, double dt) const override</td></tr>
<tr class="memdesc:a3675918e984dedb1d536be00a20d398b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the distribution function for inter-species collision. <a href="classCollisionsInter.html#a3675918e984dedb1d536be00a20d398b">More...</a><br /></td></tr>
<tr class="separator:a3675918e984dedb1d536be00a20d398b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0de983fd5f398b17fc7b5c6137f8e8ac"><td class="memItemLeft" align="right" valign="top"><a id="a0de983fd5f398b17fc7b5c6137f8e8ac"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>get_nustar0</b> () const</td></tr>
<tr class="memitem:a0de983fd5f398b17fc7b5c6137f8e8ac"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCollisionsInter.html#a0de983fd5f398b17fc7b5c6137f8e8ac">get_nustar0</a> () const</td></tr>
<tr class="memdesc:a0de983fd5f398b17fc7b5c6137f8e8ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the collision coefficient. <a href="classCollisionsInter.html#a0de983fd5f398b17fc7b5c6137f8e8ac">More...</a><br /></td></tr>
<tr class="separator:a0de983fd5f398b17fc7b5c6137f8e8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class describing the inter-species collision operator. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a17b3fd2997376d30a7d7474bf675b647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17b3fd2997376d30a7d7474bf675b647">&#9670;&nbsp;</a></span>CollisionsInter()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CollisionsInter::CollisionsInter </td>
<td>(</td>
<td class="paramtype">IDomainSpXVx const &amp;&#160;</td>
<td class="paramname"><em>mesh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>nustar0</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>The constructor for the operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mesh</td><td>The domain on which the operator will act. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nustar0</td><td>The collision coefficient. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3675918e984dedb1d536be00a20d398b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3675918e984dedb1d536be00a20d398b">&#9670;&nbsp;</a></span>operator()()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DSpanSpXVx CollisionsInter::operator() </td>
<td>(</td>
<td class="paramtype">DSpanSpXVx&#160;</td>
<td class="paramname"><em>allfdistribu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Update the distribution function for inter-species collision. </p>
<p>Update the distribution function for both electrons and ions to show how it is modified following collisions between the various species. This operator only handles collisions between particles of different species.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">allfdistribu</td><td>The distribution function. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dt</td><td>The time step over which the collisions occur.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A span referencing the distribution function passed as argument. </dd></dl>

<p>Implements <a class="el" href="classIRightHandSide.html">IRightHandSide</a>.</p>

</div>
</div>
<a id="a0de983fd5f398b17fc7b5c6137f8e8ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0de983fd5f398b17fc7b5c6137f8e8ac">&#9670;&nbsp;</a></span>get_nustar0()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double CollisionsInter::get_nustar0 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">

<p>Get the collision coefficient. </p>
<dl class="section return"><dt>Returns</dt><dd>The collision coefficient. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/__w/gyselalibxx/gyselalibxx/code_branch/src/geometryXVx/rhs/<a class="el" href="collisions__inter_8hpp_source.html">collisions_inter.hpp</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion classIRightHandSide.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
<div class="center">
<img src="classIRightHandSide.png" usemap="#IRightHandSide_map" alt=""/>
<map id="IRightHandSide_map" name="IRightHandSide_map">
<area href="classCollisionsInter.html" alt="CollisionsInter" shape="rect" coords="0,56,136,80"/>
<area href="classCollisionsInter.html" title="Class describing the inter-species collision operator." alt="CollisionsInter" shape="rect" coords="0,56,136,80"/>
<area href="classCollisionsIntra.html" alt="CollisionsIntra" shape="rect" coords="146,56,282,80"/>
<area href="classKineticSource.html" alt="KineticSource" shape="rect" coords="292,56,428,80"/>
<area href="classKrookSourceAdaptive.html" alt="KrookSourceAdaptive" shape="rect" coords="438,56,574,80"/>
Expand Down
130 changes: 130 additions & 0 deletions classITimeStepper.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gyselalib++: ITimeStepper Class Reference</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gyselalib++
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classITimeStepper.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">ITimeStepper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ITimeStepper:</div>
<div class="dyncontent">
<div class="center">
<img src="classITimeStepper.png" usemap="#ITimeStepper_map" alt=""/>
<map id="ITimeStepper_map" name="ITimeStepper_map">
<area href="classRK2.html" title="A class which provides an implementation of a second-order Runge-Kutta method." alt="RK2&lt; ValChunk, DerivChunk &gt;" shape="rect" coords="0,56,190,80"/>
<area href="classRK3.html" title="A class which provides an implementation of a third-order Runge-Kutta method." alt="RK3&lt; ValChunk, DerivChunk &gt;" shape="rect" coords="200,56,390,80"/>
<area href="classRK4.html" title="A class which provides an implementation of a fourth-order Runge-Kutta method." alt="RK4&lt; ValChunk, DerivChunk &gt;" shape="rect" coords="400,56,590,80"/>
</map>
</div></div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/__w/gyselalibxx/gyselalibxx/code_branch/src/timestepper/<a class="el" href="itimestepper_8hpp_source.html">itimestepper.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classITimeStepper.html">ITimeStepper</a></li>
<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.1 </li>
</ul>
</div>
</body>
</html>
Binary file added classITimeStepper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a9eced2

Please sign in to comment.