sources.hpp

Go to the documentation of this file.

#ifndef SOURCES_HPP
#define SOURCES_HPP
 
#include "step_trigger.hpp"
#include "monte_carlo_collisions.hpp"
#include "col_grid.hpp"
#include "diffusion.hpp"
#include "radiation.hpp"
#include "pellet.hpp"
#include "thermal_bath.hpp"
#include "current_drive.hpp"
#include "fgrid_coarse_graining.hpp"
#include "neutrals.hpp"
 
enum class CollisionMode{
    None = 0,
    MonteCarloNonConserving, // monte-carlo non-conserving
    NonLinearFokkerPlanckLandau, // fully non-linear multi-species Fokker-Planck-Landau [Hager JCP 315, 644-660 (2016)]
    PETScLandauAMR // PETSc multi-species Landau with adaptive mesh refinement (ongoing implementation)
};
 
struct Sources{
    private:
 
    StepTrigger step_trigger; // Triggers when f_source is called
 
    public:
 
    int f_source_period; 
 
    // List of sources (other collisions-related members will be folded into a child class of Source)
    Neutrals neutrals;
    Diffusion diffusion;
    Radiation radiation;
    Source heat_and_torque;
    Source collisions;
    CurrentDrive current_drive;
    Pellet pellet;
    ThermalBath thermal_bath;
    FGridCoarseGraining fgrid_coarse_graining;
 
    CollisionMode col_mode; 
    MonteCarloCollider<DeviceType> col_mc; 
    CollisionGrid<DeviceType> col_grid; 
 
    Sources(){}
 
    Sources(NLReader::NamelistReader& nlr, const DomainDecomposition<DeviceType>& pol_decomp, const MagneticField<DeviceType>& magnetic_field, const Grid<DeviceType>& grid, const VelocityGrid& vgrid, Plasma& plasma, bool exclude_private_region, bool overwrite_existing_files, double sml_dt, double transit_time);
 
    // Close streams for diagnostics associated with a source. This could be part of a destructor.
    void close_streams(){
        if(col_mode==CollisionMode::NonLinearFokkerPlanckLandau && col_grid.diag_on){
            col_grid.io_stream->Close();
        }
    }
 
    /* Returns whether the sources should be executed on this step
     * */
    bool is_triggered(int step){
        return step_trigger.is_triggered(step);
    }
};
 
#endif