particles.hpp File Reference

Particle and particle point objects. More...

#include <vector>
#include <gsl/gsl_errno.h>
#include "geometry.hpp"
#include "scalarfield.hpp"
#include "vectorfield.hpp"
#include "efield.hpp"
#include "vec3d.hpp"

Go to the source code of this file.

Classes
class	ParticlePBase
	Particle point base class More...
class	ParticleP2D
	Particle point class for 2D. More...
class	ParticlePCyl
	Particle point class for cylindrical coordinates. More...
class	ParticleP3D
	Particle point class for 3D. More...
class	ParticleBase
	Particle base class More...
class	Particle< PP >
	Particle class in some geometry. More...
struct	ParticleIteratorData
	Temporary data bundle for particle iterators. More...
Defines
#define	PARTICLES_HPP   1
#define	IBSIMU_DERIV_ERROR   201
#define	MASS_U   1.66053873e-27
#define	CHARGE_E   1.602176462e-19
Typedefs
typedef Particle< ParticleP2D >	Particle2D
	Particle class in 2D.
typedef Particle< ParticlePCyl >	ParticleCyl
	Particle class in Cylindrical symmetry.
typedef Particle< ParticleP3D >	Particle3D
	Particle class in 3D.
Enumerations
enum	particle_status_e {   PARTICLE_OK = 0, PARTICLE_OUT, PARTICLE_COLL, PARTICLE_BADDEF,   PARTICLE_TIME, PARTICLE_NSTP }
	Particle status enum. More...
Functions
std::ostream &	operator<< (std::ostream &os, const ParticleP2D &pp)
ParticleP2D	operator * (double x, const ParticleP2D &pp)
std::ostream &	operator<< (std::ostream &os, const ParticlePCyl &pp)
ParticlePCyl	operator * (double x, const ParticlePCyl &pp)
std::ostream &	operator<< (std::ostream &os, const ParticleP3D &pp)
ParticleP3D	operator * (double x, const ParticleP3D &pp)

---

Detailed Description

Particle and particle point objects.

---

Define Documentation

#define CHARGE_E   1.602176462e-19

#define IBSIMU_DERIV_ERROR   201

#define MASS_U   1.66053873e-27

#define PARTICLES_HPP   1

---

Typedef Documentation

typedef Particle<ParticleP2D> Particle2D

Particle class in 2D.

A typedef for templated class Particle.

typedef Particle<ParticleP3D> Particle3D

Particle class in 3D.

A typedef for templated class Particle.

typedef Particle<ParticlePCyl> ParticleCyl

Particle class in Cylindrical symmetry.

A typedef for templated class Particle.

---

Enumeration Type Documentation

enum particle_status_e

Particle status enum.

Particle status can be either OK (PARTICLE_OK), out of geometry (PARTICLE_OUT), collided (PARTICLE_COLL), badly defined (PARTICLE_BADDEF), simulated to time limit (PARTICLE_TIME) or simulated to step limit (PARTICLE_NSTP).

Enumerator:

PARTICLE_OK
PARTICLE_OUT
PARTICLE_COLL
PARTICLE_BADDEF
PARTICLE_TIME
PARTICLE_NSTP

---

Function Documentation

ParticleP3D operator *	(	double	x,
		const ParticleP3D &	pp
	)			[inline]

ParticlePCyl operator *	(	double	x,
		const ParticlePCyl &	pp
	)			[inline]

ParticleP2D operator *	(	double	x,
		const ParticleP2D &	pp
	)			[inline]

std::ostream& operator<<	(	std::ostream &	os,
		const ParticleP3D &	pp
	)			[inline]

std::ostream& operator<<	(	std::ostream &	os,
		const ParticlePCyl &	pp
	)			[inline]

std::ostream& operator<<	(	std::ostream &	os,
		const ParticleP2D &	pp
	)			[inline]

---