solver.h

/*
 * Copyright 2007-2024, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __SOLVER_SIMULATION_SOLVER_H__
#define __SOLVER_SIMULATION_SOLVER_H__
 
#include <yuni/job/queue/service.h>
 
#include <antares/benchmarking/DurationCollector.h>
#include <antares/logs/logs.h>
#include <antares/solver/simulation/ISimulationObserver.h>
#include <antares/study/study.h>
#include <antares/writer/writer_factory.h>
#include "antares/solver/hydro/management/management.h"
#include "antares/solver/misc/options.h"
#include "antares/solver/simulation/solver.data.h"
#include "antares/solver/simulation/solver_utils.h"
#include "antares/solver/variable/state.h"
 
namespace Antares::Solver::Simulation
{
 
template<class Impl>
class yearJob;
 
template<class Impl>
class ISimulation: public Impl
{
    friend class yearJob<Impl>;
 
public:
 
 
    ISimulation(Data::Study& study,
                const ::Settings& settings,
                Benchmarking::DurationCollector& duration_collector,
                IResultWriter& resultWriter,
                Simulation::ISimulationObserver& simulationObserver);
    ~ISimulation();
 
    // Check that the writer is valid
    void checkWriter() const;
 
    void run();
 
    void writeResults(bool synthesis, uint year = 0, uint numSpace = 9999);
 
    Data::Study& study;
    const ::Settings& settings;
 
private:
    void regenerateTimeSeries(uint year);
 
    uint buildSetsOfParallelYears(uint firstYear,
                                  uint endYear,
                                  std::vector<setOfParallelYears>& setsOfParallelYears);
 
    void allocateMemoryForRandomNumbers(randomNumbers& randomForParallelYears);
 
    void computeRandomNumbers(randomNumbers& randomForYears,
                              std::vector<uint>& years,
                              std::map<unsigned int, bool>& isYearPerformed,
                              MersenneTwister& randomHydro);
 
    void computeAnnualCostsStatistics(std::vector<Variable::State>& state,
                                      setOfParallelYears& batch);
 
    void loopThroughYears(uint firstYear, uint endYear, std::vector<Variable::State>& state);
 
    Solver::Private::Simulation::CacheData pData;
    uint pNbYearsReallyPerformed;
    uint pNbMaxPerformedYearsInParallel;
    bool pYearByYear;
    bool pFirstSetParallelWithAPerformedYearWasRun;
 
    annualCostsStatistics pAnnualStatistics;
 
    // Collecting durations inside the simulation
    Benchmarking::DurationCollector& pDurationCollector;
 
public:
    std::shared_ptr<Yuni::Job::QueueService> pQueueService = nullptr;
    Antares::Solver::IResultWriter& pResultWriter;
 
    std::reference_wrapper<ISimulationObserver> simulationObserver_;
}; // class ISimulation
} // namespace Antares::Solver::Simulation
 
#include "solver.hxx"
 
#endif // __SOLVER_SIMULATION_SOLVER_H__