IMagFieldSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
// IMagFieldSvc.h, (c) ATLAS Detector software
#ifndef MAGFIELDINTERFACES_IMAGFIELDSVC_H
#define MAGFIELDINTERFACES_IMAGFIELDSVC_H
 
#include <cmath>
#include <iostream>
 
// Framework includes
#include "GaudiKernel/IInterface.h"
 
// Amg classes
#include "GeoPrimitives/GeoPrimitives.h"
 
namespace MagField {
 
    class IMagFieldSvc: virtual public IInterface {
 
    // Public methods:
    public:
 
        DeclareInterfaceID(IMagFieldSvc, 1, 0);
 
        IMagFieldSvc() : m_solenoidCurrent(0.0), m_toroidCurrent(0.0) {;}
 
        virtual void getField(const double *xyz, double *bxyz, double *deriv = nullptr) const = 0;
 
        void getField(const Amg::Vector3D *xyz, Amg::Vector3D *bxyz) const {
          getField( xyz->data(), bxyz->data(), nullptr );
        }
        void getField(const Amg::Vector3D *xyz, Amg::Vector3D *bxyz, Amg::RotationMatrix3D *deriv) const {
          // cppcheck-suppress nullPointer; false positive
          getField( xyz->data(), bxyz->data(), deriv->data() );
        }
 
        virtual void getFieldZR(const double *xyz, double *bxyz, double *deriv = nullptr) const = 0;
 
        bool solenoidOn() const { return solenoidCurrent() > 0.0; }
        bool toroidOn() const   { return toroidCurrent()   > 0.0; }
        float solenoidCurrent() const { return m_solenoidCurrent; }
        float toroidCurrent() const   { return m_toroidCurrent;   }
 
    protected:
        void setSolenoidCurrent(float current) { m_solenoidCurrent = current; }
        void setToroidCurrent  (float current) { m_toroidCurrent   = current; }
 
    private:
        float m_solenoidCurrent; // solenoid current in ampere
        float m_toroidCurrent;   // toroid current in ampere
    };
}
 
#endif //> !MAGFIELDINTERFACES_IMAGFIELDSVC_H