# Penning Trap Simulation: include/PenningTrap.hpp Source File

Loading...
Searching...
No Matches
PenningTrap.hpp
Go to the documentation of this file.
#ifndef __PENNING_TRAP__
#define __PENNING_TRAP__
#include <armadillo>
#include <omp.h>
#include "Particle.hpp"
#include "constants.hpp"
#include "typedefs.hpp"
#pragma omp declare reduction(+ : vec_3d : omp_out += omp_in) \
initializer(omp_priv = omp_orig)
class PenningTrap {
private:
double B_0;
std::function<double(double)> V_0;
double d;
double t;
std::vector<Particle> particles;
sim_arr k_v;
sim_arr k_r;
vec_3d v_func(unsigned int i, unsigned int j, double dt);
vec_3d r_func(unsigned int i, unsigned int j, double dt);
public:
PenningTrap(
double B_0 = T,
std::function<double(double)> V_0 =
[](double t) { return 25. * V / 1000.; },
double d = 500., double t = 0.);
PenningTrap(
unsigned int i, double B_0 = T,
std::function<double(double)> V_0 =
[](double t) { return 25. * V / 1000.; },
double d = 500., double t = 0.);
PenningTrap(
std::vector<Particle> particles, double B_0 = T,
std::function<double(double)> V_0 =
[](double t) { return 25. * V / 1000.; },
double d = 500., double t = 0.);
void add_particle(Particle particle);
vec_3d external_E_field(vec_3d r);
vec_3d external_B_field(vec_3d r);
vec_3d force_on_particle(unsigned int i, unsigned int j);
vec_3d total_force_external(unsigned int i);
vec_3d total_force_particles(unsigned int i);
vec_3d total_force(unsigned int i);
void evolve_RK4(double dt, bool particle_interaction = true);
void evolve_forward_euler(double dt, bool particle_interaction = true);
sim_arr simulate(double time, unsigned int steps,
std::string method = "rk4",
bool particle_interaction = true);
void write_simulation_to_dir(std::string path, double time,
unsigned int steps, std::string method = "rk4",
bool particle_interaction = true);
double fraction_of_particles_left(double time, unsigned int steps,
std::string method = "rk4",
bool particle_interaction = true);
};
#endif
Particle.hpp
A class that holds the properties of a particle.
Particle
A class that holds attributes of a particle.
Definition: Particle.hpp:21
PenningTrap
A class that simulates a Penning trap.
Definition: PenningTrap.hpp:30
PenningTrap::particles
std::vector< Particle > particles
The particles in the Penning trap.
Definition: PenningTrap.hpp:36
PenningTrap::fraction_of_particles_left
double fraction_of_particles_left(double time, unsigned int steps, std::string method="rk4", bool particle_interaction=true)
Simulate and calculate what fraction of particles are still left inside the Penning trap after the si...
Definition: PenningTrap.cpp:266
PenningTrap::B_0
double B_0
Magnetic field strength.
Definition: PenningTrap.hpp:32
PenningTrap::external_E_field
vec_3d external_E_field(vec_3d r)
Calculate E at point r.
Definition: PenningTrap.cpp:87
PenningTrap::total_force
vec_3d total_force(unsigned int i)
calculate the total force on a particle p_i.
Definition: PenningTrap.cpp:146
PenningTrap::k_r
sim_arr k_r
Definition: PenningTrap.hpp:39
PenningTrap::evolve_RK4
void evolve_RK4(double dt, bool particle_interaction=true)
Go forward one timestep using the RK4 method.
Definition: PenningTrap.cpp:151
PenningTrap::r_func
vec_3d r_func(unsigned int i, unsigned int j, double dt)
Helper for evolve_RK4 when calculating values.
Definition: PenningTrap.cpp:64
PenningTrap::total_force_particles
vec_3d total_force_particles(unsigned int i)
Calculate the total force on a particle p_i from other particles.
Definition: PenningTrap.cpp:129
PenningTrap::simulate
sim_arr simulate(double time, unsigned int steps, std::string method="rk4", bool particle_interaction=true)
Simulate the particle system inside the Penning trap over a certain amount of time.
Definition: PenningTrap.cpp:211
PenningTrap::d
double d
Characteristic dimension.
Definition: PenningTrap.hpp:34
PenningTrap::add_particle
void add_particle(Particle particle)
Add a particle to the system.
Definition: PenningTrap.cpp:82
PenningTrap::t
double t
Current time.
Definition: PenningTrap.hpp:35
PenningTrap::force_on_particle
vec_3d force_on_particle(unsigned int i, unsigned int j)
Calculate the force between 2 particles.
Definition: PenningTrap.cpp:100
PenningTrap::V_0
std::function< double(double)> V_0
Applied potential.
Definition: PenningTrap.hpp:33
PenningTrap::evolve_forward_euler
void evolve_forward_euler(double dt, bool particle_interaction=true)
Go forward one timestep using the forward Euler method.
Definition: PenningTrap.cpp:186
PenningTrap::write_simulation_to_dir
void write_simulation_to_dir(std::string path, double time, unsigned int steps, std::string method="rk4", bool particle_interaction=true)
Simulate and write the displacement of all particles to files.
Definition: PenningTrap.cpp:240
PenningTrap::external_B_field
vec_3d external_B_field(vec_3d r)
Calculate B at point r.
Definition: PenningTrap.cpp:95
PenningTrap::total_force_external
vec_3d total_force_external(unsigned int i)
Calculate the total external force on a particle.
Definition: PenningTrap.cpp:114
PenningTrap::k_v
sim_arr k_v
Definition: PenningTrap.hpp:37
PenningTrap::v_func
vec_3d v_func(unsigned int i, unsigned int j, double dt)
Helper for evolve_RK4 when calculating values.
Definition: PenningTrap.cpp:46
constants.hpp
Library of constants.
T
#define T
1 Tesla. unit:
Definition: constants.hpp:17
V
#define V
1 Volt. unit:
Definition: constants.hpp:19
typedefs.hpp
Useful typedefs for cleaner code.
vec_3d
arma::vec::fixed< 3 > vec_3d
Typedef for a fixed 3d arma vector.
Definition: typedefs.hpp:36
sim_arr
std::vector< sim_cols > sim_arr
Typedef for the result of the simulate method.
Definition: typedefs.hpp:32