diff --git a/Doxyfile b/Doxyfile index ea0f35d..591e8ba 100644 --- a/Doxyfile +++ b/Doxyfile @@ -68,7 +68,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = docs +OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format @@ -1303,7 +1303,7 @@ GENERATE_HTML = YES # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = html +HTML_OUTPUT = docs # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). @@ -2183,7 +2183,7 @@ GENERATE_MAN = YES # The default directory is: man. # This tag requires that the tag GENERATE_MAN is set to YES. -MAN_OUTPUT = man +MAN_OUTPUT = man_pages # The MAN_EXTENSION tag determines the extension that is added to the generated # man pages. In case the manual section does not start with a number, the number diff --git a/docs/Particle_8cpp.html b/docs/Particle_8cpp.html index 9f88834..98aaf8d 100644 --- a/docs/Particle_8cpp.html +++ b/docs/Particle_8cpp.html @@ -114,7 +114,6 @@ $(document).ready(function(){initNavTree('Particle_8cpp.html',''); initResizable Janita Ovidie Sandtrøen Willumsen (janitaws)
Version
0.1
Bug:
No known bugs
-
Todo:
Implement constructor

Definition in file Particle.cpp.

diff --git a/docs/Particle_8cpp_source.html b/docs/Particle_8cpp_source.html index 159fd35..2eaf72e 100644 --- a/docs/Particle_8cpp_source.html +++ b/docs/Particle_8cpp_source.html @@ -102,16 +102,24 @@ $(document).ready(function(){initNavTree('Particle_8cpp_source.html',''); initRe
Go to the documentation of this file.
1
-
15#include "Particle.hpp"
-
16
-
17Particle::Particle(double q, double m,
-
18 arma::vec::fixed<3> r_vec,
-
19 arma::vec::fixed<3> v_vec)
-
20{
-
21
-
22}
+
14#include "Particle.hpp"
+
15
+
16Particle::Particle(double q, double m,
+
17 arma::vec::fixed<3> r_vec,
+
18 arma::vec::fixed<3> v_vec)
+
19{
+
20 // Giving the particle its properties
+
21 this->q = q;
+
22 this->m = m;
+
23 this->r_vec = r_vec;
+
24 this->v_vec = v_vec;
+
25}
Particle.hpp
A class that holds the properties of a particle.
-
Particle::Particle
Particle(double q, double m, arma::vec::fixed< 3 > r_vec, arma::vec::fixed< 3 > v_vec)
Initialize the particle.
Definition: Particle.cpp:17
+
Particle::Particle
Particle(double q, double m, arma::vec::fixed< 3 > r_vec, arma::vec::fixed< 3 > v_vec)
Initialize the particle.
Definition: Particle.cpp:16
+
Particle::v_vec
arma::vec::fixed< 3 > v_vec
velocity
Definition: Particle.hpp:24
+
Particle::q
double q
Charge.
Definition: Particle.hpp:21
+
Particle::r_vec
arma::vec::fixed< 3 > r_vec
position
Definition: Particle.hpp:23
+
Particle::m
double m
Mass.
Definition: Particle.hpp:22
diff --git a/docs/PenningTrap_8cpp.html b/docs/PenningTrap_8cpp.html index e572253..e66d85b 100644 --- a/docs/PenningTrap_8cpp.html +++ b/docs/PenningTrap_8cpp.html @@ -114,7 +114,7 @@ $(document).ready(function(){initNavTree('PenningTrap_8cpp.html',''); initResiza Janita Ovidie Sandtrøen Willumsen (janitaws)
Version
0.1
Bug:
No known bugs
-
Todo:

Implement constructor

+
Todo:

Implement constructor

Implement add_particle

Implement external_E_field

Implement external_B_field

diff --git a/docs/classParticle.html b/docs/classParticle.html index 0fcbb7a..997eb37 100644 --- a/docs/classParticle.html +++ b/docs/classParticle.html @@ -185,7 +185,7 @@ Friends

Initialize the particle.

Initialize the particle with a charge, mass, position and velocity.

-

Definition at line 17 of file Particle.cpp.

+

Definition at line 16 of file Particle.cpp.

diff --git a/docs/todo.html b/docs/todo.html index 8c5247d..c4ad491 100644 --- a/docs/todo.html +++ b/docs/todo.html @@ -102,10 +102,8 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
-
File Particle.cpp
-
Implement constructor
File PenningTrap.cpp
-

Implement constructor

+

Implement constructor

Implement add_particle

diff --git a/man_pages/man3/Particle.3 b/man_pages/man3/Particle.3 index 466ecc4..f882401 100644 --- a/man_pages/man3/Particle.3 +++ b/man_pages/man3/Particle.3 @@ -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 .nh .SH NAME @@ -57,7 +57,7 @@ Definition at line \fB19\fP of file \fBParticle\&.hpp\fP\&. .PP Initialize the particle\&. Initialize the particle with a charge, mass, position and velocity\&. .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" .PP .SS "friend class \fBPenningTrap\fP\fC [friend]\fP" diff --git a/man_pages/man3/Particle.cpp.3 b/man_pages/man3/Particle.cpp.3 index 1d94e76..3116a7f 100644 --- a/man_pages/man3/Particle.cpp.3 +++ b/man_pages/man3/Particle.cpp.3 @@ -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 .nh .SH NAME @@ -34,12 +34,6 @@ Janita Ovidie Sandtrøen Willumsen (janitaws) No known bugs .RE .PP -.PP -\fBTodo\fP -.RS 4 -Implement constructor -.RE -.PP .PP Definition in file \fBParticle\&.cpp\fP\&. diff --git a/man_pages/man3/Particle.hpp.3 b/man_pages/man3/Particle.hpp.3 index 7cec015..dd3470d 100644 --- a/man_pages/man3/Particle.hpp.3 +++ b/man_pages/man3/Particle.hpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/PenningTrap.3 b/man_pages/man3/PenningTrap.3 index 503511e..5511293 100644 --- a/man_pages/man3/PenningTrap.3 +++ b/man_pages/man3/PenningTrap.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/PenningTrap.cpp.3 b/man_pages/man3/PenningTrap.cpp.3 index 68aaa57..bcd7ee7 100644 --- a/man_pages/man3/PenningTrap.cpp.3 +++ b/man_pages/man3/PenningTrap.cpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/PenningTrap.hpp.3 b/man_pages/man3/PenningTrap.hpp.3 index 2857a95..c115455 100644 --- a/man_pages/man3/PenningTrap.hpp.3 +++ b/man_pages/man3/PenningTrap.hpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/bug.3 b/man_pages/man3/bug.3 index 670c28b..77546ad 100644 --- a/man_pages/man3/bug.3 +++ b/man_pages/man3/bug.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/constants.hpp.3 b/man_pages/man3/constants.hpp.3 index 56030e6..9db21e3 100644 --- a/man_pages/man3/constants.hpp.3 +++ b/man_pages/man3/constants.hpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/main.cpp.3 b/man_pages/man3/main.cpp.3 index 294b2fa..ef000f5 100644 --- a/man_pages/man3/main.cpp.3 +++ b/man_pages/man3/main.cpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/test_suite.cpp.3 b/man_pages/man3/test_suite.cpp.3 index c7bdeea..670feba 100644 --- a/man_pages/man3/test_suite.cpp.3 +++ b/man_pages/man3/test_suite.cpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/todo.3 b/man_pages/man3/todo.3 index e48ea02..2073548 100644 --- a/man_pages/man3/todo.3 +++ b/man_pages/man3/todo.3 @@ -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 .nh .SH NAME todo \- Todo List .PP -.IP "\fBFile \fBParticle\&.cpp\fP \fP" 1c -Implement constructor .IP "\fBFile \fBPenningTrap\&.cpp\fP \fP" 1c Implement constructor .PP diff --git a/man_pages/man3/utils.cpp.3 b/man_pages/man3/utils.cpp.3 index 1660e32..41031ad 100644 --- a/man_pages/man3/utils.cpp.3 +++ b/man_pages/man3/utils.cpp.3 @@ -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 .nh .SH NAME diff --git a/man_pages/man3/utils.hpp.3 b/man_pages/man3/utils.hpp.3 index 3aba776..6ce37f1 100644 --- a/man_pages/man3/utils.hpp.3 +++ b/man_pages/man3/utils.hpp.3 @@ -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 .nh .SH NAME diff --git a/src/Particle.cpp b/src/Particle.cpp index 1bcdb15..0ff18e8 100644 --- a/src/Particle.cpp +++ b/src/Particle.cpp @@ -9,7 +9,6 @@ * * @bug No known bugs * - * @todo Implement constructor * */ #include "Particle.hpp" @@ -18,5 +17,9 @@ Particle::Particle(double q, double m, arma::vec::fixed<3> r_vec, arma::vec::fixed<3> v_vec) { - + // Giving the particle its properties + this->q = q; + this->m = m; + this->r_vec = r_vec; + this->v_vec = v_vec; }