HypreAmgPreconditioner.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_2D_HYPRE_AMG_PRECONDITIONER_HPP
#define OPENSWMM_ENGINE_2D_HYPRE_AMG_PRECONDITIONER_HPP
 
#include "SurfaceJacobian.hpp"
 
#include <vector>
 
namespace openswmm::twoD {
 
class MeshData;
class SurfaceStateData;

class HypreAmgPreconditioner {
public:
    HypreAmgPreconditioner() = default;
    ~HypreAmgPreconditioner();
 
    HypreAmgPreconditioner(const HypreAmgPreconditioner&)            = delete;
    HypreAmgPreconditioner& operator=(const HypreAmgPreconditioner&) = delete;

    void initialize(const MeshData& mesh);

    void setup(const MeshData& mesh, const SurfaceStateData& state, double gamma,
               bool recompute = true);

    void solve(const double* r, double* z, int n);

    void finalize();
 
    bool ready() const noexcept { return amg_ != nullptr; }

    bool hierarchyBuilt() const noexcept { return hierarchy_built_; }

    void invalidate() noexcept { hierarchy_built_ = false; }
 
private:
    SurfaceJacobian   jac_;
    int               n_ = 0;
    bool              hierarchy_built_ = false;  
    std::vector<int>  rows_;     
    std::vector<int>  ncols_;    
 
    // Opaque hypre handles (HYPRE_IJMatrix / HYPRE_IJVector / HYPRE_Solver are
    // pointer typedefs; kept as void* so this header needs no HYPRE.h).
    void* A_   = nullptr;        
    void* b_   = nullptr;        
    void* x_   = nullptr;        
    void* amg_ = nullptr;        
};
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_HYPRE_AMG_PRECONDITIONER_HPP