VMEC_vars.f90

Go to the documentation of this file.

!------------------------------------------------------------------------------!
!> Variables that concern the output of VMEC.
!------------------------------------------------------------------------------!
module vmec_vars
#include <PB3D_macros.h>
    use str_utilities
    use output_ops
    use messages
    use num_vars, only: &
        &dp, max_str_ln, pi
    use read_wout_mod, only: &                                                  ! from LIBSTELL
        &is_asym_v => lasym, vmec_version => version_, is_freeb_v => lfreeb, &  ! stellerator symmetry, version number, free boundary or not
        &mpol_v => mpol, ntor_v => ntor, &                                      ! mpol, ntor
        &mnmax_v => mnmax, nfp_v => nfp, &                                      ! mnmax, nfp
        &aspr_v => aspect, &                                                    ! aspect ratio
        &beta_v => betaxis, &                                                   ! beta on axis
        &gam_v => gamma, &                                                      ! gamma in adiabatic law (not important here, incompressibility)
        &rmax_surf, rmin_surf, zmax_surf                                        ! max and min values of R, Z
    
    implicit none
    private
    public dealloc_vmec, &
        &r_v_c, r_v_s, z_v_c, z_v_s, l_v_c, l_v_s, jac_v_c, jac_v_s, mnmax_v, &
        &mpol_v, ntor_v, mn_v, pres_v, rot_t_v, q_saf_v, is_asym_v, flux_t_v, &
        &flux_p_v, vmec_version, gam_v, is_freeb_v, nfp_v, b_0_v, rmin_surf, &
        &rmax_surf, aspr_v, beta_v, b_v_sub_s, b_v_sub_c
#if ldebug
    public b_v_c, b_v_s, j_v_sup_int
#endif
    
    ! global variables
    integer, allocatable :: mn_v(:,:)                                           !< m and n of modes
    real(dp) :: b_0_v                                                           !< the magnitude of B at the magnetic axis, \f$\theta = \zeta = 0\f$
    real(dp), allocatable :: flux_t_v(:,:)                                      !< toroidal flux
    real(dp), allocatable :: flux_p_v(:,:)                                      !< poloidal flux
    real(dp), allocatable :: pres_v(:,:)                                        !< pressure
    real(dp), allocatable :: rot_t_v(:,:)                                       !< rotational transform
    real(dp), allocatable :: q_saf_v(:,:)                                       !< safety factor
    real(dp), allocatable :: r_v_c(:,:,:)                                       !< Coeff. of \f$R\f$ in sine series (FM) and norm. deriv.
    real(dp), allocatable :: r_v_s(:,:,:)                                       !< Coeff. of \f$R\f$ in cosine series (FM) and norm. deriv.
    real(dp), allocatable :: z_v_c(:,:,:)                                       !< Coeff. of \f$Z\f$ in sine series (FM) and norm. deriv.
    real(dp), allocatable :: z_v_s(:,:,:)                                       !< Coeff. of \f$Z\f$ in cosine series (FM) and norm. deriv.
    real(dp), allocatable :: l_v_c(:,:,:)                                       !< Coeff. of \f$\lambda\f$ in sine series (HM) and norm. deriv.
    real(dp), allocatable :: l_v_s(:,:,:)                                       !< Coeff. of \f$\lambda\f$ in cosine series (HM) and norm. deriv.
    real(dp), allocatable :: jac_v_c(:,:,:)                                     !< Coeff. of \f$\mathcal{J}\f$ in sine series (HM and FM) and norm. deriv.
    real(dp), allocatable :: jac_v_s(:,:,:)                                     !< Coeff. of \f$\mathcal{J}\f$ in cosine series (HM and FM) and norm. deriv.
    real(dp), allocatable :: b_v_sub_c(:,:,:)                                   !< Coeff. of B_i in sine series (r,theta,phi) (FM) \ldebug
    real(dp), allocatable :: b_v_sub_s(:,:,:)                                   !< Coeff. of B_i in cosine series (r,theta,phi) (FM) \ldebug
#if ldebug
    real(dp), allocatable :: b_v_c(:,:)                                         !< Coeff. of magnitude of B in sine series (HM and FM) \ldebug
    real(dp), allocatable :: b_v_s(:,:)                                         !< Coeff. of magnitude of B in cosine series (HM and FM) \ldebug
    real(dp), allocatable :: j_v_sup_int(:,:)                                   !< Integrated poloidal and toroidal current (FM) \ldebug
#endif
contains
    !> Deallocates VMEC quantities that are not used anymore.
    subroutine dealloc_vmec()
#if ldebug
        use num_vars, only: rank, print_mem_usage
        
        ! local variables
        integer :: mem_diff                                                     ! difference in memory
        
        ! memory usage before deallocation
        if (print_mem_usage) mem_diff = get_mem_usage()
#endif
        
        ! deallocate
        deallocate(rot_t_v)
        deallocate(q_saf_v)
        deallocate(pres_v)
        deallocate(flux_t_v)
        deallocate(flux_p_v)
        deallocate(mn_v)
        deallocate(r_v_c)
        deallocate(r_v_s)
        deallocate(z_v_c)
        deallocate(z_v_s)
        deallocate(l_v_c)
        deallocate(l_v_s)
        deallocate(jac_v_c)
        deallocate(jac_v_s)
        deallocate(b_v_sub_c)
        deallocate(b_v_sub_s)
#if ldebug
        deallocate(b_v_c)
        deallocate(b_v_s)
        deallocate(j_v_sup_int)
        
        ! memory usage difference after deallocation
        if (print_mem_usage) then
            mem_diff = mem_diff - get_mem_usage()
            call writo('Rank '//trim(i2str(rank))//' liberated '//&
                &trim(i2str(mem_diff))//'kB deallocating VMEC')
        end if
#endif
    end subroutine dealloc_vmec
end module vmec_vars