Refactor objective function evaluators API and add cost-wise Search-Tree #1186

bqth29 · 2024-10-30T08:20:47Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?
Fixes #1053

What kind of change does this PR introduce?

Refactoring of objective function evaluators and results

Previously, ObjectiveFunctionResultImpl was a non final object that had its ObjectiveFunction as an attribute so it could be recomputed when contingencies need to be filtered out (in case curative perimeters fail for instance). This was quite ambiguous for a result object that should only hold immutable data.

In the new version, the results are decomposed based on the states and can be filtered in case contingencies need to be excluded.

Finally, the objective function builder was becoming useless with this refactoring and was thus replaced by creators as follows:

What is the current behavior?

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change or deprecate an API?

Yes
No

If yes, please check if the following requirements are fulfilled

The Breaking Change or Deprecated label has been added
The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

Other information:

bqth29 · 2024-11-07T15:01:50Z

@phiedw what do you think about including the min margin overload in virtual cost?

pet-mit

I feel that you haven't finished this, let me know when you do

...java/com/powsybl/openrao/data/cracio/json/deserializers/PstRangeActionArrayDeserializer.java

docs/input-data/crac/json.md

...rao-api/src/main/java/com/powsybl/openrao/raoapi/parameters/ObjectiveFunctionParameters.java

...owsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/FunctionalCostEvaluator.java

bqth29 · 2024-11-14T12:47:33Z

I feel that you haven't finished this, let me know when you do

This PR only focuses on costly network actions, range actions will come in another PR later
I may have unintentionally forgotten features but I believe this PR is ready

...c-io-json/src/main/java/com/powsybl/openrao/data/cracio/json/JsonSerializationConstants.java

...bl/openrao/searchtreerao/commons/objectivefunctionevaluator/RemedialActionCostEvaluator.java

...rc/main/java/com/powsybl/openrao/searchtreerao/result/impl/AutomatonPerimeterResultImpl.java

.../java/com/powsybl/openrao/searchtreerao/result/impl/PreventiveAndCurativesRaoResultImpl.java

...src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorFullOptimization.java

...java/com/powsybl/openrao/data/cracio/json/deserializers/StandardRangeActionDeserializer.java

...java/com/powsybl/openrao/searchtreerao/castor/algorithm/PrePerimeterSensitivityAnalysis.java

...va/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/EvaluatorsUtils.java

.../com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/ObjectiveFunction.java

.../com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/OverloadEvaluator.java

...bl/openrao/searchtreerao/commons/objectivefunctionevaluator/RemedialActionCostEvaluator.java

Signed-off-by: Peter Mitri <peter.mitri@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

