Geometry plotter class. More...

#include <geomplot.hpp>

Inheritance diagram for GeomPlot:

Public Member Functions
	GeomPlot (Frame &frame, const Geometry &geom)
	Constructor for new geometry plot. More...

	~GeomPlot ()
	Destructor for geometry plotter. More...

void	build_plot (void)
	Rebuild plot. More...

void	disable_cache (void)
	Disable plotting caches from use. More...

void	set_epot (const EpotField *epot)

void	set_eqlines_manual (const std::vector< double > &pot)
	Set a vector of manual equipotential lines. More...

std::vector< double >	get_eqlines_manual (void) const
	Get a vector of manual equipotential lines. More...

void	set_eqlines_auto (uint32_t N)
	Set the number of automatic equipotential lines. More...

uint32_t	get_eqlines_auto (void) const
	Get the number of automatic equipotential lines. More...

void	set_bfield (const VectorField *bfield)
	Set magnetic field. More...

const VectorField *	get_bfield (void) const
	Get magnetic field. More...

void	set_efield (const VectorField *efield)
	Set electric field. More...

const VectorField *	get_efield (void) const
	Get electric field. More...

void	set_trajdens (const MeshScalarField *tdens)
	Set trajectory density field. More...

const MeshScalarField *	get_trajdens (void) const
	Get trajectory density field. More...

void	set_scharge (const MeshScalarField *scharge)
	Set space charge density field. More...

const MeshScalarField *	get_scharge (void) const
	Get space charge density field. More...

void	set_fieldgraph_plot (field_type_e fieldplot)
	Set field graph plotting type. More...

const FieldGraph *	fieldgraph (void) const
	Get field graph object. More...

FieldGraph *	fieldgraph (void)
	Get field graph object. More...

void	enable_colormap_legend (bool enable)
	Set colormap legend enable/disable. More...

void	set_particle_database (const ParticleDataBase *pdb)
	Set particle database used for particle plotting. More...

void	set_particledatabase (const ParticleDataBase *pdb)
	Set particle database used for particle plotting. More...

void	set_particle_div (uint32_t particle_div, uint32_t particle_offset=0)
	Set particle divisor and offset. More...

uint32_t	get_particle_div (void) const
	Get particle divisor. More...

uint32_t	get_particle_offset (void) const
	Get particle offset. More...

void	set_qm_discretation (bool enable)
	Set q/m particle discretation. More...

bool	get_qm_discretation (void) const
	Get q/m particle discretation. More...

void	set_mesh (bool enable)
	Set mesh plotting. More...

bool	get_mesh (void) const
	Get mesh plotting. More...

void	set_view (view_e view, int level=-1)
	Set view. More...

void	set_view_si (view_e view, double level)
	Set view in SI units. More...

view_e	get_view (void) const
	Get view. More...

int	get_level (void) const
	Get level of view in mesh squares. More...

double	get_level_si (void) const
	Get level of view in SI units. More...

int	vb (int i) const
	Get component i of view base vector. More...

void	get_vb (int vb[3]) const
	Get the view base vector. More...

Detailed Description

Geometry plotter class.

Collection of graphs for building Geometry plots containing solids, equipotential lines, space charge field, particle trajectories and mesh lines. Uses Fieldgraph, SolidGraph, EqPotGraph, ParticleGraph and MeshGraph for plotting.

Constructor & Destructor Documentation

GeomPlot::GeomPlot	(	Frame &	frame,
		const Geometry &	geom
	)

Constructor for new geometry plot.

Builds a new geometry plot in the plot frame. Default graph (SolidGraph) is added to the plot and view is set as XY-view. The default plane of view is the midplane for 3D geometries and 0 for others.

GeomPlot::~GeomPlot ( )

Destructor for geometry plotter.

Member Function Documentation

void GeomPlot::build_plot ( void )

Rebuild plot.

void GeomPlot::disable_cache ( void )

Disable plotting caches from use.

Used by the interactive plotter.

void GeomPlot::enable_colormap_legend ( bool enable )

