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

Develop #14

Merged
coryab merged 124 commits from develop into main 2023-10-24 20:43:56 +00:00
Conversation 0 Commits 124 Files Changed 193 +98 -101
5 changed files with 98 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 1ae665e7e7 - Show all commits

9
include/Particle.hpp
View File

@ -3,7 +3,7 @@
* @author Cory Alexander Balaton (coryab)
* @author Janita Ovidie Sandtrøen Willumsen (janitaws)
*
* @version 0.1
* @version 1.0
*
* @brief A class that holds the properties of a particle.
*
@ -22,8 +22,8 @@
class Particle
{
private:
vec_3d r_vec; ///< position
vec_3d v_vec; ///< velocity
vec3 r_vec; ///< position
vec3 v_vec; ///< velocity
double q; ///< Charge
double m; ///< Mass
@ -38,8 +38,7 @@ public:
* @param r_vec The initial position of the particle
* @param v_vec The initial velocity of the particle
* */
Particle(vec_3d r_vec, vec_3d v_vec, double q = CA_CHARGE,
double m = CA_MASS);
Particle(vec3 r_vec, vec3 v_vec, double q = CA_CHARGE, double m = CA_MASS);
/** @brief Make private attributes available for PenningTrap.
* */

160
include/PenningTrap.hpp
View File

@ -3,7 +3,7 @@
* @author Cory Alexander Balaton (coryab)
* @author Janita Ovidie Sandtrøen Willumsen (janitaws)
*
* @version 0.1
* @version 1.0
*
* @brief A class for simulating a Penning trap.
*
@ -20,7 +20,7 @@
#include "typedefs.hpp"
#include "utils.hpp"
#pragma omp declare reduction(+ : vec_3d : omp_out += omp_in) \
#pragma omp declare reduction(+ : vec3 : omp_out += omp_in) \
initializer(omp_priv = omp_orig)
/** @brief A class that simulates a Penning trap.
@ -28,7 +28,8 @@
* This class simulates a Penning trap. It can take in a number of particles
* and simulate how they would behave inside a Penning trap.
* */
class PenningTrap {
class PenningTrap
{
private:
double B_0; ///< Magnetic field strength
double V_0; ///< Applied potential
@ -49,9 +50,9 @@ private:
* @param j Index j for \f$k_{v,i,j}\f$
* @param dt the step length (delta time)
*
* @return vec_3d
* @return vec3
* */
vec_3d v_func(uint i, uint j, double dt);
vec3 v_func(uint i, uint j, double dt);
/** @brief Helper for evolve_RK4 when calculating \f$k_{r,i,j}\f$ values
*
@ -61,9 +62,65 @@ private:
* @param j Index j for \f$k_{r,i,j}\f$
* @param dt The step length (delta time)
*
* @return vec_3d
* @return vec3
* */
vec_3d r_func(uint i, uint j, double dt);
vec3 r_func(uint i, uint j, double dt);
/** @brief Calculate E at point r
*
* @param r The position where we want to calculate the E field
*
* @return vec3
* */
vec3 external_E_field(vec3 r);
/** @brief Calculate B at point r
*
* @param r The position where we want to calculate the B field
*
* @return vec3
* */
vec3 external_B_field(vec3 r);
/** @brief Calculate the force between 2 particles.
*
* @details Calculate the force exhibited on particle p_i from
* particle p_j.
*
* @param i The index of particle p_i
* @param j The index of particle p_j
*
* @return vec3
* */
vec3 force_on_particle(uint i, uint j);
/** @brief Calculate the total external force on a particle.
*
* @details Calculate the total amount of force that E and B exhibits
* on particle p_i.
*
* @param i The index of particle p_i
*
* @return vec3
* */
vec3 total_force_external(uint i);
/** @brief Calculate the total force on a particle p_i from other
* particles.
*
* @param i The index of particle p_i
*
* @return vec3
* */
vec3 total_force_particles(uint i);
/** @brief calculate the total force on a particle p_i.
*
* @param i The index of particle p_i
*
* @return vec3
* */
vec3 total_force(uint i);
public:
/** @brief Constructor for the PenningTrap class
@ -73,10 +130,8 @@ public:
* @param d The characteristic dimension
* @param t The starting time
* */
PenningTrap(
double B_0 = T,
double V_0 = (25. * V) / 1000.,
double d = 500., double t = 0.);
PenningTrap(double B_0 = T, double V_0 = (25. * V) / 1000., double d = 500.,
double t = 0.);
/** @brief Constructor for the PenningTrap class
*
@ -86,9 +141,7 @@ public:
* @param d The characteristic dimension
* @param t The starting time
* */
PenningTrap(
uint i, double B_0 = T,
double V_0 = (25. * V) / 1000.,
PenningTrap(uint i, double B_0 = T, double V_0 = (25. * V) / 1000.,
double d = 500., double t = 0.);
/** @brief Constructor for the PenningTrap class
@ -99,11 +152,14 @@ public:
* @param d The characteristic dimension
* @param t The starting time
* */
PenningTrap(
std::vector<Particle> particles, double B_0 = T,
double V_0 = (25. * V) / 1000.,
double d = 500., double t = 0.);
PenningTrap(std::vector<Particle> particles, double B_0 = T,
double V_0 = (25. * V) / 1000., double d = 500., double t = 0.);
/** @brief Time dependent perturbation to V_0
*
* @param f The amplitude of the perturbation
* @parma omega_V the angular frequency of the perturbation
* */
void set_pertubation(double f, double omega_V);
/** @brief Give all particles new positions and velocities, and change t
@ -112,9 +168,7 @@ public:
* @param V_0 The tiome dependent applied potential
* @param t The starting time
* */
void reinitialize(
double f, double omega_V,
double t = 0.);
void reinitialize(double f, double omega_V, double t = 0.);
/** @brief Add a particle to the system
*
@ -122,62 +176,6 @@ public:
* */
void add_particle(Particle particle);
/** @brief Calculate E at point r
*
* @param r The position where we want to calculate the E field
*
* @return vec_3d
* */
vec_3d external_E_field(vec_3d r);
/** @brief Calculate B at point r
*
* @param r The position where we want to calculate the B field
*
* @return vec_3d
* */
vec_3d external_B_field(vec_3d r);
/** @brief Calculate the force between 2 particles.
*
* @details Calculate the force exhibited on particle p_i from
* particle p_j.
*
* @param i The index of particle p_i
* @param j The index of particle p_j
*
* @return vec_3d
* */
vec_3d force_on_particle(uint i, uint j);
/** @brief Calculate the total external force on a particle.
*
* @details Calculate the total amount of force that E and B exhibits
* on particle p_i.
*
* @param i The index of particle p_i
*
* @return vec_3d
* */
vec_3d total_force_external(uint i);
/** @brief Calculate the total force on a particle p_i from other
* particles.
*
* @param i The index of particle p_i
*
* @return vec_3d
* */
vec_3d total_force_particles(uint i);
/** @brief calculate the total force on a particle p_i.
*
* @param i The index of particle p_i
*
* @return vec_3d
* */
vec_3d total_force(uint i);
/** @brief Go forward one timestep using the RK4 method
*
* @param dt The step length
@ -202,8 +200,7 @@ public:
*
* @return simulation_t
* */
simulation_t simulate(double time, uint steps,
std::string method = "rk4",
simulation_t simulate(double time, uint steps, std::string method = "rk4",
bool particle_interaction = true);
/** @brief Simulate and write the displacement of all particles to files.
@ -214,8 +211,7 @@ public:
* @param method The method to use when moving forward a timestep
* @param particle_interaction Turn particle interactions on/off
* */
void write_simulation_to_dir(std::string path, double time,
uint steps,
void write_simulation_to_dir(std::string path, double time, uint steps,
std::string method = "rk4",
bool particle_interaction = true);
@ -232,6 +228,8 @@ public:
double fraction_of_particles_left(double time, uint steps,
std::string method = "rk4",
bool particle_interaction = true);
friend class PenningTrapTest;
};
#endif

2
include/constants.hpp
View File

@ -3,7 +3,7 @@
* @author Cory Alexander Balaton (coryab)
* @author Janita Ovidie Sandtrøen Willumsen (janitaws)
*
* @version 0.1
* @version 1.0
*
* @brief Library of constants
*

12
include/typedefs.hpp
View File

@ -18,23 +18,23 @@
#include <armadillo>
#include <vector>
/** @brief Typedef for a fixed 3d arma vector.
* */
typedef arma::vec::fixed<3> vec3;
/** @brief Typedef for the column of the result vector from simulating
* particles.
* */
typedef std::vector<arma::vec::fixed<3>> sim_cols;
typedef std::vector<vec3> sim_cols;
/** @brief Typedef for the row of the result vector from simulating particles.
* */
typedef std::vector<arma::vec::fixed<3>> sim_rows;
typedef std::vector<vec3> sim_rows;
/** @brief Typedef for the result of the simulate method.
* */
typedef std::vector<sim_cols> sim_arr;
/** @brief Typedef for a fixed 3d arma vector.
* */
typedef arma::vec::fixed<3> vec_3d;
/** @brief Typedef for PenningTrap::simulation return value.
* */
typedef struct simulation {