Particle base class
More...
#include <particles.hpp>
Public Member Functions |
particle_status_e | get_status () |
| Return particle status.
|
void | set_status (particle_status_e status) |
| Set particle status.
|
double | IQ () const |
| Return current or charge carried by trajectory or particle cloud [A/C].
|
double | q () const |
| Return particle charge (q) [C].
|
double | m () const |
| Return particle mass (m) [kg].
|
double | qm () const |
| Return charge per mass ratio (q/m) [C/kg].
|
void | save (std::ostream &s) const |
| Saves data to stream.
|
Protected Attributes |
particle_status_e | _status |
| Status of particle.
|
double | _IQ |
| Current or charge of particle.
|
double | _q |
| Charge q [C].
|
double | _m |
| Mass m [kg].
|
Detailed Description
Particle base class
A parent class for common (non-templated) parts of Particle classes.
Constructor & Destructor Documentation
ParticleBase::ParticleBase |
( |
double |
IQ, |
|
|
double |
q, |
|
|
double |
m |
|
) |
| |
|
inlineprotected |
ParticleBase::ParticleBase |
( |
std::istream & |
s | ) |
|
|
inlineprotected |
Constructor for loading particle from a file.
ParticleBase::~ParticleBase |
( |
| ) |
|
|
inlineprotected |
Member Function Documentation
double ParticleBase::IQ |
( |
| ) |
const |
|
inline |
Return current or charge carried by trajectory or particle cloud [A/C].
With MODE_2D, this in A/m or C/m.
double ParticleBase::m |
( |
void |
| ) |
const |
|
inline |
Return particle mass (m) [kg].
double ParticleBase::q |
( |
| ) |
const |
|
inline |
Return particle charge (q) [C].
double ParticleBase::qm |
( |
| ) |
const |
|
inline |
Return charge per mass ratio (q/m) [C/kg].
void ParticleBase::save |
( |
std::ostream & |
s | ) |
const |
|
inline |
Member Data Documentation
Current or charge of particle.
The sign is forced to be same as the sign of q/m.
In time-dependent simulations particles are localized and IQ is charge, in time-independent simulation IQ is current. In case of 2D simulations this is in units A/m or C/m. In 3D and cylindrically symmetric simulations unit is A or C.
The documentation for this class was generated from the following file: