LinearSolver.H

Go to the documentation of this file.

#ifndef WARPX_LINEAR_SOLVER_H_
#define WARPX_LINEAR_SOLVER_H_

 
template <typename Vec, typename Ops>
class LinearSolver
{
public:
 
    using RT = typename Ops::RT; // double or float
 
    LinearSolver () = default;
 
    virtual ~LinearSolver() = default;
 
    // Prohibit Move and Copy operations
    LinearSolver(const LinearSolver&) = delete;
    LinearSolver& operator=(const LinearSolver&) = delete;
    LinearSolver(LinearSolver&&) noexcept = delete;
    LinearSolver& operator=(LinearSolver&&) noexcept = delete;

    virtual void define (Ops& linop) = 0;

    virtual void solve (Vec& a_sol,
                        Vec const& a_rhs,
                        RT a_tol_rel,
                        RT a_tol_abs,
                        int a_its=-1) = 0;

    virtual void setVerbose (int v) = 0;

    virtual void setRestartLength (int rl) { amrex::ignore_unused(rl); }

    virtual void setMaxIters (int niters) = 0;

    virtual int getNumIters () const = 0;

    virtual int getStatus () const = 0;

    virtual RT getResidualNorm () const = 0;
 
protected:
 
private:
};
 
#endif