55 lines
853 B
Groff
55 lines
853 B
Groff
.TH "include/PenningTrap.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
include/PenningTrap.hpp \- A class for simulating a Penning trap\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <armadillo>\fP
|
|
.br
|
|
\fC#include 'constants\&.hpp'\fP
|
|
.br
|
|
\fC#include 'Particle\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBPenningTrap\fP"
|
|
.br
|
|
.RI "A class that simulates a Penning trap\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A class for simulating a Penning trap\&.
|
|
|
|
|
|
.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
|
|
Definition in file \fBPenningTrap\&.hpp\fP\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.
|