FieldDiagPlot Class Reference

Field diagnostics plot. More...

#include <fielddiagplot.hpp>

Inheritance diagram for FieldDiagPlot:

Public Member Functions
	FieldDiagPlot (Frame &frame, const Geometry &geom)
	Constructor for field diagnostics plot. More...
	~FieldDiagPlot ()
	Destructor for field diagnostics plot. More...
void	set_epot (const ScalarField *epot)
	Add pointer to electric potential. More...
void	set_efield (const VectorField *efield)
	Add pointer to electric field. More...
void	set_scharge (const ScalarField *scharge)
	Add pointer to space charge density map. More...
void	set_trajdens (const ScalarField *trajdens)
	Add pointer to trajectory density map. More...
void	set_bfield (const VectorField *bfield)
	Add pointer to magnetic field. More...
void	set_coordinates (size_t N, const Vec3D &x1, const Vec3D &x2)
	Set coordinates for field diagnostics. More...
const Vec3D &	start (void)
	Get start coordinates of diagnostic line. More...
const Vec3D &	end (void)
	Get end coordinates of diagnostic line. More...
const size_t &	N (void)
	Get number of steps on diagnostic line. More...
void	set_diagnostic (const field_diag_type_e diag[2], const field_loc_type_e loc[2])
	Set field and location plot types. More...
const field_diag_type_e &	get_diagnostic_type (int i)
	Get diagnostic type for y-axis i. More...
const field_loc_type_e &	get_location_type (int i)
	Get location type for x-axis i. More...
void	export_data (const std::string &filename) const
	Export plotted data as ASCII. More...
void	build_plot (void)
	Rebuild plot. More...

Detailed Description

Field diagnostics plot.

A class for building xy-plots of various fields in simulations.

Constructor & Destructor Documentation

FieldDiagPlot()

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

Constructor for field diagnostics plot.

~FieldDiagPlot()

FieldDiagPlot::~FieldDiagPlot

(

)

Destructor for field diagnostics plot.

Member Function Documentation

build_plot()

void FieldDiagPlot::build_plot

(

void

)

Rebuild plot.

end()

const Vec3D& FieldDiagPlot::end ( void  )

inline

Get end coordinates of diagnostic line.

export_data()

void FieldDiagPlot::export_data

(

const std::string &

filename

)

const

Export plotted data as ASCII.

get_diagnostic_type()

const field_diag_type_e& FieldDiagPlot::get_diagnostic_type ( int  i )

inline

Get diagnostic type for y-axis i.

get_location_type()

const field_loc_type_e& FieldDiagPlot::get_location_type ( int  i )

inline

Get location type for x-axis i.

N()

const size_t& FieldDiagPlot::N ( void  )

inline

Get number of steps on diagnostic line.

set_bfield()

void FieldDiagPlot::set_bfield ( const VectorField *  bfield )

inline

Add pointer to magnetic field.

set_coordinates()

void FieldDiagPlot::set_coordinates ( size_t  N, const Vec3D &  x1, const Vec3D &  x2  )

inline

Set coordinates for field diagnostics.

The fields to be plotted are evaluated at N steps from x1 to x2. The first point of the plot is exactly at x1 and the last at x2.

set_diagnostic()

void FieldDiagPlot::set_diagnostic ( const field_diag_type_e  diag[2], const field_loc_type_e  loc[2]  )

inline

Set field and location plot types.

The plot can have two x-axes and two y-axes. The diagnostic for y1-axis is set by diag[0] and the diagnostic for y2-axis by diag[1]. The x1-axis is defined by loc[0] and x2-axis by loc[1].

set_efield()

void FieldDiagPlot::set_efield ( const VectorField *  efield )

inline

Add pointer to electric field.

set_epot()

void FieldDiagPlot::set_epot ( const ScalarField *  epot )

inline

Add pointer to electric potential.

set_scharge()

void FieldDiagPlot::set_scharge ( const ScalarField *  scharge )

inline

Add pointer to space charge density map.

set_trajdens()

void FieldDiagPlot::set_trajdens ( const ScalarField *  trajdens )

inline

Add pointer to trajectory density map.

start()

const Vec3D& FieldDiagPlot::start ( void  )

inline

Get start coordinates of diagnostic line.

---

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

• fielddiagplot.hpp
• fielddiagplot.cpp