sheath.hpp

Go to the documentation of this file.

#ifndef SHEATH_HPP
#define SHEATH_HPP
#include "push_controls.hpp"
#include "species.hpp"
#include "neutrals.hpp"
#include "heat_diagnostics.hpp"

// Sheath particle struct to store particle info if using sheath mode 2
template<class Device>
struct SheathParticles {

    struct SheathVec {
        double r;
        double z;
        double phi;
    };

    // Constructor
    SheathParticles(int n_ptl)
        : widx(NoInit("widx"), n_ptl),
          iphi(NoInit("iphi"), n_ptl),
          en_para(NoInit("en_para"), n_ptl),
          en_perp(NoInit("en_perp"), n_ptl),
          ph_back("ph_back", n_ptl), // Init to 0
          ph_out("ph_out", n_ptl) // Init to 0
    {
        // Set the particle values
        Kokkos::deep_copy(widx, -1);
        Kokkos::deep_copy(iphi, -1);
        Kokkos::deep_copy(en_para, -1.0);
        Kokkos::deep_copy(en_perp, -1.0);
    }

    // Null constructor
    SheathParticles(){}

    // Arrays of particle properties to track
    View<int*,CLayout,Device> widx;           
    View<int*,CLayout,Device> iphi;           
    View<double*,CLayout,Device> en_para;     
    View<double*,CLayout,Device> en_perp;     
    View<SheathVec*,CLayout,Device> ph_back;  
    View<SheathVec*,CLayout,Device> ph_out;   
};


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

    // Constructor
    Sheath(const Grid<Device>& grid, const Simulation<Device>& sml);

    // Null constructor
    Sheath(){}

    // Sheath variables
    View<double**,CLayout,Device> pot;   
    View<double***,CLayout,Device> lost;  
    View<double***,CLayout,Device> ilost;  

    // For sheath mode 2
    View<double***,CLayout,Device> en_max; 

    bool adjust;        

    SheathParticles<Device> particles;

    KOKKOS_INLINE_FUNCTION void deposition_diagnostics_and_w1(const Species<Device> &species, const Grid<Device> &grid, const MagneticField<Device> &magnetic_field, const Neutrals<Device> &neutrals, const HeatDiagnostics<Device> &heat_diag, const SimdParticles &old_part,SimdParticles &part, const SimdVector2D& xff, const Simd<int>& iphi, const Simd<double>& en_para, const Simd<double>& en_perp, SimdPhase& new_phase, const Simd<int>& widx, const Simd<bool>& just_left_the_grid, bool update_lost, bool update_ilost, bool update_neutrals, bool update_heat_diag, Simd<double>& dw) const;

    KOKKOS_INLINE_FUNCTION void save_sheath_ptl_info(const PushControls &push_controls, const Species<Device> &species, const Grid<Device> &grid, int i_item, const SimdParticles &old_part,SimdParticles &part, const Simd<int>& iphi, const Simd<double>& en_para, const Simd<double>& en_perp, const SimdPhase& new_phase, const Simd<int>& widx, const Simd<bool>& just_left_the_grid) const;

    KOKKOS_INLINE_FUNCTION void sheath_calculation(const PushControls &push_controls, const Species<Device> &species, const Grid<Device> &grid, const MagneticField<Device> &magnetic_field, const Neutrals<Device> &neutrals, const HeatDiagnostics<Device> &heat_diag, int i_item, const SimdParticles &old_part,const Simd<bool>& not_in_triangle,SimdParticles &part,SimdGridWeights<Order::One, PIT_GLOBAL>& grid_wts_new, Simd<double>& dw) const;

    void write_checkpoint_files(const XGC_IO_Stream& stream) const;

    void reorder_sheath_pot(const Grid<DeviceType>& grid) const;

    void read_checkpoint_files(const Grid<DeviceType>& grid, const XGC_IO_Stream& stream, int version);

    void clear_device_views() const;

    void copy_pot_to_device() const;

    void setup_mode_2(int n_tmp);

    void deallocate_particles();

    void mode_1_copy_to_host() const;

    void mode_2_copy_to_host() const;

    void copy_lost_to_host() const;
};

#include "sheath.tpp"
#endif