categories.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/>.
*/
#ifndef __SOLVER_VARIABLE_CATEGORIES_H__
#define __SOLVER_VARIABLE_CATEGORIES_H__
 
#include <antares/antares/constants.h>
 
namespace Antares::Solver::Variable::Category
{
namespace DataLevel
{
constexpr uint8_t area = 1;
constexpr uint8_t thermalAggregate = 2;
constexpr uint8_t link = 4;
constexpr uint8_t setOfAreas = 8;
// Data belonging to a binding constraint
constexpr uint8_t bindingConstraint = 16;
constexpr uint8_t maxDataLevel = 16;
} // namespace DataLevel
 
namespace FileLevel
{
constexpr uint8_t va = 1;
constexpr uint8_t id = 2;
constexpr uint8_t de = 4;
constexpr uint8_t de_res = 8;
constexpr uint8_t bc = 16;
constexpr uint8_t de_sts = 32;
constexpr uint8_t maxFileLevel = 32;
constexpr uint8_t allFile = va | id | de | de_res | bc | de_sts;
}; // namespace FileLevel
 
enum Precision
{
    hourly = 1,
    daily = 2,
    weekly = 4,
    monthly = 8,
    annual = 16,
    all = hourly | daily | weekly | monthly | annual,
};
 
enum ColumnManagement
{
    dynamicColumns = -1,
    noColumn = 0,
    singleColumn = 1,
};
 
enum Digest
{
    digestNone = 0,
    digestAllYears = 1,
    digestFlowLinear = 2,
    digestFlowQuad = 4,
};
 
enum SpatialAggregate
{
    noSpatialAggregate = 0,
    spatialAggregateSum = 1,
    spatialAggregateMax = 2,
    spatialAggregateAverage = 4,
    spatialAggregateSumThen1IfPositive = 8,
    spatialAggregateOr = 16,
};
 
enum SpatialAggregateMode
{
    spatialAggregateEachYear = 1,
    spatialAggregateOnce = 2,
};
 
enum SpatialAggregatePostProcessing
{
    spatialAggregatePostProcessingPrice = 1,
};
 
static inline uint MaxDecimalPrecision(uint fileLevel)
{
    return (fileLevel != FileLevel::id) ? 2u : 0u;
}
 
template<int Index, int Limit>
struct NextLevel
{
    enum
    {
        next = (Index != Limit) ? Index * 2 : 0,
    };
};
 
template<class StreamT>
inline void DataLevelToStream(StreamT& out, int dataLevel)
{
    switch (dataLevel)
    {
        using namespace DataLevel;
    case area:
        out += "area";
        break;
    case thermalAggregate:
        out += "thermal";
        break;
    case link:
        out += "link";
        break;
    case setOfAreas:
        out += "set of areas";
        break;
    default:
        out += NULL;
    };
}
 
template<class StreamT>
inline void FileLevelToStreamShort(StreamT& out, int fileLevel)
{
    switch (fileLevel)
    {
        using namespace FileLevel;
    case va:
        out += "va";
        break;
    case id:
        out += "id";
        break;
    case de:
        out += "de";
        break;
    case de_res:
        out += "res";
        break;
    case bc:
        out += "bc";
        break;
    case de_sts:
        out += "sts";
        break;
    default:
        out += NULL;
    }
}
 
template<class StreamT>
inline void FileLevelToStream(StreamT& out, int fileLevel)
{
    switch (fileLevel)
    {
        using namespace FileLevel;
    case va:
        out += "values";
        break;
    case id:
        out += "id";
        break;
    case de:
        out += "details";
        break;
    case de_res:
        out += "details-res";
        break;
    case bc:
        out += "binding-constraints";
        break;
    case de_sts:
        out += "details-STstorage";
        break;
    default:
        out += NULL;
    }
}
 
template<class StreamT>
inline void PrecisionLevelToStream(StreamT& out, int precisionLevel)
{
    switch (precisionLevel)
    {
    case hourly:
        out += "hourly";
        break;
    case daily:
        out += "daily";
        break;
    case weekly:
        out += "weekly";
        break;
    case monthly:
        out += "monthly";
        break;
    case annual:
        out += "annual";
        break;
    default:
        out += NULL;
    }
}
 
} // namespace Antares::Solver::Variable::Category
 
#endif // __SOLVER_VARIABLE_CATEGORIES_H__