Move docs

docs/man/man3/Particle.3

@@ -1,98 +0,0 @@
-.TH "Particle" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-Particle \- A class that holds attributes of a particle\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-.PP
-\fC#include <Particle\&.hpp>\fP
-.SS "Public Member Functions"
-
-.in +1c
-.ti -1c
-.RI "\fBParticle\fP (double \fBq\fP, double \fBm\fP, arma::vec::fixed< 3 > \fBr_vec\fP, arma::vec::fixed< 3 > \fBv_vec\fP)"
-.br
-.RI "Initialize the particle\&. "
-.in -1c
-.SS "Private Attributes"
-
-.in +1c
-.ti -1c
-.RI "double \fBq\fP"
-.br
-.RI "Charge\&. "
-.ti -1c
-.RI "double \fBm\fP"
-.br
-.RI "Mass\&. "
-.ti -1c
-.RI "arma::vec::fixed< 3 > \fBr_vec\fP"
-.br
-.RI "position "
-.ti -1c
-.RI "arma::vec::fixed< 3 > \fBv_vec\fP"
-.br
-.RI "velocity "
-.in -1c
-.SS "Friends"
-
-.in +1c
-.ti -1c
-.RI "class \fBPenningTrap\fP"
-.br
-.RI "Make private attributes available for \fBPenningTrap\fP\&. "
-.in -1c
-.SH "Detailed Description"
-.PP 
-A class that holds attributes of a particle\&. 
-.PP
-Definition at line \fB19\fP of file \fBParticle\&.hpp\fP\&.
-.SH "Constructor & Destructor Documentation"
-.PP 
-.SS "Particle::Particle (double q, double m, arma::vec::fixed< 3 > r_vec, arma::vec::fixed< 3 > v_vec)"
-
-.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\&.
-.SH "Friends And Related Function Documentation"
-.PP 
-.SS "friend class \fBPenningTrap\fP\fC [friend]\fP"
-
-.PP
-Make private attributes available for \fBPenningTrap\fP\&. 
-.PP
-Definition at line \fB38\fP of file \fBParticle\&.hpp\fP\&.
-.SH "Member Data Documentation"
-.PP 
-.SS "double Particle::m\fC [private]\fP"
-
-.PP
-Mass\&. 
-.PP
-Definition at line \fB22\fP of file \fBParticle\&.hpp\fP\&.
-.SS "double Particle::q\fC [private]\fP"
-
-.PP
-Charge\&. 
-.PP
-Definition at line \fB21\fP of file \fBParticle\&.hpp\fP\&.
-.SS "arma::vec::fixed<3> Particle::r_vec\fC [private]\fP"
-
-.PP
-position 
-.PP
-Definition at line \fB23\fP of file \fBParticle\&.hpp\fP\&.
-.SS "arma::vec::fixed<3> Particle::v_vec\fC [private]\fP"
-
-.PP
-velocity 
-.PP
-Definition at line \fB24\fP of file \fBParticle\&.hpp\fP\&.
-
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/Particle.cpp.3

@@ -1,48 +0,0 @@
-.TH "src/Particle.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-src/Particle.cpp \- The implementation of the \fBParticle\fP class\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-\fC#include 'Particle\&.hpp'\fP
-.br
-
-.SH "Detailed Description"
-.PP 
-The implementation of the \fBParticle\fP class\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs
-.RE
-.PP
-.PP
-\fBTodo\fP
-.RS 4
-Implement constructor 
-.RE
-.PP
-
-.PP
-Definition in file \fBParticle\&.cpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/Particle.hpp.3

@@ -1,50 +0,0 @@
-.TH "include/Particle.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-include/Particle.hpp \- A class that holds the properties of a particle\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <armadillo>\fP
-.br
-
-.SS "Classes"
-
-.in +1c
-.ti -1c
-.RI "class \fBParticle\fP"
-.br
-.RI "A class that holds attributes of a particle\&. "
-.in -1c
-.SH "Detailed Description"
-.PP 
-A class that holds the properties of a particle\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fBParticle\&.hpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/PenningTrap.3

