Initial source

include/PenningTrap.hpp

@@ -0,0 +1,80 @@
+/** @file PenningTrap.hpp
+ *
+ *  @author Cory Alexander Balaton (coryab)
+ *  @author Janita Ovidie Sandtrøen Willumsen (janitaws)
+ *
+ *  @version 0.1
+ *
+ *  @brief A class for simulating a Penning trap.
+ *
+ *  @bug No known bugs
+ * */
+#ifndef __PENNING_TRAP__
+#define __PENNING_TRAP__
+
+#include <armadillo>
+
+#include "constants.hpp"
+#include "Particle.hpp"
+
+/** @brief 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.
+ * */
+class PenningTrap {
+private:
+    double B_0; ///< Magnetic field strength
+    double V_0; ///< Applied potential
+    double d; ///< Characteristic dimension
+    std::vector<Particle> particles; ///< The particles in the Penning trap
+
+public:
+    /** @brief Set B_0, V_0 and d.
+     * */
+    PenningTrap(double B_0 = T, double V_0 = 25.*V/1000., double d = 500.);
+
+    /** @brief Add a particle to the system
+     * */
+    void add_particle(Particle particle);
+
+    /** @brief Calculate E at point r
+     * */
+    arma::vec external_E_field(arma::vec r);
+
+    /** @brief Calculate B at point r
+     * */
+    arma::vec external_B_field(arma::vec r);
+
+    /** @brief Calculate the force between 2 particles.
+     *
+     *  @details Calculate the force exhibited on particle p_i from 
+     *  particle p_j.
+     * */
+    arma::vec force_on_particle(int i, int 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.
+     * */
+    arma::vec total_force_external(int i);
+
+    /** @brief Calculate the total force on a particle from other particles.
+     * */
+    arma::vec total_force_particles(int i);
+
+    /** @brief calculate the total force on a particle.
+     * */ 
+    arma::vec total_force(int i);
+
+    /** @brief Go forward one timestep using the RK4 method
+     * */
+    void evolve_RK4(double dt);
+
+    /** @brief Go forward one timestep using the forward Euler method
+     * */
+    void evolve_forward_euler(double dt);
+};
+
+#endif