NonlinearSolver.H

Go to the documentation of this file.

#ifndef WARPX_NONLINEAR_SOLVER_H_
#define WARPX_NONLINEAR_SOLVER_H_
 
#include "PreconditionerLibrary.H"
 
#include <AMReX_GpuContainers.H>
#include <AMReX_REAL.H>
 
#include <AMReX_BaseFwd.H>
 
#include <string>
#include <array>
#include <memory>

 
template<class Vec, class Ops>
class NonlinearSolver
{
public:
 
    NonlinearSolver() = default;
 
    virtual ~NonlinearSolver() = default;
 
    // Prohibit Move and Copy operations
    NonlinearSolver(const NonlinearSolver&) = delete;
    NonlinearSolver& operator=(const NonlinearSolver&) = delete;
    NonlinearSolver(NonlinearSolver&&) noexcept = delete;
    NonlinearSolver& operator=(NonlinearSolver&&) noexcept = delete;

    virtual void Define ( const Vec&,
                          Ops* ) = 0;

    [[nodiscard]] bool IsDefined () const { return m_is_defined; }

    virtual void Solve (Vec&,
                  const Vec&,
                        amrex::Real,
                        amrex::Real,
                        int) const = 0;

    int GetExitStatus() const { return m_exit_status; }

    virtual void PrintParams () const = 0;

    virtual void GetSolverParams (amrex::Real&, amrex::Real&, int&) = 0;

    virtual PreconditionerType GetPreconditionerType () const { return PreconditionerType::none; }

    virtual void Verbose ( bool  a_verbose ) { m_verbose = a_verbose; }
 
protected:
 
    bool m_is_defined = false;
    mutable bool m_verbose = true;
    std::string m_diagnostic_file;
    int m_diagnostic_interval = 1;
    bool m_usePC = false;
 
    mutable int m_exit_status = 0;
 
};
 
#endif