/data/refman/pasoursint/CMSSW_5_3_3/src/MagneticField/Engine/interface/MagneticField.h

Go to the documentation of this file.

#ifndef MagneticField_MagneticField_h
#define MagneticField_MagneticField_h

#include "DataFormats/GeometryVector/interface/GlobalVector.h"
#include "DataFormats/GeometryVector/interface/GlobalPoint.h"
#include "FWCore/Utilities/interface/Visibility.h"
#include "FWCore/Utilities/interface/Likely.h"

class MagneticField
{
 public:
  MagneticField();
  virtual ~MagneticField();

  virtual MagneticField* clone() const {
    return 0;
  }
  

  virtual GlobalVector inTesla (const GlobalPoint& gp) const = 0;

  GlobalVector inKGauss(const GlobalPoint& gp) const  {
    return inTesla(gp) * 10.F;
  }

  GlobalVector inInverseGeV(const GlobalPoint& gp) const {
    return inTesla(gp) * 2.99792458e-3F;
  }

  // engine is defined.
  virtual bool isDefined(const GlobalPoint& gp) const {
    return true;
  }
  
  virtual GlobalVector inTeslaUnchecked (const GlobalPoint& gp) const {
    return inTesla(gp);  // default dummy implementation
  }
  
  int nominalValue() const {
    if unlikely(!nominalValueCompiuted) { 
      theNominalValue = computeNominalValue();
      nominalValueCompiuted=true;
    }
    return theNominalValue;
  }
private:
  //nominal field value 
  virtual int computeNominalValue() const;
  mutable bool nominalValueCompiuted;
  mutable int theNominalValue;
};

#endif