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

Update docs

Browse Source
This commit is contained in:
Cory Balaton
2023-10-02 21:52:25 +02:00
parent b9d39559ab
commit d759c6c8e4
26 changed files with 698 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
man_pages/man3/PenningTrap.3
View File

@@ -1,4 +1,4 @@
.TH "PenningTrap" 3 "Fri Sep 29 2023" "Penning Trap Simulation" \" -*- nroff -*-
.TH "PenningTrap" 3 "Mon Oct 2 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -52,6 +52,12 @@ PenningTrap \- A class that simulates a Penning trap\&.
.RI "void \fBevolve_forward_euler\fP (double dt)"
.br
.RI "Go forward one timestep using the forward Euler method\&. "
.ti -1c
.RI "arma::vec \fBget_particle\fP (int i)"
.br
.ti -1c
.RI "double \fBget_d\fP ()"
.br
.in -1c
.SS "Private Attributes"
@@ -95,55 +101,63 @@ Definition at line \fB26\fP of file \fBPenningTrap\&.cpp\fP\&.
.PP
Add a particle to the system\&.
.PP
Definition at line \fB31\fP of file \fBPenningTrap\&.cpp\fP\&.
Definition at line \fB33\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\&.
Definition at line \fB121\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\&.
Definition at line \fB116\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\&.
Definition at line \fB49\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\&.
Definition at line \fB38\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\&.
Definition at line \fB59\fP of file \fBPenningTrap\&.cpp\fP\&.
.SS "double PenningTrap::get_d ()"
.PP
Definition at line \fB142\fP of file \fBPenningTrap\&.cpp\fP\&.
.SS "arma::vec PenningTrap::get_particle (int i)"
.PP
Definition at line \fB137\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\&.
Definition at line \fB111\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\&.
Definition at line \fB74\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\&.
Definition at line \fB92\fP of file \fBPenningTrap\&.cpp\fP\&.
.SH "Member Data Documentation"
.PP
.SS "double PenningTrap::B_0\fC [private]\fP"