tracer_routines.hpp

Go to the documentation of this file.

#ifndef TRACER_ROUTINES_HPP
#define TRACER_ROUTINES_HPP

#ifdef ESC_PTL
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);
template<class Device>
KOKKOS_INLINE_FUNCTION void update_particle_flag1(const PushControls &push_controls, const MagneticField<Device> &magnetic_field, SimdParticles &part_tmp, Simd<double> &psi);

// Explicitly set length to 64 bits to keep same length as double
const long long int tracer_is_to_write{1};      // need to write
const long long int tracer_is_in_init{2};       // inside of separatrix initially -- Not used here
const long long int tracer_is_written{4};       // inside of separatrix before push -- Not used here
const long long int tracer_is_escaped{8};       // True: Particle crossed the separatrix into the SOL during particle push.
                                                // False: Particle did not cross separatrix during particle push
const long long int tracer_is_divertor{16};     // why write - just hit the divertor
const long long int tracer_is_outboard{32};     // when write - is this outboard?
const long long int tracer_was_inside{64};      // aux flag to indicate if the particle was inside before push
const long long int tracer_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)  
const int tracer_flag_bits = 8;
const int tracer_step_bits = 17;
const int tracer_flag_step_bits = tracer_flag_bits + tracer_step_bits; //25
const int tracer_dw_factor_bits = 28; // should not exceed 31. bits to make dw flot to integer

const long long int tracer_flag_step_mask{(1u<<tracer_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
const long long int tracer_flag_mask{(1u<<tracer_flag_bits)-1};  // mask for zero out above 8 bits - '<<8' makes 8 zeros and '-1' makes them 8 ones.
#include "tracer_routines.tpp"
#endif
// ESC_PTL above
#endif