CvodeSurfaceSolver.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_2D_CVODE_SURFACE_SOLVER_HPP
#define OPENSWMM_ENGINE_2D_CVODE_SURFACE_SOLVER_HPP
 
#include "../data/MeshData.hpp"
#include "../data/SurfaceStateData.hpp"
#include "../data/SolverOptions2D.hpp"
 
#ifdef OPENSWMM_HAS_2D
 
#include <vector>
 
// Forward declarations for SUNDIALS types (avoid pulling in full headers)
struct SUNContext_;
typedef struct SUNContext_* SUNContext;
typedef struct _generic_N_Vector* N_Vector;
typedef struct _generic_SUNLinearSolver* SUNLinearSolver;
 
namespace openswmm::twoD {
 
class CvodeSurfaceSolver;
 
struct CvodeSolverContext {
    MeshData*           mesh   = nullptr;
    SurfaceStateData*   state  = nullptr;
    SolverOptions2D*    opts   = nullptr;
    CvodeSurfaceSolver* solver = nullptr;
};
 
class CvodeSurfaceSolver {
public:
    CvodeSurfaceSolver() = default;
    ~CvodeSurfaceSolver();
 
    // Non-copyable
    CvodeSurfaceSolver(const CvodeSurfaceSolver&) = delete;
    CvodeSurfaceSolver& operator=(const CvodeSurfaceSolver&) = delete;
 
    // Movable
    CvodeSurfaceSolver(CvodeSurfaceSolver&& o) noexcept;
    CvodeSurfaceSolver& operator=(CvodeSurfaceSolver&& o) noexcept;
 
    void initialize(MeshData& mesh, SurfaceStateData& state,
                    SolverOptions2D& opts);
 
    double advance(double t_current, double t_target);
 
    void reinitialize(double t0);
 
    void finalize();
 
    long last_num_steps() const noexcept { return last_nsteps_; }
 
    double last_step_size() const noexcept { return last_h_; }
 
    bool is_initialized() const noexcept { return cvode_mem_ != nullptr; }
 
private:
    void*           cvode_mem_ = nullptr;  
    SUNLinearSolver ls_        = nullptr;  
    N_Vector        y_         = nullptr;  
    SUNContext      sun_ctx_   = nullptr;  
 
    CvodeSolverContext ctx_;               
 
    long   last_nsteps_ = 0;
    double last_h_      = 0.0;
 
    std::vector<double> precond_diag_;
 
    // ------------------------------------------------------------------
    // SUNDIALS callbacks. All three have C linkage requirements imposed
    // by SUNDIALS' function-pointer typedefs; we expose them as static
    // member functions to keep them inside the class scope.
    // ------------------------------------------------------------------
 
    static int rhs_fn(double t, N_Vector y, N_Vector ydot, void* user_data);
 
    static int psetup_fn(double t, N_Vector y, N_Vector fy,
                          int jok, int* jcurPtr, double gamma,
                          void* user_data);
 
    static int psolve_fn(double t, N_Vector y, N_Vector fy,
                          N_Vector r, N_Vector z,
                          double gamma, double delta, int lr,
                          void* user_data);
};
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_HAS_2D
 
#endif // OPENSWMM_ENGINE_2D_CVODE_SURFACE_SOLVER_HPP