GaussSeidel.H

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Saud Zahir
 *
 * This file is part of deltaFlow.
 *
 * deltaFlow is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * deltaFlow is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with deltaFlow.  If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef GAUSS_SEIDEL_H
#define GAUSS_SEIDEL_H
 
#include <Eigen/Dense>
#include <utility>
#include <vector>
 
#include "ISolver.H"
 
class GaussSeidel final : public ISolver {
    public:
        bool solve(SolverContext& ctx) override;
 
        const char* name() const override { return "Gauss-Seidel"; }
 
        static bool run(
            const Eigen::MatrixXcd& Y,
            Eigen::VectorXd& V,
            Eigen::VectorXd& delta,
            const Eigen::VectorXi& type_bus,
            const Eigen::VectorXd& P,
            const Eigen::VectorXd& Q,
            int N,
            int maxIter = 1024,
            double tolerance = 1E-8,
            double omega = 1.0,
            std::vector<std::pair<int, double>>* iterHistory = nullptr,
            ISolverObserver* observer = nullptr
        );
};
 
#endif