ae_module Module Reference

1 次元周期境界: 実フーリエ変換 More...

Functions/Subroutines
subroutine, public	ae_initial (i, k, xmin, xmax)
	スペクトル変換の格子点数, 波数, 領域の大きさを設定する. More...
real(dp) function, dimension(size(ae, 1), 0:im-1), public	ag_ae (ae)
	スペクトルデータから格子点データへ逆変換する(2 次元データ用) More...
real(dp) function, dimension(0:im-1), public	g_e (e)
	スペクトルデータから格子点データへ逆変換する(1 次元データ用) More...
real(dp) function, dimension(size(ag, 1),-km:km), public	ae_ag (ag)
	格子点データからスペクトルデータへ正変換する(2 次元データ用) More...
real(dp) function, dimension(-km:km), public	e_g (g)
	格子点データからスペクトルデータへ正変換する(1 次元データ用) More...
real(dp) function, dimension(size(ae, 1),-km:km), public	ae_dx_ae (ae)
	入力スペクトルデータに X 微分を作用する(2 次元データ). More...
real(dp) function, dimension(-km:km), public	e_dx_e (e)
	入力スペクトルデータに X 微分を作用する(1 次元データ). More...
real(dp) function, dimension(size(ag, 1)), public	a_int_ag (ag)
	1 次元格子点データが並んだ 2 次元配列の積分 More...
real(dp) function, public	int_g (g)
	1 次元格子点データの積分 More...
real(dp) function, dimension(size(ag, 1)), public	a_avr_ag (ag)
	1 次元格子点データが並んだ 2 次元配列の平均 More...
real(dp) function, public	avr_g (g)
	1 次元格子点データの平均 More...
real(dp) function, public	interpolate_e (e_data, xval)
	補間計算(1次元) More...
real(dp) function, dimension(size(ae_data, 1)), public	a_interpolate_ae (ae_data, xval)
	補間計算(2次元) More...

Variables
real(dp), dimension(:), allocatable, save, public	g_x
	格子点座標(X)を格納した1次元配列. More...
real(dp), dimension(:), allocatable, save, public	g_x_weight
	重み座標を格納した 1 次元配列. X方向の格子点の間隔が格納してある. More...

Detailed Description

1 次元周期境界: 実フーリエ変換

Author

Shin-ichi Takehiro, Youhei SASAKI

Copyright

Copyright (C) SPMODEL Development Group, 2019. License is MIT/X11. see COPYRIGHT in detail

1 次元周期境界条件の下での流体運動を 実フーリエ変換によるスペクトル法で数値計算するための Fortran90 関数を提供する. 2 次元データの 1 次元に関して同時にスペクトル計算を実行するための 関数も提供しており, 2, 3 次元領域での計算のベースも提供する.

このモジュールは内部で ISPACK3/FXPACK のサブルーチンを呼んでいる. スペクトルデータの格納方法については ISPACK3/FXPACK と異なっているので以下のコメントに注意されたい.

命名法

• 関数名の先頭 (e_, g_, ae_, ag_) は, 返す値の形を示している.
  • e_ :: スペクトルデータ,
  • g_ :: 1 次元格子点データ,
  • ae_ :: 1 次元スペクトルデータが複数並んだ 2 次元データ,
  • ag_ :: 1 次元格子点データが複数並んだ 2 次元データ.
• 関数名の間の文字列(Dx)は, その関数の作用を表している.
• 関数名の最後 (_e, _ae, _g, _ag) は, 入力変数の形スペクトルデータおよび格子点データであることを示している.
  • _e :: スペクトルデータ
  • _g :: 1 次元格子点データ
  • _ae :: 1 次元スペクトルデータが複数並んだ 2 次元データ
  • _ag :: 1 次元格子点データが複数並んだ 2 次元データ

各データの種類の説明

• 以下 DP = kind(1.0D) である
• g : 1 次元格子点データ.
  • 変数の種類と次元は real(DP), dimension(0:im-1).
  • im は X 座標の格子点数であり, サブルーチン ae_initial() にて あらかじめ設定しておく.
