Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Newton raphson new stopping criteria #699

Merged
merged 38 commits into from
Feb 10, 2023
Merged

Newton raphson new stopping criteria #699

merged 38 commits into from
Feb 10, 2023

Conversation

lejeana
Copy link
Contributor

@lejeana lejeana commented Jan 10, 2023

Please check if the PR fulfills these requirements (please use '[x]' to check the checkboxes, or submit the PR and then click the checkboxes)

  • 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)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
feature: add a new Newton-Raphson convergence criteria for OPLF.

What is the current behavior? (You can also link to an open issue here)
Only one Newton-Raphson convergence criteria that is hardcoded using mismatch vector norm

What is the new behavior (if this is a feature change)?
A new Newton-Raphson convergence criteria that different value based on the unit for Voltage, Active Power, Reactive Power.

Does this PR introduce a breaking change or deprecate an API? If yes, check the following:

  • The Breaking Change or Deprecated label has been added
  • The migration guide has been updated in the github wiki (What changes might users need to make in their application due to this PR?)

@lejeana lejeana requested a review from obrix January 10, 2023 14:37
obrix
obrix requested changes Jan 11, 2023
View reviewed changes
src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/CustomNewtonRaphsonStoppingCriteria.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/CustomNewtonRaphsonStoppingCriteria.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/CustomNewtonRaphsonStoppingCriteria.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/NewtonRaphsonStoppingCriteriaType.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/CustomNewtonRaphsonStoppingCriteria.java Outdated Show resolved Hide resolved
@AnkurArohi
Copy link

I do not understand what exactly is here the criterion

@Hadrien-Godard
Copy link
Member

I do not understand what exactly is here the criterion

Hi Ankur, in current main branch, the criterion is to have a norm 2 difference between target vector and equations evaluation under a threshold (10^-4) by default.
Here the criterion is to check, equation by equation, that norm 1 difference between the target and the equation evaluation is under a threshold. The threshold is different for each equation type based on the physical unit involved.

