BFieldMap.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <geometry/bfieldmap/BFieldComponentAbs.h>
 
#include <framework/logging/Logger.h>
 
#include <list>
#include <memory>
 
namespace Belle2 {
  class BFieldMap {
 
  public:
 
    static BFieldMap& Instance();
 
  private:
    ROOT::Math::XYZVector getBField(const ROOT::Math::XYZVector& point) const;
  public:
 
    template<class BFIELDCOMP> BFIELDCOMP& addBFieldComponent();
 
    void initialize();
 
    void clear();
 
  protected:
 
    std::list<BFieldComponentAbs*> m_components; 
  private:
 
    bool m_isMapInitialized; 
    BFieldMap();
 
    BFieldMap(const BFieldMap&);
 
    BFieldMap& operator=(const BFieldMap&);
 
    virtual ~BFieldMap();
 
    friend struct std::default_delete<BFieldMap>;
    friend class BFieldFrameworkInterface;
  };
 
 
  //------------------------------------------------------
  //       Implementation of template based methods
  //------------------------------------------------------
  template<class BFIELDCOMP> BFIELDCOMP&  BFieldMap::addBFieldComponent()
  {
    BFIELDCOMP* newComponent = new BFIELDCOMP;
    m_components.push_back(newComponent);
    return *newComponent;
  }
 
 
  inline ROOT::Math::XYZVector BFieldMap::getBField(const ROOT::Math::XYZVector& point) const
  {
    ROOT::Math::XYZVector magFieldVec(0.0, 0.0, 0.0);
    //Check that the point makes sense
    if (std::isnan(point.X()) || std::isnan(point.Y()) || std::isnan(point.Z())) {
      B2ERROR("Bfield requested for a position containing NaN, returning field 0");
      return magFieldVec;
    }
    //Loop over all magnetic field components and add their magnetic field vectors
    for (const BFieldComponentAbs* comp : m_components) {
      magFieldVec += comp->calculate(point);
    }
    return magFieldVec;
  }
 
 
} //end of namespace Belle2