parameters_ode_solver.h

#ifndef __PARAMETERS_ODE_SOLVER_H__
#define __PARAMETERS_ODE_SOLVER_H__

#include <deal.II/base/parameter_handler.h>
#include "parameters/parameters.h"

namespace PHiLiP {
namespace Parameters {

class ODESolverParam
{
public:
    enum ODESolverEnum {
        runge_kutta_solver, 
        low_storage_runge_kutta_solver, 
        implicit_solver,  
        rrk_explicit_solver, 
        pod_galerkin_solver, 
        pod_petrov_galerkin_solver, 
        hyper_reduced_petrov_galerkin_solver, 
        pod_galerkin_runge_kutta_solver 
    };

    OutputEnum ode_output; 
    ODESolverEnum ode_solver_type; 

    double atol; 
    double rtol; 
    double beta1; 
    double beta2; 
    double beta3; 
    int output_solution_every_x_steps; 
    double output_solution_every_dt_time_intervals; 
    bool output_solution_at_fixed_times; 
    std::string output_solution_fixed_times_string; 
    unsigned int number_of_fixed_times_to_output_solution; 
    bool output_solution_at_exact_fixed_times; 

    unsigned int nonlinear_max_iterations; 
    unsigned int print_iteration_modulo; 
    bool output_final_steady_state_solution_to_file; 
    std::string steady_state_final_solution_filename; 

    double nonlinear_steady_residual_tolerance; 

    double initial_time_step; 
    double time_step_factor_residual; 
    double time_step_factor_residual_exp; 

    bool output_ode_solver_steady_state_convergence_table;
  
    double initial_time; 
    unsigned int initial_iteration; 

    double initial_desired_time_for_output_solution_every_dt_time_intervals;

    enum RKMethodEnum {
        rk4_ex, 
        ssprk3_ex, 
        heun2_ex, 
        euler_ex, 
        euler_im, 
        dirk_2_im, 
        dirk_3_im, 
        RK4_3_5_3SStar, 
        RK3_2_5F_3SStarPlus, 
        RK4_3_9F_3SStarPlus, 
        RK5_4_10F_3SStarPlus 
    };

    RKMethodEnum runge_kutta_method; 
    int n_rk_stages; 
    int rk_order; 
    int num_delta; 
    bool is_3Sstarplus; 

    bool allocate_matrix_dRdW;

    OutputEnum rrk_root_solver_output;

    double relaxation_runge_kutta_root_tolerance;

    bool use_relaxation_runge_kutta;

    static void declare_parameters (dealii::ParameterHandler &prm); 
    void parse_parameters (dealii::ParameterHandler &prm); 
};

} // Parameters namespace
} // PHiLiP namespace
#endif