Replace "Usage Rules" by "Trigger Conditions" #1050

bqth29 · 2024-06-20T15:06:21Z

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 #992

What kind of change does this PR introduce?
Usage Rules have been discarded and replaced by Trigger Conditions that carry a sort of logical gates on four conditions: instant, contingency, cnec and country.

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)

TODO

Other information:

Signed-off-by: Thomas Bouquet <[email protected]>

# Conflicts: # data/crac-creation/crac-creator-csa-profiles/src/main/java/com/powsybl/openrao/data/craccreation/creator/csaprofile/craccreator/remedialaction/CsaProfileRemedialActionsCreator.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/parameters/UnoptimizedCnecParameters.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/commons/RaoUtilTest.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/commons/parameters/UnoptimizedCnecParametersTest.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/fillers/UnoptimizedCnecFillerPstLimitationRuleTest.java

Signed-off-by: Thomas Bouquet <[email protected]>

pet-mit

I think we should discuss the design more

pet-mit · 2024-06-26T13:46:19Z

...t/java/com/powsybl/openrao/data/craccreation/creator/cim/craccreator/CimCracCreatorTest.java

-                                        && ur.getUsageMethod().equals(instant.isAuto() ? UsageMethod.FORCED : UsageMethod.AVAILABLE)
-                        ));
+            ra.getTriggerConditions().stream()
+                .filter(tc -> tc.getContingency().isEmpty() && tc.getCnec().isPresent() && tc.getCountry().isEmpty())


how about we add a TriggerCondition.getType() method, that returns an enum, to retrieve the business type of the trigger condition? (equivalent to the types we had before)

yes this could work

that may make the code a few less flexible than it was first intended but for readability's sake it might be better indeed

I added the TriggerConditionType enum.

pet-mit · 2024-06-26T14:04:53Z

