Navigation
Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
Version 1.0.4
Class Index
File List
Version 1.0.4dev
Publications
Hosted by
ParticleBase Class Reference
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 of particle [A/C]. | |
| double | qm () const |
| Return q/m ratio [C/kg]. | |
Protected Member Functions | |
| ParticleBase (double IQ, double q, double m) | |
| ~ParticleBase () | |
Protected Attributes | |
| particle_status_e | _status |
| Status of particle. | |
| double | _IQ |
| Current or charge of particle. | |
| double | _qm |
| Ratio q/m [C/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 | |||
| ) | [inline, protected] |
| ParticleBase::~ParticleBase | ( | ) | [inline, protected] |
Member Function Documentation
| particle_status_e ParticleBase::get_status | ( | ) | [inline] |
Return particle status.
| double ParticleBase::IQ | ( | ) | const [inline] |
Return current or charge of particle [A/C].
| double ParticleBase::qm | ( | ) | const [inline] |
Return q/m ratio [C/kg].
| void ParticleBase::set_status | ( | particle_status_e | status | ) | [inline] |
Set particle status.
Member Data Documentation
double ParticleBase::_IQ [protected] |
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.
double ParticleBase::_qm [protected] |
Ratio q/m [C/kg].
particle_status_e ParticleBase::_status [protected] |
Status of particle.
The documentation for this class was generated from the following file: