elec::World Class Reference

#include <elecWorld.hpp>

Public Member Functions
	World ()
	anode ({0, 0}, 0, 1)
	ddp (0)
void	set_generator (const elec::Point &cathode_pos, const elec::Point &anode_pos, double radius, double voltage)
const std::list< elec::Particle > &	particles ()
World &	operator+= (elec::conductor::Metal &conductor)
void	add_electron (const elec::Point &pos)
void	add_proton (const elec::Point &pos)
void	add_protons ()
void	add_electrons (unsigned int nb)
void	end_of_particles ()
unsigned int	nb_protons ()
void	sim (double dt, unsigned int nb_splits)

Detailed Description

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

Constructor & Destructor Documentation

elec::World::World ( )

inline

Member Function Documentation

void elec::World::add_electron ( const elec::Point &  pos )

inline

Examples:

example-002-dynamics.cpp.

void elec::World::add_electrons ( unsigned int  nb )

inline

Added electrons are randomly placed inside the conductors added since last call of end_of_particles().

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

void elec::World::add_proton ( const elec::Point &  pos )

inline

void elec::World::add_protons ( )

inline

This adds the protons corresponding to the conductors added since last call of end_of_particles().

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

elec::World::anode	(	{0, 0}	,
		0	,
		1
	)

elec::World::ddp ( 0  )

inline

void elec::World::end_of_particles ( )

inline

The ends a bench of particule additions.

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

unsigned int elec::World::nb_protons ( )

inline

Returns

The number of added protons since last call of end_of_particles().

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

World& elec::World::operator+= ( elec::conductor::Metal &  conductor )

inline

This adds a conductor in the simulation. The order is important. A position belongs to the firstly added element, when elements overlap.

const std::list<elec::Particle>& elec::World::particles ( )

inline

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

void elec::World::set_generator ( const elec::Point &  cathode_pos, const elec::Point &  anode_pos, double  radius, double  voltage  )

inline

Ths adds a generator in the world. Only a single one is allowed.

Examples:

example-003-generator.cpp.

void elec::World::sim ( double  dt, unsigned int  nb_splits  )

inline

This performs one simulation step.

Parameters

dt	use 1 for a reguar simulation.
nb_splits	controls the simulation smoothness.

Examples:

example-002-dynamics.cpp, and example-003-generator.cpp.

---

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

• elecWorld.hpp