...creation/creator/csaprofile/craccreator/remedialaction/CsaProfileRemedialActionsCreator.java

        cnecStatusMap.forEach((cnecId, cnecStatus) -> {
            if (cnecStatus.isValid()) {
                Cnec<?> cnec = crac.getCnec(cnecId);
                UsageMethod usageMethod = getUsageMethod(cnecStatus.elementCombinationConstraintKind(), isSchemeRemedialAction, instant, remedialActionType);
                if (isOnConstraintInstantCoherent(cnec.getState().getInstant(), instant)) {
-                    remedialActionAdder.newOnConstraintUsageRule()
+                    remedialActionAdder.newTriggerCondition()
                        .withInstant(instant.getId())
                        .withCnec(cnecId)
                        .withUsageMethod(usageMethod)


we might as well rename UsageMethod, it doesn't make sense anymore

yes, we discussed about this with @phiedw and agreed a new name may be better
the question is: how should we rename it?

...n/java/com/powsybl/openrao/data/craciojson/deserializers/NetworkActionArrayDeserializer.java

data/crac/crac-impl/src/main/java/com/powsybl/openrao/data/cracimpl/CracImpl.java

pet-mit · 2024-06-26T14:33:20Z

...rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/AutomatonSimulator.java

@@ -368,11 +368,11 @@ Set<FlowCnec> gatherFlowCnecsForAutoRangeAction(RangeAction<?> availableRa,
                                                    Network network) {
        // UsageMethod should be FORCED
        if (availableRa.getUsageMethod(automatonState).equals(UsageMethod.FORCED)) {
-            if (availableRa.getUsageRules().stream().filter(usageRule -> usageRule instanceof OnInstant || usageRule instanceof OnContingencyState)
-                .anyMatch(usageRule -> usageRule.getUsageMethod(automatonState).equals(UsageMethod.FORCED))) {
+            if (availableRa.getTriggerConditions().stream().filter(triggerCondition -> triggerCondition.getCnec().isEmpty() && triggerCondition.getCountry().isEmpty())


I'm not a fan of checking emptiness of attributes to know if an RA is applicable... we should discuss how to improve this design

I agree, I just did this as a temporary solution for the behavior to be the same before and after the new code
But this is not elegant at all and I think there are some design discussions needed here

I changed this by checking the type of TriggerCondition. If you think this is a better way to do, we could generalize the usage elsewhere in the code (mainly in tests).

Signed-off-by: Thomas Bouquet <[email protected]>

# Conflicts: # data/crac-io/crac-io-json/src/test/java/com/powsybl/openrao/data/craciojson/CracImportExportTest.java # data/rao-result/rao-result-json/src/test/java/com/powsybl/openrao/data/raoresultjson/RaoResultRoundTripTest.java

Signed-off-by: Thomas Bouquet <[email protected]>

# Conflicts: # data/crac-creation/crac-creator-csa-profiles/src/test/java/com/powsybl/openrao/data/craccreation/creator/csaprofile/craccreator/cnec/FlowCnecCreationTest.java # data/crac-creation/crac-creator-csa-profiles/src/test/java/com/powsybl/openrao/data/craccreation/creator/csaprofile/craccreator/remedialaction/GroupRemedialActionTest.java # data/crac-creation/crac-creator-csa-profiles/src/test/java/com/powsybl/openrao/data/craccreation/creator/csaprofile/craccreator/remedialaction/PstRangeActionCreationTest.java # data/crac-creation/crac-creator-csa-profiles/src/test/java/com/powsybl/openrao/data/craccreation/creator/csaprofile/craccreator/remedialaction/RemedialActionCreationTest.java # data/crac-io/crac-io-json/src/main/java/com/powsybl/openrao/data/craciojson/JsonSerializationConstants.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/cracimpl/OnConstraintAdderImplTest.java # data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/cracimpl/OnFlowConstraintInCountryAdderImplTest.java

Signed-off-by: Thomas Bouquet <[email protected]>

bqth29 · 2024-08-19T14:38:10Z

Since the code must be made common with PowSyBl (cf. #1067) I suggest to close this PR for the moment

bqth29 added 10 commits June 18, 2024 09:56

Remove OnContingencyStateAdderToRemedialAction

660e4e7

Signed-off-by: Thomas Bouquet <[email protected]>

Create TriggerCondition in API

e9dbf90

Signed-off-by: Thomas Bouquet <[email protected]>

Delete usage rules

75e75b6

Signed-off-by: Thomas Bouquet <[email protected]>

Fix tests

c8bd484

Signed-off-by: Thomas Bouquet <[email protected]>

Remove all mentions to usage rules

6aa22b2

Signed-off-by: Thomas Bouquet <[email protected]>

TriggerCondition docstring

f19a87c

Signed-off-by: Thomas Bouquet <[email protected]>

Check version of CRAC in deserialization

7c70f16

Signed-off-by: Thomas Bouquet <[email protected]>

Docs

48cf724

Signed-off-by: Thomas Bouquet <[email protected]>

Typo

849ad89

Signed-off-by: Thomas Bouquet <[email protected]>

Change cucumber tests

26c85f5

Signed-off-by: Thomas Bouquet <[email protected]>

bqth29 added feature New feature or request cleaning This issue or pull request only concerns improving the overall state of the code breaking-change Changes could break users' code experiment This subject is experimental and needs to be discussed thoroughly first labels Jun 20, 2024

bqth29 added 4 commits June 21, 2024 09:40

Sonar

3b875e6

Signed-off-by: Thomas Bouquet <[email protected]>

Coverage

1506603

Signed-off-by: Thomas Bouquet <[email protected]>

Sonar

717d497

Signed-off-by: Thomas Bouquet <[email protected]>

bqth29 added the PR: waiting-for-review This PR is waiting to be reviewed label Jun 24, 2024

pet-mit requested changes Jun 26, 2024

View reviewed changes

pet-mit marked this pull request as draft June 26, 2024 15:06

bqth29 added 5 commits June 27, 2024 10:58

Delete older usage rules adders

b0ee043

Signed-off-by: Thomas Bouquet <[email protected]>

Update CracImpl

a717294

Signed-off-by: Thomas Bouquet <[email protected]>

Add TriggerConditionType

d18e02c

Signed-off-by: Thomas Bouquet <[email protected]>

Merge main

0378583

Signed-off-by: Thomas Bouquet <[email protected]>

bqth29 mentioned this pull request Jun 27, 2024

Mutualize usage rules with powsybl #1067

Open

bqth29 and others added 3 commits June 27, 2024 14:19

Example of usage of TriggerConditionType

c13e43d

Signed-off-by: Thomas Bouquet <[email protected]>

Merge branch 'main' into experiment/logical-gates-for-usage-rules

2ed2313

Merge main

df82e1f

Signed-off-by: Thomas Bouquet <[email protected]>

bqth29 closed this Aug 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace "Usage Rules" by "Trigger Conditions" #1050

Replace "Usage Rules" by "Trigger Conditions" #1050

bqth29 commented Jun 20, 2024 •

edited

Loading

pet-mit left a comment

pet-mit Jun 26, 2024

bqth29 Jun 26, 2024

bqth29 Jun 26, 2024

bqth29 Jun 27, 2024

pet-mit Jun 26, 2024

bqth29 Jun 26, 2024

pet-mit Jun 26, 2024

bqth29 Jun 26, 2024

bqth29 Jun 27, 2024

bqth29 commented Aug 19, 2024

Replace "Usage Rules" by "Trigger Conditions" #1050

Replace "Usage Rules" by "Trigger Conditions" #1050

Conversation

bqth29 commented Jun 20, 2024 • edited Loading

pet-mit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bqth29 commented Aug 19, 2024

bqth29 commented Jun 20, 2024 •

edited

Loading