particle_stream.hpp

Go to the documentation of this file.

#ifndef PARTICLE_STREAM_HPP
#define PARTICLE_STREAM_HPP
#include "magnetic_field.hpp"

// ParticleStream class
class ParticleStream {
    public:

    // Used in diag_1d_port1 (in pushe)
    int reset_period;       
    double pin, pout;       // psi range of selected particles

    //constructor
    //ParticleStream(NLReader::NamelistReader& nlr, const MagneticField<DeviceType>& magnetic_field);
    ParticleStream(NLReader::NamelistReader& nlr, const MagneticField<DeviceType>& magnetic_field)
    {
        nlr.use_namelist("diag_param");
        reset_period = nlr.get<int>("diag_ps_reset_period",10);
        pin =  nlr.get<double>("diag_ps_pin", 0.80);
        pout = nlr.get<double>("diag_ps_pout",0.81);

        // need to convert SI unit
        pin*= magnetic_field.equil.xpt_psi;
        pout*= magnetic_field.equil.xpt_psi;
    }

    // Null constructor
    ParticleStream(){}
};

KOKKOS_INLINE_FUNCTION void flag_set(long long int &flags, const bool tf, const long long int flag_loc);
KOKKOS_INLINE_FUNCTION bool flag_check(const long long int flags, const long long int flag_loc);

// Explicitly set length to 64 bits to keep same length as double
constexpr long long int ps_is_to_write{1};      // need to write
constexpr long long int ps_is_in_init{2};       // inside of separatrix initially -- Not used here
constexpr long long int ps_is_written{4};       // inside of separatrix before push -- Not used here
constexpr long long int ps_is_escaped{8};       // True: Particle crossed the separatrix into the SOL during particle push.
                                                // False: Particle did not cross separatrix during particle push
constexpr long long int ps_is_divertor{16};     // why write - just hit the divertor
constexpr long long int ps_is_outboard{32};     // when write - is this outboard?
constexpr long long int ps_was_inside{64};      // aux flag to indicate if the particle was inside before push
constexpr long long int ps_is_tracked{128};     // True: Particle contributes to diffusion analysis

// dw can use 38 bits. dw * 2^nb1 will be saved as integer value. 
// Let dw be between min_dw and max_dw
// This should not exceed    2^(63-nb1-nb2)  
constexpr int ps_flag_bits = 8;
constexpr int ps_step_bits = 17;
constexpr int ps_flag_step_bits = ps_flag_bits + ps_step_bits; //25
constexpr int ps_dw_factor_bits = 28; // should not exceed 31. bits to make dw flot to integer

constexpr long long int ps_flag_step_mask{(1u<<ps_flag_step_bits)-1};    // 8 bits are used for flag. 17 bits integer is used for esc_step. Above it will be used for dw
constexpr long long int ps_flag_mask{(1u<<ps_flag_bits)-1};  // mask for zero out above 8 bits - '<<8' makes 8 zeros and '-1' makes them 8 ones.
#include "particle_stream.tpp"

#endif