class BDipoleField : public ConstBField

(Return to index)

The field of a magnetic dipole.

A static magnetic dipole field in the (x,y)-plane.

Type:	Instantiable
Superclasses:	public ConstBField
Include file:	./Fields/BDipoleField.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • BDipoleField () ;
  • virtual ~BDipoleField () ;
  • virtual BVector Bfield (const Point3D&)const ;
  • virtual BVector Bfield (const Point3D&,double)const ;
  • virtual double getBx ()const ;
  • virtual double getBy ()const ;
  • virtual void setBx (double) ;
  • virtual void setBy (double) ;
  • BDipoleField& addField (const BDipoleField&) ;
  • BDipoleField& subtractField (const BDipoleField&) ;
  • virtual void scale (double) ;
  • virtual double getBz ()const ;
  • virtual void setBz (double) ;
  • const EMField& operator= (const EMField&) ;
  • virtual EVector Efield (const Point3D&)const ;
  • virtual EVector Efield (const Point3D&,double)const ;
  • virtual EBVectors EBfield (const Point3D&)const ;
  • virtual EBVectors EBfield (const Point3D&,double)const ;
  • static const EVector ZeroEfield ;
  • static const BVector ZeroBfield ;
  • static const EBVectors ZeroEBfield ;

Documentation:

• Public members:

  BDipoleField () ;

  Default constructor.
  Constructs a null field.

  virtual BVector Bfield (const Point3D&)const ;

  Get field.
  Return the time-independent part of the magnetic field in point P. This override forces implementation in derived classes.

  virtual BVector Bfield (const Point3D&,double)const ;

  Get field.
  Return the magnetic field at time t in point P. This override forces implementation in derived classes.

  BDipoleField& addField (const BDipoleField&) ;

  Add to field.
  Add field to the old value; return new value.

  virtual double getBx ()const ;

  Get horizontal component.
  Return the horizontal component of the field in Teslas.

  virtual double getBy ()const ;

  Get vertical component.
  Return the vertical component of the field in Teslas.

  virtual void scale (double) ;

  Scale the field.
  Multiply the field by scalar.

  virtual void setBx (double) ;

  Set horizontal component.
  Assign the horizontal component of the field in Teslas.

  virtual void setBy (double) ;

  Set vertical component.
  Assign the vertical component of the field in Teslas.

  BDipoleField& subtractField (const BDipoleField&) ;

  Subtract from field.
  Subtract field from the old value; return new value.