StaticElement Class Reference

Generic static element that generates fields/occupies space. More...

#include <statics.hpp>

Inheritance diagram for StaticElement:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~StaticElement ()
virtual void addFields (const vect3d &pos, vect3d &bfield, vect3d &efield)=0
 Add fiel values at given position.
virtual void addPotential (const vect3d &pos, prec_t &potential)=0
 Add the electrostatic potential from the given element.
virtual void draw (Screen &screen, const Screen::color &c=Screen::BLACK)=0
 Draw the elemnt onto a screen.
virtual std::string get_povray_script ()=0
 Get povray script of the given element.
virtual bool inContact (const vect3d &pos)=0
 Test whether given position is in contact with the given current element.

Detailed Description

Generic static element that generates fields/occupies space.

Definition at line 35 of file statics.hpp.


Constructor & Destructor Documentation

virtual StaticElement::~StaticElement (  )  [virtual]


Member Function Documentation

virtual void StaticElement::addFields ( const vect3d pos,
vect3d bfield,
vect3d efield 
) [pure virtual]

Add fiel values at given position.

Implemented in StaticPotentialField, StaticIntegrated, StaticRing, StaticLine, StaticLineInfinite, StaticRectangle, StaticCINN, StaticCICU, StaticCIL, StaticLineCharge, StaticChargedSphere, and StaticCubePolywellOctree.

virtual void StaticElement::addPotential ( const vect3d pos,
prec_t potential 
) [pure virtual]

Add the electrostatic potential from the given element.

Implemented in StaticPotentialField, StaticIntegrated, StaticRing, StaticLine, StaticLineInfinite, StaticRectangle, StaticCIBase, StaticLineCharge, StaticChargedSphere, and StaticCubePolywellOctree.

virtual void StaticElement::draw ( Screen screen,
const Screen::color c = Screen::BLACK 
) [pure virtual]

Draw the elemnt onto a screen.

Implemented in StaticPotentialField, StaticIntegrated, StaticRing, StaticLineBase, StaticLineInfinite, StaticRectangle, StaticCIBase, StaticChargedSphere, and StaticCubePolywellOctree.

virtual std::string StaticElement::get_povray_script (  )  [pure virtual]

Get povray script of the given element.

Implemented in StaticPotentialField, StaticBezier, StaticRingIntegrated, StaticRing, StaticLineBase, StaticLineInfinite, StaticRectangle, StaticCIBase, StaticChargedSphere, and StaticCubePolywellOctree.

virtual bool StaticElement::inContact ( const vect3d pos  )  [pure virtual]

Test whether given position is in contact with the given current element.

Implemented in StaticPotentialField, StaticIntegrated, StaticRingIntegrated, StaticRing, StaticLineBase, StaticLineInfinite, StaticRectangle, StaticCIBase, StaticChargedSphere, and StaticCubePolywellOctree.


The documentation for this class was generated from the following file:
Generated on Thu Dec 6 20:31:17 2007 for Ephi by  doxygen 1.5.0