h2o_m_donnees_annuelles.h

/*
** Copyright 2007-2025, 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/>.
*/
 
#pragma once
 
#define OUI 1
#define NON 0
#define EMERGENCY_SHUT_DOWN 2
 
constexpr unsigned nbMonths = 12;
 
#include "h2o_m_donnees_optimisation.h"
 
/*************************************************************************************************/
/*                    Structure contenant les champs a renseigner par l'appelant */
 
struct DONNEES_ANNUELLES
{
    // ==========================================
    // En entree:
    //      seules les donnees ci-dessous doivent etre renseignees par l'appelant apres
    //      avoir appele " H2O_M_Instanciation "
    // ==========================================
    double CoutDepassementVolume{0.};
    double CoutViolMaxDuVolumeMin{0.};
    double overflowfCost{0.};
 
    double VolumeInitial{0.};
 
    // Commence a 0 pour le 1er janvier et se termine a 11 pour le 1er decembre
    std::vector<double> TurbineMax;
    std::vector<double> TurbineMin;
    std::vector<double> TurbineCible;
    std::vector<double> Apport;
 
    // Pour decrire la bande de volumes permise
    std::vector<double> VolumeMin; /* A renseigner par l'appelant : 1 valeur par mois */
    std::vector<double> VolumeMax; /* A renseigner par l'appelant : 1 valeur par mois */
 
    // =============================================
    // Les resultats (a recuperer par l'appelant)
    // =============================================
    //  Resultats Valides ?
    //      OUI si la solution est exploitable pour le reservoir
    //      NON s'il y a eu un probleme dans la resolution
    //      EMERGENCY_SHUT_DOWN si la resolution du probleme a donne lieu a une erreur interne
    char ResultatsValides{NON};
 
    std::vector<double> Turbine;
    std::vector<double> Volume;
    std::vector<double> overflow;
 
    // Problemes internes (utilise uniquement par l'optimisation)
    DonneesOptimisationMensuelle::PROBLEME_HYDRAULIQUE ProblemeHydraulique{};
};