bindConstraints.hxx

/*
** 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
 
#include <utility>
#include <vector>
 
#include "antares/study/binding_constraint/BindingConstraint.h"
#include "antares/study/fwd.h"
 
#include "bindConstraints.h"
 
namespace Antares::Solver::Variable
{
template<class NextT>
void BindingConstraints<NextT>::buildSurveyReport(SurveyResults& results,
                                                  int dataLevel,
                                                  int fileLevel,
                                                  int precision) const
{
    if (bool bcDataLevel = dataLevel & Category::DataLevel::bindingConstraint; !bcDataLevel)
    {
        return;
    }
 
    for (uint i = 0; i != pBCcount; ++i)
    {
        const NextType& bc = pBindConstraints[i];
 
        bc.buildSurveyReport(results, dataLevel, fileLevel, precision);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::buildAnnualSurveyReport(SurveyResults& results,
                                                        int dataLevel,
                                                        int fileLevel,
                                                        int precision,
                                                        uint numSpace) const
{
    if (bool bcDataLevel = dataLevel & Category::DataLevel::bindingConstraint; !bcDataLevel)
    {
        return;
    }
 
    for (uint i = 0; i != pBCcount; ++i)
    {
        const NextType& bc = pBindConstraints[i];
 
        bc.buildAnnualSurveyReport(results, dataLevel, fileLevel, precision, numSpace);
    }
}
 
template<class NextT>
template<class PredicateT>
inline void BindingConstraints<NextT>::RetrieveVariableList(PredicateT& predicate)
{
    NextType::RetrieveVariableList(predicate);
}
 
template<class NextT>
template<class I>
inline void BindingConstraints<NextT>::provideInformations(I& infos)
{
    // Begining of the node
    if (VCardType::nodeDepthForGUI)
    {
        infos.template beginNode<VCardType>();
        // Next variable in the list
        NextType::template provideInformations<I>(infos);
        // End of the node
        infos.endNode();
    }
    else
    {
        // Giving our VCard
        infos.template addVCard<VCardType>();
        // Next variable in the list
        NextType::template provideInformations<I>(infos);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::simulationBegin()
{
    for (auto& bc: pBindConstraints)
    {
        bc.simulationBegin();
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::simulationEnd()
{
    for (auto& bc: pBindConstraints)
    {
        bc.simulationEnd();
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::yearEndBuild(State& /*state*/, uint /*year*/, uint /*numSpace*/)
{
}
 
template<class NextT>
void BindingConstraints<NextT>::initializeFromStudy(Data::Study& study)
{
    const std::vector<std::shared_ptr<Data::BindingConstraint>>
      inequalityByPtr = study.bindingConstraints.getPtrForInequalityBindingConstraints();
 
    // The total number of inequality binding constraints count
    // (we don't count BCs with equality sign)
    pBCcount = (uint)inequalityByPtr.size();
 
    // Reserving the memory
    if (pBCcount > 0)
    {
        pBindConstraints.resize(pBCcount);
    }
 
    for (uint i = 0; i != pBCcount; ++i)
    {
        NextType& bc = pBindConstraints[i];
 
        bc.setAssociatedBindConstraint(inequalityByPtr[i]);
        bc.initializeFromStudy(study);
 
        // Does user want to print output results related to the current binding constraint ?
        bc.getPrintStatusFromStudy(study);
    }
 
    // Here we supply the max number of columns to the variable print info collector
    // This is a ugly hack (it's a work around).
    // We should have a simple call to :
    //      NextType::supplyMaxNumberOfColumns(study);
    // Instead, we have a few lines as a hack.
    // What we have to do is add to the print info collector a single VariablePrintInfo
    // that has a max columns size of : (nb of inequality BCs) x ResultsType::count
    // But note that for now, BC output variables are chained statically (one output variable per
    // inequality BC). The hack is to make the first BC output variable able to supply max columns
    // size for all BC output variables with its method getMaxNumberColumns(). A solution would be
    // to make BC output variables (like BindingConstMarginCost) some DYNAMIC variables.
    if (pBCcount > 0)
    {
        NextType& bc = pBindConstraints[0];
        bc.setBindConstraintsCount(pBCcount);
        bc.supplyMaxNumberOfColumns(study);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::computeSummary(unsigned int year, unsigned int numSpace)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        // Broadcast to all constraints
        pBindConstraints[i].computeSummary(year, numSpace);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::yearBegin(uint year, uint numSpace)
{
    // Broadcast to all binding constraints
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].yearBegin(year, numSpace);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::yearEnd(uint year, uint numSpace)
{
    // Broadcast to all binding constraints
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].yearEnd(year, numSpace);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::weekBegin(State& state)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].weekBegin(state);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::weekEnd(State& state)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].weekEnd(state);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::hourBegin(uint hourInTheYear)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].hourBegin(hourInTheYear);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::hourEnd(State& state, uint hourInTheYear)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].hourEnd(state, hourInTheYear);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::weekForEachArea(State& state, unsigned int numSpace)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].weekForEachArea(state, numSpace);
    }
}
 
template<class NextT>
void BindingConstraints<NextT>::hourForEachArea(State& state, unsigned int numSpace)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].hourForEachArea(state, numSpace);
    }
}
 
template<class NextT>
template<class VCardToFindT>
inline void BindingConstraints<NextT>::retrieveResultsForArea(
  typename Storage<VCardToFindT>::ResultsType** result,
  const Data::Area* area)
{
    NextType::template retrieveResultsForArea<VCardToFindT>(result, area);
}
 
template<class NextT>
void BindingConstraints<NextT>::buildDigest(SurveyResults& results,
                                            int digestLevel,
                                            int dataLevel) const
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].buildDigest(results, digestLevel, dataLevel);
    }
}
 
template<class NextT>
template<class V>
void BindingConstraints<NextT>::simulationEndSpatialAggregates(V& allVars)
{
    NextType::template simulationEndSpatialAggregates<V>(allVars);
}
 
template<class NextT>
template<class V>
void BindingConstraints<NextT>::computeSpatialAggregatesSummary(V& allVars,
                                                                unsigned int year,
                                                                unsigned int numSpace)
{
    NextType::template computeSpatialAggregatesSummary<V>(allVars, year, numSpace);
}
 
template<class NextT>
void BindingConstraints<NextT>::beforeYearByYearExport(uint year, uint numSpace)
{
    for (uint i = 0; i != pBCcount; ++i)
    {
        pBindConstraints[i].beforeYearByYearExport(year, numSpace);
    }
}
 
template<class NextT>
template<class SearchVCardT, class O>
inline void BindingConstraints<NextT>::computeSpatialAggregateWith(O& out,
                                                                   const Data::Area* area,
                                                                   uint numSpace)
{
    NextType::template computeSpatialAggregateWith<SearchVCardT, O>(out, area, numSpace);
}
 
template<class NextT>
template<class VCardToFindT>
inline void BindingConstraints<NextT>::retrieveResultsForLink(
  typename Storage<VCardToFindT>::ResultsType** result,
  const Data::AreaLink* link)
{
    NextType::template retrieveResultsForLink<VCardToFindT>(result, link);
}
 
template<class NextT>
template<class VCardToFindT>
inline void BindingConstraints<NextT>::retrieveResultsForThermalCluster(
  typename Storage<VCardToFindT>::ResultsType** result,
  const Data::ThermalCluster* cluster)
{
    NextType::template retrieveResultsForThermalCluster<VCardToFindT>(result, cluster);
}
} // namespace Antares::Solver::Variable