@@ -1,176 +0,0 @@
-.TH "PenningTrap" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-PenningTrap \- A class that simulates a Penning trap\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-.PP
-\fC#include <PenningTrap\&.hpp>\fP
-.SS "Public Member Functions"
-
-.in +1c
-.ti -1c
-.RI "\fBPenningTrap\fP (double \fBB_0\fP=\fBT\fP, double \fBV_0\fP=25\&.*\fBV\fP/1000\&., double \fBd\fP=500\&.)"
-.br
-.RI "Set B_0, V_0 and d\&. "
-.ti -1c
-.RI "void \fBadd_particle\fP (\fBParticle\fP particle)"
-.br
-.RI "Add a particle to the system\&. "
-.ti -1c
-.RI "arma::vec \fBexternal_E_field\fP (arma::vec r)"
-.br
-.RI "Calculate E at point r\&. "
-.ti -1c
-.RI "arma::vec \fBexternal_B_field\fP (arma::vec r)"
-.br
-.RI "Calculate B at point r\&. "
-.ti -1c
-.RI "arma::vec \fBforce_on_particle\fP (int i, int j)"
-.br
-.RI "Calculate the force between 2 particles\&. "
-.ti -1c
-.RI "arma::vec \fBtotal_force_external\fP (int i)"
-.br
-.RI "Calculate the total external force on a particle\&. "
-.ti -1c
-.RI "arma::vec \fBtotal_force_particles\fP (int i)"
-.br
-.RI "Calculate the total force on a particle from other particles\&. "
-.ti -1c
-.RI "arma::vec \fBtotal_force\fP (int i)"
-.br
-.RI "calculate the total force on a particle\&. "
-.ti -1c
-.RI "void \fBevolve_RK4\fP (double dt)"
-.br
-.RI "Go forward one timestep using the RK4 method\&. "
-.ti -1c
-.RI "void \fBevolve_forward_euler\fP (double dt)"
-.br
-.RI "Go forward one timestep using the forward Euler method\&. "
-.in -1c
-.SS "Private Attributes"
-
-.in +1c
-.ti -1c
-.RI "double \fBB_0\fP"
-.br
-.RI "Magnetic field strength\&. "
-.ti -1c
-.RI "double \fBV_0\fP"
-.br
-.RI "Applied potential\&. "
-.ti -1c
-.RI "double \fBd\fP"
-.br
-.RI "Characteristic dimension\&. "
-.ti -1c
-.RI "std::vector< \fBParticle\fP > \fBparticles\fP"
-.br
-.RI "The particles in the Penning trap\&. "
-.in -1c
-.SH "Detailed Description"
-.PP 
-A class that simulates a Penning trap\&. 
-
-This class simulates a Penning trap\&. It can take in a number of particles and simulate how they would behave inside a Penning trap\&. 
-.PP
-Definition at line \fB25\fP of file \fBPenningTrap\&.hpp\fP\&.
-.SH "Constructor & Destructor Documentation"
-.PP 
-.SS "PenningTrap::PenningTrap (double B_0 = \fC\fBT\fP\fP, double V_0 = \fC25\&.*\fBV\fP/1000\&.\fP, double d = \fC500\&.\fP)"
-
-.PP
-Set B_0, V_0 and d\&. 
-.PP
-Definition at line \fB26\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SH "Member Function Documentation"
-.PP 
-.SS "void PenningTrap::add_particle (\fBParticle\fP particle)"
-
-.PP
-Add a particle to the system\&. 
-.PP
-Definition at line \fB31\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "void PenningTrap::evolve_forward_euler (double dt)"
-
-.PP
-Go forward one timestep using the forward Euler method\&. 
-.PP
-Definition at line \fB71\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "void PenningTrap::evolve_RK4 (double dt)"
-
-.PP
-Go forward one timestep using the RK4 method\&. 
-.PP
-Definition at line \fB66\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "arma::vec PenningTrap::external_B_field (arma::vec r)"
-
-.PP
-Calculate B at point r\&. 
-.PP
-Definition at line \fB41\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "arma::vec PenningTrap::external_E_field (arma::vec r)"
-
-.PP
-Calculate E at point r\&. 
-.PP
-Definition at line \fB36\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "arma::vec PenningTrap::force_on_particle (int i, int j)"
-
-.PP
-Calculate the force between 2 particles\&. Calculate the force exhibited on particle p_i from particle p_j\&. 
-.PP
-Definition at line \fB46\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "arma::vec PenningTrap::total_force (int i)"
-
-.PP
-calculate the total force on a particle\&. 
-.PP
-Definition at line \fB61\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "arma::vec PenningTrap::total_force_external (int i)"
-
-.PP
-Calculate the total external force on a particle\&. Calculate the total amount of force that E and B exhibits on particle p_i\&. 
-.PP
-Definition at line \fB51\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SS "arma::vec PenningTrap::total_force_particles (int i)"
-
-.PP
-Calculate the total force on a particle from other particles\&. 
-.PP
-Definition at line \fB56\fP of file \fBPenningTrap\&.cpp\fP\&.
-.SH "Member Data Documentation"
-.PP 
-.SS "double PenningTrap::B_0\fC [private]\fP"
-
-.PP
-Magnetic field strength\&. 
-.PP
-Definition at line \fB27\fP of file \fBPenningTrap\&.hpp\fP\&.
-.SS "double PenningTrap::d\fC [private]\fP"
-
-.PP
-Characteristic dimension\&. 
-.PP
-Definition at line \fB29\fP of file \fBPenningTrap\&.hpp\fP\&.
-.SS "std::vector<\fBParticle\fP> PenningTrap::particles\fC [private]\fP"
-
-.PP
-The particles in the Penning trap\&. 
-.PP
-Definition at line \fB30\fP of file \fBPenningTrap\&.hpp\fP\&.
-.SS "double PenningTrap::V_0\fC [private]\fP"
-
-.PP
-Applied potential\&. 
-.PP
-Definition at line \fB28\fP of file \fBPenningTrap\&.hpp\fP\&.
-
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/PenningTrap.cpp.3

