w90_readwrite_get_keyword_vector Subroutine

public subroutine w90_readwrite_get_keyword_vector(settings, keyword, found, length, error, comm, c_value, l_value, i_value, r_value, r2_value, c2_value)

Uses

  • proc~~w90_readwrite_get_keyword_vector~~UsesGraph proc~w90_readwrite_get_keyword_vector w90_readwrite_get_keyword_vector module~w90_error w90_error proc~w90_readwrite_get_keyword_vector->module~w90_error module~w90_comms w90_comms module~w90_error->module~w90_comms module~w90_error_base w90_error_base module~w90_error->module~w90_error_base module~w90_comms->module~w90_error_base module~w90_constants w90_constants module~w90_comms->module~w90_constants

Finds the values of the required keyword vector

Arguments

Type IntentOptional Attributes Name
type(settings_type), intent(inout) :: settings
character(len=*), intent(in) :: keyword

Keyword to examine

logical, intent(inout) :: found

Is keyword present

integer, intent(in) :: length

Length of vecotr to read

type(w90_error_type), intent(out), allocatable :: error
type(w90_comm_type), intent(in) :: comm
character(len=*), intent(inout), optional :: c_value(length)

Keyword data

logical, intent(inout), optional :: l_value(length)

Keyword data

integer, intent(inout), optional :: i_value(length)

Keyword data

real(kind=dp), intent(inout), optional :: r_value(length)

Keyword data

real(kind=dp), intent(inout), optional, allocatable :: r2_value(:,:)

Keyword data

character(len=*), intent(inout), optional, allocatable :: c2_value(:)

Keyword data


Calls

proc~~w90_readwrite_get_keyword_vector~~CallsGraph proc~w90_readwrite_get_keyword_vector w90_readwrite_get_keyword_vector proc~set_error_fatal set_error_fatal proc~w90_readwrite_get_keyword_vector->proc~set_error_fatal proc~set_error_input set_error_input proc~w90_readwrite_get_keyword_vector->proc~set_error_input proc~comms_sync_error comms_sync_error proc~set_error_fatal->proc~comms_sync_error proc~set_base_error set_base_error proc~set_error_fatal->proc~set_base_error proc~set_error_input->proc~comms_sync_error proc~set_error_input->proc~set_base_error

Called by

