historyaxisinquire.f90

Go to the documentation of this file.

!> @file historyaxisinquire.f90
!>
!> @author Yasuhiro MORIKAWA
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Inquire for a GT_HISTORY_AXIS variable
!> @enden
!>
!> @ja
!> @brief GT_HISTORY_AXIS 変数への問い合わせ
!> @endja
 
!>
!> @en
!> @brief Inquire a GT_HISTORY_AXIS variable
!>
!> Retrieves each piece of information from
!> a GT_HISTORY_AXIS variable.
!> @param[in]  axis     Axis information
!> @param[out] name     Dimension variable name (optional)
!> @param[out] size     Dimension length (optional)
!> @param[out] longname Descriptive name (optional)
!> @param[out] units    Units (optional)
!> @param[out] xtype    Type (optional)
!> @enden
!>
!> @ja
!> @brief GT_HISTORY_AXIS 型変数への問い合わせ
!>
!> GT_HISTORY_AXIS 型の変数内の各情報を参照します。
!> @param[in]  axis     座標軸情報
!> @param[out] name     次元変数名 (省略可能)
!> @param[out] size     次元長 (省略可能)
!> @param[out] longname 次元変数の記述的名称 (省略可能)
!> @param[out] units    次元変数の単位 (省略可能)
!> @param[out] xtype    次元変数の型 (省略可能)
!> @endja
!>
  subroutine historyaxisinquire1( axis, &
    & name, size, longname, units, xtype )
    !
    use dc_trace, only: beginsub, endsub
    use gtool_history_types, only: gt_history_axis
    implicit none
    type(gt_history_axis),intent(in) :: axis
    character(*) , intent(out), optional:: name     ! 次元変数名
    integer, intent(out), optional:: size     ! 次元長 (配列サイズ)
    character(*) , intent(out), optional:: longname ! 次元変数の記述的名称
    character(*) , intent(out), optional:: units    ! 次元変数の単位
    character(*) , intent(out), optional:: xtype    ! 次元変数の型
    character(len = *), parameter:: subname = "HistoryAxisInquire1"
  continue
    call beginsub(subname)
    if (present(name)) then
      name     = axis % name
    end if
    if (present(size)) then
      size     = axis % length
    end if
    if (present(longname)) then
      longname = axis % longname
    end if
    if (present(units)) then
      units    = axis % units
    end if
    if (present(xtype)) then
      xtype    = axis % xtype
    end if
    call endsub(subname)
  end subroutine historyaxisinquire1
 
  !-------------------------------------------------------------------
 
!> @en
  !> @brief Inquire a GT_HISTORY_AXIS variable (generic interface)
  !>
  !> Usage is same as HistoryAxisInquire.
  !> @enden
  !> @ja
  !> @brief GT_HISTORY_AXIS 型変数への問い合わせ (総称インターフェース)
  !>
  !> 使用方法は HistoryAxisInquire と同様です。
  !> @endja
  subroutine historyaxisinquire2( axis, &
    & name, size, longname, units, xtype)
    use dc_trace, only: beginsub, endsub
    use gtool_history_types, only: gt_history_axis
    use gtool_history_generic, only: historyaxisinquire
    implicit none
    type(gt_history_axis),intent(in) :: axis
    character(*) , intent(out), optional:: name     ! 次元変数名
    integer, intent(out), optional:: size     ! 次元長 (配列サイズ)
    character(*) , intent(out), optional:: longname ! 次元変数の記述的名称
    character(*) , intent(out), optional:: units    ! 次元変数の単位
    character(*) , intent(out), optional:: xtype    ! 次元変数の型
    character(len = *), parameter:: subname = "HistoryAxisInquire2"
  continue
    call beginsub(subname)
    call historyaxisinquire( axis, &
      & name, size, longname, units, xtype)
    call endsub(subname)
  end subroutine historyaxisinquire2