---

MagneticFieldProvider< T > Class Template Reference

Virtual interface for the field provider for an individual field volume. More...

#include <MagneticField/VolumeGeometry/interface/MagneticFieldProvider.h>

Inheritance diagram for MagneticFieldProvider< T >:

List of all members.

Public Types
typedef Point3DBase< T, GlobalTag >	GlobalPointType
typedef Vector3DBase< T, GlobalTag >	GlobalVectorType
typedef Point3DBase< T, LocalTag >	LocalPointType
typedef Vector3DBase< T, LocalTag >	LocalVectorType
Public Member Functions
virtual LocalVectorType	derivativeInTeslaPerMeter (const LocalPointType &p, int N) const
	Returns the Nth spacial derivative of the field in the local frame.
virtual int	hasDerivatives () const
	Returns the field vector in the global frame, at global position p Not needed, the MagVolume does the transformation to global!
virtual LocalVectorType	valueInTesla (const LocalPointType &p) const =0
	Returns the field vector in the local frame, at local position p.

---

Detailed Description

template<class T>
class MagneticFieldProvider< T >

Virtual interface for the field provider for an individual field volume.

Date

2008/03/29 14:10:47

Revision

1.3

Author:

T. Todorov

Definition at line 19 of file MagneticFieldProvider.h.

---

Member Typedef Documentation

template<class T>

typedef Point3DBase<T,GlobalTag> MagneticFieldProvider< T >::GlobalPointType

Reimplemented in ShiftingMagneticFieldProvider< T >.

Definition at line 22 of file MagneticFieldProvider.h.

template<class T>

typedef Vector3DBase<T,GlobalTag> MagneticFieldProvider< T >::GlobalVectorType

Reimplemented in ShiftingMagneticFieldProvider< T >.

Definition at line 24 of file MagneticFieldProvider.h.

template<class T>

typedef Point3DBase<T,LocalTag> MagneticFieldProvider< T >::LocalPointType

Reimplemented in ShiftingMagneticFieldProvider< T >.

Definition at line 23 of file MagneticFieldProvider.h.

template<class T>

typedef Vector3DBase<T,LocalTag> MagneticFieldProvider< T >::LocalVectorType

Reimplemented in ShiftingMagneticFieldProvider< T >.

Definition at line 25 of file MagneticFieldProvider.h.

---

Member Function Documentation

template<class T>

virtual LocalVectorType MagneticFieldProvider< T >::derivativeInTeslaPerMeter	(	const LocalPointType &	p,
		int	N
	)			const [inline, virtual]

Returns the Nth spacial derivative of the field in the local frame.

Definition at line 43 of file MagneticFieldProvider.h.

                                                                  {
    return LocalVectorType();
  }

template<class T>

virtual int MagneticFieldProvider< T >::hasDerivatives

(

)

const [inline, virtual]

Returns the field vector in the global frame, at global position p Not needed, the MagVolume does the transformation to global!

Returns the maximal order of available derivatives. Returns 0 if derivatives are not available.

Definition at line 39 of file MagneticFieldProvider.h.

{return false;}

template<class T>

virtual LocalVectorType MagneticFieldProvider< T >::valueInTesla

(

const LocalPointType &

p

)

const [pure virtual]

Returns the field vector in the local frame, at local position p.

Implemented in magneticfield::FakeInterpolator, MFGrid, MFGrid3D, CylinderFromSectorMFGrid, GlobalGridWrapper, ZReflectedMFGrid, ShiftingMagneticFieldProvider< T >, and RKTestFieldProvider.

Referenced by MagVolume::fieldInTesla().

---

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

• MagneticField/VolumeGeometry/interface/MagneticFieldProvider.h

---