imstkSOR.h

/*
** This file is part of the Interactive Medical Simulation Toolkit (iMSTK)
** iMSTK is distributed under the Apache License, Version 2.0.
** See accompanying NOTICE for details.
*/

#pragma once

#include "imstkNonLinearSystem.h"
#include "imstkIterativeLinearSolver.h"

#include <Eigen/IterativeLinearSolvers>

namespace imstk
{
class LinearProjectionConstraint;

class SOR : public IterativeLinearSolver
{
public:
    SOR(const double relaxationFactor = 0.5) : m_relaxationFactor(relaxationFactor) { m_type = Type::SuccessiveOverRelaxation; };
    SOR(const SparseMatrixd& A, const Vectord& rhs);
    ~SOR() override = default;

    SOR(const SOR&)  = delete;
    SOR(const SOR&&) = delete;
    SOR& operator=(const SOR&)  = delete;
    SOR& operator=(const SOR&&) = delete;

    //void iterate(Vectord& x, bool updateResidual = true) override {};

    void SORSolve(Vectord& x);

    void solve(Vectord& x) override;

    void solve(Vectord& x, const double tolerance);

    double getResidual(const Vectord& x) override;

    void setSystem(std::shared_ptr<LinearSystemType> newSystem) override;

    void setMaxNumIterations(const size_t maxIter) override;

    void setTolerance(const double tolerance);

    void print() const override;

    double getRelaxationFactor() const { return m_relaxationFactor; };

    void setLinearProjectors(std::vector<LinearProjectionConstraint>* f)
    {
        m_FixedLinearProjConstraints = f;
    }

    std::vector<LinearProjectionConstraint>& getLinearProjectors()
    {
        return *m_FixedLinearProjConstraints;
    }

    void setDynamicLinearProjectors(std::vector<LinearProjectionConstraint>* f)
    {
        m_DynamicLinearProjConstraints = f;
    }

    std::vector<LinearProjectionConstraint>& getDynamicLinearProjectors()
    {
        return *m_DynamicLinearProjConstraints;
    }

private:
    double m_relaxationFactor = 0.5;

    std::vector<LinearProjectionConstraint>* m_FixedLinearProjConstraints   = nullptr;
    std::vector<LinearProjectionConstraint>* m_DynamicLinearProjConstraints = nullptr;
};
} // namespace imstk