CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions
MagneticFieldProvider< T > Class Template Referenceabstract

#include <MagCylinder.h>

Public Types

typedef Point3DBase< T, GlobalTagGlobalPointType
 
typedef Vector3DBase< T, GlobalTagGlobalVectorType
 
typedef Point3DBase< T, LocalTagLocalPointType
 
typedef Vector3DBase< T, LocalTagLocalVectorType
 

Public Member Functions

virtual LocalVectorType derivativeInTeslaPerMeter (const LocalPointType &p, int N) const
 
virtual int hasDerivatives () const
 
virtual LocalVectorType valueInTesla (const LocalPointType &p) const =0
 
virtual ~MagneticFieldProvider ()
 

Detailed Description

template<class T>
class MagneticFieldProvider< T >

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

Author
T. Todorov

Definition at line 14 of file MagCylinder.h.

Member Typedef Documentation

◆ GlobalPointType

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

Definition at line 19 of file MagneticFieldProvider.h.

◆ GlobalVectorType

Definition at line 21 of file MagneticFieldProvider.h.

◆ LocalPointType

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

Definition at line 20 of file MagneticFieldProvider.h.

◆ LocalVectorType

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

Definition at line 22 of file MagneticFieldProvider.h.

Constructor & Destructor Documentation

◆ ~MagneticFieldProvider()

template<class T>
virtual MagneticFieldProvider< T >::~MagneticFieldProvider ( )
inlinevirtual

Definition at line 24 of file MagneticFieldProvider.h.

24 {}

Member Function Documentation

◆ derivativeInTeslaPerMeter()

template<class T>
virtual LocalVectorType MagneticFieldProvider< T >::derivativeInTeslaPerMeter ( const LocalPointType p,
int  N 
) const
inlinevirtual

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

Definition at line 42 of file MagneticFieldProvider.h.

42 { return LocalVectorType(); }
Vector3DBase< T, LocalTag > LocalVectorType

◆ hasDerivatives()

template<class T>
virtual int MagneticFieldProvider< T >::hasDerivatives ( ) const
inlinevirtual

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 38 of file MagneticFieldProvider.h.

38 { return false; }

◆ valueInTesla()

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, and defaultRKPropagator::TrivialFieldProvider.

Referenced by MagVolume::fieldInTesla().