• e : スペクトルデータ.
  • 変数の種類と次元は real(DP), dimension(-km:km).
  • km は X 方向の最大波数であり, サブルーチン ae_initial() にて あらかじめ設定しておく.
  • スペクトルデータの格納のされ方は 0:km までが \(\cos(kx)\) の係数, -km:-1 が \(sin(kx)\) の係数となっている.
• ag : 1 次元(X)格子点データの並んだ 2 次元データ.
  • 変数の種類と次元は real(DP), dimension(:,0:im-1). 第 2 次元が X 方向を表す.
• ae : 1 次元スペクトルデータの並んだ 2 次元データ.
  • 変数の種類と次元は real(DP), dimension(:,-km:km). 第 2 次元がスペクトルを表す.
• g_ で始まる関数が返す値は 1 次元格子点データに同じ.
• e_ で始まる関数が返す値はスペクトルデータに同じ.
• ag_ で始まる関数が返す値は 1 次元格子点データの並んだ 2 次元データに同じ.
• ae_ で始まる関数が返す値は 1 次元スペクトルデータの並んだ 2 次元データに同じ.
• スペクトルデータに対する微分等の作用とは, 対応する格子点データに 微分などを作用させたデータをスペクトル変換したもののことである.

Function/Subroutine Documentation

a_avr_ag()

real(dp) function, dimension(size(ag,1)), public ae_module::a_avr_ag

(

real(dp), dimension(:,0:), intent(in)

ag

)

1 次元格子点データが並んだ 2 次元配列の平均

Parameters

[in]

ag

格子点データ

Returns

平均結果

Definition at line 388 of file ae_module.f90.

References a_int_ag(), and g_x_weight.

    real(DP), dimension(:,0:), intent(in)     :: ag
    real(DP), dimension(size(ag,1))           :: a_avr_ag

    a_avr_ag = a_int_ag(ag)/sum(g_x_weight)

Here is the call graph for this function:

a_int_ag()

real(dp) function, dimension(size(ag,1)), public ae_module::a_int_ag

(

real(dp), dimension(:,0:), intent(in)

ag

)

1 次元格子点データが並んだ 2 次元配列の積分

Parameters

[in]

ag

格子点データ

Returns

積分結果

Definition at line 352 of file ae_module.f90.

References g_x_weight.

    real(DP), dimension(:,0:), intent(in)     :: ag
    real(DP), dimension(size(ag,1))           :: a_int_ag

    integer(8) :: i

    if ( size(ag,2) < im ) then
       call messagenotify('E','ae_Int_ag', &
            'The Grid points of input data too small.')
    elseif ( size(ag,2) > im ) then
       call messagenotify('W','ae_Int_ag', &
            'The Grid points of input data too large.')
    endif

    a_int_ag = 0.0d0
    do i=0,im-1
       a_int_ag(:) = a_int_ag(:) + ag(:,i)*g_x_weight(i)
    enddo

a_interpolate_ae()

real(dp) function, dimension(size(ae_data,1)), public ae_module::a_interpolate_ae	(	real(dp), dimension(:,-km:), intent(in)	ae_data,
		real(dp), intent(in)	xval
	)

補間計算(2次元)

Parameters

[in]	ae_data	入力スペクトルデータ
[in]	xval	補間する点の座標

Returns

補間した結果の値

Definition at line 433 of file ae_module.f90.

    real(DP), dimension(:,-km:), intent(IN)   :: ae_data
    real(DP), intent(in)                      :: xval
    real(DP), dimension(size(ae_data,1))      :: a_interpolate_ae

    integer(8) :: k

    a_interpolate_ae = ae_data(:,0)

    do k=1,km
       a_interpolate_ae = a_interpolate_ae                          &
            &  + 2.0d0 * (   ae_data(:,k)  * cos(2*pi*k/xl*xval)    &
            &              - ae_data(:,-k) * sin(2*pi*k/xl*xval) )
    end do

ae_ag()

real(dp) function, dimension(size(ag,1),-km:km), public ae_module::ae_ag

