ISurfaceSolver.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#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 resyncFromVolumes(double t0) { reinitialize(t0); }

    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;
    }

    struct RunStats {
        long   nsteps    = 0;   
        long   nrhs      = 0;   
        double last_h    = 0.0; 
        double avg_h     = 0.0; 
 
        // Marcher telemetry. Guarded: n_tiers == 0 and negative fractions
        // mean "not populated".
        double active_frac_min  = -1.0; 
        double active_frac_mean = -1.0; 
        double active_frac_max  = -1.0; 
        long   tier_cells[8]    = {0};  
        int    n_tiers          = 0;    
    };

    virtual RunStats run_stats() const noexcept { return {}; }

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