DirectLinearSolver.h

/* Copyright 2017-2021 Institute for Automation of Complex Power Systems,
*                     EONERC, RWTH Aachen University
*
* 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 https://mozilla.org/MPL/2.0/.
*********************************************************************************/
 
#pragma once
 
#include <bitset>
#include <iostream>
#include <list>
#include <unordered_map>
#include <vector>
 
#include <dpsim-models/Logger.h>
#include <dpsim/Config.h>
#include <dpsim/Definitions.h>
#include <dpsim/DirectLinearSolverConfiguration.h>
 
namespace DPsim {
class DirectLinearSolver {
public:
  DirectLinearSolver() = default;

  virtual ~DirectLinearSolver() = default;

  DirectLinearSolver(const DirectLinearSolver &) = default;

  DirectLinearSolver &operator=(const DirectLinearSolver &) = default;

  DirectLinearSolver(DirectLinearSolver &&) = default;

  DirectLinearSolver &operator=(DirectLinearSolver &&) = default;

  DirectLinearSolver(CPS::Logger::Log log) : mSLog(log) {
    // no further default configuration of DirectLinearSolver or logger
  }

  virtual void preprocessing(
      SparseMatrix &systemMatrix,
      std::vector<std::pair<UInt, UInt>> &listVariableSystemMatrixEntries) = 0;

  virtual void factorize(SparseMatrix &systemMatrix) = 0;

  virtual void refactorize(SparseMatrix &systemMatrix) = 0;

  virtual void partialRefactorize(
      SparseMatrix &systemMatrix,
      std::vector<std::pair<UInt, UInt>> &listVariableSystemMatrixEntries) = 0;

  virtual Matrix solve(Matrix &rightSideVector) = 0;
 
  virtual void
  setConfiguration(DirectLinearSolverConfiguration &configuration) {
    mConfiguration = configuration;
    this->applyConfiguration();
  }
 
protected:
  CPS::Logger::Log mSLog;

  DirectLinearSolverConfiguration mConfiguration;
 
  virtual void applyConfiguration() {
    // no default application, configuration options vary for each solver
    // warn user that no configuration setting is used
    SPDLOG_LOGGER_WARN(mSLog, "Linear solver configuration is not used!");
  }
};
} // namespace DPsim