proc~~w90_readwrite_get_keyword_vector~~CalledByGraph proc~w90_readwrite_get_keyword_vector w90_readwrite_get_keyword_vector proc~get_module_kmesh get_module_kmesh proc~get_module_kmesh->proc~w90_readwrite_get_keyword_vector proc~w90_readwrite_clear_keywords w90_readwrite_clear_keywords proc~w90_readwrite_clear_keywords->proc~w90_readwrite_get_keyword_vector proc~w90_readwrite_get_range_vector w90_readwrite_get_range_vector proc~w90_readwrite_clear_keywords->proc~w90_readwrite_get_range_vector proc~w90_readwrite_get_range_vector->proc~w90_readwrite_get_keyword_vector proc~w90_readwrite_read_atoms w90_readwrite_read_atoms proc~w90_readwrite_read_atoms->proc~w90_readwrite_get_keyword_vector proc~w90_readwrite_read_mp_grid w90_readwrite_read_mp_grid proc~w90_readwrite_read_mp_grid->proc~w90_readwrite_get_keyword_vector proc~w90_readwrite_read_ws_data w90_readwrite_read_ws_data proc~w90_readwrite_read_ws_data->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_berry w90_wannier90_readwrite_read_berry proc~w90_wannier90_readwrite_read_berry->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_berry->proc~w90_readwrite_get_range_vector proc~w90_wannier90_readwrite_read_global_kmesh w90_wannier90_readwrite_read_global_kmesh proc~w90_wannier90_readwrite_read_global_kmesh->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_gyrotropic w90_wannier90_readwrite_read_gyrotropic proc~w90_wannier90_readwrite_read_gyrotropic->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_gyrotropic->proc~w90_readwrite_get_range_vector proc~w90_wannier90_readwrite_read_hamil w90_wannier90_readwrite_read_hamil proc~w90_wannier90_readwrite_read_hamil->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_kslice w90_wannier90_readwrite_read_kslice proc~w90_wannier90_readwrite_read_kslice->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_wann_plot w90_wannier90_readwrite_read_wann_plot proc~w90_wannier90_readwrite_read_wann_plot->proc~w90_readwrite_get_keyword_vector proc~w90_wannier90_readwrite_read_wann_plot->proc~w90_readwrite_get_range_vector proc~w90_postw90_readwrite_read w90_postw90_readwrite_read proc~w90_postw90_readwrite_read->proc~w90_readwrite_read_atoms proc~w90_postw90_readwrite_read->proc~w90_readwrite_read_mp_grid proc~w90_postw90_readwrite_read->proc~w90_readwrite_read_ws_data proc~w90_postw90_readwrite_read->proc~w90_wannier90_readwrite_read_berry proc~w90_postw90_readwrite_read->proc~w90_wannier90_readwrite_read_global_kmesh proc~w90_postw90_readwrite_read->proc~w90_wannier90_readwrite_read_gyrotropic proc~w90_postw90_readwrite_read->proc~w90_wannier90_readwrite_read_kslice proc~w90_readwrite_read_exclude_bands w90_readwrite_read_exclude_bands proc~w90_postw90_readwrite_read->proc~w90_readwrite_read_exclude_bands proc~w90_readwrite_read_kmesh_data w90_readwrite_read_kmesh_data proc~w90_postw90_readwrite_read->proc~w90_readwrite_read_kmesh_data proc~w90_wannier90_readwrite_read_dos w90_wannier90_readwrite_read_dos proc~w90_postw90_readwrite_read->proc~w90_wannier90_readwrite_read_dos proc~w90_wannier90_readwrite_read_local_kmesh w90_wannier90_readwrite_read_local_kmesh proc~w90_postw90_readwrite_read->proc~w90_wannier90_readwrite_read_local_kmesh proc~w90_postw90_readwrite_readall w90_postw90_readwrite_readall proc~w90_postw90_readwrite_readall->proc~w90_wannier90_readwrite_read_berry proc~w90_postw90_readwrite_readall->proc~w90_wannier90_readwrite_read_global_kmesh proc~w90_postw90_readwrite_readall->proc~w90_wannier90_readwrite_read_gyrotropic proc~w90_postw90_readwrite_readall->proc~w90_wannier90_readwrite_read_kslice proc~w90_postw90_readwrite_readall->proc~w90_wannier90_readwrite_read_dos proc~w90_postw90_readwrite_readall->proc~w90_wannier90_readwrite_read_local_kmesh proc~w90_readwrite_clean_infile w90_readwrite_clean_infile proc~w90_readwrite_clean_infile->proc~w90_readwrite_clear_keywords proc~w90_readwrite_read_distk w90_readwrite_read_distk proc~w90_readwrite_read_distk->proc~w90_readwrite_get_range_vector proc~w90_readwrite_read_exclude_bands->proc~w90_readwrite_get_range_vector proc~w90_readwrite_read_kmesh_data->proc~w90_readwrite_get_range_vector proc~w90_wannier90_readwrite_read w90_wannier90_readwrite_read proc~w90_wannier90_readwrite_read->proc~w90_readwrite_read_ws_data proc~w90_wannier90_readwrite_read->proc~w90_wannier90_readwrite_read_hamil proc~w90_wannier90_readwrite_read->proc~w90_wannier90_readwrite_read_wann_plot proc~w90_wannier90_readwrite_read_band_plot w90_wannier90_readwrite_read_band_plot proc~w90_wannier90_readwrite_read->proc~w90_wannier90_readwrite_read_band_plot proc~w90_wannier90_readwrite_read_band_plot->proc~w90_readwrite_get_range_vector proc~w90_wannier90_readwrite_read_dos->proc~w90_readwrite_get_range_vector proc~w90_wannier90_readwrite_read_local_kmesh->proc~get_module_kmesh proc~w90_wannier90_readwrite_read_projections w90_wannier90_readwrite_read_projections proc~w90_wannier90_readwrite_read_projections->proc~w90_readwrite_get_range_vector proc~w90_wannier90_readwrite_read_special w90_wannier90_readwrite_read_special proc~w90_wannier90_readwrite_read_special->proc~w90_readwrite_read_atoms proc~w90_wannier90_readwrite_read_special->proc~w90_readwrite_read_mp_grid proc~w90_wannier90_readwrite_read_special->proc~w90_readwrite_read_distk proc~w90_wannier90_readwrite_read_special->proc~w90_readwrite_read_exclude_bands proc~w90_wannier90_readwrite_read_special->proc~w90_readwrite_read_kmesh_data proc~w90_wannier90_readwrite_read_special->proc~w90_wannier90_readwrite_read_projections proc~input_reader_special input_reader_special proc~input_reader_special->proc~w90_readwrite_clean_infile proc~input_reader_special->proc~w90_wannier90_readwrite_read_special proc~w90_input_reader~2 w90_input_reader proc~w90_input_reader~2->proc~w90_readwrite_clean_infile proc~w90_input_reader~2->proc~w90_wannier90_readwrite_read proc~w90_input_setopt w90_input_setopt proc~w90_input_setopt->proc~w90_wannier90_readwrite_read proc~w90_input_setopt->proc~w90_wannier90_readwrite_read_special program~postw90 postw90 program~postw90->proc~w90_postw90_readwrite_read program~postw90->proc~w90_readwrite_clean_infile proc~w90_input_reader w90_input_reader proc~w90_input_reader->proc~w90_input_reader~2 proc~w90_input_setopt_f w90_input_setopt_f proc~w90_input_setopt_f->proc~w90_input_setopt program~wannier wannier program~wannier->proc~input_reader_special program~wannier->proc~w90_input_reader~2

