LoadDetailImpl.java

/**
 * Copyright (c) 2020, 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/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.iidm.network.impl.extensions;

import com.powsybl.iidm.network.Load;
import com.powsybl.iidm.network.extensions.LoadDetail;
import com.powsybl.iidm.network.impl.AbstractMultiVariantIdentifiableExtension;
import gnu.trove.list.array.TDoubleArrayList;

/**
 * @author Miora Ralambotiana {@literal <miora.ralambotiana at rte-france.com>}
 */
public class LoadDetailImpl extends AbstractMultiVariantIdentifiableExtension<Load> implements LoadDetail {

    private final TDoubleArrayList fixedActivePower;

    private final TDoubleArrayList fixedReactivePower;

    private final TDoubleArrayList variableActivePower;

    private final TDoubleArrayList variableReactivePower;

    public LoadDetailImpl(Load load, double fixedActivePower, double fixedReactivePower,
                double variableActivePower, double variableReactivePower) {
        super(load);
        int variantArraySize = getVariantManagerHolder().getVariantManager().getVariantArraySize();
        this.fixedActivePower = new TDoubleArrayList(variantArraySize);
        this.fixedReactivePower = new TDoubleArrayList(variantArraySize);
        this.variableActivePower = new TDoubleArrayList(variantArraySize);
        this.variableReactivePower = new TDoubleArrayList(variantArraySize);
        for (int i = 0; i < variantArraySize; i++) {
            this.fixedActivePower.add(checkPower(fixedActivePower, "Invalid fixedActivePower", load));
            this.fixedReactivePower.add(checkPower(fixedReactivePower, "Invalid fixedReactivePower", load));
            this.variableActivePower.add(checkPower(variableActivePower, "Invalid variableActivePower", load));
            this.variableReactivePower.add(checkPower(variableReactivePower, "Invalid variableReactivePower", load));
        }
    }

    public double getFixedActivePower() {
        return fixedActivePower.get(getVariantIndex());
    }

    @Override
    public LoadDetail setFixedActivePower(double fixedActivePower) {
        checkPower(fixedActivePower, "Invalid fixedActivePower", this.getExtendable());
        this.fixedActivePower.set(getVariantIndex(), fixedActivePower);
        return this;
    }

    @Override
    public double getFixedReactivePower() {
        return fixedReactivePower.get(getVariantIndex());
    }

    @Override
    public LoadDetail setFixedReactivePower(double fixedReactivePower) {
        checkPower(fixedReactivePower, "Invalid fixedReactivePower", this.getExtendable());
        this.fixedReactivePower.set(getVariantIndex(), fixedReactivePower);
        return this;
    }

    @Override
    public double getVariableActivePower() {
        return variableActivePower.get(getVariantIndex());
    }

    @Override
    public LoadDetail setVariableActivePower(double variableActivePower) {
        checkPower(variableActivePower, "Invalid variableActivePower", this.getExtendable());
        this.variableActivePower.set(getVariantIndex(), variableActivePower);
        return this;
    }

    @Override
    public double getVariableReactivePower() {
        return variableReactivePower.get(getVariantIndex());
    }

    @Override
    public LoadDetail setVariableReactivePower(double variableReactivePower) {
        checkPower(variableReactivePower, "Invalid variableReactivePower", this.getExtendable());
        this.variableReactivePower.set(getVariantIndex(), variableReactivePower);
        return this;
    }

    private static double checkPower(double power, String errorMessage, Load load) {
        if (Double.isNaN(power)) {
            throw new IllegalArgumentException(String.format("%s (%s) for load %s",
                errorMessage,
                power,
                load.getId()));
        }
        return power;
    }

    @Override
    public void extendVariantArraySize(int initVariantArraySize, int number, int sourceIndex) {
        fixedActivePower.ensureCapacity(fixedActivePower.size() + number);
        fixedReactivePower.ensureCapacity(fixedReactivePower.size() + number);
        variableActivePower.ensureCapacity(variableActivePower.size() + number);
        variableReactivePower.ensureCapacity(variableReactivePower.size() + number);
        for (int i = 0; i < number; ++i) {
            fixedActivePower.add(fixedActivePower.get(sourceIndex));
            fixedReactivePower.add(fixedReactivePower.get(sourceIndex));
            variableActivePower.add(variableActivePower.get(sourceIndex));
            variableReactivePower.add(variableReactivePower.get(sourceIndex));
        }
    }

    @Override
    public void reduceVariantArraySize(int number) {
        fixedActivePower.remove(fixedActivePower.size() - number, number);
        fixedReactivePower.remove(fixedReactivePower.size() - number, number);
        variableActivePower.remove(variableActivePower.size() - number, number);
        variableReactivePower.remove(variableReactivePower.size() - number, number);
    }

    @Override
    public void deleteVariantArrayElement(int index) {
        // Does nothing
        // TODO: maybe set default/undefined values for deleted variant index
    }

    @Override
    public void allocateVariantArrayElement(int[] indexes, int sourceIndex) {
        for (int index : indexes) {
            fixedActivePower.set(index, fixedActivePower.get(sourceIndex));
            fixedReactivePower.set(index, fixedReactivePower.get(sourceIndex));
            variableActivePower.set(index, variableActivePower.get(sourceIndex));
            variableReactivePower.set(index, variableReactivePower.get(sourceIndex));
        }
    }
}