Class lapack_eigen
In: libsrc/eigmatrix/lapack_eigen.f90

lapack_eigen

Authors:Shin-ichi Takehiro, Youhei SASAKI
Version:$Id: lapack_eigen.f90 617 2013-09-25 17:06:05Z uwabami $
Copyright&License:See COPYRIGHT

概要

spml/lapack_eigen は eigmatrix モジュールの公開サブルーチン eigen 用の固有値計算用共通インターフェースを与える.

  * 行列 AMAT の i 番目固有値を eigen_r(i), eigen_i(i) に格納
  * 対応する固有ベクトルを eigvec_r(:,i), eigvec_i(:,i) に格納
  * 格納する固有値の数は引数 eigen_r の大きさで決まる
  * 固有値の順番は sort と order で定められる.
  * sort によって順番を定めるために用いる量を指定する.
    実部(R), 実部の絶対値(RA), 虚部(I), 虚部の絶対値(IA)
  * reverse によって小さい順(.false.), 大きい順(.true.)を指定できる.
  * デフォルトは sort='R', reverse=.false.

内部では DGEEV/LAPACK ルーチンによる実行列の固有値/固有ベクトル計算を 行っている. が, ユーザーは用いているライブラリとサブルーチンを意識 することなく使うことができる.

Methods

Included Modules

dc_message

Public Instance methods

Subroutine :
amat :real(8), dimension(:,:)
: 入力正方行列
eigen_r :real(8), intent(out), dimension(:)
: 固有値実数部
eigen_i :real(8), intent(out), dimension(:)
: 固有値虚数部
eigvec_r :real(8), intent(out), dimension(size(amat,1),size(eigen_r))
: 固有ベクトル実部
eigvec_i :real(8), intent(out), dimension(size(amat,1),size(eigen_i))
: 固有ベクトル虚部
info :integer, intent(out)
: ステータス
sort :character(len=2), intent(in), optional
: 並び変えの量
reverse :logical, intent(in), optional
: 並び変えスイッチ

このサブルーチンは固有値計算用共通インターフェースを与える eigmatrix モジュールの公開サブルーチン eigen として用いられる.

  * 行列 AMAT の i 番目固有値を eigen_r(i), eigen_i(i) に格納
  * 対応する固有ベクトルを eigvec_r(:,i), eigvec_i(:,i) に格納
  * 格納する固有値の数は引数 eigen_r の大きさで決まる

  * 固有値の順番は sort と order で定められる.
  * sort によって順番を定めるために用いる量を指定する.
    実部(R), 実部の絶対値(RA), 虚部(I), 虚部の絶対値(IA)
  * reverse によって小さい順(.false.), 大きい順(.true.)を指定できる.
  * デフォルトは sort='R', reverse=.false.

内部では DGEEV/LAPACK ルーチンによる実行列の固有値/固有ベクトル計算を 行っている. が, ユーザーは用いているライブラリとサブルーチンを意識 することなく使うことができる.

[Source]

  subroutine deigen_lapack(amat,eigen_r,eigen_i,eigvec_r,eigvec_i, info,sort,reverse )
    !
    ! このサブルーチンは固有値計算用共通インターフェースを与える
    ! eigmatrix モジュールの公開サブルーチン eigen として用いられる.
    !
    !   * 行列 AMAT の i 番目固有値を eigen_r(i), eigen_i(i) に格納
    !   * 対応する固有ベクトルを eigvec_r(:,i), eigvec_i(:,i) に格納
    !   * 格納する固有値の数は引数 eigen_r の大きさで決まる
    !
    !   * 固有値の順番は sort と order で定められる.
    !   * sort によって順番を定めるために用いる量を指定する.
    !     実部(R), 実部の絶対値(RA), 虚部(I), 虚部の絶対値(IA)
    !   * reverse によって小さい順(.false.), 大きい順(.true.)を指定できる.
    !   * デフォルトは sort='R', reverse=.false.
    !
    ! 内部では DGEEV/LAPACK ルーチンによる実行列の固有値/固有ベクトル計算を
    ! 行っている. が, ユーザーは用いているライブラリとサブルーチンを意識
    ! することなく使うことができる.
    !


   !------------ 引数 ------------
    real(8), dimension(:,:)                   :: amat      ! 入力正方行列
    real(8), intent(out), dimension(:)        :: eigen_r   ! 固有値実数部
    real(8), intent(out), dimension(:)        :: eigen_i   ! 固有値虚数部
    real(8), intent(out), dimension(size(amat,1),size(eigen_r))   :: eigvec_r  ! 固有ベクトル実部
    real(8), intent(out), dimension(size(amat,1),size(eigen_i))   :: eigvec_i  ! 固有ベクトル虚部
    integer, intent(out)                      :: info      ! ステータス
    character(len=2), intent(in), optional    :: sort      ! 並び変えの量
    logical, intent(in), optional             :: reverse   ! 並び変えスイッチ

   !------------ 作業変数 ------------
    real(8), dimension(size(amat,1))              :: wr    ! 固有値実数部
    real(8), dimension(size(amat,1))              :: wi    ! 固有値虚数部
    real(8), dimension(size(amat,1),size(amat,1)) :: vl    ! 左固有ベクトル
    real(8), dimension(size(amat,1),size(amat,1)) :: vr    ! 右固有ベクトル
    real(8), dimension(size(amat,1)*4)            :: work  ! 作業変数
    integer, dimension(size(amat,1))              :: index ! 並び変え用
    character(len=1), parameter :: jobvl='N', jobvr='V'    ! DEGGV へ渡すスイッチ

    integer :: nm, i, j

    !------- 形状チェック ------
    if (size(amat,1) /= size(amat,2))then
       call MessageNotify('E','DEIGEN_LAPACK','Input matrix not square')
    else
       nm = size(amat,1)
    endif

    !------- DGEEV/LAPACK による計算 ------
    call DGEEV( jobvl, jobvr, nm, amat, nm, wr, wi, vl, nm, vr, nm, work, nm*4, info )

    !------- サブルーチンエラー処理 -------
    if ( info /= 0 ) then
       call MessageNotify('W','DEIGEN_LAPACK', 'Error in calculating eigenvalues/vectors...',i=(/info/) )
       return
    endif

    !------- 固有ベクトル入れ換え -------
    if ( present(sort) ) then
       if ( sort == 'RA' ) then          ! 固有値実部の絶対値
          index=indexx(abs(wr))
       elseif ( trim(sort) == 'I ' ) then ! 固有値虚部
          index=indexx(wi)
       elseif ( sort == 'IA' ) then      ! 固有値虚部の絶対値
          index=indexx(abs(wi))
       else
          index=indexx(wr)               ! defaultは固有値実部
       endif
    else
       index=indexx(wr)                  ! defaultは固有値実部
    endif

    if ( present(reverse) )then
       if ( reverse ) then               ! 大きい順
          index=index(size(index):1:-1)
       endif
    endif

    do i=1,size(eigen_r)
       j = index(i)
       eigen_r(i) = wr(j)
       eigen_i(i) = wi(j)

       if ( abs(wi(j)) <= epsilon(0.0D0) ) then
          eigvec_r(:,i) = vr(:,j)
          eigvec_i(:,i) = 0.0D0

       elseif ( wi(j) > 0.0D0 ) then
          eigvec_r(:,i) = vr(:,j)
          eigvec_i(:,i) = vr(:,j+1)
       else
          eigvec_r(:,i) = vr(:,j-1)
          eigvec_i(:,i) = -vr(:,j)
       endif
    enddo

  end subroutine deigen_lapack