IFieldSource.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 CERN for the benefit of the SHiP Collaboration
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include <SHiP/Units.hpp>
#include <array>
#include <memory>
#include <string>
#include <vector>
 
namespace ship {
 
class IFieldEvaluator {
   public:
    // Aliases of the canonical ShipSoft quantity types (SHiP/Units.hpp);
    // kept for source compatibility with existing implementations.
    using pos_q = ship::Length;
    using field_q = ship::MagneticField;
 
    virtual ~IFieldEvaluator() = default;
 
    [[nodiscard]] virtual std::array<field_q, 3> at(pos_q x, pos_q y, pos_q z) const = 0;
};
 
struct FieldRegion {
    std::string name;
    std::string volume_pattern;
    std::shared_ptr<IFieldEvaluator> field;
};
 
class IFieldSource {
   public:
    virtual ~IFieldSource() = default;
 
    [[nodiscard]] virtual std::vector<FieldRegion> const& regions() const = 0;
};
 
}  // namespace ship