HELENA_vars.f90

Go to the documentation of this file.

!------------------------------------------------------------------------------!
!> Variables that have to do with HELENA quantities.
!------------------------------------------------------------------------------!
module helena_vars
#include <PB3D_macros.h>
    use num_vars, only: pi
    use str_utilities
    use output_ops
    use messages
    use num_vars, only: dp, max_str_ln
    use grid_vars, only: grid_type
    use x_vars, only: x_1_type, x_2_type
    
    implicit none
    private
    public dealloc_hel, &
        &pres_h, q_saf_h, rot_t_h, flux_p_h, flux_t_h, nchi, chi_h, ias, &
        &rbphi_h, r_h, z_h, h_h_11, h_h_12, h_h_33, rmtog_h, bmtog_h
    
    ! global variables
    real(dp) :: rmtog_h                                                         !< R_geo/R_mag
    real(dp) :: bmtog_h                                                         !< B_geo/B_mag
    real(dp), allocatable :: chi_h(:)                                           !< poloidal angle
    real(dp), allocatable :: flux_p_h(:,:)                                      !< poloidal flux
    real(dp), allocatable :: flux_t_h(:,:)                                      !< toroidal flux
    real(dp), allocatable :: pres_h(:,:)                                        !< pressure profile
    real(dp), allocatable :: q_saf_h(:,:)                                       !< safety factor
    real(dp), allocatable :: rot_t_h(:,:)                                       !< rotational transform
    real(dp), allocatable :: rbphi_h(:,:)                                       !< \f$R B_\phi (= F) \f$
    real(dp), allocatable :: h_h_11(:,:)                                        !< upper metric factor \f$h_{11}\f$ (\c gem11)
    real(dp), allocatable :: h_h_12(:,:)                                        !< upper metric factor \f$h_{12}\f$ (\c gem12)
    real(dp), allocatable :: h_h_33(:,:)                                        !< upper metric factor \f$h_{32}\f$ (1 / \c gem12)
    real(dp), allocatable :: r_h(:,:)                                           !< major radius \f$R\f$ (xout)
    real(dp), allocatable :: z_h(:,:)                                           !< height \f$Z\f$ (yout)
    integer :: nchi                                                             !< nr. of poloidal points
    integer :: ias                                                              !< 0 if top-bottom symmetric, 1 if not
 
contains
    !> Deallocates HELENA quantities that are not used any more.
    subroutine dealloc_hel
#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(chi_h)
        deallocate(flux_p_h)
        deallocate(flux_t_h)
        deallocate(pres_h)
        deallocate(q_saf_h)
        deallocate(rot_t_h)
        deallocate(rbphi_h)
        deallocate(r_h)
        deallocate(z_h)
        deallocate(h_h_11)
        deallocate(h_h_12)
        deallocate(h_h_33)
        
#if ldebug
        ! 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 HELENA')
        end if
#endif
    end subroutine dealloc_hel
end module helena_vars