Skip to content

Commit

Permalink
DynaFlow: add mergeLoads
Browse files Browse the repository at this point in the history 
Updated test resources, to compare results when the property mergeLoads is true

Signed-off-by: BAUDRIER Dimitri <dimitri.baudrier@rte-france.com>
  • Loading branch information
BAUDRIER Dimitri committed Nov 23, 2022
1 parent eead11b commit 27a5773
Show file tree
Hide file tree
Showing 8 changed files with 3,829 additions and 1,347 deletions.
20 changes: 19 additions & 1 deletion dynaflow/src/main/java/com/powsybl/dynaflow/DynaFlowParameters.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ public boolean isSerializable() {
private static final String CHOSEN_OUTPUTS = "chosenOutputs";
private static final String TIME_STEP = "timeStep";
private static final String STARTING_POINT_MODE = "startingPointMode";
private static final String MERGE_LOADS = "mergeLoads";

private static final boolean DEFAULT_MERGE_LOADS = true;

private Boolean svcRegulationOn = null;
private Boolean shuntRegulationOn = null;
Expand All @@ -94,6 +97,7 @@ public boolean isSerializable() {
private List<String> chosenOutputs = null;
private Double timeStep = null;
private StartingPointMode startingPointMode = null;
private boolean mergeLoads = DEFAULT_MERGE_LOADS;

public Boolean getSvcRegulationOn() {
return svcRegulationOn;
Expand Down Expand Up @@ -234,6 +238,15 @@ public DynaFlowParameters setSa(Sa securityAnalysis) {
return this;
}

@JsonIgnore
public boolean getMergeLoads() {
return mergeLoads;
}

public void setMergeLoads(boolean mergeLoads) {
this.mergeLoads = mergeLoads;
}

@Override
public String getName() {
return "DynaFlowParameters";
Expand All @@ -256,6 +269,7 @@ public String toString() {
.add(CHOSEN_OUTPUTS, chosenOutputs)
.add(TIME_STEP, timeStep)
.add(STARTING_POINT_MODE, startingPointMode)
.add(MERGE_LOADS, mergeLoads)
.toString();
}

Expand Down Expand Up @@ -321,6 +335,9 @@ private static void load(DynaFlowParameters parameters, ModuleConfig config) {
if (config.hasProperty(STARTING_POINT_MODE)) {
parameters.setStartingPointMode(StartingPointMode.fromString(config.getStringProperty(STARTING_POINT_MODE)));
}
if (config.hasProperty(MERGE_LOADS)) {
parameters.setMergeLoads(config.getBooleanProperty(MERGE_LOADS, DEFAULT_MERGE_LOADS));
}
}

public void update(Map<String, String> properties) {
Expand All @@ -345,6 +362,7 @@ public void update(Map<String, String> properties) {
setChosenOutputs(Stream.of(prop.split(CHOSEN_OUTPUT_STRING_DELIMITER)).map(String::trim).collect(Collectors.toList())));
Optional.ofNullable(properties.get(TIME_STEP)).ifPresent(prop -> setTimeStep(Double.parseDouble(prop)));
Optional.ofNullable(properties.get(STARTING_POINT_MODE)).ifPresent(prop -> setStartingPointMode(StartingPointMode.fromString(prop)));
Optional.ofNullable(properties.get(MERGE_LOADS)).ifPresent(prop -> setMergeLoads(Boolean.parseBoolean(prop)));
}

public static DynaFlowParameters load(Map<String, String> properties) {
Expand All @@ -357,7 +375,7 @@ public static List<String> getSpecificParametersNames() {
return Arrays.asList(
SVC_REGULATION_ON, SHUNT_REGULATION_ON, AUTOMATIC_SLACK_BUS_ON, DSO_VOLTAGE_LEVEL,
ACTIVE_POWER_COMPENSATION, SETTING_PATH, ASSEMBLING_PATH, START_TIME, STOP_TIME, PRECISION_NAME,
Sa.TIME_OF_EVENT, CHOSEN_OUTPUTS, TIME_STEP, STARTING_POINT_MODE
Sa.TIME_OF_EVENT, CHOSEN_OUTPUTS, TIME_STEP, STARTING_POINT_MODE, MERGE_LOADS
);
}

Expand Down
9 changes: 9 additions & 0 deletions dynaflow/src/main/java/com/powsybl/dynaflow/DynaFlowProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import com.powsybl.computation.*;
import com.powsybl.dynaflow.json.DynaFlowConfigSerializer;
import com.powsybl.dynaflow.json.JsonDynaFlowParametersSerializer;
import com.powsybl.dynawo.commons.DynawoResultsMergeLoads;
import com.powsybl.dynawo.commons.DynawoResultsNetworkUpdate;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.xml.IidmXmlVersion;
Expand All @@ -30,6 +31,7 @@
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;
import java.util.List;
import java.util.concurrent.CompletableFuture;

import static com.powsybl.dynaflow.DynaFlowConstants.*;
Expand Down Expand Up @@ -118,6 +120,7 @@ public CompletableFuture<LoadFlowResult> run(Network network, ComputationManager
ExecutionEnvironment env = new ExecutionEnvironment(config.createEnv(), WORKING_DIR_PREFIX, config.isDebug());
Command versionCmd = getVersionCommand(config);
DynaFlowUtil.checkDynaFlowVersion(env, computationManager, versionCmd);
DynawoResultsMergeLoads dynawoResultsMergeLoads = new DynawoResultsMergeLoads(network.getId());
return computationManager.execute(env, new AbstractExecutionHandler<LoadFlowResult>() {

@Override
Expand All @@ -127,6 +130,9 @@ public List<CommandExecution> before(Path workingDir) throws IOException {
Files.delete(outputNetworkFile);
}
network.getVariantManager().setWorkingVariant(workingStateId);
if (dynaFlowParameters.getMergeLoads()) {
dynawoResultsMergeLoads.mergeLoads(network);
}
writeIIDM(workingDir, network);
DynaFlowConfigSerializer.serialize(loadFlowParameters, dynaFlowParameters, workingDir, workingDir.resolve(CONFIG_FILENAME));
return Collections.singletonList(createCommandExecution(config));
Expand All @@ -144,6 +150,9 @@ public LoadFlowResult after(Path workingDir, ExecutionReport report) throws IOEx
} else {
status = false;
}
if (dynaFlowParameters.getMergeLoads()) {
dynawoResultsMergeLoads.unmergeLoads(network);
}
Path resultsPath = workingDir.resolve(OUTPUT_RESULTS_FILENAME);
if (!Files.exists(resultsPath)) {
Map<String, String> metrics = new HashMap<>();
Expand Down
15 changes: 13 additions & 2 deletions dynaflow/src/test/java/com/powsybl/dynaflow/DynaFlowParametersTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ public void checkParameters() {
List<String> chosenOutputs = Arrays.asList(OutputTypes.STEADYSTATE.name(), OutputTypes.TIMELINE.name());
double timeStep = 0;
StartingPointMode startingPointMode = StartingPointMode.FLAT;
boolean mergedLoads = false;

DynaFlowParameters.Sa securityAnalysis = new DynaFlowParameters.Sa();
securityAnalysis.setTimeOfEvent(2.);
Expand All @@ -93,6 +94,7 @@ public void checkParameters() {
moduleConfig.setStringListProperty("chosenOutputs", chosenOutputs);
moduleConfig.setStringProperty("timeStep", Double.toString(timeStep));
moduleConfig.setStringProperty("startingPointMode", startingPointMode.getName());
moduleConfig.setStringProperty("mergeLoads", Boolean.toString(mergedLoads));

DynaFlowParameters parameters = DynaFlowParameters.load(platformConfig);

Expand All @@ -110,6 +112,7 @@ public void checkParameters() {
assertArrayEquals(chosenOutputs.toArray(), parameters.getChosenOutputs().toArray());
assertEquals(timeStep, parameters.getTimeStep(), 0.1d);
assertEquals(startingPointMode, parameters.getStartingPointMode());
assertEquals(mergedLoads, parameters.getMergeLoads());
}

@Test
Expand All @@ -132,14 +135,15 @@ public void checkDefaultParameters() {
assertNull(parametersExt.getChosenOutputs());
assertNull(parametersExt.getTimeStep());
assertNull(parametersExt.getStartingPointMode());
assertTrue(parametersExt.getMergeLoads());
}

@Test
public void checkDefaultToString() {
LoadFlowParameters parameters = LoadFlowParameters.load(platformConfig);
DynaFlowParameters parametersExt = parameters.getExtension(DynaFlowParameters.class);

String expectedString = "{}";
String expectedString = "{mergeLoads=true}";

assertEquals(expectedString, parametersExt.toString());

Expand All @@ -163,6 +167,7 @@ public void checkAllParametersAssignedToString() {
List<String> chosenOutputs = Arrays.asList(OutputTypes.STEADYSTATE.name(), OutputTypes.TIMELINE.name());
double timeStep = 0;
StartingPointMode startingPointMode = StartingPointMode.WARM;
boolean mergeLoad = false;

Map<String, String> properties = new HashMap<>();
properties.put("svcRegulationOn", Boolean.toString(svcRegulationOn));
Expand All @@ -179,6 +184,7 @@ public void checkAllParametersAssignedToString() {
properties.put("chosenOutputs", OutputTypes.STEADYSTATE.name() + "," + OutputTypes.TIMELINE.name());
properties.put("timeStep", Double.toString(timeStep));
properties.put("startingPointMode", startingPointMode.name());
properties.put("mergeLoads", Boolean.toString(mergeLoad));

parametersExt.update(properties);

Expand All @@ -196,7 +202,8 @@ public void checkAllParametersAssignedToString() {
"{timeOfEvent=" + timeOfEvent + "}" +
", chosenOutputs=" + chosenOutputs +
", timeStep=" + timeStep +
", startingPointMode=" + startingPointMode + "}";
", startingPointMode=" + startingPointMode +
", mergeLoads=" + mergeLoad + "}";
assertEquals(expectedString, parametersExt.toString());
System.out.println(expectedString);
}
Expand Down Expand Up @@ -241,6 +248,7 @@ public void parametersSerialization() throws IOException {
dynaFlowParameters.setChosenOutputs(Collections.singletonList(OutputTypes.STEADYSTATE.name()));
dynaFlowParameters.setTimeStep(2.6);
dynaFlowParameters.setStartingPointMode(StartingPointMode.WARM);
dynaFlowParameters.setMergeLoads(false);
lfParameters.addExtension(DynaFlowParameters.class, dynaFlowParameters);

Path workingDir = fileSystem.getPath("dynaflow/workingDir");
Expand Down Expand Up @@ -270,6 +278,7 @@ public void loadMapDynaflowParameters() {
List<String> chosenOutputs = Arrays.asList(OutputTypes.STEADYSTATE.name(), OutputTypes.TIMELINE.name());
double timeStep = 0;
StartingPointMode startingPointMode = StartingPointMode.WARM;
boolean mergeLoads = false;

Map<String, String> properties = new HashMap<>();
properties.put("svcRegulationOn", Boolean.toString(svcRegulationOn));
Expand All @@ -286,6 +295,7 @@ public void loadMapDynaflowParameters() {
properties.put("chosenOutputs", OutputTypes.STEADYSTATE.name() + ", " + OutputTypes.TIMELINE.name());
properties.put("timeStep", Double.toString(timeStep));
properties.put("startingPointMode", startingPointMode.getName());
properties.put("mergeLoads", Boolean.toString(mergeLoads));

DynaFlowParameters dynaFlowParameters = DynaFlowParameters.load(properties);

Expand All @@ -303,5 +313,6 @@ public void loadMapDynaflowParameters() {
assertArrayEquals(chosenOutputs.toArray(), dynaFlowParameters.getChosenOutputs().toArray());
assertEquals(timeStep, dynaFlowParameters.getTimeStep(), 0.1d);
assertEquals(startingPointMode, dynaFlowParameters.getStartingPointMode());
assertEquals(mergeLoads, dynaFlowParameters.getMergeLoads());
}
}
72 changes: 68 additions & 4 deletions dynaflow/src/test/java/com/powsybl/dynaflow/DynaFlowProviderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import java.util.Objects;
import java.util.concurrent.ForkJoinPool;

import static com.powsybl.commons.ComparisonUtils.compareTxt;
import static com.powsybl.commons.ComparisonUtils.compareXml;
import static com.powsybl.dynaflow.DynaFlowConstants.*;
import static org.junit.Assert.*;
Expand Down Expand Up @@ -123,10 +124,12 @@ public int execute(String program, List<String> args, Path outFile, Path errFile
}

@Test
public void test() throws Exception {
public void testWithoutMergeLoads() throws Exception {
Network network = createTestSmallBusBranch();
LoadFlow.Runner dynaFlowSimulation = LoadFlow.find();
LoadFlowParameters params = LoadFlowParameters.load();
DynaFlowParameters dynaFlowParameters = params.getExtension(DynaFlowParameters.class);
dynaFlowParameters.setMergeLoads(false);

assertEquals("DynaFlow", dynaFlowSimulation.getName());
assertEquals("0.1", dynaFlowSimulation.getVersion());
Expand All @@ -140,14 +143,51 @@ public void test() throws Exception {
}

@Test
public void testFail() throws Exception {
public void testWithMergeLoads() throws Exception {
Network network = createTestSmallBusBranch();
LoadFlow.Runner dynaFlowSimulation = LoadFlow.find();
LoadFlowParameters params = LoadFlowParameters.load();

assertEquals("DynaFlow", dynaFlowSimulation.getName());
assertEquals("0.1", dynaFlowSimulation.getVersion());

LocalCommandExecutor commandExecutor = new LocalCommandExecutorMock("/dynaflow_version.out",
"/SmallBusBranch_mergeLoads_outputIIDM.xml", "/results.json");
ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(fileSystem.getPath("/working-dir"), 1), commandExecutor, ForkJoinPool.commonPool());
LoadFlowResult result = dynaFlowSimulation.run(network, computationManager, params);
assertNotNull(result);
assertTrue(result.isOk());
}

@Test
public void testFailWithoutMergeLoads() throws Exception {
Network network = createTestSmallBusBranch();
LoadFlow.Runner dynaFlowSimulation = LoadFlow.find();
LoadFlowParameters params = LoadFlowParameters.load();
DynaFlowParameters dynaFlowParameters = params.getExtension(DynaFlowParameters.class);
dynaFlowParameters.setMergeLoads(false);

assertEquals("DynaFlow", dynaFlowSimulation.getName());
assertEquals("0.1", dynaFlowSimulation.getVersion());

LocalCommandExecutor commandExecutor = new EmptyLocalCommandExecutorMock("/dynaflow_version.out");
ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(fileSystem.getPath("/working-dir"), 1), commandExecutor, ForkJoinPool.commonPool());
LoadFlowResult result = dynaFlowSimulation.run(network, computationManager, params);
assertNotNull(result);
assertFalse(result.isOk());
}

@Test
public void testFailWithMergeLoads() throws Exception {
Network network = createTestSmallBusBranch();
LoadFlow.Runner dynaFlowSimulation = LoadFlow.find();
LoadFlowParameters params = LoadFlowParameters.load();
DynaFlowParameters dynaFlowParameters = params.getExtension(DynaFlowParameters.class);
dynaFlowParameters.setMergeLoads(false);

assertEquals("DynaFlow", dynaFlowSimulation.getName());
assertEquals("0.1", dynaFlowSimulation.getVersion());

LocalCommandExecutor commandExecutor = new EmptyLocalCommandExecutorMock("/dynaflow_version.out");
ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(fileSystem.getPath("/working-dir"), 1), commandExecutor, ForkJoinPool.commonPool());
LoadFlowResult result = dynaFlowSimulation.run(network, computationManager, params);
Expand All @@ -156,10 +196,12 @@ public void testFail() throws Exception {
}

@Test
public void testUpdate() throws Exception {
public void testUpdateWithoutMergeLoads() throws Exception {
Network network = createTestSmallBusBranch();
LoadFlow.Runner dynaFlowSimulation = LoadFlow.find();
LoadFlowParameters params = LoadFlowParameters.load();
DynaFlowParameters dynaFlowParameters = params.getExtension(DynaFlowParameters.class);
dynaFlowParameters.setMergeLoads(false);

assertEquals("DynaFlow", dynaFlowSimulation.getName());
assertEquals("0.1", dynaFlowSimulation.getVersion());
Expand All @@ -177,6 +219,28 @@ public void testUpdate() throws Exception {
compare(expectedNetwork, network);
}

@Test
public void testUpdateWithMergeLoads() throws Exception {
Network network = createTestSmallBusBranch();
LoadFlow.Runner dynaFlowSimulation = LoadFlow.find();
LoadFlowParameters params = LoadFlowParameters.load();

assertEquals("DynaFlow", dynaFlowSimulation.getName());
assertEquals("0.1", dynaFlowSimulation.getVersion());

LocalCommandExecutor commandExecutor = new LocalCommandExecutorMock("/dynaflow_version.out",
"/SmallBusBranch_mergeLoads_outputIIDM.xml", "/results.json");
ComputationManager computationManager = new LocalComputationManager(new LocalComputationConfig(fileSystem.getPath("/working-dir"), 1), commandExecutor, ForkJoinPool.commonPool());
LoadFlowResult result = dynaFlowSimulation.run(network, computationManager, params);
assertNotNull(result);
assertTrue(result.isOk());

InputStream pReferenceOutput = getClass().getResourceAsStream("/SmallBusBranch_outputIIDM.xml");
Network expectedNetwork = NetworkXml.read(pReferenceOutput);

compare(expectedNetwork, network);
}

@Test
public void testUpdateSpecificParameters() {
Map<String, String> properties = Map.of(
Expand Down Expand Up @@ -207,7 +271,7 @@ private void compare(Network expected, Network actual) throws IOException {
NetworkXml.write(expected, pexpected);
actual.setCaseDate(expected.getCaseDate());
NetworkXml.write(actual, pactual);
compareXml(Files.newInputStream(pexpected), Files.newInputStream(pactual));
compareTxt(Files.newInputStream(pexpected), Files.newInputStream(pactual));
}

private static Network createTestSmallBusBranch() {
Expand Down
4 changes: 2 additions & 2 deletions dynaflow/src/test/resources/SmallBusBranch.xiidm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<iidm:bus id="_04483c26-c766-11e1-8775-005056c00008" name="Madison" v="128.132538" angle="-14.5066376"/>
</iidm:busBreakerTopology>
<iidm:load id="_045b00d5-c766-11e1-8775-005056c00008" name="Madison LD" loadType="UNDEFINED" p0="62.0" q0="13.0" bus="_04483c26-c766-11e1-8775-005056c00008" connectableBus="_04483c26-c766-11e1-8775-005056c00008" p="62.0" q="13.0"></iidm:load>
<iidm:load id="_04689566-c766-11e1-8775-005056c00008" name="Madison NegG LD" loadType="UNDEFINED" p0="9.0" q0="0.0" bus="_04483c26-c766-11e1-8775-005056c00008" connectableBus="_04483c26-c766-11e1-8775-005056c00008" p="9.0" q="0.0"></iidm:load>
<iidm:load id="_04689566-c766-11e1-8775-005056c00008" name="Madison NegG LD" loadType="UNDEFINED" p0="2.0" q0="0.0" bus="_04483c26-c766-11e1-8775-005056c00008" connectableBus="_04483c26-c766-11e1-8775-005056c00008" p="2.0" q="0.0"></iidm:load>
</iidm:voltageLevel>
</iidm:substation>
<iidm:substation id="_04542302-c766-11e1-8775-005056c00008" name="Gringotts" country="GB" geographicalTags="_0472a781-c766-11e1-8775-005056c00008">
Expand Down Expand Up @@ -746,7 +746,7 @@
<iidm:bus id="_0483be8a-c766-11e1-8775-005056c00008" name="Reusens" v="124.763" angle="-12.388133"/>
</iidm:busBreakerTopology>
<iidm:load id="_04566cf3-c766-11e1-8775-005056c00008" name="Reusens NegG LD" loadType="UNDEFINED" p0="22.0" q0="0.0" bus="_0483be8a-c766-11e1-8775-005056c00008" connectableBus="_0483be8a-c766-11e1-8775-005056c00008" p="22.0" q="0.0"></iidm:load>
<iidm:load id="_0482fb36-c766-11e1-8775-005056c00008" name="Reusens LD" loadType="UNDEFINED" p0="28.0" q0="12.0" bus="_0483be8a-c766-11e1-8775-005056c00008" connectableBus="_0483be8a-c766-11e1-8775-005056c00008" p="28.0" q="12.0"></iidm:load>
<iidm:load id="_0482fb36-c766-11e1-8775-005056c00008" name="Reusens LD" loadType="UNDEFINED" p0="32.0" q0="12.0" bus="_0483be8a-c766-11e1-8775-005056c00008" connectableBus="_0483be8a-c766-11e1-8775-005056c00008" p="32.0" q="12.0"></iidm:load>
<iidm:shunt id="_04558293-c766-11e1-8775-005056c00008" name="Reusens SC" bPerSection="6.88E-5" maximumSectionCount="10" currentSectionCount="5" voltageRegulatorOn="true" targetV="124.763" targetDeadband="1.0" bus="_0483be8a-c766-11e1-8775-005056c00008" connectableBus="_0483be8a-c766-11e1-8775-005056c00008" q="-5.354637">
<iidm:property name="CGMES.RegulatingControl" value="_99303cd3-6b53-4ee2-a5ce-fe8d5feeb304"/>
</iidm:shunt>
Expand Down
Loading

0 comments on commit 27a5773

Please sign in to comment.