neutrals.hpp

Go to the documentation of this file.

#ifndef NEUTRALS_HPP
#define NEUTRALS_HPP
 
#include "view_arithmetic.hpp"
#include "xgc_io.hpp"
#include "NamelistReader.hpp"
#include "grid.hpp"
#include "plasma.hpp"
#include "vgrid_distribution.hpp"
#include "diag_f0_df.hpp"
#include "step_trigger.hpp"
#include "source.hpp"
 
// Struct to collect particle loss data at wall in push
struct WallLoss{
    View<double**,CLayout,DeviceType> weight_wall_lost;  
 
    bool ebin_log;
    double ebin_min;
    double ebin_delta;
    View<double***,CLayout,DeviceType> weight_lost_ebin;  
};
 
 
// Neutrals class
class Neutrals : public Source {
public:
 
    WallLoss wall_loss;
 
    // Neutrals variables
    int background_period;
 
    // Step trigger for the neutral background update
    StepTrigger trigger_neutral_update;
 
    View<double*,CLayout,HostType> weight_sum_lost_h;   
    View<double*,CLayout,HostType> weight_wall_lost_h;  
    View<double**,CLayout,HostType> weight_lost_ebin_h;  
    View<double*,CLayout,HostType> node_dens_h;
    View<double*,CLayout,HostType> node_temp_h;
 
    StepTrigger trigger_diag; // trigger for diagnostic
#ifndef NO_FORTRAN_MODULES
    std::shared_ptr<XGC_IO_Stream> io_stream;
#endif
 
    // Constructor
    Neutrals( int nthreads, int nbins, int nnode, NLReader::NamelistReader& nlr, double sml_dt, double transit_time);
 
    // "Null constructor"
    Neutrals(){}
 
    void diag(const DomainDecomposition<DeviceType>& pol_decomp, int gstep, const View<double*,CLayout,HostType>& n_neut, const View<double*,CLayout,HostType>& T_neut) const;
 
    void write_checkpoint_files(const XGC_IO_Stream& stream) const;
 
    void read_checkpoint_files(const XGC_IO_Stream& stream) const;
 
    void copy_to_host() const;
 
    void clear_device_views() const;
 
    void clear_host_views() const;
 
    void apply(const Grid<DeviceType>& grid, const DomainDecomposition<DeviceType>& pol_decomp, const VelocityGrid& vgrid, Plasma& plasma, const VGridDistribution<DeviceType>& f0_f, const VGridDistribution<HostType>&  f0_f_h, VGridDistribution<DeviceType>& f0_df0g_cumul, const int axisym_parallelization_int, int gstep, DiagF0DF& diag_f0_df, double dt) const;
};
#endif