FYS3150/Project-3
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Cory Balaton 2023-09-29 13:55:10 +02:00
parent b0b05d239b
commit 9967101a70
No known key found for this signature in database
GPG Key ID: 3E5FCEBFD80F432B
18 changed files with 34 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Particle_8cpp.html
View File

@ -114,7 +114,6 @@ $(document).ready(function(){initNavTree('Particle_8cpp.html',''); initResizable
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl> Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>0.1</dd></dl> <dl class="section version"><dt>Version</dt><dd>0.1</dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000006">Bug:</a></b></dt><dd>No known bugs</dd></dl> <dl class="bug"><dt><b><a class="el" href="bug.html#_bug000006">Bug:</a></b></dt><dd>No known bugs</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Implement constructor </dd></dl>
<p class="definition">Definition in file <a class="el" href="Particle_8cpp_source.html">Particle.cpp</a>.</p> <p class="definition">Definition in file <a class="el" href="Particle_8cpp_source.html">Particle.cpp</a>.</p>
</div></div><!-- contents --> </div></div><!-- contents -->

26
docs/Particle_8cpp_source.html
View File

@ -102,16 +102,24 @@ $(document).ready(function(){initNavTree('Particle_8cpp_source.html',''); initRe
</div><!--header--> </div><!--header-->
<div class="contents"> <div class="contents">
<a href="Particle_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div> <a href="Particle_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="Particle_8hpp.html">Particle.hpp</a>&quot;</span></div> <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;<a class="code" href="Particle_8hpp.html">Particle.hpp</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classParticle.html#a00e108823877a25513ccae7cac011b4c"> 17</a></span><a class="code hl_function" href="classParticle.html#a00e108823877a25513ccae7cac011b4c">Particle::Particle</a>(<span class="keywordtype">double</span> q, <span class="keywordtype">double</span> m,</div> <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classParticle.html#a00e108823877a25513ccae7cac011b4c"> 16</a></span><a class="code hl_function" href="classParticle.html#a00e108823877a25513ccae7cac011b4c">Particle::Particle</a>(<span class="keywordtype">double</span> q, <span class="keywordtype">double</span> m,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> arma::vec::fixed&lt;3&gt; r_vec,</div> <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> arma::vec::fixed&lt;3&gt; r_vec,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> arma::vec::fixed&lt;3&gt; v_vec)</div> <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> arma::vec::fixed&lt;3&gt; v_vec)</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>{</div> <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>{</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Giving the particle its properties</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>}</div> <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> this-&gt;q = <a class="code hl_variable" href="classParticle.html#a566dcc1de4bdc01251776948798ea8e1">q</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> this-&gt;m = <a class="code hl_variable" href="classParticle.html#aedcc7e1bc53b0e2b1a4a07c9a1b47563">m</a>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> this-&gt;r_vec = <a class="code hl_variable" href="classParticle.html#acf1a0f3c978b06d76df5bb4279594467">r_vec</a>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> this-&gt;v_vec = <a class="code hl_variable" href="classParticle.html#a4a5d22c7aeca66f67d083f270cba25df">v_vec</a>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>}</div>
<div class="ttc" id="aParticle_8hpp_html"><div class="ttname"><a href="Particle_8hpp.html">Particle.hpp</a></div><div class="ttdoc">A class that holds the properties of a particle.</div></div> <div class="ttc" id="aParticle_8hpp_html"><div class="ttname"><a href="Particle_8hpp.html">Particle.hpp</a></div><div class="ttdoc">A class that holds the properties of a particle.</div></div>
<div class="ttc" id="aclassParticle_html_a00e108823877a25513ccae7cac011b4c"><div class="ttname"><a href="classParticle.html#a00e108823877a25513ccae7cac011b4c">Particle::Particle</a></div><div class="ttdeci">Particle(double q, double m, arma::vec::fixed&lt; 3 &gt; r_vec, arma::vec::fixed&lt; 3 &gt; v_vec)</div><div class="ttdoc">Initialize the particle.</div><div class="ttdef"><b>Definition:</b> <a href="Particle_8cpp_source.html#l00017">Particle.cpp:17</a></div></div> <div class="ttc" id="aclassParticle_html_a00e108823877a25513ccae7cac011b4c"><div class="ttname"><a href="classParticle.html#a00e108823877a25513ccae7cac011b4c">Particle::Particle</a></div><div class="ttdeci">Particle(double q, double m, arma::vec::fixed&lt; 3 &gt; r_vec, arma::vec::fixed&lt; 3 &gt; v_vec)</div><div class="ttdoc">Initialize the particle.</div><div class="ttdef"><b>Definition:</b> <a href="Particle_8cpp_source.html#l00016">Particle.cpp:16</a></div></div>
<div class="ttc" id="aclassParticle_html_a4a5d22c7aeca66f67d083f270cba25df"><div class="ttname"><a href="classParticle.html#a4a5d22c7aeca66f67d083f270cba25df">Particle::v_vec</a></div><div class="ttdeci">arma::vec::fixed&lt; 3 &gt; v_vec</div><div class="ttdoc">velocity</div><div class="ttdef"><b>Definition:</b> <a href="Particle_8hpp_source.html#l00024">Particle.hpp:24</a></div></div>
<div class="ttc" id="aclassParticle_html_a566dcc1de4bdc01251776948798ea8e1"><div class="ttname"><a href="classParticle.html#a566dcc1de4bdc01251776948798ea8e1">Particle::q</a></div><div class="ttdeci">double q</div><div class="ttdoc">Charge.</div><div class="ttdef"><b>Definition:</b> <a href="Particle_8hpp_source.html#l00021">Particle.hpp:21</a></div></div>
<div class="ttc" id="aclassParticle_html_acf1a0f3c978b06d76df5bb4279594467"><div class="ttname"><a href="classParticle.html#acf1a0f3c978b06d76df5bb4279594467">Particle::r_vec</a></div><div class="ttdeci">arma::vec::fixed&lt; 3 &gt; r_vec</div><div class="ttdoc">position</div><div class="ttdef"><b>Definition:</b> <a href="Particle_8hpp_source.html#l00023">Particle.hpp:23</a></div></div>
<div class="ttc" id="aclassParticle_html_aedcc7e1bc53b0e2b1a4a07c9a1b47563"><div class="ttname"><a href="classParticle.html#aedcc7e1bc53b0e2b1a4a07c9a1b47563">Particle::m</a></div><div class="ttdeci">double m</div><div class="ttdoc">Mass.</div><div class="ttdef"><b>Definition:</b> <a href="Particle_8hpp_source.html#l00022">Particle.hpp:22</a></div></div>
</div><!-- fragment --></div><!-- contents --> </div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content --> </div><!-- doc-content -->
<!-- start footer part --> <!-- start footer part -->

2
docs/PenningTrap_8cpp.html
View File

@ -114,7 +114,7 @@ $(document).ready(function(){initNavTree('PenningTrap_8cpp.html',''); initResiza
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl> Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>0.1</dd></dl> <dl class="section version"><dt>Version</dt><dd>0.1</dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000007">Bug:</a></b></dt><dd>No known bugs</dd></dl> <dl class="bug"><dt><b><a class="el" href="bug.html#_bug000007">Bug:</a></b></dt><dd>No known bugs</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd><p class="startdd">Implement constructor </p> <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd><p class="startdd">Implement constructor </p>
<p class="interdd">Implement add_particle </p> <p class="interdd">Implement add_particle </p>
<p class="interdd">Implement external_E_field </p> <p class="interdd">Implement external_E_field </p>
<p class="interdd">Implement external_B_field </p> <p class="interdd">Implement external_B_field </p>

2
docs/classParticle.html
View File

@ -185,7 +185,7 @@ Friends</h2></td></tr>
<p>Initialize the particle. </p> <p>Initialize the particle. </p>
<p>Initialize the particle with a charge, mass, position and velocity. </p> <p>Initialize the particle with a charge, mass, position and velocity. </p>
<p class="definition">Definition at line <a class="el" href="Particle_8cpp_source.html#l00017">17</a> of file <a class="el" href="Particle_8cpp_source.html">Particle.cpp</a>.</p> <p class="definition">Definition at line <a class="el" href="Particle_8cpp_source.html#l00016">16</a> of file <a class="el" href="Particle_8cpp_source.html">Particle.cpp</a>.</p>
</div> </div>
</div> </div>

4
docs/todo.html
View File

@ -102,10 +102,8 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
</div><!--header--> </div><!--header-->
<div class="contents"> <div class="contents">
<div class="textblock"><dl class="reflist"> <div class="textblock"><dl class="reflist">
<dt>File <a class="el" href="Particle_8cpp.html">Particle.cpp</a> </dt>
<dd><a class="anchor" id="_todo000001"></a>Implement constructor </dd>
<dt>File <a class="el" href="PenningTrap_8cpp.html">PenningTrap.cpp</a> </dt> <dt>File <a class="el" href="PenningTrap_8cpp.html">PenningTrap.cpp</a> </dt>
<dd><p class="startdd"><a class="anchor" id="_todo000002"></a>Implement constructor </p> <dd><p class="startdd"><a class="anchor" id="_todo000001"></a>Implement constructor </p>
<p class="interdd"></p> <p class="interdd"></p>
<p class="interdd">Implement add_particle </p> <p class="interdd">Implement add_particle </p>
<p class="interdd"></p> <p class="interdd"></p>

4
man_pages/man3/Particle.3
View File

@ -1,4 +1,4 @@
.TH "Particle" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "Particle" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
@ -57,7 +57,7 @@ Definition at line \fB19\fP of file \fBParticle\&.hpp\fP\&.
.PP .PP
Initialize the particle\&. Initialize the particle with a charge, mass, position and velocity\&. Initialize the particle\&. Initialize the particle with a charge, mass, position and velocity\&.
.PP .PP
Definition at line \fB17\fP of file \fBParticle\&.cpp\fP\&. Definition at line \fB16\fP of file \fBParticle\&.cpp\fP\&.
.SH "Friends And Related Function Documentation" .SH "Friends And Related Function Documentation"
.PP .PP
.SS "friend class \fBPenningTrap\fP\fC [friend]\fP" .SS "friend class \fBPenningTrap\fP\fC [friend]\fP"

8
man_pages/man3/Particle.cpp.3
View File

@ -1,4 +1,4 @@
.TH "src/Particle.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "src/Particle.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
@ -34,12 +34,6 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)
No known bugs No known bugs
.RE .RE
.PP .PP
.PP
\fBTodo\fP
.RS 4
Implement constructor
.RE
.PP
.PP .PP
Definition in file \fBParticle\&.cpp\fP\&. Definition in file \fBParticle\&.cpp\fP\&.

2
man_pages/man3/Particle.hpp.3
View File

@ -1,4 +1,4 @@
.TH "include/Particle.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "include/Particle.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/PenningTrap.3
View File

@ -1,4 +1,4 @@
.TH "PenningTrap" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "PenningTrap" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/PenningTrap.cpp.3
View File

@ -1,4 +1,4 @@
.TH "src/PenningTrap.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "src/PenningTrap.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/PenningTrap.hpp.3
View File

@ -1,4 +1,4 @@
.TH "include/PenningTrap.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "include/PenningTrap.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/bug.3
View File

@ -1,4 +1,4 @@
.TH "bug" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "bug" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/constants.hpp.3
View File

@ -1,4 +1,4 @@
.TH "include/constants.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "include/constants.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/main.cpp.3
View File

@ -1,4 +1,4 @@
.TH "src/main.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "src/main.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/test_suite.cpp.3
View File

@ -1,4 +1,4 @@
.TH "src/test_suite.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "src/test_suite.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

4
man_pages/man3/todo.3
View File

@ -1,12 +1,10 @@
.TH "todo" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "todo" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
todo \- Todo List todo \- Todo List
.PP .PP
.IP "\fBFile \fBParticle\&.cpp\fP \fP" 1c
Implement constructor
.IP "\fBFile \fBPenningTrap\&.cpp\fP \fP" 1c .IP "\fBFile \fBPenningTrap\&.cpp\fP \fP" 1c
Implement constructor Implement constructor
.PP .PP

2
man_pages/man3/utils.cpp.3
View File

@ -1,4 +1,4 @@
.TH "src/utils.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "src/utils.cpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME

2
man_pages/man3/utils.hpp.3
View File

@ -1,4 +1,4 @@
.TH "include/utils.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*- .TH "include/utils.hpp" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l .ad l
.nh .nh
.SH NAME .SH NAME