ISurfaceSolver.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_2D_I_SURFACE_SOLVER_HPP
#define OPENSWMM_ENGINE_2D_I_SURFACE_SOLVER_HPP
 
#include <vector>
 
namespace openswmm::twoD {
 
// Forward declarations — passed by reference, no definitions needed here.
struct MeshData;
struct SurfaceStateData;
struct SolverOptions2D;

class ISurfaceSolver {
public:
    virtual ~ISurfaceSolver() = default;

    virtual void initialize(MeshData& mesh, SurfaceStateData& state,
                            SolverOptions2D& opts) = 0;

    virtual double advance(double t_current, double t_target) = 0;

    virtual void reinitialize(double t0) = 0;

    virtual void finalize() = 0;

    virtual long last_num_steps() const noexcept = 0;

    virtual double last_step_size() const noexcept = 0;

    virtual const std::vector<double>& last_coupling_exchange() const noexcept {
        static const std::vector<double> kEmpty;
        return kEmpty;
    }

    virtual bool is_initialized() const noexcept = 0;
};
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_I_SURFACE_SOLVER_HPP