580 lines
29 KiB
HTML
580 lines
29 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&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&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&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> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<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 <<a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>></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:a81add5063bd5f29d77f0b5c299c6c560"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a81add5063bd5f29d77f0b5c299c6c560">PenningTrap</a> (double <a class="el" href="classPenningTrap.html#a0cac3509aa96e71a26d3b2c902e27716">B_0</a>=<a class="el" href="constants_8hpp.html#a0acb682b8260ab1c60b918599864e2e5">T</a>, double <a class="el" href="classPenningTrap.html#a715329844d75ec4c04f8391421fb4e89">V_0</a>=25.*<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>/1000., double <a class="el" href="classPenningTrap.html#a66dfe89c68716b9502927b97f59c27d2">d</a>=500.)</td></tr>
|
|
<tr class="memdesc:a81add5063bd5f29d77f0b5c299c6c560"><td class="mdescLeft"> </td><td class="mdescRight">Set B_0, V_0 and d. <br /></td></tr>
|
|
<tr class="separator:a81add5063bd5f29d77f0b5c299c6c560"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e9776ff5b149f01080800716455d7c8"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Add a particle to the system. <br /></td></tr>
|
|
<tr class="separator:a6e9776ff5b149f01080800716455d7c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a978a2e2026a4b5308d5184712f81704b"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a978a2e2026a4b5308d5184712f81704b">external_E_field</a> (arma::vec r)</td></tr>
|
|
<tr class="memdesc:a978a2e2026a4b5308d5184712f81704b"><td class="mdescLeft"> </td><td class="mdescRight">Calculate E at point r. <br /></td></tr>
|
|
<tr class="separator:a978a2e2026a4b5308d5184712f81704b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a3e7f480ba52e9f24d4c50c3981a784"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a2a3e7f480ba52e9f24d4c50c3981a784">external_B_field</a> (arma::vec r)</td></tr>
|
|
<tr class="memdesc:a2a3e7f480ba52e9f24d4c50c3981a784"><td class="mdescLeft"> </td><td class="mdescRight">Calculate B at point r. <br /></td></tr>
|
|
<tr class="separator:a2a3e7f480ba52e9f24d4c50c3981a784"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4790f41e4fbc6ede4991aa7bbda92182"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a4790f41e4fbc6ede4991aa7bbda92182">force_on_particle</a> (int i, int j)</td></tr>
|
|
<tr class="memdesc:a4790f41e4fbc6ede4991aa7bbda92182"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the force between 2 particles. <br /></td></tr>
|
|
<tr class="separator:a4790f41e4fbc6ede4991aa7bbda92182"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a045adb85e97a8e0c38fb36d2fd74eeee"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a045adb85e97a8e0c38fb36d2fd74eeee">total_force_external</a> (int i)</td></tr>
|
|
<tr class="memdesc:a045adb85e97a8e0c38fb36d2fd74eeee"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the total external force on a particle. <br /></td></tr>
|
|
<tr class="separator:a045adb85e97a8e0c38fb36d2fd74eeee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a135db7d991d9b88b00fde4edee71f78d"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a135db7d991d9b88b00fde4edee71f78d">total_force_particles</a> (int i)</td></tr>
|
|
<tr class="memdesc:a135db7d991d9b88b00fde4edee71f78d"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the total force on a particle from other particles. <br /></td></tr>
|
|
<tr class="separator:a135db7d991d9b88b00fde4edee71f78d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83cc7a04dae009ed8e75453c38fdf8be"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a83cc7a04dae009ed8e75453c38fdf8be">total_force</a> (int i)</td></tr>
|
|
<tr class="memdesc:a83cc7a04dae009ed8e75453c38fdf8be"><td class="mdescLeft"> </td><td class="mdescRight">calculate the total force on a particle. <br /></td></tr>
|
|
<tr class="separator:a83cc7a04dae009ed8e75453c38fdf8be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab891b839c40eeb38d8a2a636c70090a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#ab891b839c40eeb38d8a2a636c70090a9">evolve_RK4</a> (double dt)</td></tr>
|
|
<tr class="memdesc:ab891b839c40eeb38d8a2a636c70090a9"><td class="mdescLeft"> </td><td class="mdescRight">Go forward one timestep using the RK4 method. <br /></td></tr>
|
|
<tr class="separator:ab891b839c40eeb38d8a2a636c70090a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56544b6f4befb42984e9650cf2a40965"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a56544b6f4befb42984e9650cf2a40965">evolve_forward_euler</a> (double dt)</td></tr>
|
|
<tr class="memdesc:a56544b6f4befb42984e9650cf2a40965"><td class="mdescLeft"> </td><td class="mdescRight">Go forward one timestep using the forward Euler method. <br /></td></tr>
|
|
<tr class="separator:a56544b6f4befb42984e9650cf2a40965"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12b511e6903a0b033ba894c10b54d264"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a12b511e6903a0b033ba894c10b54d264">get_particle</a> (int i)</td></tr>
|
|
<tr class="separator:a12b511e6903a0b033ba894c10b54d264"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85b6a231a3208963b46811776da7e580"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a85b6a231a3208963b46811776da7e580">get_d</a> ()</td></tr>
|
|
<tr class="separator:a85b6a231a3208963b46811776da7e580"><td class="memSeparator" colspan="2"> </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 </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"> </td><td class="mdescRight">Magnetic field strength. <br /></td></tr>
|
|
<tr class="separator:a0cac3509aa96e71a26d3b2c902e27716"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a715329844d75ec4c04f8391421fb4e89"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a715329844d75ec4c04f8391421fb4e89">V_0</a></td></tr>
|
|
<tr class="memdesc:a715329844d75ec4c04f8391421fb4e89"><td class="mdescLeft"> </td><td class="mdescRight">Applied potential. <br /></td></tr>
|
|
<tr class="separator:a715329844d75ec4c04f8391421fb4e89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66dfe89c68716b9502927b97f59c27d2"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a66dfe89c68716b9502927b97f59c27d2">d</a></td></tr>
|
|
<tr class="memdesc:a66dfe89c68716b9502927b97f59c27d2"><td class="mdescLeft"> </td><td class="mdescRight">Characteristic dimension. <br /></td></tr>
|
|
<tr class="separator:a66dfe89c68716b9502927b97f59c27d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0112525d9e79a472e761f8ef402a339f"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classParticle.html">Particle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPenningTrap.html#a0112525d9e79a472e761f8ef402a339f">particles</a></td></tr>
|
|
<tr class="memdesc:a0112525d9e79a472e761f8ef402a339f"><td class="mdescLeft"> </td><td class="mdescRight">The particles in the Penning trap. <br /></td></tr>
|
|
<tr class="separator:a0112525d9e79a472e761f8ef402a339f"><td class="memSeparator" colspan="2"> </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#l00025">25</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a81add5063bd5f29d77f0b5c299c6c560" name="a81add5063bd5f29d77f0b5c299c6c560"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81add5063bd5f29d77f0b5c299c6c560">◆ </a></span>PenningTrap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PenningTrap::PenningTrap </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </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">double </td>
|
|
<td class="paramname"><em>V_0</em> = <code>25.*<a class="el" href="constants_8hpp.html#af40a326b23c68a27cebe60f16634a2cb">V</a>/1000.</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>d</em> = <code>500.</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set B_0, V_0 and d. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00026">26</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">◆ </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> </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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00033">33</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a56544b6f4befb42984e9650cf2a40965" name="a56544b6f4befb42984e9650cf2a40965"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a56544b6f4befb42984e9650cf2a40965">◆ </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 </td>
|
|
<td class="paramname"><em>dt</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Go forward one timestep using the forward Euler method. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00121">121</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab891b839c40eeb38d8a2a636c70090a9" name="ab891b839c40eeb38d8a2a636c70090a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab891b839c40eeb38d8a2a636c70090a9">◆ </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 </td>
|
|
<td class="paramname"><em>dt</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Go forward one timestep using the RK4 method. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00116">116</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2a3e7f480ba52e9f24d4c50c3981a784" name="a2a3e7f480ba52e9f24d4c50c3981a784"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a3e7f480ba52e9f24d4c50c3981a784">◆ </a></span>external_B_field()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::external_B_field </td>
|
|
<td>(</td>
|
|
<td class="paramtype">arma::vec </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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00049">49</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a978a2e2026a4b5308d5184712f81704b" name="a978a2e2026a4b5308d5184712f81704b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a978a2e2026a4b5308d5184712f81704b">◆ </a></span>external_E_field()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::external_E_field </td>
|
|
<td>(</td>
|
|
<td class="paramtype">arma::vec </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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00038">38</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4790f41e4fbc6ede4991aa7bbda92182" name="a4790f41e4fbc6ede4991aa7bbda92182"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4790f41e4fbc6ede4991aa7bbda92182">◆ </a></span>force_on_particle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::force_on_particle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>j</em> </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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00059">59</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85b6a231a3208963b46811776da7e580" name="a85b6a231a3208963b46811776da7e580"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85b6a231a3208963b46811776da7e580">◆ </a></span>get_d()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double PenningTrap::get_d </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#l00142">142</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12b511e6903a0b033ba894c10b54d264" name="a12b511e6903a0b033ba894c10b54d264"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12b511e6903a0b033ba894c10b54d264">◆ </a></span>get_particle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::get_particle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </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#l00137">137</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a83cc7a04dae009ed8e75453c38fdf8be" name="a83cc7a04dae009ed8e75453c38fdf8be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a83cc7a04dae009ed8e75453c38fdf8be">◆ </a></span>total_force()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::total_force </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00111">111</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a045adb85e97a8e0c38fb36d2fd74eeee" name="a045adb85e97a8e0c38fb36d2fd74eeee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a045adb85e97a8e0c38fb36d2fd74eeee">◆ </a></span>total_force_external()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::total_force_external </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </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>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PenningTrap_8cpp_source.html#l00074">74</a> of file <a class="el" href="PenningTrap_8cpp_source.html">PenningTrap.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a135db7d991d9b88b00fde4edee71f78d" name="a135db7d991d9b88b00fde4edee71f78d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a135db7d991d9b88b00fde4edee71f78d">◆ </a></span>total_force_particles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec PenningTrap::total_force_particles </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </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 from other particles. </p>
|
|
|
|
<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>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a0cac3509aa96e71a26d3b2c902e27716" name="a0cac3509aa96e71a26d3b2c902e27716"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cac3509aa96e71a26d3b2c902e27716">◆ </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#l00027">27</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">◆ </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#l00029">29</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">◆ </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<<a class="el" href="classParticle.html">Particle</a>> 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#l00030">30</a> of file <a class="el" href="PenningTrap_8hpp_source.html">PenningTrap.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a715329844d75ec4c04f8391421fb4e89" name="a715329844d75ec4c04f8391421fb4e89"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a715329844d75ec4c04f8391421fb4e89">◆ </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">double 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#l00028">28</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>
|