@@ -1,66 +0,0 @@
-.TH "src/PenningTrap.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-src/PenningTrap.cpp \- The implementation of the \fBPenningTrap\fP class\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-\fC#include 'PenningTrap\&.hpp'\fP
-.br
-
-.SH "Detailed Description"
-.PP 
-The implementation of the \fBPenningTrap\fP class\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs
-.RE
-.PP
-.PP
-\fBTodo\fP
-.RS 4
-Implement constructor 
-.PP
-Implement add_particle 
-.PP
-Implement external_E_field 
-.PP
-Implement external_B_field 
-.PP
-Implement force_on_particle 
-.PP
-Implement total_force_external 
-.PP
-Implement total_force_particles 
-.PP
-Implement total_force 
-.PP
-Implement evolve_RK4 
-.PP
-Implement evolve_forward_euler 
-.RE
-.PP
-
-.PP
-Definition in file \fBPenningTrap\&.cpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/PenningTrap.hpp.3

@@ -1,54 +0,0 @@
-.TH "include/PenningTrap.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-include/PenningTrap.hpp \- A class for simulating a Penning trap\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <armadillo>\fP
-.br
-\fC#include 'constants\&.hpp'\fP
-.br
-\fC#include 'Particle\&.hpp'\fP
-.br
-
-.SS "Classes"
-
-.in +1c
-.ti -1c
-.RI "class \fBPenningTrap\fP"
-.br
-.RI "A class that simulates a Penning trap\&. "
-.in -1c
-.SH "Detailed Description"
-.PP 
-A class for simulating a Penning trap\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fBPenningTrap\&.hpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/bug.3

@@ -1,27 +0,0 @@
-.TH "bug" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-bug \- Bug List 
-.PP
-
-.IP "\fBFile \fBconstants\&.hpp\fP \fP" 1c
-No known bugs  
-.IP "\fBFile \fBmain\&.cpp\fP \fP" 1c
-No known bugs  
-.IP "\fBFile \fBParticle\&.cpp\fP \fP" 1c
-No known bugs 
-.IP "\fBFile \fBParticle\&.hpp\fP \fP" 1c
-No known bugs  
-.IP "\fBFile \fBPenningTrap\&.cpp\fP \fP" 1c
-No known bugs 
-.IP "\fBFile \fBPenningTrap\&.hpp\fP \fP" 1c
-No known bugs  
-.IP "\fBFile \fBtest_suite\&.cpp\fP \fP" 1c
-No known bugs  
-.IP "\fBFile \fButils\&.cpp\fP \fP" 1c
-No known bugs  
-.IP "\fBFile \fButils\&.hpp\fP \fP" 1c
-No known bugs 
-.PP
-

docs/man/man3/constants.hpp.3

