IMagFieldSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/

// IMagFieldSvc.h, (c) ATLAS Detector software
#ifndef G4ATLASINTERFACES_IMAGFIELDSVC_H
#define G4ATLASINTERFACES_IMAGFIELDSVC_H
 
// Framework includes
#include "GaudiKernel/IInterface.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;

        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