Navigation
Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
Version 1.0.5new_solver
Version 1.0.5dev
Class Index
File List
Version 1.0.5b
Version 1.0.4dev
Version 1.0.4
Publications
Hosted by
FieldDiagPlot Class Reference
Field diagnostics plot. More...
#include <fielddiagplot.hpp>
Public Member Functions | |
| FieldDiagPlot (Frame &frame, const Geometry &geom) | |
| Constructor for field diagnostics plot. | |
| ~FieldDiagPlot () | |
| Destructor for field diagnostics plot. | |
| void | set_epot (const ScalarField *epot) |
| Add pointer to electric potential. | |
| void | set_efield (const VectorField *efield) |
| Add pointer to electric field. | |
| void | set_scharge (const ScalarField *scharge) |
| Add pointer to space charge density map. | |
| void | set_bfield (const VectorField *bfield) |
| Add pointer to magnetic field. | |
| void | set_coordinates (size_t N, const Vec3D &x1, const Vec3D &x2) |
| Set coordinates for field diagnostics. | |
| const Vec3D & | start (void) |
| Get start coordinates of diagnostic line. | |
| const Vec3D & | end (void) |
| Get end coordinates of diagnostic line. | |
| const size_t & | N (void) |
| Get number of steps on diagnostic line. | |
| void | set_diagnostic (const field_diag_type_e diag[2], const field_loc_type_e loc[2]) |
| Set field and location plot types. | |
| const field_diag_type_e & | get_diagnostic_type (int i) |
| Get diagnostic type for y-axis i. | |
| const field_loc_type_e & | get_location_type (int i) |
| Get location type for x-axis i. | |
| void | export_data (const std::string &filename) const |
| Export plotted data as ASCII. | |
| void | build_plot (void) |
| Rebuild plot. | |
Detailed Description
Field diagnostics plot.
A class for building xy-plots of various fields in simulations.
Constructor & Destructor Documentation
Constructor for field diagnostics plot.
| FieldDiagPlot::~FieldDiagPlot | ( | ) |
Destructor for field diagnostics plot.
Member Function Documentation
| void FieldDiagPlot::build_plot | ( | void | ) |
Rebuild plot.
| const Vec3D& FieldDiagPlot::end | ( | void | ) | [inline] |
Get end coordinates of diagnostic line.
| void FieldDiagPlot::export_data | ( | const std::string & | filename | ) | const |
Export plotted data as ASCII.
| const field_diag_type_e& FieldDiagPlot::get_diagnostic_type | ( | int | i | ) | [inline] |
Get diagnostic type for y-axis i.
| const field_loc_type_e& FieldDiagPlot::get_location_type | ( | int | i | ) | [inline] |
Get location type for x-axis i.
| const size_t& FieldDiagPlot::N | ( | void | ) | [inline] |
Get number of steps on diagnostic line.
| void FieldDiagPlot::set_bfield | ( | const VectorField * | bfield | ) | [inline] |
Add pointer to magnetic field.
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.
| 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].
| void FieldDiagPlot::set_efield | ( | const VectorField * | efield | ) | [inline] |
Add pointer to electric field.
| void FieldDiagPlot::set_epot | ( | const ScalarField * | epot | ) | [inline] |
Add pointer to electric potential.
| void FieldDiagPlot::set_scharge | ( | const ScalarField * | scharge | ) | [inline] |
Add pointer to space charge density map.
| const Vec3D& FieldDiagPlot::start | ( | void | ) | [inline] |
Get start coordinates of diagnostic line.
The documentation for this class was generated from the following file: