src/Sample/FromFile.h

Go to the documentation of this file.

//
// Class FromFile
//   This class parses a file that contains design variable values.
//   Each column belongs to a design variable.
//   The first line is considered as header and consists of the
//   design variable name. The name has to agree with the string
//   in the input file.
//
// Copyright (c) 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef SAMPLE_FROMFILE_H
#define SAMPLE_FROMFILE_H
 
#include "Sample/SamplingMethod.h"
 
#include <string>
#include <vector>

class FromFile : public SamplingMethod {
 
public:
    explicit FromFile(const std::string& filename, const std::string& dvarName, std::size_t modulo);

    ~FromFile() override = default;
 
    // Disable copying to avoid issues with memory management
    FromFile(const FromFile&) = delete;
    FromFile& operator=(const FromFile&) = delete;
 
    // Allow move semantics for efficient resource transfer
    FromFile(FromFile&&) noexcept = default;
    FromFile& operator=(FromFile&&) noexcept = default;

    void create(std::shared_ptr<SampleIndividual>& ind, std::size_t i) override;

    void allocate(const CmdArguments_t& args, const Comm::Bundle_t& comm) override;

    double getNext(unsigned int id);

    unsigned int getSize() const;
 
private:
    std::vector<double> chain_m;

    std::size_t mod_m;

    std::string filename_m;

    std::string dvarName_m;

    std::size_t globalSize_m;
};
 
#endif