@@ -1,75 +0,0 @@
-.TH "include/constants.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-include/constants.hpp \- Library of constants\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-.SS "Macros"
-
-.in +1c
-.ti -1c
-.RI "#define \fBK_E\fP   138935\&.333"
-.br
-.RI "Coulomb constant\&. unit: $\frac{u(\mu m)^3}{(\mu s)^2 e^2}$\&. "
-.ti -1c
-.RI "#define \fBT\fP   96\&.4852558"
-.br
-.RI "1 Tesla\&. unit: $ \frac{u}{(\mu s) e} $ "
-.ti -1c
-.RI "#define \fBV\fP   96485255\&.8"
-.br
-.RI "1 Volt\&. unit: $ \frac{u (\mu m)^2}{(\mu s)^2 e} $ "
-.in -1c
-.SH "Detailed Description"
-.PP 
-Library of constants\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fBconstants\&.hpp\fP\&.
-.SH "Macro Definition Documentation"
-.PP 
-.SS "#define K_E   138935\&.333"
-
-.PP
-Coulomb constant\&. unit: $\frac{u(\mu m)^3}{(\mu s)^2 e^2}$\&. 
-.PP
-Definition at line \fB15\fP of file \fBconstants\&.hpp\fP\&.
-.SS "#define T   96\&.4852558"
-
-.PP
-1 Tesla\&. unit: $ \frac{u}{(\mu s) e} $ 
-.PP
-Definition at line \fB17\fP of file \fBconstants\&.hpp\fP\&.
-.SS "#define V   96485255\&.8"
-
-.PP
-1 Volt\&. unit: $ \frac{u (\mu m)^2}{(\mu s)^2 e} $ 
-.PP
-Definition at line \fB19\fP of file \fBconstants\&.hpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/main.cpp.3

@@ -1,52 +0,0 @@
-.TH "src/main.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-src/main.cpp \- The main program for this project\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-.SS "Functions"
-
-.in +1c
-.ti -1c
-.RI "int \fBmain\fP ()"
-.br
-.in -1c
-.SH "Detailed Description"
-.PP 
-The main program for this project\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fBmain\&.cpp\fP\&.
-.SH "Function Documentation"
-.PP 
-.SS "int main ()"
-
-.PP
-Definition at line \fB13\fP of file \fBmain\&.cpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/test_suite.cpp.3

@@ -1,52 +0,0 @@
-.TH "src/test_suite.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-src/test_suite.cpp \- The test suite for the project\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-.SS "Functions"
-
-.in +1c
-.ti -1c
-.RI "int \fBmain\fP ()"
-.br
-.in -1c
-.SH "Detailed Description"
-.PP 
-The test suite for the project\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-0\&.1
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fBtest_suite\&.cpp\fP\&.
-.SH "Function Documentation"
-.PP 
-.SS "int main ()"
-
-.PP
-Definition at line \fB12\fP of file \fBtest_suite\&.cpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/todo.3

@@ -1,40 +0,0 @@
-.TH "todo" 3 "Thu Sep 28 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
-.PP
-Implement add_particle 
-.PP
-.PP
-Implement external_E_field 
-.PP
-.PP
-Implement external_B_field 
-.PP
-.PP
-Implement force_on_particle 
-.PP
-.PP
-Implement total_force_external 
-.PP
-.PP
-Implement total_force_particles 
-.PP
-.PP
-Implement total_force 
-.PP
-.PP
-Implement evolve_RK4 
-.PP
-.PP
-Implement evolve_forward_euler 
-.PP
-

docs/man/man3/utils.cpp.3

@@ -1,100 +0,0 @@
-.TH "src/utils.cpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-src/utils.cpp \- Implementation of the utils\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-\fC#include 'utils\&.hpp'\fP
-.br
-
-.SS "Functions"
-
-.in +1c
-.ti -1c
-.RI "std::string \fBscientific_format\fP (double d, int width, int prec)"
-.br
-.RI "Turns a double into a string written in scientific format\&. "
-.ti -1c
-.RI "std::string \fBscientific_format\fP (const std::vector< double > &v, int width, int prec)"
-.br
-.RI "Turns a vector of doubles into a string written in scientific format\&. "
-.in -1c
-.SH "Detailed Description"
-.PP 
-Implementation of the utils\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-1\&.0
-.RE
-.PP
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fButils\&.cpp\fP\&.
-.SH "Function Documentation"
-.PP 
-.SS "std::string scientific_format (const std::vector< double > & v, int width = \fC20\fP, int prec = \fC10\fP)"
-
-.PP
-Turns a vector of doubles into a string written in scientific format\&. 
-.PP
-\fBParameters\fP
-.RS 4
-\fIv\fP The vector to stringify 
-.br
-\fIwidth\fP The reserved width of the string 
-.br
-\fIprec\fP The precision of the stringified number
-.RE
-.PP
-\fBReturns\fP
-.RS 4
-String 
-.RE
-.PP
-
-.PP
-Definition at line \fB21\fP of file \fButils\&.cpp\fP\&.
-.SS "std::string scientific_format (double d, int width = \fC20\fP, int prec = \fC10\fP)"
-
-.PP
-Turns a double into a string written in scientific format\&. Code stolen from https://github.com/anderkve/FYS3150 Header: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/include/utils.hpp Source: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/src/utils.cpp 
-.PP
-\fBParameters\fP
-.RS 4
-\fId\fP The number to stringify 
-.br
-\fIwidth\fP The reserved width of the string 
-.br
-\fIprec\fP The precision of the stringified number
-.RE
-.PP
-\fBReturns\fP
-.RS 4
-String 
-.RE
-.PP
-
-.PP
-Definition at line \fB14\fP of file \fButils\&.cpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.

