sml.hpp

Go to the documentation of this file.

#ifndef SML_HPP
#define SML_HPP
#include "space_settings.hpp"
#include "NamelistReader.hpp"

// Simulation class
template<class Device>
class Simulation {
    public:

    // Constructor
    // transit_time_in and psi_norm are 1.0 so that the regression tests pass. Update the
    // reference data and remove these default values when possible. Or better, address the related TODO in xgc.cpp
    Simulation(NLReader::NamelistReader& nlr, bool reduced_deltaf_in=false, double transit_time_in=1.0, double psi_norm=1.0);

#ifdef XGCA
    static constexpr bool is_XGCa = true; 
#else
    static constexpr bool is_XGCa = false; 
#endif

#ifdef EXPLICIT_EM
    static constexpr bool explicit_electromagnetic = true; 
#else
    static constexpr bool explicit_electromagnetic = false; 
#endif

#ifdef F0_UPDATE_ANALYTIC_OLD
    static constexpr bool old_f0_update_analytic = true; 
#else
    static constexpr bool old_f0_update_analytic = false; 
#endif

    static constexpr int nhybrid = 2;  

    bool reduced_deltaf; 
    bool separate_n0; 

    // Input parameters
    int bounce;                
    int bounce_zero_weight;    
    double bounce_buffer;      
    double dt;                 
    double transit_time;       
    int sheath_mode;           
    bool sheath_adjust;        
    bool ptb_3db_on;           
    bool drift_on;             
    bool neutrals;             
    bool diag_heat_on;         
    bool xz_00_up;             
    int mstep;                 
    int nrk;                   
    bool electron_on;          
    bool limit_marker_den;     
    int nthreads;              

    bool field_solver;  
    bool helmholtz_spectral;    

    bool thermal_bath_on;      

    bool dwdt_fix_bg;           // 1-w factor in dwdt
    bool dwdt_exb_only;         // excluding grad-b drift in dwdt

    bool em_mixed_variable;     
    bool em_control_variate;    
    int  em_pullback_mode;      
    double em_pullback_dampfac;   
    bool em_control_variate_final_cv; // Should be local variable/argument
    bool em_control_variate_flag; // Should be local variable/argument
    int em_control_variate_niter; 
    bool em_b_para_eff;               
    bool em_es_step;            
    bool em_dAsdt_filter_on;   
    bool no_turb;              
    bool em_n0;                
    bool em_dAsdt_hypvis;      

    bool exclude_private;      

    bool grad_psitheta;        
    bool iter_solver; 
    int poisson_solver_type; 
    bool update_poisson_solver; 

    bool iter_solver_converge; 
    bool positive_phi00_sol; 
    bool heuristic_priv_pot; 
    bool poisson_natural_boundary; 
    int add_pot0; 
    bool poisson_use_bc; 

    bool dpot_bd_apply; 
    double dpot_bd_width; 
    bool poisson_bias;  

    bool poisson_adia_wall;  
                             // If true, an adiabatic wall condition is used (no polarization, n_i=0, n_e!=0)
                             // in the axisymmetric solver; this is an experimental option and should
                             // be used together with sml_sheath_mode=1 and sml_sheath_init_pot_factor=0.

    double dpot_te_limit;      
    bool em_use_dpot_te_limit; 

    // Used in update_f0
    bool no_fp_in_f;            
    double f0_grid_alpha;       
    bool f0_update_analytic;     
    bool f0_update_analytic_local;        
    double f0_update_analytic_alpha;      
    double f0_update_analytic_damp_width; 
    int f0_grid_alpha_start;    
    bool ignore_f0g; 
    bool symmetric_f; 

    double update_g_alpha; 
    // Diffusion
    bool diff_on;

    // Resampling
    bool resamp_on; 
    bool resamp_for_final_restart_write; 
    bool resamp_restart_read; 

    // Simulation variables
    double time;               
    int gstep;                 

    bool multirate_timestepping; 
    int mr_factor; 
    double mr_psi_max; 

    // RMP penetration calculation
    int mstep_rmp_es;           
    int mstep_rmp_em;           
    int rmp_es_to_em_dt_ratio;  

    bool use_em_bounds;
    bool em_exclude_private;
    double bd_ext_delta_Ai;
    double bd_ext_delta_Ao;

    // Core-edge coupling
    bool cce_coupling_on;       

    // Push performance - could be elsewhere
    bool use_unfused_electron_push_kernel;

    // Loop-voltage (for driving the equilibrium current)
    bool loop_voltage_on;       
    bool loop_voltage_fsa;      
    double loop_voltage;        
    double loop_voltage_psimax; 
    //double current_drive_gamma; //!< Damping factor for heuristic current drive, 1.0 means plasma current is restored exactly each time step
    bool   current_drive_on;    
    double current_drive_p;     
    double current_drive_i;     
    double current_drive_d;     


    // Fourier filter
    int mode_select_mode;
    double mode_select_inpsi;
    double mode_select_outpsi;
    double mode_select_bd_width;
};

#include "sml.tpp"
#endif