ISolver.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 ISOLVER_H
#define ISOLVER_H
 
#include <Eigen/Dense>
#include <utility>
#include <vector>
 
struct SolverContext {
    // Common admittance representation.
    const Eigen::MatrixXcd* Y = nullptr;  
    const Eigen::MatrixXd* G = nullptr;   
    const Eigen::MatrixXd* B = nullptr;   
 
    // State (in/out).
    Eigen::VectorXd* V = nullptr;       
    Eigen::VectorXd* delta = nullptr;   
 
    // Bus classification.
    Eigen::VectorXi* type_bus = nullptr;        
    const std::vector<int>* pq_bus_id = nullptr;  
 
    // Scheduled power injections.
    const Eigen::VectorXd* P = nullptr;  
    const Eigen::VectorXd* Q = nullptr;  
 
    // Sizes.
    int N = 0;       
    int n_pq = 0;     
 
    // Solver tuning.
    int maxIter = 1024;        
    double tolerance = 1E-8;   
    double omega = 1.0;        
 
    // Diagnostics.
    std::vector<std::pair<int, double>>* iterHistory = nullptr;  
    class ISolverObserver* observer = nullptr;  
};
 
class ISolverObserver {
    public:
        virtual ~ISolverObserver() = default;
 
        virtual void onIteration(const char* solverName, int iter, int maxIter, double error, double tolerance) = 0;
 
        virtual void onFinished(const char* solverName, bool converged, int iter, int maxIter, double error, double tolerance) = 0;
 
        virtual void onMessage(const char* solverName, const char* message) = 0;
};
 
class ISolver {
    public:
        virtual ~ISolver() = default;
 
        virtual bool solve(SolverContext& ctx) = 0;
 
        virtual const char* name() const = 0;
};
 
#endif