inline

Set colormap legend enable/disable.

const FieldGraph* GeomPlot::fieldgraph ( void ) const

inline

Get field graph object.

FieldGraph* GeomPlot::fieldgraph ( void )

inline

Get field graph object.

const VectorField* GeomPlot::get_bfield ( void ) const

inline

Get magnetic field.

const VectorField* GeomPlot::get_efield ( void ) const

inline

Get electric field.

uint32_t GeomPlot::get_eqlines_auto ( void ) const

inline

Get the number of automatic equipotential lines.

std::vector<double> GeomPlot::get_eqlines_manual ( void ) const

inline

Get a vector of manual equipotential lines.

int GeomPlot::get_level ( void ) const

inline

Get level of view in mesh squares.

double GeomPlot::get_level_si ( void ) const

inline

Get level of view in SI units.

bool GeomPlot::get_mesh ( void ) const

inline

Get mesh plotting.

uint32_t GeomPlot::get_particle_div ( void ) const

inline

Get particle divisor.

uint32_t GeomPlot::get_particle_offset ( void ) const

inline

Get particle offset.

bool GeomPlot::get_qm_discretation ( void ) const

inline

Get q/m particle discretation.

const MeshScalarField* GeomPlot::get_scharge ( void ) const

inline

Get space charge density field.

const MeshScalarField* GeomPlot::get_trajdens ( void ) const

inline

Get trajectory density field.

void GeomPlot::get_vb ( int vb[3] ) const

inline

Get the view base vector.

view_e GeomPlot::get_view ( void ) const

inline

Get view.

void GeomPlot::set_bfield ( const VectorField * bfield )

Set magnetic field.

void GeomPlot::set_efield ( const VectorField * efield )

Set electric field.

void GeomPlot::set_eqlines_auto ( uint32_t N )

Set the number of automatic equipotential lines.

The automatic lines are plotted at potentials pot = min + (i+0.5)*(max-min)/N ), where i is running from 0 to N and min is the minimum potential in the system and max is the maximum potential in the system.

void GeomPlot::set_eqlines_manual ( const std::vector< double > & pot )

Set a vector of manual equipotential lines.

void GeomPlot::set_fieldgraph_plot ( field_type_e fieldplot )

Set field graph plotting type.

void GeomPlot::set_mesh ( bool enable )

Set mesh plotting.

If enabled, the mesh squares are plotted. Mesh plotting is disabled by default.

void GeomPlot::set_particle_database ( const ParticleDataBase * pdb )

inline

Set particle database used for particle plotting.

void GeomPlot::set_particle_div	(	uint32_t	particle_div,
		uint32_t	particle_offset = `0`
	)

Set particle divisor and offset.

Set particle_div to zero for no plotting, one for plotting every particle, two for plotting every second particle, three for plotting every third particle, etc. Defaults to

Plotter skips the first particle_offset particles.

void GeomPlot::set_particledatabase ( const ParticleDataBase * pdb )

Set particle database used for particle plotting.

void GeomPlot::set_qm_discretation ( bool enable )

Set q/m particle discretation.

If enabled, the different q/m values will be plotted with different colors. Otherwise, all particles are plotted with same color.

void GeomPlot::set_scharge ( const MeshScalarField * scharge )

Set space charge density field.

void GeomPlot::set_trajdens ( const MeshScalarField * tdens )

Set trajectory density field.

void GeomPlot::set_view	(	view_e	view,
		int	level = `-1`
	)

Set view.

Sets the viewplane to the geometry. The viewplane is set by direction view and depth level set as mesh level. Level is checked and limited to existing levels. Level -1 (default) means half the range (midplane).

void GeomPlot::set_view_si	(	view_e	view,
		double	level
	)

Set view in SI units.

Sets the viewplane to the geometry. The viewplane is set by direction view and depth level set as coordinates in SI units. The level is limited to existing values.

int GeomPlot::vb ( int i ) const

inline

Get component i of view base vector.

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

Navigation

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation