Project-3/docs/classPenningTrap.html
2023-10-19 18:37:42 +02:00

1186 lines
61 KiB
HTML

<!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.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Penning Trap Simulation: PenningTrap 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/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" />
<link href="doxygen-awesome.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="projectalign">
<div id="projectname">Penning Trap Simulation
</div>
<div id="projectbrief">Simulate particle behavior inside a Penning Trap</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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('classPenningTrap.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPenningTrap-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PenningTrap Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A class that simulates a Penning trap.
<a href="classPenningTrap.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae670d7de621acdb343b01af098086f63"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#ae670d7de621acdb343b01af098086f63">PenningTrap</a> (double <a class="el" href="classPenningTrap.html#a0cac3509aa96e71a26d3b2c902e27716">B_0</a>=<a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a>, std::function&lt; double(double)&gt; <a class="el" href="classPenningTrap.html#aaf105828121c4a33cc2b217453c20317">V_0</a>=[](double <a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>) { return 25. *<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>/1000.;}, double <a class="el" href="classPenningTrap.html#a66dfe89c68716b9502927b97f59c27d2">d</a>=500., double <a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>=0.)</td></tr>
<tr class="memdesc:ae670d7de621acdb343b01af098086f63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the <a class="el" href="classPenningTrap.html" title="A class that simulates a Penning trap.">PenningTrap</a> class. <br /></td></tr>
<tr class="separator:ae670d7de621acdb343b01af098086f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a763700316b502d5900e587c1f61e6bf1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a763700316b502d5900e587c1f61e6bf1">PenningTrap</a> (unsigned int i, double <a class="el" href="classPenningTrap.html#a0cac3509aa96e71a26d3b2c902e27716">B_0</a>=<a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a>, std::function&lt; double(double)&gt; <a class="el" href="classPenningTrap.html#aaf105828121c4a33cc2b217453c20317">V_0</a>=[](double <a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>) { return 25. *<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>/1000.;}, double <a class="el" href="classPenningTrap.html#a66dfe89c68716b9502927b97f59c27d2">d</a>=500., double <a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>=0.)</td></tr>
<tr class="memdesc:a763700316b502d5900e587c1f61e6bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the <a class="el" href="classPenningTrap.html" title="A class that simulates a Penning trap.">PenningTrap</a> class. <br /></td></tr>
<tr class="separator:a763700316b502d5900e587c1f61e6bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67139e04ef69c0bcffde8f30f67cbf73"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a67139e04ef69c0bcffde8f30f67cbf73">PenningTrap</a> (std::vector&lt; <a class="el" href="classParticle.html">Particle</a> &gt; <a class="el" href="classPenningTrap.html#a0112525d9e79a472e761f8ef402a339f">particles</a>, double <a class="el" href="classPenningTrap.html#a0cac3509aa96e71a26d3b2c902e27716">B_0</a>=<a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a>, std::function&lt; double(double)&gt; <a class="el" href="classPenningTrap.html#aaf105828121c4a33cc2b217453c20317">V_0</a>=[](double <a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>) { return 25. *<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>/1000.;}, double <a class="el" href="classPenningTrap.html#a66dfe89c68716b9502927b97f59c27d2">d</a>=500., double <a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>=0.)</td></tr>
<tr class="memdesc:a67139e04ef69c0bcffde8f30f67cbf73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the <a class="el" href="classPenningTrap.html" title="A class that simulates a Penning trap.">PenningTrap</a> class. <br /></td></tr>
<tr class="separator:a67139e04ef69c0bcffde8f30f67cbf73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e9776ff5b149f01080800716455d7c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a6e9776ff5b149f01080800716455d7c8">add_particle</a> (<a class="el" href="classParticle.html">Particle</a> particle)</td></tr>
<tr class="memdesc:a6e9776ff5b149f01080800716455d7c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a particle to the system. <br /></td></tr>
<tr class="separator:a6e9776ff5b149f01080800716455d7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d58feaa2c9e34cbf26b1c5ed75ca9d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a1d58feaa2c9e34cbf26b1c5ed75ca9d9">external_E_field</a> (<a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> r)</td></tr>
<tr class="memdesc:a1d58feaa2c9e34cbf26b1c5ed75ca9d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate E at point r. <br /></td></tr>
<tr class="separator:a1d58feaa2c9e34cbf26b1c5ed75ca9d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbf065c9c125682329ad82a8d166554c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#acbf065c9c125682329ad82a8d166554c">external_B_field</a> (<a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> r)</td></tr>
<tr class="memdesc:acbf065c9c125682329ad82a8d166554c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate B at point r. <br /></td></tr>
<tr class="separator:acbf065c9c125682329ad82a8d166554c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ae34ad740a230e667e96bc6ee8730ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a9ae34ad740a230e667e96bc6ee8730ce">force_on_particle</a> (unsigned int i, unsigned int j)</td></tr>
<tr class="memdesc:a9ae34ad740a230e667e96bc6ee8730ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the force between 2 particles. <br /></td></tr>
<tr class="separator:a9ae34ad740a230e667e96bc6ee8730ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae72d203b0bfa1b9e72bea28cb2863c56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#ae72d203b0bfa1b9e72bea28cb2863c56">total_force_external</a> (unsigned int i)</td></tr>
<tr class="memdesc:ae72d203b0bfa1b9e72bea28cb2863c56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the total external force on a particle. <br /></td></tr>
<tr class="separator:ae72d203b0bfa1b9e72bea28cb2863c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46a954a0946def199e30fb300ba1c47b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a46a954a0946def199e30fb300ba1c47b">total_force_particles</a> (unsigned int i)</td></tr>
<tr class="memdesc:a46a954a0946def199e30fb300ba1c47b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the total force on a particle p_i from other particles. <br /></td></tr>
<tr class="separator:a46a954a0946def199e30fb300ba1c47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f668c4433421136ad51741741aa1bc8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a1f668c4433421136ad51741741aa1bc8">total_force</a> (unsigned int i)</td></tr>
<tr class="memdesc:a1f668c4433421136ad51741741aa1bc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculate the total force on a particle p_i. <br /></td></tr>
<tr class="separator:a1f668c4433421136ad51741741aa1bc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36946152fd951b1f7c346c51ff900d8e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a36946152fd951b1f7c346c51ff900d8e">evolve_RK4</a> (double dt, bool particle_interaction=true)</td></tr>
<tr class="memdesc:a36946152fd951b1f7c346c51ff900d8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Go forward one timestep using the RK4 method. <br /></td></tr>
<tr class="separator:a36946152fd951b1f7c346c51ff900d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9ea97a406534bbe621a95215144875e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#ab9ea97a406534bbe621a95215144875e">evolve_forward_euler</a> (double dt, bool particle_interaction=true)</td></tr>
<tr class="memdesc:ab9ea97a406534bbe621a95215144875e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Go forward one timestep using the forward Euler method. <br /></td></tr>
<tr class="separator:ab9ea97a406534bbe621a95215144875e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae09ef9cfa7e4ed1c108c8576405b3599"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a784799c37b5e4fb8bf4f6368e004dec6">simulation_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#ae09ef9cfa7e4ed1c108c8576405b3599">simulate</a> (double time, unsigned int steps, std::string method=&quot;rk4&quot;, bool particle_interaction=true)</td></tr>
<tr class="memdesc:ae09ef9cfa7e4ed1c108c8576405b3599"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate the particle system inside the Penning trap over a certain amount of time. <br /></td></tr>
<tr class="separator:ae09ef9cfa7e4ed1c108c8576405b3599"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbb832a85139b1a56ebde57d7b8f9a57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#abbb832a85139b1a56ebde57d7b8f9a57">write_simulation_to_dir</a> (std::string path, double time, unsigned int steps, std::string method=&quot;rk4&quot;, bool particle_interaction=true)</td></tr>
<tr class="memdesc:abbb832a85139b1a56ebde57d7b8f9a57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate and write the displacement of all particles to files. <br /></td></tr>
<tr class="separator:abbb832a85139b1a56ebde57d7b8f9a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0194be61c956a9259c747c23e4163c5b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a0194be61c956a9259c747c23e4163c5b">fraction_of_particles_left</a> (double time, unsigned int steps, std::string method=&quot;rk4&quot;, bool particle_interaction=true)</td></tr>
<tr class="memdesc:a0194be61c956a9259c747c23e4163c5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simulate and calculate what fraction of particles are still left inside the Penning trap after the simulation. <br /></td></tr>
<tr class="separator:a0194be61c956a9259c747c23e4163c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea6e41b0cef85c498e69b264a81cfd7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#aea6e41b0cef85c498e69b264a81cfd7f">get_r</a> (int i)</td></tr>
<tr class="separator:aea6e41b0cef85c498e69b264a81cfd7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62be138b421f0e550399abadc10efd83"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a62be138b421f0e550399abadc10efd83">get_t</a> ()</td></tr>
<tr class="separator:a62be138b421f0e550399abadc10efd83"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:af98a720da60b0e1a62aefa5f5cb37c1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#af98a720da60b0e1a62aefa5f5cb37c1e">v_func</a> (unsigned int i, unsigned int j, double dt)</td></tr>
<tr class="memdesc:af98a720da60b0e1a62aefa5f5cb37c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for evolve_RK4 when calculating \(k_{v,i,j}\) values. <br /></td></tr>
<tr class="separator:af98a720da60b0e1a62aefa5f5cb37c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43e74792ab4b3f9299f35cb64bdb2648"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a43e74792ab4b3f9299f35cb64bdb2648">r_func</a> (unsigned int i, unsigned int j, double dt)</td></tr>
<tr class="memdesc:a43e74792ab4b3f9299f35cb64bdb2648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper for evolve_RK4 when calculating \(k_{r,i,j}\) values. <br /></td></tr>
<tr class="separator:a43e74792ab4b3f9299f35cb64bdb2648"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a0cac3509aa96e71a26d3b2c902e27716"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a0cac3509aa96e71a26d3b2c902e27716">B_0</a></td></tr>
<tr class="memdesc:a0cac3509aa96e71a26d3b2c902e27716"><td class="mdescLeft">&#160;</td><td class="mdescRight">Magnetic field strength. <br /></td></tr>
<tr class="separator:a0cac3509aa96e71a26d3b2c902e27716"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf105828121c4a33cc2b217453c20317"><td class="memItemLeft" align="right" valign="top">std::function&lt; double(double)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#aaf105828121c4a33cc2b217453c20317">V_0</a></td></tr>
<tr class="memdesc:aaf105828121c4a33cc2b217453c20317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applied potential. <br /></td></tr>
<tr class="separator:aaf105828121c4a33cc2b217453c20317"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66dfe89c68716b9502927b97f59c27d2"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a66dfe89c68716b9502927b97f59c27d2">d</a></td></tr>
<tr class="memdesc:a66dfe89c68716b9502927b97f59c27d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Characteristic dimension. <br /></td></tr>
<tr class="separator:a66dfe89c68716b9502927b97f59c27d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ca4e21291f60fde619c14099d8c4e8e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a></td></tr>
<tr class="memdesc:a8ca4e21291f60fde619c14099d8c4e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current time. <br /></td></tr>
<tr class="separator:a8ca4e21291f60fde619c14099d8c4e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0112525d9e79a472e761f8ef402a339f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classParticle.html">Particle</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a0112525d9e79a472e761f8ef402a339f">particles</a></td></tr>
<tr class="memdesc:a0112525d9e79a472e761f8ef402a339f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The particles in the Penning trap. <br /></td></tr>
<tr class="separator:a0112525d9e79a472e761f8ef402a339f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9b5afdaa5cd366e94bd294452a1eed4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#ae9b5afdaa5cd366e94bd294452a1eed4">k_v</a></td></tr>
<tr class="separator:ae9b5afdaa5cd366e94bd294452a1eed4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f168622587709b9e3c49077f0b9a640"><td class="memItemLeft" align="right" valign="top"><a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a2f168622587709b9e3c49077f0b9a640">k_r</a></td></tr>
<tr class="separator:a2f168622587709b9e3c49077f0b9a640"><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>A class that simulates a Penning trap. </p>
<p>This class simulates a Penning trap. It can take in a number of particles and simulate how they would behave inside a Penning trap. </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00031">31</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae670d7de621acdb343b01af098086f63" name="ae670d7de621acdb343b01af098086f63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae670d7de621acdb343b01af098086f63">&#9670;&#160;</a></span>PenningTrap() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PenningTrap::PenningTrap </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>B_0</em> = <code><a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; double(double)&gt;&#160;</td>
<td class="paramname"><em>V_0</em> = <code>[](double&#160;<a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>)&#160;{&#160;return&#160;25.&#160;*&#160;<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>&#160;/&#160;1000.;&#160;}</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>d</em> = <code>500.</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>t</em> = <code>0.</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="classPenningTrap.html" title="A class that simulates a Penning trap.">PenningTrap</a> class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">B_0</td><td>The magnetic field strength </td></tr>
<tr><td class="paramname">V_0</td><td>The time dependent applied potential </td></tr>
<tr><td class="paramname">d</td><td>The characteristic dimension </td></tr>
<tr><td class="paramname">t</td><td>The starting time </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00015">15</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a763700316b502d5900e587c1f61e6bf1" name="a763700316b502d5900e587c1f61e6bf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a763700316b502d5900e587c1f61e6bf1">&#9670;&#160;</a></span>PenningTrap() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PenningTrap::PenningTrap </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>B_0</em> = <code><a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; double(double)&gt;&#160;</td>
<td class="paramname"><em>V_0</em> = <code>[](double&#160;<a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>)&#160;{&#160;return&#160;25.&#160;*&#160;<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>&#160;/&#160;1000.;&#160;}</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>d</em> = <code>500.</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>t</em> = <code>0.</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="classPenningTrap.html" title="A class that simulates a Penning trap.">PenningTrap</a> class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The number of particles to generate </td></tr>
<tr><td class="paramname">B_0</td><td>The magnetic field strength </td></tr>
<tr><td class="paramname">V_0</td><td>The time dependent applied potential </td></tr>
<tr><td class="paramname">d</td><td>The characteristic dimension </td></tr>
<tr><td class="paramname">t</td><td>The starting time </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00024">24</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a67139e04ef69c0bcffde8f30f67cbf73" name="a67139e04ef69c0bcffde8f30f67cbf73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67139e04ef69c0bcffde8f30f67cbf73">&#9670;&#160;</a></span>PenningTrap() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PenningTrap::PenningTrap </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classParticle.html">Particle</a> &gt;&#160;</td>
<td class="paramname"><em>particles</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>B_0</em> = <code><a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; double(double)&gt;&#160;</td>
<td class="paramname"><em>V_0</em> = <code>[](double&#160;<a class="el" href="classPenningTrap.html#a8ca4e21291f60fde619c14099d8c4e8e">t</a>)&#160;{&#160;return&#160;25.&#160;*&#160;<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>&#160;/&#160;1000.;&#160;}</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>d</em> = <code>500.</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>t</em> = <code>0.</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="classPenningTrap.html" title="A class that simulates a Penning trap.">PenningTrap</a> class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">particles</td><td>The starting particles </td></tr>
<tr><td class="paramname">B_0</td><td>The magnetic field strength </td></tr>
<tr><td class="paramname">V_0</td><td>The time dependent applied potential </td></tr>
<tr><td class="paramname">d</td><td>The characteristic dimension </td></tr>
<tr><td class="paramname">t</td><td>The starting time </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00036">36</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e9776ff5b149f01080800716455d7c8" name="a6e9776ff5b149f01080800716455d7c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9776ff5b149f01080800716455d7c8">&#9670;&#160;</a></span>add_particle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PenningTrap::add_particle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classParticle.html">Particle</a>&#160;</td>
<td class="paramname"><em>particle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a particle to the system. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">particle</td><td>The particle to add to the Penning trap </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00079">79</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="ab9ea97a406534bbe621a95215144875e" name="ab9ea97a406534bbe621a95215144875e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9ea97a406534bbe621a95215144875e">&#9670;&#160;</a></span>evolve_forward_euler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PenningTrap::evolve_forward_euler </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>particle_interaction</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Go forward one timestep using the forward Euler method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dt</td><td>The step length </td></tr>
<tr><td class="paramname">particle_interaction</td><td>Turn particle interactions on/off </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00183">183</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a36946152fd951b1f7c346c51ff900d8e" name="a36946152fd951b1f7c346c51ff900d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36946152fd951b1f7c346c51ff900d8e">&#9670;&#160;</a></span>evolve_RK4()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PenningTrap::evolve_RK4 </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>particle_interaction</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Go forward one timestep using the RK4 method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dt</td><td>The step length </td></tr>
<tr><td class="paramname">particle_interaction</td><td>Turn particle interactions on/off </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00148">148</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="acbf065c9c125682329ad82a8d166554c" name="acbf065c9c125682329ad82a8d166554c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbf065c9c125682329ad82a8d166554c">&#9670;&#160;</a></span>external_B_field()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::external_B_field </td>
<td>(</td>
<td class="paramtype"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate B at point r. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>The position where we want to calculate the B field</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00092">92</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a1d58feaa2c9e34cbf26b1c5ed75ca9d9" name="a1d58feaa2c9e34cbf26b1c5ed75ca9d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d58feaa2c9e34cbf26b1c5ed75ca9d9">&#9670;&#160;</a></span>external_E_field()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::external_E_field </td>
<td>(</td>
<td class="paramtype"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a>&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate E at point r. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>The position where we want to calculate the E field</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00084">84</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a9ae34ad740a230e667e96bc6ee8730ce" name="a9ae34ad740a230e667e96bc6ee8730ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ae34ad740a230e667e96bc6ee8730ce">&#9670;&#160;</a></span>force_on_particle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::force_on_particle </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the force between 2 particles. </p>
<p>Calculate the force exhibited on particle p_i from particle p_j.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The index of particle p_i </td></tr>
<tr><td class="paramname">j</td><td>The index of particle p_j</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00097">97</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a0194be61c956a9259c747c23e4163c5b" name="a0194be61c956a9259c747c23e4163c5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0194be61c956a9259c747c23e4163c5b">&#9670;&#160;</a></span>fraction_of_particles_left()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PenningTrap::fraction_of_particles_left </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>steps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>method</em> = <code>&quot;rk4&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>particle_interaction</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate and calculate what fraction of particles are still left inside the Penning trap after the simulation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>The time to simulate in microseconds </td></tr>
<tr><td class="paramname">steps</td><td>The amount of steps for the whole simulation </td></tr>
<tr><td class="paramname">method</td><td>The method to use when moving forward a timestep </td></tr>
<tr><td class="paramname">particle_interaction</td><td>Turn particle interactions on/off</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>double </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00281">281</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="aea6e41b0cef85c498e69b264a81cfd7f" name="aea6e41b0cef85c498e69b264a81cfd7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea6e41b0cef85c498e69b264a81cfd7f">&#9670;&#160;</a></span>get_r()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::get_r </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00299">299</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a62be138b421f0e550399abadc10efd83" name="a62be138b421f0e550399abadc10efd83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62be138b421f0e550399abadc10efd83">&#9670;&#160;</a></span>get_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PenningTrap::get_t </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00304">304</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a43e74792ab4b3f9299f35cb64bdb2648" name="a43e74792ab4b3f9299f35cb64bdb2648"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43e74792ab4b3f9299f35cb64bdb2648">&#9670;&#160;</a></span>r_func()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::r_func </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>j</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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper for evolve_RK4 when calculating \(k_{r,i,j}\) values. </p>
<p>Something</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Index i for \(k_{r,i,j}\) </td></tr>
<tr><td class="paramname">j</td><td>Index j for \(k_{r,i,j}\) </td></tr>
<tr><td class="paramname">dt</td><td>The step length (delta time)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00061">61</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="ae09ef9cfa7e4ed1c108c8576405b3599" name="ae09ef9cfa7e4ed1c108c8576405b3599"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae09ef9cfa7e4ed1c108c8576405b3599">&#9670;&#160;</a></span>simulate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a784799c37b5e4fb8bf4f6368e004dec6">simulation_t</a> PenningTrap::simulate </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>steps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>method</em> = <code>&quot;rk4&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>particle_interaction</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate the particle system inside the Penning trap over a certain amount of time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>The time to simulate in microseconds </td></tr>
<tr><td class="paramname">steps</td><td>The amount of steps for the whole simulation </td></tr>
<tr><td class="paramname">method</td><td>The method to use when moving forward a timestep </td></tr>
<tr><td class="paramname">particle_interaction</td><td>Turn particle interactions on/off</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>simulation_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00212">212</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a1f668c4433421136ad51741741aa1bc8" name="a1f668c4433421136ad51741741aa1bc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f668c4433421136ad51741741aa1bc8">&#9670;&#160;</a></span>total_force()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::total_force </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>calculate the total force on a particle p_i. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The index of particle p_i</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00140">140</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="ae72d203b0bfa1b9e72bea28cb2863c56" name="ae72d203b0bfa1b9e72bea28cb2863c56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae72d203b0bfa1b9e72bea28cb2863c56">&#9670;&#160;</a></span>total_force_external()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::total_force_external </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the total external force on a particle. </p>
<p>Calculate the total amount of force that E and B exhibits on particle p_i.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The index of particle p_i</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00108">108</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="a46a954a0946def199e30fb300ba1c47b" name="a46a954a0946def199e30fb300ba1c47b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46a954a0946def199e30fb300ba1c47b">&#9670;&#160;</a></span>total_force_particles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::total_force_particles </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the total force on a particle p_i from other particles. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The index of particle p_i</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00123">123</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="af98a720da60b0e1a62aefa5f5cb37c1e" name="af98a720da60b0e1a62aefa5f5cb37c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af98a720da60b0e1a62aefa5f5cb37c1e">&#9670;&#160;</a></span>v_func()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#a9f33f4962c8fb62cc5ccd0e4e039a8df">vec_3d</a> PenningTrap::v_func </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>j</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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper for evolve_RK4 when calculating \(k_{v,i,j}\) values. </p>
<p>Something</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Index i for \(k_{v,i,j}\) </td></tr>
<tr><td class="paramname">j</td><td>Index j for \(k_{v,i,j}\) </td></tr>
<tr><td class="paramname">dt</td><td>the step length (delta time)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>vec_3d </dd></dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00043">43</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<a id="abbb832a85139b1a56ebde57d7b8f9a57" name="abbb832a85139b1a56ebde57d7b8f9a57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbb832a85139b1a56ebde57d7b8f9a57">&#9670;&#160;</a></span>write_simulation_to_dir()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PenningTrap::write_simulation_to_dir </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>steps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>method</em> = <code>&quot;rk4&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>particle_interaction</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate and write the displacement of all particles to files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The directory to save the data </td></tr>
<tr><td class="paramname">time</td><td>The time to simulate in microseconds </td></tr>
<tr><td class="paramname">steps</td><td>The amount of steps for the whole simulation </td></tr>
<tr><td class="paramname">method</td><td>The method to use when moving forward a timestep </td></tr>
<tr><td class="paramname">particle_interaction</td><td>Turn particle interactions on/off </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00246">246</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0cac3509aa96e71a26d3b2c902e27716" name="a0cac3509aa96e71a26d3b2c902e27716"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cac3509aa96e71a26d3b2c902e27716">&#9670;&#160;</a></span>B_0</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double PenningTrap::B_0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Magnetic field strength. </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00033">33</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<a id="a66dfe89c68716b9502927b97f59c27d2" name="a66dfe89c68716b9502927b97f59c27d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66dfe89c68716b9502927b97f59c27d2">&#9670;&#160;</a></span>d</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double PenningTrap::d</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Characteristic dimension. </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00035">35</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<a id="a2f168622587709b9e3c49077f0b9a640" name="a2f168622587709b9e3c49077f0b9a640"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f168622587709b9e3c49077f0b9a640">&#9670;&#160;</a></span>k_r</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a> PenningTrap::k_r</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A 2D vector containing all \(k_{i,j}\) where \(j\) is the index of a particle </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00040">40</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<a id="ae9b5afdaa5cd366e94bd294452a1eed4" name="ae9b5afdaa5cd366e94bd294452a1eed4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9b5afdaa5cd366e94bd294452a1eed4">&#9670;&#160;</a></span>k_v</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="typedefs_8hpp.html#aec69d34220fff45de238b9e01f2686af">sim_arr</a> PenningTrap::k_v</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A 2D vector containing all \(k_{i,j}\) where \(j\) is the index of a particle </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00038">38</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<a id="a0112525d9e79a472e761f8ef402a339f" name="a0112525d9e79a472e761f8ef402a339f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0112525d9e79a472e761f8ef402a339f">&#9670;&#160;</a></span>particles</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classParticle.html">Particle</a>&gt; PenningTrap::particles</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The particles in the Penning trap. </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00037">37</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<a id="a8ca4e21291f60fde619c14099d8c4e8e" name="a8ca4e21291f60fde619c14099d8c4e8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ca4e21291f60fde619c14099d8c4e8e">&#9670;&#160;</a></span>t</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double PenningTrap::t</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Current time. </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00036">36</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<a id="aaf105828121c4a33cc2b217453c20317" name="aaf105828121c4a33cc2b217453c20317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf105828121c4a33cc2b217453c20317">&#9670;&#160;</a></span>V_0</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::function&lt;double(double)&gt; PenningTrap::V_0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Applied potential. </p>
<p class="definition">Definition at line <a class="el" href="PenningTrap_8hpp_source.html#l00034">34</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a></li>
<li>src/<a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</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="classPenningTrap.html">PenningTrap</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.6 </li>
</ul>
</div>
</body>
</html>