vacuum_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 vacuum_input
      USE stel_kinds
      USE data_parameters
      USE profiler
 
      IMPLICIT NONE
 
!*******************************************************************************
!  v3fit input module parameters
!*******************************************************************************
      INTEGER, PARAMETER :: vacuum_max_currents = 1000
 
!*******************************************************************************
!  DERIVED-TYPE DECLARATIONS
!  1) vacuum_namelist_class
!
!*******************************************************************************
      CHARACTER (len=path_length) :: coils_dot_file = ''
 
      INTEGER                                      :: n_extcur = 0
      REAL (rprec), DIMENSION(vacuum_max_currents) :: extcur = 0.0
 
!  Variables for shifts and rotations of coil_groups of coils_dot file 
      REAL (rprec), DIMENSION(vacuum_max_currents,3) ::                        &
     &   cg_shift_1 = 0.0
 
      REAL (rprec), DIMENSION(vacuum_max_currents)   ::                        &
     &   cg_rot_theta = 0.0
 
      REAL (rprec), DIMENSION(vacuum_max_currents)   ::                        &
     &   cg_rot_phi = 0.0
 
      REAL (rprec), DIMENSION(vacuum_max_currents)   ::                        &
     &   cg_rot_angle = 0.0
 
      REAL (rprec), DIMENSION(vacuum_max_currents,3) ::                        &
     &   cg_rot_xcent = 0.0
 
      LOGICAL, DIMENSION(vacuum_max_currents)        ::                        &
     &   l_rot_coil_center = .false.
 
      REAL (rprec), DIMENSION(vacuum_max_currents,3) ::                        &
     &   cg_shift_2 = 0.0
 
!  Declare Namelist
      NAMELIST/vacuum_main_nli/                                                &
     &   coils_dot_file,                                                       &
!  External currents
     &   n_extcur, extcur,                                                     &
!  Variables for shifts and rotations of coil_groups of coils_dot file
     &   cg_shift_1, cg_rot_theta, cg_rot_phi, cg_rot_angle,                   &
     &   cg_rot_xcent, l_rot_coil_center, cg_shift_2
 
      CONTAINS
 
!*******************************************************************************
!  UTILITY SUBROUTINES
!*******************************************************************************
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE vacuum_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_vacnli, status
      REAL (rprec)                  :: start_time
 
!  Start of executable code
      start_time = profiler_get_start_time()
 
      iou_vacnli = 0
      status = 0
 
      CALL safe_open(iou_vacnli, status, trim(namelist_file),                  &
     &               'old', 'formatted')
      CALL assert_eq(0, status, 'vacuum_input_read_namelist' //                &
     &   ': Safe_open of ' // trim(namelist_file) // ' failed')
 
!  Read the namelist input file.
      READ (iou_vacnli, nml=vacuum_main_nli)
      CLOSE (iou_vacnli, iostat=status)
      CALL assert_eq(0, status, 'vacuum_input_read_namelist' //                &
     &   ': Error closing ' // trim(namelist_file) // ' failed')
 
      CALL profiler_set_stop_time('vacuum_input_read_namelist',                &
     &                            start_time)
 
      END SUBROUTINE
 
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE vacuum_input_write_namelist(namelist_file)
      USE safe_open_mod
      USE v3_utilities
 
      IMPLICIT NONE
 
!  Declare Arguments
      CHARACTER (len=*), INTENT(in) :: namelist_file
 
!  local variables
      INTEGER                       :: iou_vacnli, status
      REAL (rprec)                  :: start_time
 
!  Start of executable code
      start_time = profiler_get_start_time()
 
      iou_vacnli = 0
      status = 0
 
      CALL safe_open(iou_vacnli, status, trim(namelist_file),                  &
     &               'old', 'formatted')
      CALL assert_eq(0, status, 'vacuum_input_write_namelist' //               &
     &   ': Safe_open of ' // trim(namelist_file) // ' failed')
 
!  Read the namelist input file.
      WRITE (iou_vacnli, nml=vacuum_main_nli)
      CLOSE (iou_vacnli, iostat=status)
      CALL assert_eq(0, status, 'vacuum_input_write_namelist' //               &
     &   ': Error closing ' // trim(namelist_file) // ' failed')
 
      CALL profiler_set_stop_time('vacuum_input_write_namelist',               &
     &                            start_time)
 
      END SUBROUTINE
 
      END MODULE