CovfieFieldSource.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/FieldService/IFieldSource.h"
 
#include <memory>
#include <string>
#include <vector>
 
namespace SHiP {
 
[[deprecated("use loadFieldMap and the SHiP field-map format"),
  nodiscard]] std::shared_ptr<IFieldEvaluator>
loadCovfieField(std::string const& cvf_path);
 
class [[deprecated("use FieldMapSource and the SHiP field-map format")]] CovfieFieldSource final
    : public IFieldSource {
   public:
    struct MagnetConfig {
        std::string name;
        std::string volume_pattern;
        std::string cvf_file;
    };
 
    explicit CovfieFieldSource(std::vector<MagnetConfig> magnets);
    ~CovfieFieldSource() override = default;
 
    CovfieFieldSource(CovfieFieldSource const&) = delete;
    CovfieFieldSource& operator=(CovfieFieldSource const&) = delete;
    CovfieFieldSource(CovfieFieldSource&&) = default;
    CovfieFieldSource& operator=(CovfieFieldSource&&) = default;
 
    [[nodiscard]] std::vector<FieldRegion> const& regions() const override { return regions_; }
 
   private:
    std::vector<FieldRegion> regions_;
};
 
}  // namespace SHiP