historyautoaddweight.f90

Go to the documentation of this file.

!--
! *** Caution!! ***
!
! This file is generated from "historyautoaddweight.rb2f90" by Ruby 3.3.8.
! Please do not edit this file directly.
!
! [JAPANESE]
!
! ※※※ 注意!!! ※※※
!
! このファイルは "historyautoaddweight.rb2f90" から Ruby 3.3.8
! によって自動生成されたファイルです.
! このファイルを直接編集しませんようお願い致します.
!
!
!++
!> @file historyautoaddweight.f90
!>
!> @author Yasuhiro MORIKAWA
!> @copyright Copyright (C) GFD Dennou Club, 2008-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Settings of weights of axes
!> @enden
!>
!> @ja
!> @brief 座標の重みデータの設定
!> @endja
 
  !> @en
  !> @brief Set weights of axes.
  !>
  !> @param[in] dim    Name of axis to which *weight* are set.
  !>                    Note that this value must be set
  !>                    as *dims* of HistoryAutoCreate.
  !> @param[in] weight Weight of axis.
  !>                    Integer, single or double precision are
  !>                    acceptable as data type.
  !>                    Note that when this is output to a file,
  !>                    data type is converted into *xtype* or
  !>                    type of the axis.
  !> @param[in] units  (optional) Units of axis weight.
  !>                    If this argument is omitted,
  !>                    unit of the dimension is used.
  !> @param[in] xtype  (optional) Data type of weight of the dimension.
  !>                    If this argument is omitted,
  !>                    data type of the dimension is used.
  !> @enden
  !>
  !> @ja
  !> @brief 座標の重みデータを設定します.
  !>
  !> @param[in] dim    座標重みを設定する座標の名称.
  !>                    ただし, ここで指定するものは,
  !>                    HistoryAutoCreate の *dims* で
  !>                    既に指定されていなければなりません.
  !> @param[in] weight 座標重みデータ.
  !>                    データ型は整数, 単精度実数型,
  !>                    倍精度実数型のどれでもかまいません.
  !>                    ただし, ファイルへ出力される際には,
  !>                    *xtype* もしくは座標データの型へと変換されます.
  !> @param[in] units  (optional) 座標重みの単位.
  !>                    省略した場合には, 座標の単位が使用されます.
  !> @param[in] xtype  (optional) 座標重みのデータ型.
  !>                    省略した場合には, 座標のデータ型が使用されます.
  !> @endja
  subroutine historyautoaddweightreal( &
    & dim, weight, &  ! (in)
    & units, xtype &  ! (in) optional
    & )
    use gtool_historyauto_internal, only: initialized, numdims, numwgts, &
      & wgtsuf, gthst_axes, data_weights, gthst_weights
    use gtool_history, only: historyaxisinquire, historyaxisaddattr, &
      &                    historyvarinfocreate
    use dc_trace, only: beginsub, endsub
    use dc_error, only: storeerror, dc_noerr, &
      & gt_eargsizemismatch, hst_enoaxisname, dc_enotinit
    use dc_types, only: string, token
 
    implicit none
    character(*), intent(in):: dim
                              ! 座標重みを設定する座標の名称.
                              !
                              ! ただし, ここで指定するもの
                              ! は, HistoryAutoCreate の *dims*
                              ! 既に指定されていなければなりません.
                              !
                              ! Name of axis to which "weight" are set.
                              !
                              ! Note that this value must be set
                              ! as "dims" of "HistoryAutoCreate".
                              !
    real, intent(in):: weight(:)
                              ! 座標重みデータ.
                              !
                              ! データ型は整数, 単精度実数型,
                              ! 倍精度実数型のどれでもかまいません.
                              ! ただし, ファイルへ出力される際には,
                              ! xtype もしくは座標データの型へと
                              ! 変換されます.
                              !
                              ! Weight of axis.
                              !
                              ! Integer, single or double precision are
                              ! acceptable as data type.
                              ! Note that when this is output to a file,
                              ! data type is converted into "xtype" or
                              ! type of the axis.
                              !
    character(*), intent(in), optional:: units
                              ! 座標重みの単位.
                              ! 省略した場合には, 座標の単位が
                              ! 使用されます.
                              !
                              ! Units of axis weight.
                              ! If this argument is omitted,
                              ! unit of the dimension is used.
                              !
    character(*), intent(in),  optional:: xtype
                              ! 座標重みのデータ型.
                              ! 省略した場合には, 座標のデータ型が
                              ! 使用されます.
                              !
                              ! Data type of weight of the dimension.
                              ! If this argument is omitted,
                              ! data type of the dimension is used.
                              !
 
    character(STRING):: name, longname
    character(TOKEN):: dim_units, dim_xtype
    integer:: dim_size
    integer:: stat, i
    character(STRING):: cause_c
    character(*), parameter:: subname = "HistoryAutoAddWeightReal"
  continue
    call beginsub(subname, 'dim=<%c>', c1=trim(dim) )
    stat = dc_noerr
    cause_c = ""
 
    ! 初期設定チェック
    ! Check initialization
    !
    if ( .not. initialized ) then
      stat = dc_enotinit
      cause_c = 'gtool_historyauto'
      goto 999
    end if
 
    do i = 1, numdims
      call historyaxisinquire( &
        & axis = gthst_axes(i), &  ! (in)
        & name = name, &           ! (out)
        & size = dim_size, &       ! (out)
        & longname = longname, &   ! (out)
        & units = dim_units, &     ! (out)
        & xtype = dim_xtype )      ! (out)
      if ( trim(dim) == trim(name) ) then
        if ( dim_size /= size(weight) ) then
          stat = gt_eargsizemismatch
          cause_c = 'weight'
        end if
        if ( present(units) ) dim_units = units
        if ( present(xtype) ) dim_xtype = xtype
        call historyvarinfocreate( &
          & varinfo = gthst_weights(numwgts + 1), &          ! (out)
          & name = trim(dim) // wgtsuf, dims = (/ dim /), &  ! (in)
          & longname = 'weight for integration or average in ' // &
          &            trim(longname), &                     ! (in)
          & units = dim_units, xtype = dim_xtype )           ! (in)
 
        call historyaxisaddattr( &
          & axis = gthst_axes(i), &        ! (inout)
          & attrname = 'gt_calc_weight', & ! (in)
          & value = trim(dim) // wgtsuf )  ! (in)
 
        allocate( data_weights(numwgts + 1) % a_axis( dim_size ) )
        data_weights(numwgts + 1) % a_axis = weight
 
        numwgts = numwgts + 1
        goto 999
      end if
    end do
 
    stat = hst_enoaxisname
    cause_c = dim
    
999 continue
    call storeerror(stat, subname, cause_c = cause_c)
    call endsub(subname)
  end subroutine historyautoaddweightreal
 
 
  !> @en
  !> @brief Set weights of axes.
  !>
  !> @param[in] dim    Name of axis to which *weight* are set.
  !>                    Note that this value must be set
  !>                    as *dims* of HistoryAutoCreate.
  !> @param[in] weight Weight of axis.
  !>                    Integer, single or double precision are
  !>                    acceptable as data type.
  !>                    Note that when this is output to a file,
  !>                    data type is converted into *xtype* or
  !>                    type of the axis.
  !> @param[in] units  (optional) Units of axis weight.
  !>                    If this argument is omitted,
  !>                    unit of the dimension is used.
  !> @param[in] xtype  (optional) Data type of weight of the dimension.
  !>                    If this argument is omitted,
  !>                    data type of the dimension is used.
  !> @enden
  !>
  !> @ja
  !> @brief 座標の重みデータを設定します.
  !>
  !> @param[in] dim    座標重みを設定する座標の名称.
  !>                    ただし, ここで指定するものは,
  !>                    HistoryAutoCreate の *dims* で
  !>                    既に指定されていなければなりません.
  !> @param[in] weight 座標重みデータ.
  !>                    データ型は整数, 単精度実数型,
  !>                    倍精度実数型のどれでもかまいません.
  !>                    ただし, ファイルへ出力される際には,
  !>                    *xtype* もしくは座標データの型へと変換されます.
  !> @param[in] units  (optional) 座標重みの単位.
  !>                    省略した場合には, 座標の単位が使用されます.
  !> @param[in] xtype  (optional) 座標重みのデータ型.
  !>                    省略した場合には, 座標のデータ型が使用されます.
  !> @endja
  subroutine historyautoaddweightdouble( &
    & dim, weight, &  ! (in)
    & units, xtype &  ! (in) optional
    & )
    use gtool_historyauto_internal, only: initialized, numdims, numwgts, &
      & wgtsuf, gthst_axes, data_weights, gthst_weights
    use gtool_history, only: historyaxisinquire, historyaxisaddattr, &
      &                    historyvarinfocreate
    use dc_trace, only: beginsub, endsub
    use dc_error, only: storeerror, dc_noerr, &
      & gt_eargsizemismatch, hst_enoaxisname, dc_enotinit
    use dc_types, only: string, token, dp
 
    implicit none
    character(*), intent(in):: dim
                              ! 座標重みを設定する座標の名称.
                              !
                              ! ただし, ここで指定するもの
                              ! は, HistoryAutoCreate の *dims*
                              ! 既に指定されていなければなりません.
                              !
                              ! Name of axis to which "weight" are set.
                              !
                              ! Note that this value must be set
                              ! as "dims" of "HistoryAutoCreate".
                              !
    real(DP), intent(in):: weight(:)
                              ! 座標重みデータ.
                              !
                              ! データ型は整数, 単精度実数型,
                              ! 倍精度実数型のどれでもかまいません.
                              ! ただし, ファイルへ出力される際には,
                              ! xtype もしくは座標データの型へと
                              ! 変換されます.
                              !
                              ! Weight of axis.
                              !
                              ! Integer, single or double precision are
                              ! acceptable as data type.
                              ! Note that when this is output to a file,
                              ! data type is converted into "xtype" or
                              ! type of the axis.
                              !
    character(*), intent(in), optional:: units
                              ! 座標重みの単位.
                              ! 省略した場合には, 座標の単位が
                              ! 使用されます.
                              !
                              ! Units of axis weight.
                              ! If this argument is omitted,
                              ! unit of the dimension is used.
                              !
    character(*), intent(in),  optional:: xtype
                              ! 座標重みのデータ型.
                              ! 省略した場合には, 座標のデータ型が
                              ! 使用されます.
                              !
                              ! Data type of weight of the dimension.
                              ! If this argument is omitted,
                              ! data type of the dimension is used.
                              !
 
    character(STRING):: name, longname
    character(TOKEN):: dim_units, dim_xtype
    integer:: dim_size
    integer:: stat, i
    character(STRING):: cause_c
    character(*), parameter:: subname = "HistoryAutoAddWeightDouble"
  continue
    call beginsub(subname, 'dim=<%c>', c1=trim(dim) )
    stat = dc_noerr
    cause_c = ""
 
    ! 初期設定チェック
    ! Check initialization
    !
    if ( .not. initialized ) then
      stat = dc_enotinit
      cause_c = 'gtool_historyauto'
      goto 999
    end if
 
    do i = 1, numdims
      call historyaxisinquire( &
        & axis = gthst_axes(i), &  ! (in)
        & name = name, &           ! (out)
        & size = dim_size, &       ! (out)
        & longname = longname, &   ! (out)
        & units = dim_units, &     ! (out)
        & xtype = dim_xtype )      ! (out)
      if ( trim(dim) == trim(name) ) then
        if ( dim_size /= size(weight) ) then
          stat = gt_eargsizemismatch
          cause_c = 'weight'
        end if
        if ( present(units) ) dim_units = units
        if ( present(xtype) ) dim_xtype = xtype
        call historyvarinfocreate( &
          & varinfo = gthst_weights(numwgts + 1), &          ! (out)
          & name = trim(dim) // wgtsuf, dims = (/ dim /), &  ! (in)
          & longname = 'weight for integration or average in ' // &
          &            trim(longname), &                     ! (in)
          & units = dim_units, xtype = dim_xtype )           ! (in)
 
        call historyaxisaddattr( &
          & axis = gthst_axes(i), &        ! (inout)
          & attrname = 'gt_calc_weight', & ! (in)
          & value = trim(dim) // wgtsuf )  ! (in)
 
        allocate( data_weights(numwgts + 1) % a_axis( dim_size ) )
        data_weights(numwgts + 1) % a_axis = weight
 
        numwgts = numwgts + 1
        goto 999
      end if
    end do
 
    stat = hst_enoaxisname
    cause_c = dim
    
999 continue
    call storeerror(stat, subname, cause_c = cause_c)
    call endsub(subname)
  end subroutine historyautoaddweightdouble
 
 
  !> @en
  !> @brief Set weights of axes.
  !>
  !> @param[in] dim    Name of axis to which *weight* are set.
  !>                    Note that this value must be set
  !>                    as *dims* of HistoryAutoCreate.
  !> @param[in] weight Weight of axis.
  !>                    Integer, single or double precision are
  !>                    acceptable as data type.
  !>                    Note that when this is output to a file,
  !>                    data type is converted into *xtype* or
  !>                    type of the axis.
  !> @param[in] units  (optional) Units of axis weight.
  !>                    If this argument is omitted,
  !>                    unit of the dimension is used.
  !> @param[in] xtype  (optional) Data type of weight of the dimension.
  !>                    If this argument is omitted,
  !>                    data type of the dimension is used.
  !> @enden
  !>
  !> @ja
  !> @brief 座標の重みデータを設定します.
  !>
  !> @param[in] dim    座標重みを設定する座標の名称.
  !>                    ただし, ここで指定するものは,
  !>                    HistoryAutoCreate の *dims* で
  !>                    既に指定されていなければなりません.
  !> @param[in] weight 座標重みデータ.
  !>                    データ型は整数, 単精度実数型,
  !>                    倍精度実数型のどれでもかまいません.
  !>                    ただし, ファイルへ出力される際には,
  !>                    *xtype* もしくは座標データの型へと変換されます.
  !> @param[in] units  (optional) 座標重みの単位.
  !>                    省略した場合には, 座標の単位が使用されます.
  !> @param[in] xtype  (optional) 座標重みのデータ型.
  !>                    省略した場合には, 座標のデータ型が使用されます.
  !> @endja
  subroutine historyautoaddweightint( &
    & dim, weight, &  ! (in)
    & units, xtype &  ! (in) optional
    & )
    use gtool_historyauto_internal, only: initialized, numdims, numwgts, &
      & wgtsuf, gthst_axes, data_weights, gthst_weights
    use gtool_history, only: historyaxisinquire, historyaxisaddattr, &
      &                    historyvarinfocreate
    use dc_trace, only: beginsub, endsub
    use dc_error, only: storeerror, dc_noerr, &
      & gt_eargsizemismatch, hst_enoaxisname, dc_enotinit
    use dc_types, only: string, token
 
    implicit none
    character(*), intent(in):: dim
                              ! 座標重みを設定する座標の名称.
                              !
                              ! ただし, ここで指定するもの
                              ! は, HistoryAutoCreate の *dims*
                              ! 既に指定されていなければなりません.
                              !
                              ! Name of axis to which "weight" are set.
                              !
                              ! Note that this value must be set
                              ! as "dims" of "HistoryAutoCreate".
                              !
    integer, intent(in):: weight(:)
                              ! 座標重みデータ.
                              !
                              ! データ型は整数, 単精度実数型,
                              ! 倍精度実数型のどれでもかまいません.
                              ! ただし, ファイルへ出力される際には,
                              ! xtype もしくは座標データの型へと
                              ! 変換されます.
                              !
                              ! Weight of axis.
                              !
                              ! Integer, single or double precision are
                              ! acceptable as data type.
                              ! Note that when this is output to a file,
                              ! data type is converted into "xtype" or
                              ! type of the axis.
                              !
    character(*), intent(in), optional:: units
                              ! 座標重みの単位.
                              ! 省略した場合には, 座標の単位が
                              ! 使用されます.
                              !
                              ! Units of axis weight.
                              ! If this argument is omitted,
                              ! unit of the dimension is used.
                              !
    character(*), intent(in),  optional:: xtype
                              ! 座標重みのデータ型.
                              ! 省略した場合には, 座標のデータ型が
                              ! 使用されます.
                              !
                              ! Data type of weight of the dimension.
                              ! If this argument is omitted,
                              ! data type of the dimension is used.
                              !
 
    character(STRING):: name, longname
    character(TOKEN):: dim_units, dim_xtype
    integer:: dim_size
    integer:: stat, i
    character(STRING):: cause_c
    character(*), parameter:: subname = "HistoryAutoAddWeightInt"
  continue
    call beginsub(subname, 'dim=<%c>', c1=trim(dim) )
    stat = dc_noerr
    cause_c = ""
 
    ! 初期設定チェック
    ! Check initialization
    !
    if ( .not. initialized ) then
      stat = dc_enotinit
      cause_c = 'gtool_historyauto'
      goto 999
    end if
 
    do i = 1, numdims
      call historyaxisinquire( &
        & axis = gthst_axes(i), &  ! (in)
        & name = name, &           ! (out)
        & size = dim_size, &       ! (out)
        & longname = longname, &   ! (out)
        & units = dim_units, &     ! (out)
        & xtype = dim_xtype )      ! (out)
      if ( trim(dim) == trim(name) ) then
        if ( dim_size /= size(weight) ) then
          stat = gt_eargsizemismatch
          cause_c = 'weight'
        end if
        if ( present(units) ) dim_units = units
        if ( present(xtype) ) dim_xtype = xtype
        call historyvarinfocreate( &
          & varinfo = gthst_weights(numwgts + 1), &          ! (out)
          & name = trim(dim) // wgtsuf, dims = (/ dim /), &  ! (in)
          & longname = 'weight for integration or average in ' // &
          &            trim(longname), &                     ! (in)
          & units = dim_units, xtype = dim_xtype )           ! (in)
 
        call historyaxisaddattr( &
          & axis = gthst_axes(i), &        ! (inout)
          & attrname = 'gt_calc_weight', & ! (in)
          & value = trim(dim) // wgtsuf )  ! (in)
 
        allocate( data_weights(numwgts + 1) % a_axis( dim_size ) )
        data_weights(numwgts + 1) % a_axis = weight
 
        numwgts = numwgts + 1
        goto 999
      end if
    end do
 
    stat = hst_enoaxisname
    cause_c = dim
    
999 continue
    call storeerror(stat, subname, cause_c = cause_c)
    call endsub(subname)
  end subroutine historyautoaddweightint
 
!--
! vi:set readonly sw=4 ts=8:
!
!Local Variables:
!mode: f90
!buffer-read-only: t
!End:
!
!++