@obrix obrix removed the prototype label Jan 18, 2023
@obrix obrix force-pushed the newtonraphsonnewstoppingcriteria branch from 4207797 to 1d90dd8 Compare January 18, 2023 15:46
lejeana added 12 commits January 31, 2023 11:47
@lejeana @obrix
WIP try adding new convergence criteria
af94038 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
revert change from last commit
8779d26 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
feature(OPLF/ac): changed class NewtonRaphsonStoppingCriteria to requ…
f38db60 
…ire an EquationSystem to call the method Test()

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
feat(OPLF/ac): added a new class that inherits from NewtonRaphsonStop…
418dd86 
…pingCriteria

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
feat(OPLF/ac): added possible usage in OpenLoadFlowParameters of the …
ab658e8 
…new implemented class NewtonRaphsonStoppingCriteria

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
fix(OPLF/parameters): added suffix DEFAULT_VALUE to constants that re…
74ff9f6 
…present a constant value.

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
refactor(OPLF): changed variable's name in enum NewtonRaphsonStopping…
1a735ea 
…CriteriaType

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
feat(OPLF/parameters): changed a return null to a throw exception for…
88117d7 
… better trace in log in case of error

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
fix(OPLF): added Licence Identifier and fix author in file CustomNewt…
7599960 
…onRaphsonStoppingCriteria.java

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
refactor(OPLF): drop legacy code
358d2e4 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
feat(OPLF/parameters): added get/set for new attributes
c9cc199 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
fix(OPLF/parameters): updated toString() method
9b19840 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
lejeana and others added 6 commits January 31, 2023 11:50
@lejeana @obrix
fix(OPLF/NewtonCriteria): update tests to pass the new modifications
68ad866 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@obrix
Rename stopping criteria and try unlock the ci.
d30c3d7 
Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>
@lejeana @obrix
fix(OPLF/NewtonCriteria): corrected default value of the maximum volt…
086ce75 
…age mismatch

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
refactoring(OPLF/NewtonCriteria): renamed variables as discussed in t…
33e236a 
…he pull request

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana @obrix
test(OPLF/NewtonCriteria): added new class test for Newton-Raphson st…
9aba8ef 
…opping criteria

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@obrix
Update number of parameters after rebase.
96d63ae 
Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>
@obrix obrix force-pushed the newtonraphsonnewstoppingcriteria branch from 03aa6ce to 96d63ae Compare January 31, 2023 10:53
lejeana and others added 3 commits January 31, 2023 17:04
@lejeana
feat(OPLF/NewtonCriteria): added access to mismatch value for angle, …
0fc5bda 
…ratio and susceptance.

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
test(OPLF/NewtonCriteria): added test for angle mismatch in NewtonRap…
dbb75bf 
…hsonCriteria.

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@geofjamg
Merge branch 'main' into newtonraphsonnewstoppingcriteria
8ba5f20
geofjamg
geofjamg requested changes Feb 7, 2023
View reviewed changes
src/main/java/com/powsybl/openloadflow/ac/nr/NewtonRaphsonStoppingCriteriaType.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/NewtonRaphsonStoppingCriteriaType.java Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/PerEquationTypeStoppingCriteria.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/ac/nr/LineSearchStateVectorScaling.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java Outdated Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java Show resolved Hide resolved
src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java Outdated Show resolved Hide resolved
lejeana and others added 10 commits February 9, 2023 09:45
@lejeana
Fix copyright and added missing @author
135c9c0 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
feat(OPLF/NewtonCriteria): added value requirements in new set() func…
a0d9363 
…tions

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
refactor(OPLF/NewtonCriteria): refactored a function name from "gener…
ace5a61 
…ate" to "create" for better uniformity

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
test(OPLF/NewtonCriteria): added test for ratio and susceptance misma…
bd837b7 
…tch value.

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
fix(OPLF/NewtonCriteria): added missing enumeration of possible value…
8a58a90 
…s for new parameter newtonraphson stopping criteria type

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
test(OPLF/NewtonCriteria): added tests for throw of PowsyblException
e908e1b 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@geofjamg
Merge branch 'main' into newtonraphsonnewstoppingcriteria
6424463 
# Conflicts:
#	src/main/java/com/powsybl/openloadflow/OpenLoadFlowParameters.java
#	src/test/java/com/powsybl/openloadflow/OpenLoadFlowProviderTest.java
@geofjamg
Fix
8c2fe44 
Signed-off-by: Geoffroy Jamgotchian <geoffroy.jamgotchian@gmail.com>
@geofjamg
Fix MacOS build
6f5950d 
Signed-off-by: Geoffroy Jamgotchian <geoffroy.jamgotchian@gmail.com>
@geofjamg
Merge branch 'main' into newtonraphsonnewstoppingcriteria
185c8b7
@lejeana
feat(OPLF/NewtonCriteria): added default case in switch
99297c0 
Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@lejeana
fix(OPLF/NewtonCriteria): mismatch value must be strictly positive, c…
ed50bf0 
…hanged tests accordingly

Signed-off-by: Alexandre Le Jean <alexandre.le-jean@artelys.com>
@geofjamg geofjamg changed the title [WIP] Newton raphson new stopping criteria Newton raphson new stopping criteria Feb 10, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

92.1% 92.1% Coverage
0.0% 0.0% Duplication

@geofjamg geofjamg merged commit 962f622 into main Feb 10, 2023
@geofjamg geofjamg deleted the newtonraphsonnewstoppingcriteria branch February 10, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AnkurArohi AnkurArohi AnkurArohi left review comments

@jeandemanged jeandemanged jeandemanged left review comments

@obrix obrix obrix requested changes

@Hadrien-Godard Hadrien-Godard Hadrien-Godard approved these changes

@geofjamg geofjamg geofjamg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@lejeana @AnkurArohi @Hadrien-Godard @geofjamg @obrix @jeandemanged