com.farao_community.farao.data.crac_impl.InjectionSetpointImpl 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.Unit;
import com.farao_community.farao.data.crac_api.network_action.InjectionSetpoint;
import com.farao_community.farao.data.crac_api.NetworkElement;
import com.powsybl.iidm.network.*;
import org.apache.commons.lang3.NotImplementedException;

import java.util.Collections;
import java.util.Set;

/**
 * Injection setpoint remedial action: set a load or generator at a given value.
 *
 * @author Viktor Terrier {@literal }
 */
public final class InjectionSetpointImpl implements InjectionSetpoint {
    private static final double EPSILON = 0.1;

    private final NetworkElement networkElement;
    private final double setpoint;
    private final Unit unit;

    InjectionSetpointImpl(NetworkElement networkElement, double setpoint, Unit unit) {
        this.networkElement = networkElement;
        this.setpoint = setpoint;
        this.unit = unit;
    }

    @Override
    public double getSetpoint() {
        return setpoint;
    }

    @Override
    public Unit getUnit() {
        return unit;
    }

    @Override
    public boolean hasImpactOnNetwork(Network network) {
        Identifiable identifiable = network.getIdentifiable(networkElement.getId());
        if (identifiable instanceof Generator) {
            return Math.abs(((Generator) identifiable).getTargetP() - setpoint) >= EPSILON;
        } else if (identifiable instanceof Load) {
            return Math.abs(((Load) identifiable).getP0() - setpoint) >= EPSILON;
        } else if (identifiable instanceof DanglingLine) {
            return Math.abs(((DanglingLine) identifiable).getP0() - setpoint) >= EPSILON;
        } else if (identifiable instanceof ShuntCompensator) {
            return Math.abs(((ShuntCompensator) identifiable).getSectionCount() - setpoint) >= EPSILON;
        } else {
            throw new NotImplementedException("Injection setpoint only handled for generators, loads, dangling lines or shunt compensator");
        }
    }

    @Override
    public boolean canBeApplied(Network network) {
        Identifiable identifiable = network.getIdentifiable(networkElement.getId());
        if (identifiable instanceof ShuntCompensator) {
            ShuntCompensator shuntCompensator = (ShuntCompensator) identifiable;
            return shuntCompensator.getMaximumSectionCount() < setpoint;
        }
        return true;
    }

    @Override
    public void apply(Network network) {
        Identifiable identifiable = network.getIdentifiable(networkElement.getId());
        if (identifiable instanceof Generator) {
            Generator generator = (Generator) identifiable;
            generator.setTargetP(setpoint);
        } else if (identifiable instanceof Load) {
            Load load = (Load) identifiable;
            load.setP0(setpoint);
        } else if (identifiable instanceof DanglingLine) {
            DanglingLine danglingLine = (DanglingLine) identifiable;
            danglingLine.setP0(setpoint);
        } else if (identifiable instanceof ShuntCompensator) {
            ShuntCompensator shuntCompensator = (ShuntCompensator) identifiable;
            shuntCompensator.setSectionCount((int) setpoint);
        } else {
            throw new NotImplementedException("Injection setpoint only handled for generators, loads, dangling lines or shunt compensators");
        }
    }

    @Override
    public NetworkElement getNetworkElement() {
        return networkElement;
    }

    @Override
    public Set getNetworkElements() {
        return Collections.singleton(networkElement);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        InjectionSetpointImpl oInjectionSetPoint =  (InjectionSetpointImpl) o;
        return oInjectionSetPoint.getNetworkElement().equals(this.networkElement)
            && oInjectionSetPoint.getSetpoint() == this.setpoint;
    }

    @Override
    public int hashCode() {
        return networkElement.hashCode() + 37 * Double.valueOf(setpoint).hashCode();
    }
}