com.powsybl.openloadflow.equations.EquationVector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-open-loadflow Show documentation

An open source loadflow based on PowSyBl

The newest version!

/**
 * Copyright (c) 2022, 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.openloadflow.equations;

import com.google.common.base.Stopwatch;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;

import static com.powsybl.openloadflow.util.Markers.PERFORMANCE_MARKER;

/**
 * @author Geoffroy Jamgotchian {@literal }
 */
public class EquationVector & Quantity, E extends Enum & Quantity> extends AbstractVector
        implements StateVectorListener, AutoCloseable {

    private static final Logger LOGGER = LoggerFactory.getLogger(EquationVector.class);

    public EquationVector(EquationSystem equationSystem) {
        super(equationSystem);
        equationSystem.getStateVector().addListener(this);
    }

    @Override
    public void onStateUpdate() {
        invalidateValues();
    }

    @Override
    protected double[] createArray() {
        double[] array = new double[equationSystem.getIndex().getSortedEquationsToSolve().size()];
        updateArray(array);
        return array;
    }

    private void evalLhs(double[] array, List> equations) {
        Arrays.fill(array, 0); // necessary?
        for (Equation equation : equations) {
            array[equation.getColumn()] = equation.evalLhs();
        }
    }

    @Override
    protected void updateArray(double[] array) {
        Stopwatch stopwatch = Stopwatch.createStarted();

        var equations = equationSystem.getIndex().getSortedEquationsToSolve();

        if (array.length != equations.size()) {
            throw new IllegalArgumentException("Bad equation vector length: " + array.length);
        }

        evalLhs(array, equations);

        LOGGER.debug(PERFORMANCE_MARKER, "Equation vector updated in {} us", stopwatch.elapsed(TimeUnit.MICROSECONDS));
    }

    @Override
    public void close() {
        equationSystem.getStateVector().removeListener(this);
    }
}