magnetic_field.hpp

Go to the documentation of this file.

#ifndef MAGNETIC_FIELD_HPP
#define MAGNETIC_FIELD_HPP
#include "equil.hpp"
#include "bicub.hpp"
#include "cub_interp.hpp"

// Magnetic field class
template<class Device>
class MagneticField {

    KOKKOS_INLINE_FUNCTION void derivs(const double (&x)[2],double phi,double (&dx)[2]) const;

    public:

    // Field variables
    double bt_sign;  
    double bp_sign;  
    int ff_step;     
    int ff_order;    
    double bd_min_r; 
    double bd_max_r; 
    double bd_min_z; 
    double bd_max_z; 

    double inpsi;    
    double outpsi;   


    // Structures inside B-field
    Bicub<Device> psi_bicub;   
    CubInterp<Device> I_interp;   
    Equilibrium<Device> equil; 

    MagneticField(double bt_sign_in, double bp_sign_in, int ff_step_in, int ff_order_in, double bd_min_r_in, double bd_max_r_in, double bd_min_z_in, double bd_max_z_in, double inpsi_in, double outpsi_in,
                  // Bicub:
                  double *rc_in, double *zc_in, BicubCoeff *acoeff_in, int nr_in, int nz_in, double rmin_in, double zmin_in, double dr_inv_in, double dz_inv_in,
                  // Interp:
                  OneDCoeff *one_d_cub_acoef_in, int ncoeff_in, double max_psi_in, double min_psi_in, double one_d_cub_dpsi_inv_in,
                  // Equil:
                  double eq_min_r, double eq_max_r, double eq_min_z, double eq_max_z,
                  double eq_x_psi, double epsil_psi, double eq_x_r, double eq_x_slope, double eq_x_z,
                  double eq_x2_r, double eq_x2_slope, double eq_x2_z, double eq_x2_psi, double eq_axis_r,
                  double eq_axis_z, int eq_mpsi);

    // Constructor for analytic test field
    MagneticField(PsiOption psi_opt)
      : inpsi(0.0),
        outpsi(2.0),

        bt_sign(-1),
        bp_sign(1),

        bd_min_r(0.5),
        bd_max_r(2.5),
        bd_min_z(-1.0),
        bd_max_z(1.0),
        equil(psi_opt)
    {}

    // Default constructor
    MagneticField(){}

    KOKKOS_INLINE_FUNCTION void get_psi(const Simd<double>& r_in,const Simd<double>& z_in,Simd<double>& psi_out) const;

    KOKKOS_INLINE_FUNCTION double I_value(double psi_in,int rgn3) const;

    KOKKOS_INLINE_FUNCTION double I_deriv(double psi_in,int rgn3) const;

    // Get complete B-field info
    KOKKOS_INLINE_FUNCTION void field(const Simd<double>& fld_r, const Simd<double>& fld_z,
               SimdVector &bvec, SimdVector (&jacb)[3], Simd<double>& psivec, SimdVector2D &gradpsi, SimdVector &tdb, Simd<bool>& rz_outside) const;

    KOKKOS_INLINE_FUNCTION void bvec_interpol(double r,double z,double phi,double &br,double &bz,double &bphi) const;

    KOKKOS_INLINE_FUNCTION void bmag_interpol(const Simd<double>& r, const Simd<double>& z, const Simd<double>& phi,Simd<double>& bmag) const;

    KOKKOS_INLINE_FUNCTION void follow_field(const SimdVector2D &x_org,const Simd<double>& phi_org, const Simd<double>& phi_dest,SimdVector2D &x_dest) const;
};

#include "magnetic_field.tpp"
#endif