dc_message::messagenotify Interface Reference

Private Member Functions
subroutine	messagenotifyc (level, where, message, i, r, d, L, n, c1, c2, c3, ca, rank_mpi)
subroutine	messagenotifyi (number, where, message, i, r, d, L, n, c1, c2, c3, ca, rank_mpi)

Detailed Description

Definition at line 40 of file dc_message.f90.

Member Function/Subroutine Documentation

messagenotifyc()

subroutine dc_message::messagenotify::messagenotifyc ( character(*), intent(in)  level, character(*), intent(in)  where, character(*), intent(in)  message, integer, dimension(:), intent(in), optional  i, real, dimension(:), intent(in), optional  r, real(dp), dimension(:), intent(in), optional  d, logical, dimension(:), intent(in), optional  L, integer, dimension(:), intent(in), optional  n, character(*), intent(in), optional  c1, character(*), intent(in), optional  c2, character(*), intent(in), optional  c3, character(*), dimension(:), intent(in), optional  ca, integer, intent(in), optional  rank_mpi  )

private

Definition at line 51 of file dc_message.f90.

    !
    !=== メッセージの出力およびエラーによる終了
    !
    ! メッセージを標準出力へ出力したい場合に用います。
    !
    ! 文字型変数 where にはプログラム名 (サブルーチン名) など、
    ! プログラム内のどこでメッセージを出力するのかを示すものを与えます。
    !
    ! 文字型変数 message には、出力したい文字列を与えます。
    ! オプション変数 i, r, d, L, s, n, c1, c2, c3 を付加する事も出来ます。
    ! 詳細に関しては dc_string#CPrintf を参照して下さい。
    !
    ! 文字型変数 level は出力するメッセージの種類を決める引数で、
    ! <b><tt>"W"</tt></b> (または<b><tt>"Warning"</tt></b>
    ! など <b><tt>"W"</tt></b> で始まる文字)
    ! を与える事で<b>警告</b>であることを、
    ! <b><tt>"E"</tt></b> (または<b><tt>"Error"</tt></b>
    ! など <b><tt>"E"</tt></b> で始まる文字) を与える事で
    ! <b>エラー (メッセージ出力後プログラムを終了) </b>であることを、
    ! それ以外の文字 (大抵は <b><tt>"M"</tt></b>
    ! を与えることを想定しています)
    ! を与える事で<b>通常のメッセージ</b>であることを指定します。
    ! <b><tt>"E"</tt></b>を与えた場合はメッセージ出力後、プログラムを
    ! 強制終了させます。エラーコードは dc_error#USR_ERRNO となります。
    !
    use dc_types  ,only: string, dp
    use dc_string ,only: uchar, strhead, printf, cprintf
    use dc_error  ,only: storeerror, usr_errno
    implicit none
    character(*), intent(in)          :: level ! "E", "W", "M" のどれかを与える。
    character(*), intent(in)          :: where ! プログラム名、手続き名
    character(*), intent(in)          :: message ! メッセージ
    integer     , intent(in), optional:: i(:), n(:)
    real        , intent(in), optional:: r(:)
    real(DP)    , intent(in), optional:: d(:)
    logical     , intent(in), optional:: l(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    integer     , intent(in), optional:: rank_mpi
                                        ! MPI 使用時に, ここで指定された
                                        ! ランク数のノードでのみ
                                        ! メッセージ出力を行います. 
                                        ! 負の値を与えた場合には, 
                                        ! 全てのノードで出力を行います. 
                                        ! 
                                        ! MPI を使用していない場合には
                                        ! このオプションは無視されます. 
                                        ! 
                                        ! When MPI is used, messages are 
                                        ! output in only node that has
                                        ! this runk number. 
                                        ! If negative value is given, 
                                        ! output is done on all nodes
                                        ! 
                                        ! This option is ignored 
                                        ! if MPI is not used. 
                                        ! 
    character(string)        :: msg
  continue
    if ( invalid_rank_number( rank_mpi ) ) return
    if (   strhead(  'ERROR', trim( uchar(level) )  )   ) then
      msg = cprintf(message, &
        &           i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca)
      call storeerror(usr_errno, where, cause_c=msg)
    elseif (   strhead(  'WARNING', trim( uchar(level) )  )   ) then
      msg = cprintf(message, &
        &           i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca)
      msg=' *** WARNING [' // trim(where) // '] ***  '// trim(msg)
      call printf(fmt='%c', c1=msg)
    else
      msg = cprintf(message, &
        &           i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca)
      msg=' *** MESSAGE [' // trim(where) // '] ***  ' // trim(msg)
      call printf(fmt='%c', c1=msg)
    endif
    return

messagenotifyi()

subroutine dc_message::messagenotify::messagenotifyi ( integer, intent(in)  number, character(*), intent(in)  where, character(*), intent(in), optional  message, integer, dimension(:), intent(in), optional  i, real, dimension(:), intent(in), optional  r, real(dp), dimension(:), intent(in), optional  d, logical, dimension(:), intent(in), optional  L, integer, dimension(:), intent(in), optional  n, character(*), intent(in), optional  c1, character(*), intent(in), optional  c2, character(*), intent(in), optional  c3, character(*), dimension(:), intent(in), optional  ca, integer, intent(in), optional  rank_mpi  )

private

Definition at line 130 of file dc_message.f90.

    !
    !=== メッセージの出力およびエラーによる終了
    !
    ! 基本的にもう一方の MessageNotify (または dc_message#MessageNotifyC)
    ! と同様ですが、こちらは第１引数に数値型変数
    ! number をとります。この number はエラーコードとして、
    ! そのまま dc_error#StoreError に引き渡されます。
    ! エラーコードに関しては (dc_error を参照ください)
    !
    use dc_types  ,only: dp
    use dc_string ,only: cprintf
    use dc_error  ,only: storeerror, usr_errno
    implicit none
    integer,      intent(in)          :: number    ! エラーコード (dc_error 参照)
    character(*), intent(in)          :: where
    character(*), intent(in), optional:: message
    integer     , intent(in), optional:: i(:), n(:)
    real        , intent(in), optional:: r(:)
    real(DP)    , intent(in), optional:: d(:)
    logical     , intent(in), optional:: l(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    integer     , intent(in), optional:: rank_mpi
                                        ! MPI 使用時に, ここで指定された
                                        ! ランク数のノードでのみ
                                        ! メッセージ出力を行います. 
                                        ! 負の値を与えた場合には, 
                                        ! 全てのノードで出力を行います. 
                                        ! 
                                        ! MPI を使用していない場合には
                                        ! このオプションは無視されます. 
                                        ! 
                                        ! When MPI is used, messages are 
                                        ! output in only node that has
                                        ! this runk number. 
                                        ! If negative value is given, 
                                        ! output is done on all nodes
                                        ! 
                                        ! This option is ignored 
                                        ! if MPI is not used. 
                                        ! 
  continue
    if ( invalid_rank_number( rank_mpi ) ) return
    if (.not. present(message)) then
      call storeerror(number, where)
    else
      call storeerror(number, where,  &
        &             cause_c=cprintf( message, &
        &             i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca )  )
    endif
    return

---

The documentation for this interface was generated from the following file:

• dc_utils/dc_message.f90