com.farao_community.farao.data.crac_impl.ContingencyImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of farao-crac-impl Show documentation
Object model for CRAC implementation
There is a newer version: 5.0.0
/*
 * Copyright (c) 2019, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

package com.farao_community.farao.data.crac_impl;

import com.farao_community.farao.commons.FaraoException;
import com.farao_community.farao.data.crac_api.Contingency;
import com.farao_community.farao.data.crac_api.NetworkElement;
import com.powsybl.computation.ComputationManager;
import com.powsybl.contingency.*;
import com.powsybl.iidm.network.*;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

/**
 * Business object for a contingency in the CRAC file.
 *
 * @author Viktor Terrier {@literal }
 */
public class ContingencyImpl extends AbstractIdentifiable implements Contingency {

    private Set networkElements;

    ContingencyImpl(String id, String name, final Set networkElements) {
        super(id, name);
        this.networkElements = networkElements;
    }

    @Override
    public Set getNetworkElements() {
        return networkElements;
    }

    @Override
    public void apply(Network network, ComputationManager computationManager) {
        // This implementation is unused for now as long as the contingencies are applied in the systematic sensitivity computation
        // It might be used to implement curative features
        com.powsybl.contingency.Contingency contingency = new com.powsybl.contingency.Contingency(getId(), new ArrayList<>());
        getNetworkElements().forEach(contingencyElement -> {
            Identifiable element = network.getIdentifiable(contingencyElement.getId());
            if (element instanceof Branch) {
                contingency.addElement(new BranchContingency(contingencyElement.getId()));
            } else if (element instanceof Generator) {
                contingency.addElement(new GeneratorContingency(contingencyElement.getId()));
            } else if (element instanceof HvdcLine) {
                contingency.addElement(new HvdcLineContingency(contingencyElement.getId()));
            } else if (element instanceof BusbarSection) {
                contingency.addElement(new BusbarSectionContingency(contingencyElement.getId()));
            } else if (element instanceof DanglingLine) {
                contingency.addElement(new DanglingLineContingency(contingencyElement.getId()));
            } else {
                throw new FaraoException("Unable to apply contingency element " + contingencyElement.getId());
            }
        });
        com.powsybl.contingency.Contingency.checkValidity(Collections.singletonList(contingency), network);
        contingency.toModification().apply(network, computationManager);
    }

    /**
     * Check if complex contingencies are equals. Complex contingencies are considered equals when IDs are equals
     * and all the contained network elements are also equals. So sets of network elements have to be strictly equals.
     *
     * @param o: If it's null or another object than ContingencyImpl it will return false.
     * @return A boolean true if objects are equals, otherwise false.
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        ContingencyImpl contingency = (ContingencyImpl) o;
        return super.equals(o) && new HashSet<>(contingency.getNetworkElements()).equals(new HashSet<>(networkElements));
    }

    @Override
    public int hashCode() {
        return super.hashCode();
    }
}