Preconditioner.H

Go to the documentation of this file.

/* Copyright 2024 Debojyoti Ghosh
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PRECONDITIONER_H_
#define WARPX_PRECONDITIONER_H_
 
#include "Utils/TextMsg.H"
#include <AMReX_Enum.H>
#include <string>

AMREX_ENUM(PreconditionerType,
    pc_curl_curl_mlmg,
    pc_jacobi,
    pc_petsc,
    none
);
 
// Can't wrap pc_petsc inside AMREX_USE_PETSC directives.

 
template <class T, class Ops>
class Preconditioner
{
    public:
 
        using RT = typename T::value_type;

        Preconditioner () = default;

        virtual ~Preconditioner () = default;
 
        // Default move and copy operations
        Preconditioner(const Preconditioner&) = default;
        Preconditioner& operator=(const Preconditioner&) = default;
        Preconditioner(Preconditioner&&) noexcept = default;
        Preconditioner& operator=(Preconditioner&&) noexcept = default;

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

        virtual void Update ( const T& a_U ) = 0;

        virtual void Apply (T& a_x, const T& a_b) = 0;

        virtual void getPCMatrix( amrex::Gpu::DeviceVector<int>&,
                                  amrex::Gpu::DeviceVector<int>&,
                                  amrex::Gpu::DeviceVector<int>&,
                                  amrex::Gpu::DeviceVector<RT>&,
                                  int&, int& )
        {
            WARPX_ABORT_WITH_MESSAGE("getPCMatrix() called on base class!");
        }

        [[nodiscard]] virtual bool IsDefined () const = 0;

        virtual void setName (const std::string&) { }

        virtual void printParameters() const { }

        inline void CurTime (const RT a_time) { m_time = a_time; }

        inline void CurTimeStep (const RT a_dt) { m_dt = a_dt; }
 
    protected:
 
        RT m_time = 0.0;
        RT m_dt = 0.0;
 
    private:
 
};
 
#endif