siesta_namelist.f90

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 siesta_namelist
      USE shared_data, ONLY: ngmres_type, iortho, lcolscale, lasym,            &
                             hesspass_test, mupar_test, lrecon
      USE hessian, ONLY: levmarq_param, mupar
      USE stel_kinds
 
      IMPLICIT NONE
 
!*******************************************************************************
!  siesta_namelist input module parameters
!*******************************************************************************
      INTEGER, PARAMETER ::  siesta_namelist_name_length = 256
 
!*******************************************************************************
!  DERIVED-TYPE DECLARATIONS
!  1) siesta_namelist_class
!
!*******************************************************************************
!  Control Flags
      LOGICAL :: ladd_pert = .true.
      LOGICAL :: lresistive = .true.
      LOGICAL :: lrestart = .false.
      LOGICAL :: l_tracing = .false.
      LOGICAL :: l_silo_output = .false.
      LOGICAL :: l_silo3d = .false.
      LOGICAL :: l_output_alliter = .false.
      LOGICAL :: l_vmec_uniform
      LOGICAL :: l_vessel = .false.
 
!  Algrothim Control Variables}
      INTEGER  :: niter = 10
      REAL(dp) :: ftol = 1.e-20_dp
      REAL(dp) :: eta_factor = 1.e-2_dp
      INTEGER  :: nprecon = 0
 
!  Island parameters
      INTEGER, DIMENSION(20)  :: mres = 0
      REAL(dp), DIMENSION(20) :: helpert = 0.0
      REAL(dp), DIMENSION(20) :: helperta = 0.0
 
!  Grid Sizes
      INTEGER :: nsin = 101
      INTEGER :: nsin_ext = 0
      INTEGER :: mpolin = 12
      INTEGER :: ntorin = 3
      INTEGER :: nfpin = 0
 
!  Output Grid Sizes
      INTEGER :: nphis = 2
      INTEGER :: nrs = 200
      INTEGER :: nzs = 200
      INTEGER :: nvs = 150
      INTEGER :: nus = 150
      INTEGER :: nss = 100
 
!  File Names
      CHARACTER(LEN=siesta_namelist_name_length) :: wout_file = ''
      CHARACTER(LEN=siesta_namelist_name_length) :: restart_ext = ''
      CHARACTER(LEN=siesta_namelist_name_length) :: mgrid_file = ''
      CHARACTER(LEN=siesta_namelist_name_length) :: vessel_file = ''
 
!  Declare Namelist
      NAMELIST/siesta_info/                                             &
!  Control flags
        ladd_pert, lresistive, lrestart, l_tracing, lcolscale,          &
        l_silo_output, l_silo_output, l_silo3d, l_output_alliter,       &
        l_vmec_uniform, lasym, lrecon, l_vessel,                        &
!  Algrothim Control Variables
        niter, ftol, mupar, levmarq_param, eta_factor, nprecon,         &
        ngmres_type, iortho,                                            &
!  Island parameters Island Parameters
        mres, helpert, helperta,                                        &
!  Input grid sizes
        nsin, nsin_ext, mpolin, ntorin, nfpin,                          &
!  Output grid sizes
        nphis, nrs, nzs, nvs, nus, nss,                                 &
!  File names
        wout_file, restart_ext, mgrid_file, vessel_file,                &
!  Test controls
        hesspass_test, mupar_test
 
      CONTAINS
 
!*******************************************************************************
!  UTILITY SUBROUTINES
!*******************************************************************************
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE siesta_namelist_read(namelist_file)
      USE safe_open_mod
      USE v3_utilities
      USE hessian, ONLY: levmarq_param, mupar, levmarq_param0, mupar0
 
      IMPLICIT NONE
 
!  Declare Arguments
      CHARACTER (len=*), INTENT(in) :: namelist_file
 
!  local variables
      INTEGER                       :: iou_mnli
      INTEGER                       :: status
 
!  Start of executable code
      levmarq_param = 1.e-3_dp
      mupar         = 0
      niter         = 10
      mres          = 0
      helpert       = 0
      helperta      = 0
      lcolscale     = .true.
      mupar_test    = 0
 
!  Initalize a default value of the I\O unit. SIESTA increments from there.
      iou_mnli = 0
      CALL safe_open(iou_mnli, status, trim(namelist_file),             &
                    'old', 'formatted')
      CALL assert_eq(0, status, 'siesta_namelist_read' //               &
        ': Safe_open of ' // trim(namelist_file) // ' failed')
 
!  Read the namelist input file.
      READ (iou_mnli, nml=siesta_info)
      CLOSE (iou_mnli, iostat=status)
      CALL assert_eq(0, status, 'siesta_namelist_read' //               &
        ': Error closing ' // trim(namelist_file) // ' failed')
 
      levmarq_param0 = levmarq_param
      mupar0         = mupar
 
      END SUBROUTINE
 
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
      SUBROUTINE siesta_namelist_write(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
 
!  Start of executable code
 
!  Initalize a default value of the I\O unit. SIESTA increments from there.
      iou_mnli = 0
      CALL safe_open(iou_mnli, status, trim(namelist_file),                    &
     &               'replace', 'formatted', delim_in='quote')
      CALL assert_eq(0, status, 'siesta_namelist_write' //                     &
     &   ': Safe_open of ' // trim(namelist_file) // ' failed')
 
!  Write the namelist input file.
      WRITE (iou_mnli, nml=siesta_info)
      CLOSE (iou_mnli, iostat=status)
      CALL assert_eq(0, status, 'siesta_namelist_read' //                      &
     &   ': Error closing ' // trim(namelist_file) // ' failed')
 
      END SUBROUTINE
 
      END MODULE