(

real(dp), dimension(:,:), intent(in)

ag

)

格子点データからスペクトルデータへ正変換する(2 次元データ用)

スペクトル正変換の定義は以下のとおり:

• 格子点データ \(g_j \, (j=-0,...,im-1)\)
• スペクトルデータ \(e_k \, (k=-km,...,km)\)

  \begin{align*} e_0 & = (1/im)\sum_{j=0}^{im-1} g_j \\ e_k & = (1/im)\sum_{j=0}^{im-1} g_j \cos(2\pi jk/im) \quad (k=1,2,...,km) \\ e_{-k} & = - (1/im)\sum_{j=0}^{im-1} g_j \sin(2\pi jk/im) \quad (k=1,2,...,km) \end{align*}

Parameters

[in]

ag

格子点データ

Returns

スペクトルデータ

Definition at line 245 of file ae_module.f90.

    real(DP), dimension(:,:), intent(in)   :: ag
    real(DP), dimension(size(ag,1),-km:km) :: ae_ag

    real(DP), dimension(size(ag,1),0:im-1) :: ag_work
    integer(8) :: nm, k

    nm = size(ag,1)
    if ( size(ag,2) < im ) then
       call messagenotify('E','ae_ag', &
            'The Grid points of input data too small.')
    elseif ( size(ag,2) > im ) then
       call messagenotify('W','ae_ag', &
            'The Grid points of input data too large.')
    endif
    ag_work = ag

    call fxrtfa(nm,im,ag_work,it,t)

    do k=1,min(km,im/2-1)
       ae_ag(:, k) = ag_work(:,2*k)
       ae_ag(:,-k) = ag_work(:,2*k+1)
    enddo
    ae_ag(:,0) = ag_work(:,0)
    if ( km == im/2 ) then
      ae_ag(:,km) = ag_work(:,1)
    end if

ae_dx_ae()

real(dp) function, dimension(size(ae,1),-km:km), public ae_module::ae_dx_ae

(

real(dp), dimension(:,-km:), intent(in)

ae

)

入力スペクトルデータに X 微分を作用する(2 次元データ).

スペクトルデータの X 微分とは, 対応する格子点データに X 微分を 作用させたデータのスペクトル変換のことである.

Parameters

[in]

ae

入力スペクトルデータ

Returns

入力スペクトルデータの X 微分

Definition at line 310 of file ae_module.f90.

    real(DP), dimension(:,-km:), intent(in)  :: ae
    real(DP), dimension(size(ae,1),-km:km)   :: ae_dx_ae

    integer(8) ::  k

    if ( size(ae,2) < 2*km+1 ) then
       call messagenotify('W','ae_Dx_ae', &
            'The Fourier dimension of input data too small.')
    elseif ( size(ae,2) > 2*km+1 ) then
       call messagenotify('W','ae_Dx_ae', &
            'The Fourier dimension of input data too large.')
    endif

    do k=-km,km
       ae_dx_ae(:,k) = -(2*pi*k/xl)*ae(:,-k)
    enddo

ae_initial()

subroutine, public ae_module::ae_initial	(	integer, intent(in)	i,
		integer, intent(in)	k,
		real(dp), intent(in)	xmin,
		real(dp), intent(in)	xmax
	)

スペクトル変換の格子点数, 波数, 領域の大きさを設定する.

他の関数や変数を呼ぶ前に, 最初にこのサブルーチンを呼んで 初期設定をしなければならない.

Parameters

[in]	i	格子点の数
[in]	k	切断波数
[in]	xmin	X座標下端
[in]	xmax	X座標上端

Definition at line 122 of file ae_module.f90.