…se of violation (#1154) * Round angle value with more decimals in case of violation Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * linter Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Create static method computeNumberOfRelevantDecimals in SweCneUtil Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Sonar Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Export flow as double Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Round double flow value with relevant decimals Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * define rounding noise as class constant Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Move decimals computation to commons Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Round flows, angles and voltages more properly in RaoResult Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Round flows, angles and voltages more properly in RaoResult Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Mutualize rounding using margin value Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * use default decimals in decimals computing Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * use default decimals in decimals computing Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * add docstring Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * simplify angle margin computation Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * round flow value in logs Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * round swe cne export values with 1 default decimal Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * round swe cne export values with 1 default decimal Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * rollback to bigdecimals in rounding tests Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * adapt logging Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> * MR comments Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> * generate getters for MonitoringResult Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> * add cucumber step Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> * MR comments 2 Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> --------- Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> Co-authored-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

* Generify CSA CRAC Creation Parameters Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Add curative instants in parameters Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Create curative instants from crac creation parameters Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * add TODO Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Merge main Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> * Replace list of pair by map Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> --------- Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com> Co-authored-by: benrejebmoh <48012306+benrejebmoh@users.noreply.github.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

# Conflicts: # data/crac/crac-io/crac-io-json/src/main/resources/schemas/network-action/network-action-v1.8.json # data/crac/crac-io/crac-io-json/src/main/resources/schemas/network-action/network-action-v2.5.json # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorFullOptimization.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/RaoLogger.java

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

...search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/FlowCnecSorting.java

...m/powsybl/openrao/searchtreerao/commons/costevaluatorresult/AbsoluteCostEvaluatorResult.java

.../openrao/searchtreerao/commons/costevaluatorresult/AbstractStateWiseCostEvaluatorResult.java

...com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/MinMarginEvaluator.java

...bl/openrao/searchtreerao/commons/objectivefunctionevaluator/MinMarginViolationEvaluator.java

...ybl/openrao/searchtreerao/commons/objectivefunctionevaluator/MnecViolationCostEvaluator.java

...openrao/searchtreerao/commons/objectivefunctionevaluator/LoopFlowViolationCostEvaluator.java

...ybl/openrao/searchtreerao/commons/objectivefunctionevaluator/MnecViolationCostEvaluator.java

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

.../openrao/searchtreerao/commons/costevaluatorresult/AbstractStateWiseCostEvaluatorResult.java

...bl/openrao/searchtreerao/commons/objectivefunctionevaluator/MinMarginViolationEvaluator.java

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

# Conflicts: # data/crac/crac-impl/src/main/java/com/powsybl/openrao/data/crac/impl/AbstractStandardRangeActionAdder.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/crac/impl/CounterTradeRangeActionAdderImplTest.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/crac/impl/HvdcRangeActionAdderImplTest.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/crac/impl/InjectionRangeActionAdderImplTest.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/crac/impl/PstRangeActionAdderImplTest.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/crac/impl/utils/ExhaustiveCracCreation.java # data/crac/crac-io/crac-io-json/src/main/java/com/powsybl/openrao/data/crac/io/json/JsonSerializationConstants.java # data/crac/crac-io/crac-io-json/src/main/java/com/powsybl/openrao/data/crac/io/json/serializers/NetworkActionSerializer.java # data/crac/crac-io/crac-io-json/src/main/java/com/powsybl/openrao/data/crac/io/json/serializers/PstRangeActionSerializer.java # data/crac/crac-io/crac-io-json/src/main/java/com/powsybl/openrao/data/crac/io/json/serializers/StandardRangeActionSerializer.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/PrePerimeterSensitivityAnalysis.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/RaoLogger.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/CostEvaluator.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/LoopFlowViolationCostEvaluator.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/MinMarginEvaluator.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/MnecViolationCostEvaluator.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/ObjectiveFunction.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/ObjectiveFunctionResultImpl.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/SensitivityFailureOvercostEvaluator.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/MinMarginEvaluatorTest.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/ObjectiveFunctionTest.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/SensitivityFailureOvercostEvaluatorTest.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/RangeActionActivationResultImplTest.java

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

# Conflicts: # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/SensitivityFailureOvercostEvaluator.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/AutomatonPerimeterResultImpl.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/CurativeWithSecondPraoResult.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/IteratingLinearOptimizationResultImpl.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/OptimizationResultImpl.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/PrePerimeterSensitivityResultImpl.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/PreventiveAndCurativesRaoResultImpl.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/SkippedOptimizationResultImpl.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/OptimizationResultImplTest.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/PreventiveAndCurativesRaoResultImplTest.java

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

# Conflicts: # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorFullOptimization.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/PreventiveAndCurativesRaoResultImpl.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorFullOptimizationTest.java

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

lack of time

bqth29 added the feature New feature or request label Oct 30, 2024

bqth29 linked an issue Oct 30, 2024 that may be closed by this pull request

Cost minimization mode #1054

Closed

bqth29 marked this pull request as ready for review November 8, 2024 12:39

bqth29 requested review from pet-mit and phiedw November 8, 2024 12:40

bqth29 changed the base branch from feature/activation-cost to main November 8, 2024 12:40

pet-mit requested changes Nov 14, 2024

View reviewed changes

bqth29 requested a review from pet-mit November 14, 2024 12:54

bqth29 mentioned this pull request Nov 14, 2024

Use Range Action variations variables in margin optimization #1196

Closed

bqth29 added PR: waiting-for-review This PR is waiting to be reviewed PR : dont-merge-before-other PR mustn't be merged before another (referenced in the description or in the comments) labels Nov 18, 2024

pet-mit previously requested changes Nov 18, 2024

View reviewed changes

phiedw requested changes Nov 18, 2024

View reviewed changes

pet-mit and others added 11 commits November 26, 2024 13:14

prepare next release v6.2.0-SNAPSHOT

8bfe021

Signed-off-by: Peter Mitri <peter.mitri@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

expose securityStatus (#1179)

3a4fe90

Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

prepare release 6.1.1

c70359e

Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

prepare next release 6.2.0-SNAPSHOT

4f834cf

Signed-off-by: Godelaine de Montmorillon <godelaine.demontmorillon@rte-france.com> Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

updated parent pom to v19 (#1169)

7da1c35

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

add activation and variation costs in API

81dcc1c

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Add activatoin cost in JSON CRAC

813917f

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Add variation costs in JSON CRAC

20cdb12

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Serialization of costs

f7de661

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

bqth29 removed the PR: waiting-for-correction This PR is waiting to be corrected by its author label Nov 26, 2024

bqth29 requested review from pet-mit and phiedw November 26, 2024 12:26

bqth29 changed the title ~~Cost-wise Search-Tree~~ Refactor objective function evaluators API and add cost-wise Search-Tree Nov 26, 2024

remove useless method

1c5160a

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

phiedw requested changes Nov 27, 2024

View reviewed changes

bqth29 added 2 commits November 28, 2024 10:27

fix after comments

a3408a7

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

fix test

7f0cf47

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

phiedw reviewed Nov 28, 2024

View reviewed changes

.../openrao/searchtreerao/commons/costevaluatorresult/AbstractStateWiseCostEvaluatorResult.java Outdated Show resolved Hide resolved

...bl/openrao/searchtreerao/commons/objectivefunctionevaluator/MinMarginViolationEvaluator.java Show resolved Hide resolved

rename method

c14feed

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

bqth29 requested a review from phiedw November 28, 2024 14:48

bqth29 added 3 commits December 2, 2024 11:09

remove null cost threshold on mnecs

1f8634b

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

merge main

0f7b310

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

bqth29 mentioned this pull request Dec 2, 2024

Add remedial actions' activation cost and range actions' variation costs in API #1182

Closed

7 tasks

bqth29 and others added 3 commits December 2, 2024 15:14

merge main

07b2eed

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

Merge branch 'main' into feature/cost-search-tree

d1b81fe

phiedw previously approved these changes Dec 2, 2024

View reviewed changes

bqth29 added the new-crac-version This pull request introduces a new version of the JSON CRAC format label Dec 2, 2024

Merge branch 'main' into feature/cost-search-tree

8350d84

bqth29 mentioned this pull request Dec 6, 2024

Power Gradient Constraints #1218

Open

bqth29 removed the request for review from pet-mit December 9, 2024 13:37

bqth29 added 2 commits December 9, 2024 14:45

merge main

251aa8a

Signed-off-by: Thomas Bouquet <thomas.bouquet@rte-france.com>

bqth29 dismissed phiedw’s stale review via 251aa8a December 9, 2024 13:55

phiedw approved these changes Dec 10, 2024

View reviewed changes

phiedw merged commit 8ad6dfc into main Dec 10, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor objective function evaluators API and add cost-wise Search-Tree #1186

Refactor objective function evaluators API and add cost-wise Search-Tree #1186

bqth29 commented Oct 30, 2024 •

edited

Loading

bqth29 commented Nov 7, 2024

pet-mit left a comment

bqth29 commented Nov 14, 2024

Refactor objective function evaluators API and add cost-wise Search-Tree #1186

Refactor objective function evaluators API and add cost-wise Search-Tree #1186

Conversation

bqth29 commented Oct 30, 2024 • edited Loading

bqth29 commented Nov 7, 2024

pet-mit left a comment

Choose a reason for hiding this comment

bqth29 commented Nov 14, 2024

bqth29 commented Oct 30, 2024 •

edited

Loading