Source Code

  subroutine w90_readwrite_get_keyword_vector(settings, keyword, found, length, error, comm, &
                                              c_value, l_value, i_value, r_value, r2_value, &
                                              c2_value)
    !================================================!
    !
    !! Finds the values of the required keyword vector
    !
    !================================================!

    use w90_error, only: w90_error_type, set_error_input, set_error_fatal

    implicit none

    type(w90_error_type), allocatable, intent(out) :: error
    type(w90_comm_type), intent(in) :: comm
    character(*), intent(in)  :: keyword
    !! Keyword to examine
    logical, intent(inout) :: found
    !! Is keyword present
    integer, intent(in)  :: length
    !! Length of vecotr to read
    character(*), optional, intent(inout) :: c_value(length)
    !! Keyword data
    logical, optional, intent(inout) :: l_value(length)
    !! Keyword data
    integer, optional, intent(inout) :: i_value(length)
    !! Keyword data
    real(kind=dp), optional, intent(inout) :: r_value(length)
    !! Keyword data
    real(kind=dp), allocatable, optional, intent(inout) :: r2_value(:, :)
    !! Keyword data
    character(len=*), allocatable, optional, intent(inout) :: c2_value(:)
    !! Keyword data
    type(settings_type), intent(inout) :: settings

    integer :: kl, in, loop, i, itmp
    character(len=maxlen) :: dummy

    kl = len_trim(keyword)

    found = .false.

    if (allocated(settings%entries) .and. allocated(settings%in_data)) then
      call set_error_fatal(error, 'Error: (library use) options interface and .win parsing clash.'// &
                           '  See library documentation "setting options." (readwrite.F90)', comm)
      return
    elseif (allocated(settings%entries)) then

      do loop = 1, settings%num_entries  ! this means the first occurance of the variable in settings is used
        ! memory beyond num_entries is not initialised
        if (settings%entries(loop)%keyword == keyword) then
          if (present(i_value)) then
            i_value = settings%entries(loop)%i1d
          else if (present(r_value)) then
            r_value = settings%entries(loop)%r1d
          else if (present(r2_value)) then
            r2_value = settings%entries(loop)%r2d
          else if (present(c2_value)) then
            c2_value = settings%entries(loop)%c2d
          else
            call set_error_fatal(error, 'Error: vector sought, but no variable provided to assign to. (readwrite.F90)', comm)
            return
          end if
          found = .true.
        end if
      end do

    else if (allocated(settings%in_data)) then

      do loop = 1, settings%num_lines
        in = index(settings%in_data(loop), trim(keyword))
        itmp = in + len(trim(keyword))
        if (settings%in_data(loop) (itmp:itmp) /= '=' &
            .and. settings%in_data(loop) (itmp:itmp) /= ':' &
            .and. settings%in_data(loop) (itmp:itmp) /= ' ') cycle
        if (in == 0 .or. in > 1) cycle
        if (found) then
          call set_error_input(error, 'Error: Found keyword '//trim(keyword)//' more than once in input file', comm)
          return
        end if
        found = .true.
        dummy = settings%in_data(loop) (kl + 1:)
        settings%in_data(loop) (1:maxlen) = ' '
        dummy = adjustl(dummy)
        if (dummy(1:1) == '=' .or. dummy(1:1) == ':') then
          dummy = dummy(2:)
          dummy = adjustl(dummy)
        end if
      end do

      if (found) then
        if (present(c_value)) read (dummy, *, err=230, end=230) (c_value(i), i=1, length)
        if (present(l_value)) then
          ! I don't think we need this. Maybe read into a dummy charater
          ! array and convert each element to logical
          call set_error_input(error, 'w90_readwrite_get_keyword_vector unimplemented for logicals', comm)
          return
        end if
        if (present(i_value)) read (dummy, *, err=230, end=230) (i_value(i), i=1, length)
        if (present(r_value)) read (dummy, *, err=230, end=230) (r_value(i), i=1, length)
      end if
    end if

    return

230 call set_error_input(error, 'Error: Problem reading keyword '//trim(keyword)//' in w90_readwrite_get_keyword_vector', comm)
    return
  end subroutine w90_readwrite_get_keyword_vector