GeomPlot Class Reference

Geometry plotter class. More...

#include <geomplot.hpp>

Inheritance diagram for GeomPlot:

GeomPlotter List of all members.

Public Member Functions

 GeomPlot (Frame *frame, const Geometry *geom)
 Constructor for new geometry plot.
 ~GeomPlot ()
void disable_cache (void)
void set_epot (const ScalarField *epot)
void set_eqlines_manual (const std::vector< double > &pot)
std::vector< double > get_eqlines_manual (void)
void set_eqlines_auto (size_t N)
size_t get_eqlines_auto (void)
void set_bfield (const VectorField *bfield)
 Set magnetic field.
void set_scharge (const ScalarField *scharge)
void set_scharge_field (bool enable)
bool get_scharge_field (void)
void set_particle_database (const ParticleDataBase *pdb)
void set_particledatabase (const ParticleDataBase *pdb)
void set_particle_div (size_t particle_div)
size_t get_particle_div (void)
void set_qm_discretation (bool enable)
bool get_qm_discretation (void)
void set_mesh (bool enable)
bool get_mesh (void)
void set_view (view_e view, int level=-1)
 Set view.
view_e get_view (void) const
int get_level (void) const
double get_level_si (void) const
int vb (int i) const
void get_vb (int vb[3]) const

Detailed Description

Geometry plotter class.


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 (  ) 


Member Function Documentation

void GeomPlot::disable_cache ( void   ) 

size_t GeomPlot::get_eqlines_auto ( void   )  [inline]

std::vector<double> GeomPlot::get_eqlines_manual ( void   )  [inline]

int GeomPlot::get_level ( void   )  const [inline]

double GeomPlot::get_level_si ( void   )  const [inline]

bool GeomPlot::get_mesh ( void   )  [inline]

size_t GeomPlot::get_particle_div ( void   )  [inline]

bool GeomPlot::get_qm_discretation ( void   )  [inline]

bool GeomPlot::get_scharge_field ( void   )  [inline]

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

view_e GeomPlot::get_view ( void   )  const [inline]

void GeomPlot::set_bfield ( const VectorField bfield  ) 

Set magnetic field.

Saves a pointer to the magnetic field data in the geometry plot. Does not enable plotting of the magnetic field by default. NOTE: Plotting of the magnetic field is not implemented yet.

void GeomPlot::set_epot ( const ScalarField epot  ) 

void GeomPlot::set_eqlines_auto ( size_t  N  ) 

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

void GeomPlot::set_mesh ( bool  enable  ) 

void GeomPlot::set_particle_database ( const ParticleDataBase pdb  )  [inline]

void GeomPlot::set_particle_div ( size_t  particle_div  ) 

void GeomPlot::set_particledatabase ( const ParticleDataBase pdb  ) 

void GeomPlot::set_qm_discretation ( bool  enable  ) 

void GeomPlot::set_scharge ( const ScalarField scharge  ) 

void GeomPlot::set_scharge_field ( bool  enable  ) 

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).

int GeomPlot::vb ( int  i  )  const [inline]


The documentation for this class was generated from the following file:
Generated on Thu Apr 21 13:39:22 2011 for IBSimu by  doxygen 1.4.7