parameters_flow_solver.h

#ifndef __PARAMETERS_FLOW_SOLVER_H__
#define __PARAMETERS_FLOW_SOLVER_H__

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

namespace PHiLiP {

namespace Parameters {

class FlowSolverParam
{
public:

    enum FlowCaseType{
        taylor_green_vortex,
        decaying_homogeneous_isotropic_turbulence,
        burgers_viscous_snapshot,
        naca0012,
        burgers_rewienski_snapshot,
        burgers_inviscid,
        convection_diffusion,
        advection,
        periodic_1D_unsteady,
        gaussian_bump,
        channel_flow,
        isentropic_vortex,
        kelvin_helmholtz_instability,
        dipole_wall_collision_normal,
        dipole_wall_collision_oblique,
        non_periodic_cube_flow,
        sod_shock_tube,
        low_density,
        leblanc_shock_tube,
        shu_osher_problem,
        advection_limiter,
        burgers_limiter,
        double_mach_reflection,
        shock_diffraction,
        astrophysical_jet,
        strong_vortex_shock_wave,
        turbulent_airfoil_3D,
        multi_species_vortex_advection,
        multi_species_vortex_advection_high_temp,
        multi_species_sod_shock_tube,
        multi_species_isentropic_vortex,
        multi_species_taylor_green_vortex_smooth,
        multi_species_taylor_green_vortex_sharp
        };
    FlowCaseType flow_case_type; 

    unsigned int poly_degree; 
    unsigned int max_poly_degree_for_adaptation; 
    

    double final_time; 
    double constant_time_step; 
    double courant_friedrichs_lewy_number; 

    std::string unsteady_data_table_filename;

    bool steady_state; 
    bool steady_state_polynomial_ramping; 

    bool error_adaptive_time_step; 
    bool adaptive_time_step; 

    std::string sensitivity_table_filename;

    std::string input_mesh_filename;
    bool use_gmsh_mesh; 
    bool mesh_reader_verbose_output;

    bool use_periodic_BC_in_x; 
    bool use_periodic_BC_in_y; 
    bool use_periodic_BC_in_z; 

    int x_periodic_id_face_1; 
    int x_periodic_id_face_2; 

    int y_periodic_id_face_1; 
    int y_periodic_id_face_2; 

    int z_periodic_id_face_1; 
    int z_periodic_id_face_2; 

    bool restart_computation_from_file; 
    bool output_restart_files; 
    std::string restart_files_directory_name; 
    unsigned int restart_file_index; 
    int output_restart_files_every_x_steps; 
    double output_restart_files_every_dt_time_intervals; 
    double write_unsteady_data_table_file_every_dt_time_intervals; 

    unsigned int grid_degree; 
    double grid_left_bound; 
    double grid_right_bound; 
    unsigned int number_of_grid_elements_per_dimension; 
    int number_of_mesh_refinements; 
    double channel_height; 
    double channel_length; 
    double bump_height; 
    int number_of_subdivisions_in_x_direction; 
    int number_of_subdivisions_in_y_direction; 
    int number_of_subdivisions_in_z_direction; 
    double grid_top_bound; 
    double grid_bottom_bound; 
    double grid_z_upper_bound; 
    double grid_z_lower_bound; 

    unsigned int number_of_grid_elements_x; 
    unsigned int number_of_grid_elements_y; 
    unsigned int number_of_grid_elements_z; 

    double expected_order_at_final_time; 

    double expected_kinetic_energy_at_final_time;

    double expected_theoretical_dissipation_rate_at_final_time;

    enum DensityInitialConditionType{
        uniform,
        isothermal,
        };
    DensityInitialConditionType density_initial_condition_type;
    bool do_calculate_numerical_entropy;
    bool check_nonphysical_flow_case_behavior;

    double turbulent_channel_friction_velocity_reynolds_number; 
    int turbulent_channel_number_of_cells_x_direction; 
    int turbulent_channel_number_of_cells_y_direction; 
    int turbulent_channel_number_of_cells_z_direction; 
    double turbulent_channel_domain_length_x_direction; 
    double turbulent_channel_domain_length_y_direction; 
    double turbulent_channel_domain_length_z_direction; 
    double relaxation_coefficient_for_turbulent_channel_flow_source_term;

    enum XVelocityInitialConditionType{
        laminar,
        turbulent,
        manufactured,
        };
    XVelocityInitialConditionType xvelocity_initial_condition_type;

    enum TurbulentChannelMeshStretchingFunctionType{
        gullbrand,
        hopw,
        carton_de_wiart_et_al,
        uniform_mesh_no_stretching,
        };
    TurbulentChannelMeshStretchingFunctionType turbulent_channel_mesh_stretching_function_type;

    bool do_use_stretched_mesh;

    bool do_compute_angular_momentum;

    double expected_enstrophy_at_final_time;

    double expected_palinstrophy_at_final_time;

    double expected_average_wall_shear_stress_at_final_time;

    double expected_skin_friction_coefficient_at_final_time;
    
    double atwood_number;


    int number_ESFR_parameter_values;

    double ESFR_parameter_values_start;

    double ESFR_parameter_values_end;

    enum ApplyInitialConditionMethod{
        interpolate_initial_condition_function,
        project_initial_condition_function,
        read_values_from_file_and_project
        };
    ApplyInitialConditionMethod apply_initial_condition_method; 

    std::string input_flow_setup_filename_prefix;

    bool output_velocity_field_at_fixed_times; 
    std::string output_velocity_field_times_string; 
    unsigned int number_of_times_to_output_velocity_field; 
    bool output_vorticity_magnitude_field_in_addition_to_velocity; 
    bool output_density_field_in_addition_to_velocity; 
    bool output_viscosity_field_in_addition_to_velocity; 
    bool do_compute_time_averaged_solution; 
    double time_to_start_averaging; 
    bool do_compute_Reynolds_stress; 
    double time_to_start_computing_Reynolds_stress; 
    std::string output_flow_field_files_directory_name; 
    unsigned int output_velocity_number_of_subvisions; 

    bool end_exactly_at_final_time; 
    bool do_compute_unsteady_data_and_write_to_table;

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

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

} // Parameters namespace

} // PHiLiP namespace

#endif