GTKPlotter Class Reference

GTK Plotter class. More...

#include <gtkplotter.hpp>

Public Member Functions
	GTKPlotter (int *argc, char ***argv)
	Constructor. More...
	~GTKPlotter ()
	Destructor. More...
void	run ()
	Run gtkplotter. More...
const std::vector< double > *	get_surface_triangle_data (void) const
	Get pointer to surface data. More...
const Geometry *	get_geometry (void) const
	Get pointer to geometry. More...
const EpotField *	get_epot (void) const
	Get pointer to electric potential. More...
const EpotEfield *	get_efield (void) const
	Get pointer to E-field. More...
const MeshScalarField *	get_scharge (void) const
	Get pointer to space charge density field. More...
const MeshScalarField *	get_trajdens (void) const
	Get pointer to trajectory density field. More...
const VectorField *	get_bfield (void) const
	Get pointer to B-field. More...
const ParticleDataBase *	get_particledatabase (void) const
	Get pointer to particle database. More...
void	set_surface_triangle_data (const std::vector< double > *data)
	Set surface data. More...
void	set_geometry (const Geometry *geom)
	Set pointer to geometry. More...
void	set_epot (const EpotField *epot)
	Set pointer to electric potential. More...
void	set_efield (const EpotEfield *efield)
	Set pointer to E-field. More...
void	set_scharge (const MeshScalarField *scharge)
	Set pointer to space charge density field. More...
void	set_trajdens (const MeshScalarField *tdens)
	Set pointer to trajectory density field. More...
void	set_bfield (const VectorField *bfield)
	Set pointer to B-field. More...
void	set_particledatabase (const ParticleDataBase *pdb)
	Set pointer to particle database. More...
bool	opengl (void) const
	Return if OpenGL has been initialized. More...
void	force_software_renderer (void) const
	Force the use of software renderer. More...
GTKWindow *	new_geometry_3d_plot_window (void)
	Create new 3D geometry plot window. More...
GTKWindow *	new_geometry_plot_window (void)
	Create new 2D geometry plot window. More...
GTKWindow *	new_particle_plot_window (coordinate_axis_e axis, double level, particle_diag_plot_type_e type, trajectory_diagnostic_e diagx, trajectory_diagnostic_e diagy)
	Create new particle plot window. More...
GTKWindow *	new_field_plot_window (size_t N, const Vec3D &x1, const Vec3D &x2, const field_diag_type_e diag[2], const field_loc_type_e loc[2])
	Create new field plot window. More...
void	delete_window (GTKWindow *window)
	Delete window. More...

Detailed Description

GTK Plotter class.

The GTKPlotter is the main simulation plotter class for interactive diagnostics.

Constructor & Destructor Documentation

GTKPlotter::GTKPlotter	(	int *	argc,
		char ***	argv
	)

Constructor.

GTKPlotter::~GTKPlotter

(

)

Destructor.

Member Function Documentation

void GTKPlotter::delete_window

(

GTKWindow *

window

)

Delete window.

void GTKPlotter::force_software_renderer

(

void

)

const

Force the use of software renderer.

By default the OpenGL renderer is used if it is available.

const VectorField * GTKPlotter::get_bfield

(

void

)

const

Get pointer to B-field.

const EpotEfield * GTKPlotter::get_efield

(

void

)

const

Get pointer to E-field.

const EpotField * GTKPlotter::get_epot

(

void

)

const

Get pointer to electric potential.

const Geometry * GTKPlotter::get_geometry

(

void

)

const

Get pointer to geometry.

const ParticleDataBase * GTKPlotter::get_particledatabase

(

void

)

const

Get pointer to particle database.

const MeshScalarField * GTKPlotter::get_scharge

(

void

)

const

Get pointer to space charge density field.

const std::vector< double > * GTKPlotter::get_surface_triangle_data

(

void

)

const

Get pointer to surface data.

const MeshScalarField * GTKPlotter::get_trajdens

(

void

)

const

Get pointer to trajectory density field.

GTKWindow * GTKPlotter::new_field_plot_window	(	size_t	N,
		const Vec3D &	x1,
		const Vec3D &	x2,
		const field_diag_type_e	diag[2],
		const field_loc_type_e	loc[2]
	)

Create new field plot window.

GTKWindow * GTKPlotter::new_geometry_3d_plot_window

(

void

)

Create new 3D geometry plot window.

GTKWindow * GTKPlotter::new_geometry_plot_window

(

void

)

Create new 2D geometry plot window.

GTKWindow * GTKPlotter::new_particle_plot_window	(	coordinate_axis_e	axis,
		double	level,
		particle_diag_plot_type_e	type,
		trajectory_diagnostic_e	diagx,
		trajectory_diagnostic_e	diagy
	)

Create new particle plot window.

bool GTKPlotter::opengl

(

void

)

const

Return if OpenGL has been initialized.

void GTKPlotter::run

(

void

)

Run gtkplotter.

Returns when all gtk windows are closed.

void GTKPlotter::set_bfield

(

const VectorField *

bfield

)

Set pointer to B-field.

void GTKPlotter::set_efield

(

const EpotEfield *

efield

)

Set pointer to E-field.

void GTKPlotter::set_epot

(

const EpotField *

epot

)

Set pointer to electric potential.

void GTKPlotter::set_geometry

(

const Geometry *

geom

)

Set pointer to geometry.

void GTKPlotter::set_particledatabase

(

const ParticleDataBase *

pdb

)

Set pointer to particle database.

void GTKPlotter::set_scharge

(

const MeshScalarField *

scharge

)

Set pointer to space charge density field.

void GTKPlotter::set_surface_triangle_data

(

const std::vector< double > *

data

)

Set surface data.

void GTKPlotter::set_trajdens

(

const MeshScalarField *

tdens

)

Set pointer to trajectory density field.

---

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

• gtkplotter.hpp
• gtkplotter.cpp