ForwardRegionFieldSvc.h

Go to the documentation of this file.

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

// ForwardRegionFieldSvc.h, (c) ATLAS Detector software
 
#ifndef FORWARDREGIONMGFIELD_FORWARDREGIONFIELDFIELDSVC_H
#define FORWARDREGIONMGFIELD_FORWARDREGIONFIELDFIELDSVC_H 1
 
//CLHEP includes
#include "CLHEP/Geometry/Point3D.h"
 
//Geant4 includes
#include "G4ThreeVector.hh"
 
// FrameWork includes
#include "AthenaBaseComps/AthService.h"
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/IIncidentListener.h"
 
#include "ForwardRegionGeoModel/IForwardRegionProperties.h"
// MagField includes
#include "G4AtlasInterfaces/IMagFieldSvc.h"
 
namespace MagField {
 
  class ForwardRegionFieldSvc : public extends<AthService, IMagFieldSvc, IIncidentListener>  {
    // Public methods:
  public:
    ForwardRegionFieldSvc(const std::string& name,ISvcLocator* svc);

    StatusCode initialize() override final;

    void handle(const Incident& runIncident) override final;

    virtual void getField(const double *xyz, double *bxyz, double *deriv = nullptr) const override final;

    virtual void getFieldZR(const double *xyz, double *bxyz, double *deriv = nullptr) const override final;

    // get magnetic induction vector in certain point inside Q1-Q3 quadrupoles (uses bilinear interpolation), q=0 - Q1, q=1 - Q2, q=2 - Q3
    G4ThreeVector getMagInd(G4ThreeVector Point, int q, int beam) const;
 
    double getMag(int magnet, int beam) const;
 
    G4ThreeVector getKick(int beam) const;
 
    double getMagXOff(int magnet) const;
 
    double getMagYOff(int magnet) const;
 
  private:
 
    G4ThreeVector FieldValue(G4ThreeVector Point) const;
 
    int m_magnet;
 
    void InitMagData();
 
    std::vector<std::vector<std::string> > m_magnets;
 
    // array for storing magnets data
    // dipoles/quadrupoles: field/gradient beam 1 | field/gradient beam 2 | x offset | y offset
    // kickers: B_x beam 1 | B_x beam 2 | B_y beam 1 | B_y beam 2
    double m_magData[4];
 
    // switch for magnetic data input file type: 0 = magnets.dat, 1 = twiss file
    int m_magDataType;
 
    std::string m_MQXA_DataFile; // @TODO DOCUMENT
    std::string m_MQXB_DataFile; // @TODO DOCUMENT
 
    //std::string m_twissFileB1, m_twissFileB2;
 
     // file indexes
    static const int s_Q1 = 0;
    static const int s_Q2 = 1;
    static const int s_Q3 = 2;
    static const int s_D1 = 3;
    static const int s_D2 = 4;
    static const int s_Q4 = 5;
    static const int s_Q5 = 6;
    static const int s_Q6 = 7;
    static const int s_Q7 = 8;
    static const int s_Q1HKick = 9;
    static const int s_Q1VKick = 10;
    static const int s_Q2HKick = 11;
    static const int s_Q2VKick = 12;
    static const int s_Q3HKick = 13;
    static const int s_Q3VKick = 14;
    static const int s_Q4VKickA = 15;
    static const int s_Q4HKick = 16;
    static const int s_Q4VKickB = 17;
    static const int s_Q5HKick = 18;
    static const int s_Q6VKick = 19;
   //mapfile parameters
    static const int s_rowsMQXA = 97;
    static const int s_colsMQXA = 97;
    static const int s_rowsMQXB = 89;
    static const int s_colsMQXB = 89;
 
    double m_magIndMQXA[s_rowsMQXA][s_colsMQXA][2];
    double m_magIndMQXB[s_rowsMQXB][s_colsMQXB][2];
 
    // Load data from file into 2D array of strings
    std::vector<std::vector<std::string> > loadDataFile(const char * fileName, int cols);
    std::vector<std::vector<std::string> > loadDataFileNLines(const char * fileName, int cols, int N, std::string& header);
 
    // Calculate magnetic induction value / gradient from K*L values
    double kLToB(double kL, double lenght, double momentum);
 
    void InitMagDataFromTwiss(const std::vector<std::vector<std::string> >& loadedTwissFile, int beam, double momentum);
 
    // property configuration
    FWDMg_CONFIGURATION m_Config;
 
    ToolHandle<IForwardRegionProperties> m_properties;
 
//    G4ThreeVector applyDisplacement(G4ThreeVector Point, G4ThreeVector field, int beam) const;
 
    void writeOutTwiss(const std::vector<std::vector<std::string>>& loadedTwissFile, int beam, const std::string& header);
    void getMagnetTransformParams(int beam, int magnet, G4ThreeVector Point, HepGeom::Point3D<double> &pointMagStart,HepGeom::Point3D<double> &pointMagEnd, double &rotZ) const;
    int getMagNumFromName(const std::string& name) const;
 
 
  };
}
#endif // FORWARDREGIONMGFIELD_FORWARDREGIONFIELDFIELDSVC_H