.TH "Particle" 3 "Mon Oct 2 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Particle \- A class that holds attributes of a particle\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Particle\&.hpp>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBParticle\fP (double \fBq\fP, double \fBm\fP, arma::vec::fixed< 3 > \fBr_vec\fP, arma::vec::fixed< 3 > \fBv_vec\fP)"
.br
.RI "Initialize the particle\&. "
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "double \fBq\fP"
.br
.RI "Charge\&. "
.ti -1c
.RI "double \fBm\fP"
.br
.RI "Mass\&. "
.ti -1c
.RI "arma::vec::fixed< 3 > \fBr_vec\fP"
.br
.RI "position "
.ti -1c
.RI "arma::vec::fixed< 3 > \fBv_vec\fP"
.br
.RI "velocity "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBPenningTrap\fP"
.br
.RI "Make private attributes available for \fBPenningTrap\fP\&. "
.in -1c
.SH "Detailed Description"
.PP 
A class that holds attributes of a particle\&. 
.PP
Definition at line \fB19\fP of file \fBParticle\&.hpp\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Particle::Particle (double q, double m, arma::vec::fixed< 3 > r_vec, arma::vec::fixed< 3 > v_vec)"

.PP
Initialize the particle\&. Initialize the particle with a charge, mass, position and velocity\&. 
.PP
Definition at line \fB16\fP of file \fBParticle\&.cpp\fP\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "friend class \fBPenningTrap\fP\fC [friend]\fP"

.PP
Make private attributes available for \fBPenningTrap\fP\&. 
.PP
Definition at line \fB38\fP of file \fBParticle\&.hpp\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "double Particle::m\fC [private]\fP"

.PP
Mass\&. 
.PP
Definition at line \fB22\fP of file \fBParticle\&.hpp\fP\&.
.SS "double Particle::q\fC [private]\fP"

.PP
Charge\&. 
.PP
Definition at line \fB21\fP of file \fBParticle\&.hpp\fP\&.
.SS "arma::vec::fixed<3> Particle::r_vec\fC [private]\fP"

.PP
position 
.PP
Definition at line \fB23\fP of file \fBParticle\&.hpp\fP\&.
.SS "arma::vec::fixed<3> Particle::v_vec\fC [private]\fP"

.PP
velocity 
.PP
Definition at line \fB24\fP of file \fBParticle\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.