OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Private Attributes | List of all members
EDipoleField Class Reference

A static homogeneous electrostatic field in the (x,y)-plane. More...

#include <EDipoleField.h>

Inheritance diagram for EDipoleField:
Inheritance graph
[legend]
Collaboration diagram for EDipoleField:
Collaboration graph
[legend]

Public Member Functions

 EDipoleField ()
 Default constructor. More...
 
virtual ~EDipoleField ()
 
virtual EVector Efield (const Point3D &P) const
 Get field. More...
 
virtual EVector Efield (const Point3D &P, double t) const
 Get field. More...
 
virtual double getEx () const
 Get component. More...
 
virtual double getEy () const
 Get component. More...
 
virtual void setEx (double)
 Set component. More...
 
virtual void setEy (double)
 Set component. More...
 
virtual void scale (double scalar)
 Scale the field. More...
 
- Public Member Functions inherited from ConstEField
 ConstEField ()
 Default constructor. More...
 
virtual ~ConstEField ()
 
virtual double getEz () const
 Get component. More...
 
virtual void setEz (double)
 Set component. More...
 
- Public Member Functions inherited from StaticElectricField
 StaticElectricField ()
 
virtual ~StaticElectricField ()
 
- Public Member Functions inherited from EMField
 EMField ()
 Default constructor. More...
 
 EMField (const EMField &right)
 
virtual ~EMField ()
 
const EMFieldoperator= (const EMField &right)
 
virtual BVector Bfield (const Point3D &P) const
 Get field. More...
 
virtual BVector Bfield (const Point3D &P, double t) const
 Get field. More...
 
virtual EBVectors EBfield (const Point3D &P) const
 Get field. More...
 
virtual EBVectors EBfield (const Point3D &P, double t) const
 Get field. More...
 

Private Attributes

double Ex
 
double Ey
 

Additional Inherited Members

- Static Public Attributes inherited from EMField
static const EVector ZeroEfield
 The constant representing a zero electric field. More...
 
static const BVector ZeroBfield
 The constant representing a zero magnetic field. More...
 
static const EBVectors ZeroEBfield
 The constant representing a zero electromagnetic field. More...
 

Detailed Description

A static homogeneous electrostatic field in the (x,y)-plane.

Definition at line 30 of file EDipoleField.h.

Constructor & Destructor Documentation

EDipoleField::EDipoleField ( )

Default constructor.

Definition at line 27 of file EDipoleField.cpp.

EDipoleField::~EDipoleField ( )
virtual

Definition at line 31 of file EDipoleField.cpp.

Member Function Documentation

EVector EDipoleField::Efield ( const Point3D P) const
virtual

Get field.

Reimplemented from EMField.

Definition at line 35 of file EDipoleField.cpp.

References Ex, and Ey.

EVector EDipoleField::Efield ( const Point3D P,
double  t 
) const
virtual

Get field.

Reimplemented from EMField.

Definition at line 40 of file EDipoleField.cpp.

References Ex, and Ey.

double EDipoleField::getEx ( ) const
virtual

Get component.

Reimplemented from ConstEField.

Definition at line 45 of file EDipoleField.cpp.

References Ex.

Referenced by SeparatorRep::getEx().

double EDipoleField::getEy ( ) const
virtual

Get component.

Reimplemented from ConstEField.

Definition at line 49 of file EDipoleField.cpp.

References Ey.

Referenced by SeparatorRep::getEy().

void EDipoleField::scale ( double  scalar)
virtual

Scale the field.

Implements EMField.

Definition at line 64 of file EDipoleField.cpp.

References Ex, and Ey.

void EDipoleField::setEx ( double  value)
virtual

Set component.

Reimplemented from ConstEField.

Definition at line 54 of file EDipoleField.cpp.

References Ex.

Referenced by SeparatorRep::setEx().

void EDipoleField::setEy ( double  value)
virtual

Set component.

Reimplemented from ConstEField.

Definition at line 59 of file EDipoleField.cpp.

References Ey.

Referenced by SeparatorRep::setEy().

Member Data Documentation

double EDipoleField::Ex
private

Definition at line 71 of file EDipoleField.h.

Referenced by Efield(), getEx(), scale(), and setEx().

double EDipoleField::Ey
private

Definition at line 71 of file EDipoleField.h.

Referenced by Efield(), getEy(), scale(), and setEy().


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