SolverOptions2D.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_2D_SOLVER_OPTIONS_HPP
#define OPENSWMM_ENGINE_2D_SOLVER_OPTIONS_HPP
 
#include <cstdint>
#include <string>
 
namespace openswmm::twoD {
 
enum class LinearSolverType : int8_t {
    GMRES    = 0,   
    BICGSTAB = 1,   
    TFQMR    = 2    
};
 
enum class PreconditionerType : int8_t {
    NONE   = 0,     
    JACOBI = 1,     
    ILU    = 2      
    // AMG  = 3     ///< Reserved for Phase 2 (hypre BoomerAMG).
};
 
struct SolverOptions2D {
    double max_timestep      = 10.0;    
    double min_timestep      = 0.001;   
    double rel_tolerance     = 1.0e-4;  
    double abs_tolerance     = 1.0e-6;  
    double dry_depth         = 0.001;   
    double limiter_epsilon   = 1.0e-6;  
    double coupling_cd       = 0.65;    
    int    max_krylov_dim    = 30;      
    int    coupling_interval = 0;       
    int    max_cvode_steps   = 500;     
    bool   report_2d         = true;    
 
    LinearSolverType   linear_solver   = LinearSolverType::GMRES;
    PreconditionerType preconditioner  = PreconditionerType::NONE;
 
    std::string mesh_file;
 
    std::string output_file;
};
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_SOLVER_OPTIONS_HPP