67 lines
1021 B
Groff
67 lines
1021 B
Groff
.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\&.
|