Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
load-options.h
1/*
2** Copyright 2007-2024, RTE (https://www.rte-france.com)
3** See AUTHORS.txt
4** SPDX-License-Identifier: MPL-2.0
5** This file is part of Antares-Simulator,
6** Adequacy and Performance assessment for interconnected energy networks.
7**
8** Antares_Simulator is free software: you can redistribute it and/or modify
9** it under the terms of the Mozilla Public Licence 2.0 as published by
10** the Mozilla Foundation, either version 2 of the License, or
11** (at your option) any later version.
12**
13** Antares_Simulator is distributed in the hope that it will be useful,
14** but WITHOUT ANY WARRANTY; without even the implied warranty of
15** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16** Mozilla Public Licence 2.0 for more details.
17**
18** You should have received a copy of the Mozilla Public Licence 2.0
19** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20*/
21#ifndef __ANTARES_LIBS_SOLVER_LOAD_OPTIONS_H__
22#define __ANTARES_LIBS_SOLVER_LOAD_OPTIONS_H__
23
24#include <yuni/yuni.h>
25#include <yuni/core/string.h>
26
27#include <antares/optimization-options/options.h>
28
29#include "parameters.h"
30
31namespace Antares
32{
33namespace Data
34{
36{
37public:
39
40
43
44 void checkForceSimulationMode();
45
46public:
48 uint nbYears;
55
58
60 // This option might be useful for running old studies without upgrading
62
64 SimplexOptimization simplexOptimizationRange;
68 bool namedProblems = false;
72 SimulationMode forceMode;
73
76
79 uint maxNbYearsInParallel;
80
83
86
88 mutable Yuni::String logMessage;
89
91 bool displayVersion = false;
92
94 bool listSolvers = false;
95
97 bool forceExpansion = false;
98 bool forceEconomy = false;
99 bool forceAdequacy = false;
100
101 YString studyFolder;
102 YString simulationName;
103}; // class StudyLoadOptions
104
105} // namespace Data
106} // namespace Antares
107
108#endif // __ANTARES_LIBS_SOLVER_LOAD_OPTIONS_H__
Definition load-options.h:36
SimplexOptimization simplexOptimizationRange
Simplex optimization range.
Definition load-options.h:64
bool listSolvers
True => display the list of OR-Tools solvers and exit.
Definition load-options.h:94
bool forceYearByYear
Force the year-by-year flag.
Definition load-options.h:54
bool forceParallel
Force a maximum number of MC years computed simultaneously.
Definition load-options.h:78
bool ignoreConstraints
Ignore all constraints.
Definition load-options.h:70
bool noTimeseriesImportIntoInput
No Timeseries import in the input.
Definition load-options.h:61
bool forceExpansion
Simulation mode.
Definition load-options.h:97
bool enableParallel
Enables the parallel computation of MC years.
Definition load-options.h:75
StudyLoadOptions()
Default constructor.
Definition load-options.cpp:29
bool prepareOutput
True to prepare the output folder.
Definition load-options.h:50
bool forceDerated
Force the derated mode.
Definition load-options.h:57
bool namedProblems
named problems
Definition load-options.h:68
bool usedByTheSolver
A non-zero value if the data will be used for a simulation.
Definition load-options.h:82
bool displayVersion
Display version number and exit.
Definition load-options.h:91
Antares::Solver::Optimization::OptimizationOptions optOptions
All options related to optimization.
Definition load-options.h:85
SimulationMode forceMode
Simulation mode.
Definition load-options.h:72
uint nbYears
The number of MC years (non-zero to force the value)
Definition load-options.h:48
Yuni::String logMessage
Temporary string for passing log message.
Definition load-options.h:88
bool mpsToExport
Mps files export asked.
Definition load-options.h:66
bool loadOnlyNeeded
True to load only the strictly required data.
Definition load-options.h:52