IMP::atom::Charged Class Reference

Detailed Description

A decorator for a point particle that has an electrostatic charge.

The charge itself should be given in atomic units; i.e. the charge on a proton is +1 and on an electron, -1.

Inheritance diagram for IMP::atom::Charged:


Public Member Functions
	Charged (::IMP::Particle *p)
Float	get_charge () const
void	set_charge (Float t)
Static Public Member Functions
static Charged	decorate_particle (::IMP::Particle *p)
static FloatKey	get_charge_key ()
static bool	particle_is_instance (Particle *p)
	Return true if the particle is an instance of a Charged.
static Charged	setup_particle (Particle *p, Float charge=0)
static Charged	setup_particle (Particle *p, const algebra::VectorD< 3 > &v, Float charge)

static Charged IMP::atom::Charged::setup_particle	(	Particle *	p,
		Float	charge = `0`
	)			`[static]`

Create a decorator with the passed charge. The particle is assumed to already have x,y,z attributes.

static Charged IMP::atom::Charged::setup_particle	(	Particle *	p,
		const algebra::VectorD< 3 > &	v,
		Float	charge
	)			`[static]`

Create a decorator with the passed coordinates and charge.

The documentation for this class was generated from the following files: