template class BSingleMultipoleField<int> : public EMField

(Return to index)

Representation for a single magnetic multipole field.

The order and the skew flag are encoded in a template parameter. {center} order > 0: normal multipole, order < 0: skew multipole. {/center} Thus the compiler may optimize by unrolling loops on the order. It should also omit some tests and eliminate unreachable code.

Type:	Instantiable
Superclasses:	public EMField
Include file:	./Fields/BSingleMultipoleField.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • BSingleMultipoleField () ;
  • BSingleMultipoleField (const BSingleMultipoleField&) ;
  • virtual ~BSingleMultipoleField () ;
  • BSingleMultipoleField& operator= (const BSingleMultipoleField&) ;
  • operator ()const ;
  • virtual BVector Bfield (const Point3D&)const ;
  • virtual BVector Bfield (const Point3D&,double)const ;
  • virtual double getComponent ()const ;
  • virtual void setComponent (double) ;
  • void scale (double) ;
  • int size ()const ;
  • 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:

  BSingleMultipoleField () ;

  Default constructor.
  Constructs a null field.

  virtual BVector Bfield (const Point3D&)const ;

  Field at a given point.
  Return the magnetic field at point P.

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

  Get field.
  Return the magnetic field at time t in point P. This default action returns the static part BField(P).

  virtual double getComponent ()const ;

  Return field coefficient.
  Return the single multipole coefficient in T/m**n.

  operator ()const ;

  Conversion operator.
  Return the field as a BMultipoleField.

  void scale (double) ;

  Scale the field.
  Multiply the field by scalar.

  virtual void setComponent (double) ;

  Set field coefficient.
  Assign the single multipole coefficient in T/m**n.

  int size ()const ;

  Return order.