References g_x, and g_x_weight.

    integer, intent(in) :: i
    integer, intent(in) :: k
    real(DP),intent(in) :: xmin
    real(DP),intent(in) :: xmax
    integer(8)          :: ii

    im = i
    km = k
    xl = xmax - xmin

    if ( im <= 0 .or. km <= 0 ) then
       call messagenotify('E','ae_Initial', &
            'Number of grid points and waves should be positive')
    elseif ( mod(im,2_8) /= 0 ) then
       call messagenotify('E','ae_Initial', &
            'Number of grid points should be even')
    elseif ( km > im/2 ) then
       call messagenotify('E','ae_Initial', &
            'KM shoud be less equal to IM/2')
    endif

    allocate(it(im/2),t(im*3/2))

    call fxrini(im,it,t)

    allocate(g_x(0:im-1))
    do ii=0,im-1
       g_x(ii) = xmin + (xl/im)*ii
    enddo

    allocate(g_x_weight(0:im-1))
    g_x_weight = xl/im

    call messagenotify(&
         'M','ae_initial','ae_module (2019/09/17) is initialized')

ag_ae()

real(dp) function, dimension(size(ae,1),0:im-1), public ae_module::ag_ae

(

real(dp), dimension(:,-km:), intent(in)

ae

)

スペクトルデータから格子点データへ逆変換する(2 次元データ用)

スペクトル逆変換の定義は以下のとおり:

• スペクトルデータ: \(e_k \, (k=-km,...,km)\)
• 格子点データ: \(g_j \, (j=-0,...,im-1)\)

  \begin{align*} g_j = e_0 + 2\sum_{k=1}^{km}e_k\cos(2\pi jk/im) - e_{-k}\sin(2\pi jk/im)) \quad (j=0,1,...,im-1). \end{align*}

Parameters

[in]

ae

スペクトルデータ

Returns

格子点データ

Definition at line 176 of file ae_module.f90.

    real(DP), dimension(:,-km:), intent(in)  :: ae
    real(DP), dimension(size(ae,1),0:im-1)   :: ag_ae

    integer(8) :: nm, k
    nm=size(ae,1)

    if ( size(ae,2) < 2*km+1 ) then
       call messagenotify('E','ag_ae', &
            'The Fourier dimension of input data too small.')
    elseif ( size(ae,2) > 2*km+1 ) then
       call messagenotify('W','ag_ae', &
            'The Fourier dimension of input data too large.')
    endif

    ag_ae       = 0.0d0
    ag_ae(:,0)  = ae(:,0)
    do k=1,min(km,im/2-1)
       ag_ae(:,2*k)   = ae(:,k)
       ag_ae(:,2*k+1) = ae(:,-k)
    enddo
    if ( km == im/2 ) then
      ag_ae(:,1) = ae(:,km)
    end if

    call fxrtba(nm,im,ag_ae,it,t)

avr_g()

real(dp) function, public ae_module::avr_g

(

real(dp), dimension(0:im-1), intent(in)

g

)

1 次元格子点データの平均

Parameters

[in]

g

格子点データ

Returns

平均値

Definition at line 400 of file ae_module.f90.

References g_x_weight, and int_g().

    real(DP), dimension(0:im-1), intent(in)   :: g
    real(DP)                                  :: avr_g

    avr_g = int_g(g)/sum(g_x_weight)

Here is the call graph for this function:

e_dx_e()

real(dp) function, dimension(-km:km), public ae_module::e_dx_e

(

real(dp), dimension(-km:km), intent(in)

e

)

入力スペクトルデータに X 微分を作用する(1 次元データ).

スペクトルデータの X 微分とは, 対応する格子点データに X 微分を 作用させたデータのスペクトル変換のことである.

Parameters

[in]

e

入力スペクトルデータ

Returns

入力スペクトルデータの X 微分

Definition at line 336 of file ae_module.f90.

References ae_dx_ae().

    real(DP), dimension(-km:km), intent(in)     :: e
    real(DP), dimension(-km:km)                 :: e_dx_e

    real(DP), dimension(1,-km:km)               :: ae_work

    ae_work(1,:) = e
    ae_work = ae_dx_ae(ae_work)
    e_dx_e = ae_work(1,:)

Here is the call graph for this function:

e_g()

real(dp) function, dimension(-km:km), public ae_module::e_g

(

real(dp), dimension(0:im-1), intent(in)

g

)

格子点データからスペクトルデータへ正変換する(1 次元データ用)

スペクトル正変換の定義は以下のとおり:

