MagneticFieldInterfaceConsistencyTests.cpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file MagneticFieldInterfaceConsistencyTests.cpp

// This file is part of the Acts project.
//
// Copyright (C) 2018 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.


#include <boost/test/data/test_case.hpp>
#include <boost/test/floating_point_comparison.hpp>
#include <boost/test/unit_test.hpp>

#include "Acts/MagneticField/ConstantBField.hpp"
#include "Acts/MagneticField/InterpolatedBFieldMap.hpp"
#include "Acts/MagneticField/MagneticFieldContext.hpp"
#include "Acts/MagneticField/SharedBField.hpp"
#include "Acts/MagneticField/SolenoidBField.hpp"
#include "Acts/Utilities/Definitions.hpp"
#include "Acts/Utilities/Units.hpp"

namespace bdata = boost::unit_test::data;
namespace tt = boost::test_tools;

namespace Acts {

namespace Test {

// Create a test context
MagneticFieldContext mfContext = MagneticFieldContext();

template <class BField_t>
void testInterfaceConsistency(const BField_t& field) {
  using Cache_t = typename BField_t::Cache;
  Vector3D pos(0, 0, 0);
  Vector3D B;
  ActsMatrixD<3, 3> gradient;

  // test interface method without cache
  field.getField(pos);
  field.getFieldGradient(pos, gradient);

  // test interface method with cache
  Cache_t cache(mfContext);
  field.getField(pos, cache);
  field.getFieldGradient(pos, gradient, cache);
}

BOOST_AUTO_TEST_CASE(TestConstantBFieldInterfaceConsistency) {
  ConstantBField field(1, 1, 1);
  testInterfaceConsistency(field);
}

BOOST_AUTO_TEST_CASE(TestSolenoidBFieldInterfaceConsistency) {
  SolenoidBField field({100, 1000, 20, 5});
  testInterfaceConsistency(field);
}

BOOST_AUTO_TEST_CASE(TestInterpolatedBFieldMapInterfaceConsistency) {
  // define dummy mapper and field cell, we don't need them to do anything
  struct DummyFieldCell {
    Vector3D getField(const Vector3D&) const { return {0, 0, 0}; }
    bool isInside(const Vector3D&) const { return true; }
  };

  struct DummyMapper : DummyFieldCell {
    using FieldCell = DummyFieldCell;

    DummyFieldCell getFieldCell(const Vector3D&) const {
      return DummyFieldCell();
    }
    std::vector<size_t> getNBins() const { return {42}; }
    std::vector<double> getMin() const { return {5}; }
    std::vector<double> getMax() const { return {15}; }
  };

  DummyMapper m;
  InterpolatedBFieldMap<DummyMapper>::Config config(std::move(m));
  config.scale = 1.;

  // create BField service
  InterpolatedBFieldMap<DummyMapper> b(std::move(config));

  testInterfaceConsistency(b);
}

BOOST_AUTO_TEST_CASE(TestSharedBFieldInterfaceConsistency) {
  SharedBField<ConstantBField> field(
      std::make_shared<ConstantBField>(Vector3D(1, 1, 1)));
  testInterfaceConsistency(field);
}
}  // namespace Test

}  // namespace Acts