docs/man/man3/utils.hpp.3

@@ -1,124 +0,0 @@
-.TH "include/utils.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-include/utils.hpp \- Function prototypes and macros that are useful\&.  
-
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <string>\fP
-.br
-\fC#include <vector>\fP
-.br
-\fC#include <iomanip>\fP
-.br
-\fC#include <sstream>\fP
-.br
-
-.SS "Macros"
-
-.in +1c
-.ti -1c
-.RI "#define \fBDEBUG\fP(msg)"
-.br
-.RI "Writes a debug message\&. "
-.in -1c
-.SS "Functions"
-
-.in +1c
-.ti -1c
-.RI "std::string \fBscientific_format\fP (double d, int width=20, int prec=10)"
-.br
-.RI "Turns a double into a string written in scientific format\&. "
-.ti -1c
-.RI "std::string \fBscientific_format\fP (const std::vector< double > &v, int width=20, int prec=10)"
-.br
-.RI "Turns a vector of doubles into a string written in scientific format\&. "
-.in -1c
-.SH "Detailed Description"
-.PP 
-Function prototypes and macros that are useful\&. 
-
-
-.PP
-\fBAuthor\fP
-.RS 4
-Cory Alexander Balaton (coryab) 
-.PP
-Janita Ovidie Sandtrøen Willumsen (janitaws)
-.RE
-.PP
-\fBVersion\fP
-.RS 4
-1\&.0
-.RE
-.PP
-.PP
-These utility function are mainly for convenience and aren't directly related to the project\&.
-.PP
-\fBBug\fP
-.RS 4
-No known bugs 
-.RE
-.PP
-
-.PP
-Definition in file \fButils\&.hpp\fP\&.
-.SH "Macro Definition Documentation"
-.PP 
-.SS "#define DEBUG(msg)"
-
-.PP
-Writes a debug message\&. This function writes a debug message that includes the filename, line number, and a custom message\&. The function is wrapped in an ifdef that checks if DBG is defined, so one can choose to display the debug messages by adding the -DDBG flag when compiling\&. 
-.PP
-Definition at line \fB35\fP of file \fButils\&.hpp\fP\&.
-.SH "Function Documentation"
-.PP 
-.SS "std::string scientific_format (const std::vector< double > & v, int width = \fC20\fP, int prec = \fC10\fP)"
-
-.PP
-Turns a vector of doubles into a string written in scientific format\&. 
-.PP
-\fBParameters\fP
-.RS 4
-\fIv\fP The vector to stringify 
-.br
-\fIwidth\fP The reserved width of the string 
-.br
-\fIprec\fP The precision of the stringified number
-.RE
-.PP
-\fBReturns\fP
-.RS 4
-String 
-.RE
-.PP
-
-.PP
-Definition at line \fB21\fP of file \fButils\&.cpp\fP\&.
-.SS "std::string scientific_format (double d, int width = \fC20\fP, int prec = \fC10\fP)"
-
-.PP
-Turns a double into a string written in scientific format\&. Code stolen from https://github.com/anderkve/FYS3150 Header: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/include/utils.hpp Source: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/src/utils.cpp 
-.PP
-\fBParameters\fP
-.RS 4
-\fId\fP The number to stringify 
-.br
-\fIwidth\fP The reserved width of the string 
-.br
-\fIprec\fP The precision of the stringified number
-.RE
-.PP
-\fBReturns\fP
-.RS 4
-String 
-.RE
-.PP
-
-.PP
-Definition at line \fB14\fP of file \fButils\&.cpp\fP\&.
-.SH "Author"
-.PP 
-Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.