v3rfun_input.f

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!  The @header, @table_section, @table_subsection, @item and @end_table commands
!  are custom defined commands in Doxygen.in. They are defined under ALIASES.
!  For the page created here, the 80 column limit is exceeded. Arguments of
!  aliases are separated by ','. If you intended ',' to be a string you must use
!  an escaped comma '\,'.
!
!-------------------------------------------------------------------------------
!*******************************************************************************
!
!  Note separating the Doxygen comment block here so detailed decription is
!  found in the Module not the file.
!
!*******************************************************************************
      MODULE v3rfun_input
      USE stel_kinds
      USE vsvd0, ONLY: nigroup
      USE profiler
 
      IMPLICIT NONE
 
!*******************************************************************************
!  v3rfun input module parameters
!*******************************************************************************
      INTEGER, PARAMETER :: v3rfun_file_length = 120
      INTEGER, PARAMETER :: v3rfun_name_length = 25
 
!*******************************************************************************
!  DERIVED-TYPE DECLARATIONS
!  1) v3rfun_namelist_class
!
!*******************************************************************************
      CHARACTER (len=v3rfun_file_length) :: name_coils_dot = ''
      CHARACTER (len=v3rfun_file_length) :: name_diagnostic_dot = ''
 
      CHARACTER (len=v3rfun_name_length) :: idrfun = ''
 
      LOGICAL :: lstell_sym = .false.
      LOGICAL :: l_read_coils_dot = .true.
      LOGICAL :: use_con_shell = .false.
 
      INTEGER :: ir = 101
      INTEGER :: jz = 101
      INTEGER :: kp = 1
      INTEGER :: kp_shell = 1
      INTEGER :: n_field_periods_nli = 0
 
      REAL (rprec) :: rmin = 0.0
      REAL (rprec) :: rmax = 0.0
      REAL (rprec) :: zmin = 0.0
      REAL (rprec) :: zmax = 0.0
 
      REAL (rprec) :: major_radius = 0.0
      REAL (rprec) :: minor_radius = 0.0
 
      REAL (rprec) :: len_integrate_ddc = 0.001
 
      LOGICAL, DIMENSION(nigroup) :: is_super_con = .false.
 
      REAL (rprec), DIMENSION(nigroup,3) :: cg_shift_1 = 0.0
      REAL (rprec), DIMENSION(nigroup,3) :: cg_shift_2 = 0.0
      REAL (rprec), DIMENSION(nigroup,3) :: cg_rot_xcent = 0.0
      REAL (rprec), DIMENSION(nigroup)   :: cg_rot_theta = 0.0
      REAL (rprec), DIMENSION(nigroup)   :: cg_rot_phi = 0.0
      REAL (rprec), DIMENSION(nigroup)   :: cg_rot_angle = 0.0
      LOGICAL, DIMENSION(nigroup)        :: l_rot_coil_center = .true.
 
!  Declare Namelist
      NAMELIST/v3r_coils/                                                      &
!  Files
     &   name_coils_dot, name_diagnostic_dot, idrfun,                          &
!  Control parameters
     &   lstell_sym, l_read_coils_dot, use_con_shell,                          &
!  Super conductors
     &   is_super_con,                                                         &
!  Grid sizes
     &   rmin, rmax, zmin, zmax, major_radius, minor_radius,                   &
     &   ir, jz, kp, kp_shell, n_field_periods_nli, len_integrate_ddc,         &
!  Coil tilt and shift
     &   cg_shift_1, cg_shift_2, cg_rot_xcent, cg_rot_theta, cg_rot_phi,       &
     &   cg_rot_angle, l_rot_coil_center
 
      CONTAINS
 
!*******************************************************************************
!  UTILITY SUBROUTINES
!*******************************************************************************
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE v3rfun_input_read_namelist(namelist_file)
      USE safe_open_mod
      USE v3_utilities
 
      IMPLICIT NONE
 
!  Declare Arguments
      CHARACTER (len=*), INTENT(in) :: namelist_file
 
!  local variables
      INTEGER                       :: iou_mnli
      INTEGER                       :: status
      REAL (rprec)                  :: start_time
 
!  Start of executable code
      start_time = profiler_get_start_time()
 
!  Initalize a default value of the I\O unit. V3FIT increments from there.
      iou_mnli = 0
      CALL safe_open(iou_mnli, status, trim(namelist_file),                    &
     &               'old', 'formatted')
      CALL assert_eq(0, status, 'v3rfun_input_read_namelist' //                &
     &   ': Safe_open of ' // trim(namelist_file) // ' failed')
 
!  Read the namelist input file.
      READ (iou_mnli,nml=v3r_coils)
      CLOSE (iou_mnli,iostat=status)
      CALL assert_eq(0, status, 'v3rfun_input_read_namelist' //                &
     &   ': Error closing ' // trim(namelist_file) // ' failed')
 
      IF (l_read_coils_dot .and. name_coils_dot .eq. '') THEN
         WRITE(*,*) 'l_read_coils_dot is TRUE, but'
         WRITE(*,*) 'name_coils_dot = blank. '
         WRITE(*,*) 'Setting l_read_coils_dot to FALSE'
         l_read_coils_dot = .false.
      END IF
 
      WRITE (*,*) ' *** V3RFUN namelist input read from ' //                   &
     &            trim(namelist_file)
 
      CALL profiler_set_stop_time('v3rfun_input_read_namelist',                &
     &                            start_time)
 
      END SUBROUTINE
 
      END MODULE