• 格子点データ: \(g_j \, (j=-0,...,im-1)\)
• スペクトルデータ: \(e_k \, (k=-km,...,km)\)

  \begin{align*} e_0 & = (1/im)\sum_{j=0}^{im-1} g_j \\ e_k & = (1/im)\sum_{j=0}^{im-1} g_j \cos(2\pi jk/im) \quad (k=1,2,...,km) \\ e_{-k} & = - (1/im)\sum_{j=0}^{im-1} g_j \sin(2\pi jk/im) \quad (k=1,2,...,km) \end{align*}

Parameters

[in]

g

格子点データ

Returns

スペクトルデータ

Definition at line 290 of file ae_module.f90.

References ae_ag().

    real(DP), dimension(0:im-1), intent(in)  :: g
    real(DP), dimension(-km:km)              :: e_g

    real(DP), dimension(1,size(g))        :: ag_work
    real(DP), dimension(1,-km:km)         :: ae_work

    ag_work(1,:) = g
    ae_work = ae_ag(ag_work)
    e_g = ae_work(1,:)

Here is the call graph for this function:

g_e()

real(dp) function, dimension(0:im-1), public ae_module::g_e

(

real(dp), dimension(-km:km), intent(in)

e

)

スペクトルデータから格子点データへ逆変換する(1 次元データ用)

• スペクトルデータ: \(e_k \, (k=-km,...,km)\)
• 格子点データ: \(g_j \, (j=-0,...,im-1)\)

  \begin{align*} g_j = e_0 + 2\sum_{k=1}^{km}(e_k\cos(2\pi jk/im) - e_{-k}\sin(2\pi jk/im)) \quad (j=0,1,...,im-1). \end{align*}

Parameters

[in]

e

スペクトルデータ

Returns

格子点データ

Definition at line 217 of file ae_module.f90.

References ag_ae().

    real(DP), dimension(-km:km), intent(in) :: e
    real(DP), dimension(0:im-1)             :: g_e

    real(DP), dimension(1,size(e))  :: ae_work
    real(DP), dimension(1,0:im-1)   :: ag_work

    ae_work(1,:) = e
    ag_work = ag_ae(ae_work)
    g_e = ag_work(1,:)

Here is the call graph for this function:

int_g()

real(dp) function, public ae_module::int_g

(

real(dp), dimension(0:im-1), intent(in)

g

)

1 次元格子点データの積分

Parameters

[in]

g

格子点データ

Returns

積分結果

Definition at line 376 of file ae_module.f90.

References g_x_weight.

    real(DP), dimension(0:im-1), intent(in)   :: g
    real(DP)                                  :: int_g

    int_g = sum(g*g_x_weight)

interpolate_e()

real(dp) function, public ae_module::interpolate_e	(	real(dp), dimension(-km:km), intent(in)	e_data,
		real(dp), intent(in)	xval
	)

補間計算(1次元)

Parameters

[in]	e_data	入力スペクトルデータ
[in]	xval	補間する点の座標

Returns

補間した結果の値

Definition at line 412 of file ae_module.f90.

    real(DP), dimension(-km:km), intent(IN) :: e_data
    real(DP), intent(in)                    :: xval
    real(DP)                                :: interpolate_e

    integer(8) :: k

    interpolate_e = e_data(0)
    do k=1,km
       interpolate_e = interpolate_e                             &
            &  + 2.0d0 * (   e_data(k)  * cos(2*pi*k/xl*xval)    &
            &              - e_data(-k) * sin(2*pi*k/xl*xval) )
    end do

Variable Documentation

g_x

real(dp), dimension(:), allocatable, save, public ae_module::g_x

格子点座標(X)を格納した1次元配列.

Definition at line 102 of file ae_module.f90.

  real(DP), allocatable    :: g_x(:)

g_x_weight

real(dp), dimension(:), allocatable, save, public ae_module::g_x_weight

重み座標を格納した 1 次元配列. X方向の格子点の間隔が格納してある.

Definition at line 104 of file ae_module.f90.

  real(DP), allocatable    :: g_x_weight(:)