CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions
MagneticFieldProvider< T > Class Template Referenceabstract

#include <MagCylinder.h>

Inheritance diagram for MagneticFieldProvider< T >:
ShiftingMagneticFieldProvider< T >

Public Types

typedef Point3DBase< T, GlobalTagGlobalPointType
 
typedef Vector3DBase< T,
GlobalTag
GlobalVectorType
 
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.

Date:
2011/07/29 14:57:40
Revision:
1.4
Author
T. Todorov

Definition at line 14 of file MagCylinder.h.

Member Typedef Documentation

Definition at line 22 of file MagneticFieldProvider.h.

Definition at line 24 of file MagneticFieldProvider.h.

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

Definition at line 23 of file MagneticFieldProvider.h.

Definition at line 25 of file MagneticFieldProvider.h.

Constructor & Destructor Documentation

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

Definition at line 28 of file MagneticFieldProvider.h.

28 {}

Member Function Documentation

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

47  {
48  return LocalVectorType();
49  }
Vector3DBase< T, LocalTag > LocalVectorType
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 42 of file MagneticFieldProvider.h.

42 {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 RKTestFieldProvider, magneticfield::FakeInterpolator, and ShiftingMagneticFieldProvider< T >.

Referenced by MagVolume::fieldInTesla().