AtlasFieldCache.h

Go to the documentation of this file.

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

 
#ifndef MAGFIELDCONDITIONS_ATLASMTFIELDCACHE_H
#define MAGFIELDCONDITIONS_ATLASMTFIELDCACHE_H 1
 
// MagField includes
#include "CxxUtils/restrict.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/SystemOfUnits.h"
#include "MagFieldElements/AtlasFieldMap.h"
#include "MagFieldElements/BFieldCache.h"
#include "MagFieldElements/BFieldCacheZR.h"
#include "MagFieldElements/BFieldCond.h"
#include "MagFieldElements/BFieldMeshZR.h"
#include "MagFieldElements/BFieldZone.h"
 
#include <memory>
namespace MagField {

class AtlasFieldCache
{
public:
  AtlasFieldCache() = default;
  AtlasFieldCache(double solFieldScale,
                  double torFieldScale,
                  const AtlasFieldMap* fieldMap);

  AtlasFieldCache& operator=(AtlasFieldCache&& other) = default;
  AtlasFieldCache(AtlasFieldCache&& other) = default;
  AtlasFieldCache(const AtlasFieldCache& other) = default;
  AtlasFieldCache& operator=(const AtlasFieldCache& other) = default;
  ~AtlasFieldCache() = default;

  void getField(const double* ATH_RESTRICT xyz,
                double* ATH_RESTRICT bxyz,
                double* ATH_RESTRICT deriv = nullptr);

  void getFieldZR(const double* ATH_RESTRICT xyz,
                  double* ATH_RESTRICT bxyz,
                  double* ATH_RESTRICT deriv = nullptr);

  bool solenoidOn() const;
  bool toroidOn() const;
 
private:

  bool fillFieldCache(double z, double r, double phi);
  bool fillFieldCacheZR(double z, double r);

  double m_solScale{ 1 };
  double m_torScale{ 1 };
  double m_scaleToUse{ 1 };
 
  // Solenoid zone ID number - needed to set solScale.
  // Assumes only one Solenoid zone.
  int m_solZoneId{ -1 };

  const AtlasFieldMap* m_fieldMap{ nullptr };

  const BFieldZone* m_zone3d{ nullptr };

  BFieldCache m_cache3d;

  const std::vector<BFieldCond>* m_cond{ nullptr };

  const BFieldMeshZR* m_meshZR{ nullptr };

  BFieldCacheZR m_cacheZR{};
};
 
} // namespace MagField
#include "AtlasFieldCache.icc"
#endif // MAGFIELDCONDITIONS_ATLASMTFIELDCACHE_H