Class | constants |
In: |
shared/constants.f90
|
Note that Japanese and English are described in parallel.
物理定数を管理・設定するためのモジュールです.
This module manages physical constants.
Create : | CONST 型変数の初期設定 |
Get : | CONST 型変数に格納される物理定数等の取得 |
PutLine : | CONST 型変数に格納されている情報の印字 |
Close : | CONST 型変数の終了処理 |
initialized : | CONST 型変数が初期設定されているか否か |
———— : | ———— |
Create : | Constructor of "CONST" |
Get : | Get physical constants etc. stored in "CONST" |
PutLine : | Print information of "CONST" |
Close : | Deconstructor of "CONST" |
initialized : | Check initialization of "CONST" |
始めに, 構造データ型 CONST の変数を定義し, Create で初期設定します. Create で初期設定することにより CONST 内の物理変数が設定されます. CONST 内の物理定数を取得する際には Get を用いてください.
Firstly, initialize "CONST" by "Create". Then physical constants in "CONST" are configured. To get physical constants in "CONST", use "Get".
program constants_sample use dc_string, only: Printf use dc_types, only: DP use constants, only: CONST, Create, Get implicit none type(CONST):: constants_earth, constants_mars real(DP):: RPlanet, Omega, Grav call Create(constants_earth) call Create(constants_mars, & & RPlanet = 3.397e6_DP, Omega = 7.088e-5_DP, Grav = 3.72_DP ) ! print some phycical constants on Earth call Get(constants_earth, & & RPlanet = RPlanet, Omega = Omega, Grav = Grav) call Printf( & & fmt = 'The radius of Earth is %f (m), ' // & & 'the angular velocity of Earth is %f (m/s), ' // & & 'the acceleration due to gravity on Earth is %f (m^2/s)', & & d=(/RPlanet, Omega, Grav/)) ! print some phycical constants on Mars call Get(constants_mars, & & RPlanet = RPlanet, Omega = Omega, Grav = Grav) call Printf( & & fmt = 'The radius of Mars is %f (m), ' // & & 'the angular velocity of Mars is %f (m/s), ' // & & 'the acceleration due to gravity on Mars is %f (m^2/s)', & & d=(/RPlanet, Omega, Grav/)) end program constants_sample
Derived Type : | |||
initialized = .false. : | logical
| ||
dummy0 : | integer
| ||
PI : | real(DP)
| ||
RPlanet : | real(DP)
| ||
Omega : | real(DP)
| ||
Grav : | real(DP)
| ||
Cp : | real(DP)
| ||
RAir : | real(DP)
| ||
EL : | real(DP)
| ||
CpVap : | real(DP)
| ||
RVap : | real(DP)
| ||
DH2O : | real(DP)
| ||
EpsV : | real(DP)
| ||
ES0 : | real(DP)
| ||
StB : | real(DP)
| ||
FKarm : | real(DP)
| ||
EFoldTime : | real(DP)
| ||
VisOrder : | integer
| ||
dummy1 : | integer
|
Subroutine : | |||
constant : | type(CONST), intent(inout) | ||
err : | logical, intent(out), optional
|
CONST 型の変数の終了処理を行います. なお, 与えられた constant が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Deconstructor of "CONST". Note that if constant is not initialized by "Create" yet, error is occurred.
Alias for ConstantsClose
Subroutine : | |||
constant : | type(CONST), intent(inout) | ||
PI : | real(DP), intent(in), optional
| ||
RPlanet : | real(DP), intent(in), optional
| ||
Omega : | real(DP), intent(in), optional
| ||
Grav : | real(DP), intent(in), optional
| ||
Cp : | real(DP), intent(in), optional
| ||
RAir : | real(DP), intent(in), optional
| ||
EL : | real(DP), intent(in), optional
| ||
CpVap : | real(DP), intent(in), optional
| ||
RVap : | real(DP), intent(in), optional
| ||
DH2O : | real(DP), intent(in), optional
| ||
EpsV : | real(DP), intent(in), optional
| ||
ES0 : | real(DP), intent(in), optional
| ||
StB : | real(DP), intent(in), optional
| ||
FKarm : | real(DP), intent(in), optional
| ||
EFoldTime : | real(DP), intent(in), optional
| ||
VisOrder : | integer , intent(in), optional
| ||
nmlfile : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
引数 constant に物理定数の設定を行います. デフォルトでは地球大気に関する値が設定されます.
NAMELIST を利用する場合には引数 nmlfile に NAMELIST ファイル名 を与えてください. NAMELIST 変数群の詳細に関しては NAMELIST#constants_nml を参照してください.
Physical constants are configured to argument constant. By default, values on Earth are configured.
In order to use NAMELIST, specify a NAMELIST filename to argument nmlfile. See "NAMELIST#constants_nml" for details about a NAMELIST group.
Alias for ConstantsCreate
Subroutine : | |||
constant : | type(CONST), intent(inout) | ||
PI : | real(DP), intent(out), optional
| ||
RPlanet : | real(DP), intent(out), optional
| ||
Omega : | real(DP), intent(out), optional
| ||
Grav : | real(DP), intent(out), optional
| ||
Cp : | real(DP), intent(out), optional
| ||
RAir : | real(DP), intent(out), optional
| ||
EL : | real(DP), intent(out), optional
| ||
CpVap : | real(DP), intent(out), optional
| ||
RVap : | real(DP), intent(out), optional
| ||
DH2O : | real(DP), intent(out), optional
| ||
EpsV : | real(DP), intent(out), optional
| ||
ES0 : | real(DP), intent(out), optional
| ||
StB : | real(DP), intent(out), optional
| ||
FKarm : | real(DP), intent(out), optional
| ||
EFoldTime : | real(DP), intent(out), optional
| ||
VisOrder : | integer , intent(out), optional
| ||
err : | logical, intent(out), optional
|
引数 constant に格納されている物理定数などを取り出します.
なお, 与えられた constant が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Physical constants etc. stored in argument constant are gotten.
If constant is not initialized by "Create" yet, error is occurred.
Alias for ConstantsGet
Subroutine : | |||
constant : | type(CONST), intent(in) | ||
unit : | integer, intent(in), optional
| ||
indent : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
引数 constant に設定されている情報を印字します. デフォルトではメッセージは標準出力に出力されます. unit に装置番号を指定することで, 出力先を変更することが可能です.
Print information of constant. By default messages are output to standard output. Unit number for output can be changed by unit argument.
Alias for ConstantsPutLine
Function : | |
result : | logical |
constant : | type(CONST), intent(in) |
constant が初期設定されている場合には .true. が, 初期設定されていない場合には .false. が返ります.
If constant is initialized, .true. is returned. If constant is not initialized, .false. is returned.
Alias for ConstantsInitialized
Subroutine : | |||
constant : | type(CONST), intent(inout) | ||
err : | logical, intent(out), optional
|
CONST 型の変数の終了処理を行います. なお, 与えられた constant が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Deconstructor of "CONST". Note that if constant is not initialized by "Create" yet, error is occurred.
subroutine ConstantsClose( constant, err ) ! ! CONST 型の変数の終了処理を行います. ! なお, 与えられた *constant* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Deconstructor of "CONST". ! Note that if *constant* is not initialized by "Create" yet, ! error is occurred. ! use dc_trace, only: BeginSub, EndSub use dc_types, only: STRING, STDOUT use dcpam_error, only: StoreError, DC_NOERR, DCPAM_ENOTINIT implicit none type(CONST), intent(inout):: constant logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. integer:: stat character(STRING):: cause_c character(*), parameter:: subname = 'ConstantsClose' continue call BeginSub(subname) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if (.not. constant % initialized) then stat = DCPAM_ENOTINIT cause_c = 'CONST' goto 999 end if !----------------------------------------------------------------- ! "CONST" の設定の消去 ! Clear the settings for "CONST" !----------------------------------------------------------------- !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- constant % initialized = .false. 999 continue call StoreError(stat, subname, err, cause_c) call EndSub(subname) end subroutine ConstantsClose
Subroutine : | |||
constant : | type(CONST), intent(inout) | ||
PI : | real(DP), intent(in), optional
| ||
RPlanet : | real(DP), intent(in), optional
| ||
Omega : | real(DP), intent(in), optional
| ||
Grav : | real(DP), intent(in), optional
| ||
Cp : | real(DP), intent(in), optional
| ||
RAir : | real(DP), intent(in), optional
| ||
EL : | real(DP), intent(in), optional
| ||
CpVap : | real(DP), intent(in), optional
| ||
RVap : | real(DP), intent(in), optional
| ||
DH2O : | real(DP), intent(in), optional
| ||
EpsV : | real(DP), intent(in), optional
| ||
ES0 : | real(DP), intent(in), optional
| ||
StB : | real(DP), intent(in), optional
| ||
FKarm : | real(DP), intent(in), optional
| ||
EFoldTime : | real(DP), intent(in), optional
| ||
VisOrder : | integer , intent(in), optional
| ||
nmlfile : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
引数 constant に物理定数の設定を行います. デフォルトでは地球大気に関する値が設定されます.
NAMELIST を利用する場合には引数 nmlfile に NAMELIST ファイル名 を与えてください. NAMELIST 変数群の詳細に関しては NAMELIST#constants_nml を参照してください.
Physical constants are configured to argument constant. By default, values on Earth are configured.
In order to use NAMELIST, specify a NAMELIST filename to argument nmlfile. See "NAMELIST#constants_nml" for details about a NAMELIST group.
subroutine ConstantsCreate( constant, PI, RPlanet, Omega, Grav, Cp, RAir, EL, CpVap, RVap, DH2O, EpsV, ES0, StB, FKarm, EFoldTime, VisOrder, nmlfile, err ) ! ! 引数 *constant* に物理定数の設定を行います. ! デフォルトでは地球大気に関する値が設定されます. ! ! NAMELIST を利用する場合には引数 *nmlfile* に NAMELIST ファイル名 ! を与えてください. NAMELIST 変数群の詳細に関しては ! NAMELIST#constants_nml を参照してください. ! ! Physical constants are configured to argument *constant*. ! By default, values on Earth are configured. ! ! In order to use NAMELIST, specify a NAMELIST filename to ! argument *nmlfile*. See "NAMELIST#constants_nml" ! for details about a NAMELIST group. ! use dc_trace, only: BeginSub, EndSub use dc_types, only: STRING, DP use dcpam_error, only: StoreError, DC_NOERR, DCPAM_EALREADYINIT use dc_present, only: present_and_not_empty use dc_message, only: MessageNotify type(CONST), intent(inout) :: constant real(DP), intent(in), optional:: PI ! $ \pi $ . 円周率. Circular constant real(DP), intent(in), optional:: RPlanet ! $ a $ . 惑星半径. Radius of planet real(DP), intent(in), optional:: Omega ! $ \Omega $ . 回転角速度. Angular velocity real(DP), intent(in), optional:: Grav ! $ g $ . 重力加速度. Gravitational acceleration real(DP), intent(in), optional:: Cp ! $ C_p $ . 大気定圧比熱. Specific heat of air at constant pressure real(DP), intent(in), optional:: RAir ! $ R $ . 大気気体定数. Gas constant of air real(DP), intent(in), optional:: EL ! $ L $ . 水の凝結の潜熱. Latent heat of condensation of water vapor real(DP), intent(in), optional:: CpVap ! $ C_v $ . 水蒸気定圧比熱. Specific heat of water vapor at constant pressure real(DP), intent(in), optional:: RVap ! $ R_v $ . 水蒸気気体定数. Gas constant of water vapor real(DP), intent(in), optional:: DH2O ! $ d_{\mathrm{H_2O}} $ . 液体水の密度. Density of liquid water real(DP), intent(in), optional:: EpsV ! $ \epsilon_v $ . 水蒸気分子量比. Molecular weight of water vapor real(DP), intent(in), optional:: ES0 ! $ e^{*} $ (273K) . 0 ℃での飽和蒸気圧. Saturated vapor pressure at 0 degrees C real(DP), intent(in), optional:: StB ! $ \sigma_{SB} $ . ステファンボルツマン定数. Stefan-Boltzmann constant real(DP), intent(in), optional:: FKarm ! $ k $ . カルマン定数. Karman constant real(DP), intent(in), optional:: EFoldTime ! 最大波数に対する e-folding time. E-folding time for maximum wavenumber integer , intent(in), optional:: VisOrder ! 超粘性の次数. Order of hyperviscosity character(*), intent(in), optional :: nmlfile ! NAMELIST ファイルの名称. ! この引数に空文字以外を与えた場合, ! 指定されたファイルから ! NAMELIST 変数群を読み込みます. ! ファイルを読み込めない場合にはエラーを ! 生じます. ! ! NAMELIST 変数群の詳細に関しては ! NAMELIST#constants_nml ! を参照してください. ! ! NAMELIST file name. ! If nonnull character is specified to ! this argument, ! NAMELIST group name is loaded from the ! file. ! If the file can not be read, ! an error occurs. ! ! See "NAMELIST#constants_nml" ! for details about a NAMELIST group. ! logical, intent(out), optional :: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. !----------------------------------- ! 作業変数 ! Work variables integer :: stat character(STRING) :: cause_c character(*), parameter :: subname = 'ConstantsCreate' continue call BeginSub(subname, version=version) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if (constant % initialized) then stat = DCPAM_EALREADYINIT cause_c = 'CONST' goto 999 end if !------------------------------------------------------------------- ! constant の設定 ! Configure the settings of constant !------------------------------------------------------------------- !------------------------- ! デフォルト値 (地球上の値) ! Default values (on Earth) constant % PI = 3.1415926535897930_DP constant % RPlanet = 6.371e6_DP constant % Omega = 7.29210659088065e-05_DP constant % Grav = 9.8_DP constant % Cp = 1004.6_DP constant % RAir = 287.04_DP constant % EL = 2.5e6_DP constant % CpVap = 1810.0_DP constant % RVap = 461.0_DP constant % DH2O = 1000.0_DP constant % EpsV = 0.62264642082430_DP constant % ES0 = 611.0_DP constant % StB = 5.67e-8_DP constant % FKarm = 0.4_DP constant % EFoldTime = 8640.0_DP constant % VisOrder = 4 !------------------------- ! オプショナル引数からの値 ! Values from optional arguments if ( present(PI) ) constant % PI = PI if ( present(RPlanet) ) constant % RPlanet = RPlanet if ( present(Omega) ) constant % Omega = Omega if ( present(Grav) ) constant % Grav = Grav if ( present(Cp) ) constant % Cp = Cp if ( present(RAir) ) constant % RAir = RAir if ( present(EL) ) constant % EL = EL if ( present(CpVap) ) constant % CpVap = CpVap if ( present(RVap) ) constant % RVap = RVap if ( present(DH2O) ) constant % DH2O = DH2O if ( present(EpsV) ) constant % EpsV = EpsV if ( present(ES0) ) constant % ES0 = ES0 if ( present(StB) ) constant % StB = StB if ( present(FKarm) ) constant % FKarm = FKarm if ( present(EFoldTime) ) constant % EFoldTime = EFoldTime if ( present(VisOrder) ) constant % VisOrder = VisOrder !------------------------- ! NAMELIST からの値 ! Values from NAMELIST if ( present_and_not_empty(nmlfile) ) then call MessageNotify( 'M', subname, 'NAMELIST file "%c" is loaded.', c1=trim(nmlfile) ) call NmlRead ( nmlfile = nmlfile, PI = constant % PI, RPlanet = constant % RPlanet, Omega = constant % Omega, Grav = constant % Grav, Cp = constant % Cp, RAir = constant % RAir, EL = constant % EL, CpVap = constant % CpVap, RVap = constant % RVap, DH2O = constant % DH2O, EpsV = constant % EpsV, ES0 = constant % ES0, StB = constant % StB, FKarm = constant % FKarm, EFoldTime = constant % EFoldTime, VisOrder = constant % VisOrder ) ! (inout) end if !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- constant % initialized = .true. 999 continue call StoreError(stat, subname, err, cause_c) call EndSub(subname) end subroutine ConstantsCreate
Subroutine : | |||
constant : | type(CONST), intent(inout) | ||
PI : | real(DP), intent(out), optional
| ||
RPlanet : | real(DP), intent(out), optional
| ||
Omega : | real(DP), intent(out), optional
| ||
Grav : | real(DP), intent(out), optional
| ||
Cp : | real(DP), intent(out), optional
| ||
RAir : | real(DP), intent(out), optional
| ||
EL : | real(DP), intent(out), optional
| ||
CpVap : | real(DP), intent(out), optional
| ||
RVap : | real(DP), intent(out), optional
| ||
DH2O : | real(DP), intent(out), optional
| ||
EpsV : | real(DP), intent(out), optional
| ||
ES0 : | real(DP), intent(out), optional
| ||
StB : | real(DP), intent(out), optional
| ||
FKarm : | real(DP), intent(out), optional
| ||
EFoldTime : | real(DP), intent(out), optional
| ||
VisOrder : | integer , intent(out), optional
| ||
err : | logical, intent(out), optional
|
引数 constant に格納されている物理定数などを取り出します.
なお, 与えられた constant が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Physical constants etc. stored in argument constant are gotten.
If constant is not initialized by "Create" yet, error is occurred.
subroutine ConstantsGet( constant, PI, RPlanet, Omega, Grav, Cp, RAir, EL, CpVap, RVap, DH2O, EpsV, ES0, StB, FKarm, EFoldTime, VisOrder, err ) ! ! 引数 *constant* に格納されている物理定数などを取り出します. ! ! なお, 与えられた *constant* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Physical constants etc. stored in argument *constant* ! are gotten. ! ! If *constant* is not initialized by "Create" yet, ! error is occurred. ! use dc_trace, only: BeginSub, EndSub use dc_types, only: STRING, STDOUT use dcpam_error, only: StoreError, DC_NOERR, DCPAM_ENOTINIT implicit none type(CONST), intent(inout):: constant real(DP), intent(out), optional:: PI ! $ \pi $ . 円周率. Circular constant real(DP), intent(out), optional:: RPlanet ! $ a $ . 惑星半径. Radius of planet real(DP), intent(out), optional:: Omega ! $ \Omega $ . 回転角速度. Angular velocity real(DP), intent(out), optional:: Grav ! $ g $ . 重力加速度. Gravitational acceleration real(DP), intent(out), optional:: Cp ! $ C_p $ . 大気定圧比熱. Specific heat of air at constant pressure real(DP), intent(out), optional:: RAir ! $ R $ . 大気気体定数. Gas constant of air real(DP), intent(out), optional:: EL ! $ L $ . 水の凝結の潜熱. Latent heat of condensation of water vapor real(DP), intent(out), optional:: CpVap ! $ C_v $ . 水蒸気定圧比熱. Specific heat of water vapor at constant pressure real(DP), intent(out), optional:: RVap ! $ R_v $ . 水蒸気気体定数. Gas constant of water vapor real(DP), intent(out), optional:: DH2O ! $ d_{\mathrm{H_2O}} $ . 液体水の密度. Density of liquid water real(DP), intent(out), optional:: EpsV ! $ \epsilon_v $ . 水蒸気分子量比. Molecular weight of water vapor real(DP), intent(out), optional:: ES0 ! $ e^{*} $ (273K) . 0 ℃での飽和蒸気圧. Saturated vapor pressure at 0 degrees C real(DP), intent(out), optional:: StB ! $ \sigma_{SB} $ . ステファンボルツマン定数. Stefan-Boltzmann constant real(DP), intent(out), optional:: FKarm ! $ k $ . カルマン定数. Karman constant real(DP), intent(out), optional:: EFoldTime ! 最大波数に対する e-folding time. E-folding time for maximum wavenumber integer , intent(out), optional:: VisOrder ! 超粘性の次数. Order of hyperviscosity logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. integer:: stat character(STRING):: cause_c character(*), parameter:: subname = 'ConstantsGet' continue call BeginSub(subname) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if (.not. constant % initialized) then stat = DCPAM_ENOTINIT cause_c = 'CONST' goto 999 end if !----------------------------------------------------------------- ! 物理定数等の取り出し ! Fetch physical constants etc. !----------------------------------------------------------------- if ( present(PI) ) PI = constant % PI if ( present(RPlanet) ) RPlanet = constant % RPlanet if ( present(Omega) ) Omega = constant % Omega if ( present(Grav) ) Grav = constant % Grav if ( present(Cp) ) Cp = constant % Cp if ( present(RAir) ) RAir = constant % RAir if ( present(EL) ) EL = constant % EL if ( present(CpVap) ) CpVap = constant % CpVap if ( present(RVap) ) RVap = constant % RVap if ( present(DH2O) ) DH2O = constant % DH2O if ( present(EpsV) ) EpsV = constant % EpsV if ( present(ES0) ) ES0 = constant % ES0 if ( present(StB) ) StB = constant % StB if ( present(FKarm) ) FKarm = constant % FKarm if ( present(EFoldTime) ) EFoldTime = constant % EFoldTime if ( present(VisOrder) ) VisOrder = constant % VisOrder !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- 999 continue call StoreError(stat, subname, err, cause_c) call EndSub(subname) end subroutine ConstantsGet
Function : | |
result : | logical |
constant : | type(CONST), intent(in) |
constant が初期設定されている場合には .true. が, 初期設定されていない場合には .false. が返ります.
If constant is initialized, .true. is returned. If constant is not initialized, .false. is returned.
logical function ConstantsInitialized( constant ) result(result) ! ! *constant* が初期設定されている場合には .true. が, ! 初期設定されていない場合には .false. が返ります. ! ! If *constant* is initialized, .true. is returned. ! If *constant* is not initialized, .false. is returned. ! implicit none type(CONST), intent(in):: constant continue result = constant % initialized end function ConstantsInitialized
Subroutine : | |||
nmlfile : | character(*), intent(in)
| ||
PI : | real(DP), intent(inout)
| ||
RPlanet : | real(DP), intent(inout)
| ||
Omega : | real(DP), intent(inout)
| ||
Grav : | real(DP), intent(inout)
| ||
Cp : | real(DP), intent(inout)
| ||
RAir : | real(DP), intent(inout)
| ||
EL : | real(DP), intent(inout)
| ||
CpVap : | real(DP), intent(inout)
| ||
RVap : | real(DP), intent(inout)
| ||
DH2O : | real(DP), intent(inout)
| ||
EpsV : | real(DP), intent(inout)
| ||
ES0 : | real(DP), intent(inout)
| ||
StB : | real(DP), intent(inout)
| ||
FKarm : | real(DP), intent(inout)
| ||
EFoldTime : | real(DP), intent(inout)
| ||
VisOrder : | integer , intent(inout)
| ||
err : | logical, intent(out), optional
|
NAMELIST ファイル nmlfile から値を入力するための 内部サブルーチンです. Create 内で呼び出されることを 想定しています.
値が NAMELIST ファイル内で指定されていない場合には, 入力された値がそのまま返ります.
なお, nmlfile に空文字が与えられた場合, または 与えられた nmlfile を読み込むことができない場合, プログラムはエラーを発生させます.
This is an internal subroutine to input values from NAMELIST file nmlfile. This subroutine is expected to be called by "Create".
A value not specified in NAMELIST file is returned without change.
If nmlfile is empty, or nmlfile can not be read, error is occurred.
This procedure input/output NAMELIST#constants_nml .
subroutine ConstantsNmlRead( nmlfile, PI, RPlanet, Omega, Grav, Cp, RAir, EL, CpVap, RVap, DH2O, EpsV, ES0, StB, FKarm, EFoldTime, VisOrder, err ) ! ! NAMELIST ファイル *nmlfile* から値を入力するための ! 内部サブルーチンです. Create 内で呼び出されることを ! 想定しています. ! ! 値が NAMELIST ファイル内で指定されていない場合には, ! 入力された値がそのまま返ります. ! ! なお, *nmlfile* に空文字が与えられた場合, または ! 与えられた *nmlfile* を読み込むことができない場合, ! プログラムはエラーを発生させます. ! ! This is an internal subroutine to input values from ! NAMELIST file *nmlfile*. This subroutine is expected to be ! called by "Create". ! ! A value not specified in NAMELIST file is returned ! without change. ! ! If *nmlfile* is empty, or *nmlfile* can not be read, ! error is occurred. ! use dc_trace, only: BeginSub, EndSub use dc_types, only: STRING, DP, STDOUT use dcpam_error, only: StoreError, DC_NOERR use dc_iounit, only: FileOpen use dc_message, only: MessageNotify implicit none character(*), intent(in):: nmlfile ! NAMELIST ファイルの名称. ! NAMELIST file name real(DP), intent(inout):: PI ! $ \pi $ . 円周率. Circular constant real(DP), intent(inout):: RPlanet ! $ a $ . 惑星半径. Radius of planet real(DP), intent(inout):: Omega ! $ \Omega $ . 回転角速度. Angular velocity real(DP), intent(inout):: Grav ! $ g $ . 重力加速度. Gravitational acceleration real(DP), intent(inout):: Cp ! $ C_p $ . 大気定圧比熱. Specific heat of air at constant pressure real(DP), intent(inout):: RAir ! $ R $ . 大気気体定数. Gas constant of air real(DP), intent(inout):: EL ! $ L $ . 水の凝結の潜熱. Latent heat of condensation of water vapor real(DP), intent(inout):: CpVap ! $ C_v $ . 水蒸気定圧比熱. Specific heat of water vapor at constant pressure real(DP), intent(inout):: RVap ! $ R_v $ . 水蒸気気体定数. Gas constant of water vapor real(DP), intent(inout):: DH2O ! $ d_{\mathrm{H_2O}} $ . 液体水の密度. Density of liquid water real(DP), intent(inout):: EpsV ! $ \epsilon_v $ . 水蒸気分子量比. Molecular weight of water vapor real(DP), intent(inout):: ES0 ! $ e^{*} $ (273K) . 0 ℃での飽和蒸気圧. Saturated vapor pressure at 0 degrees C real(DP), intent(inout):: StB ! $ \sigma_{SB} $ . ステファンボルツマン定数. Stefan-Boltzmann constant real(DP), intent(inout):: FKarm ! $ k $ . カルマン定数. Karman constant real(DP), intent(inout):: EFoldTime ! 最大波数に対する e-folding time. E-folding time for maximum wavenumber integer , intent(inout):: VisOrder ! 超粘性の次数. Order of hyperviscosity logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. namelist /constants_nml/ PI, RPlanet, Omega, Grav, Cp, RAir, EL, CpVap, RVap, DH2O, EpsV, ES0, StB, FKarm, EFoldTime, VisOrder ! ! constants モジュール用 NAMELIST 変数群名. ! 物理定数等を読み込みます. ! ! constants#Create を使用する際に, ! オプショナル引数 *nmlfile* へ NAMELIST ! ファイル名を指定することで, そのファイルから ! この NAMELIST 変数群を読み込みます. ! ! NAMELIST group name for "constants" module. ! physical constants etc. are input. ! ! If a NAMELIST filename is specified to ! an optional argument *nmlfile* ! when "constants#Create" is used, ! this NAMELIST group is loaded from ! the file. !----------------------------------- ! 作業変数 ! Work variables integer:: stat character(STRING):: cause_c integer:: unit_nml ! NAMELIST ファイルオープン用装置番号. ! Unit number for NAMELIST file open integer:: iostat_nml ! NAMELIST 読み込み時の IOSTAT. ! IOSTAT of NAMELIST read character(*), parameter:: subname = 'ConstantsNmlRead' continue call BeginSub(subname) stat = DC_NOERR cause_c = '' !---------------------------------------------------------------- ! NAMELIST ファイルのオープン ! Open NAMELIST file !---------------------------------------------------------------- call FileOpen( unit = unit_nml, file = nmlfile, mode = 'r' ) ! (in) !----------------------------------------------------------------- ! NAMELIST 変数群の取得 ! Get NAMELIST group !----------------------------------------------------------------- read( unit = unit_nml, nml = constants_nml, iostat = iostat_nml ) ! (out) if ( iostat_nml == 0 ) then call MessageNotify( 'M', subname, 'NAMELIST group "%c" is loaded from "%c".', c1='constants_nml', c2=trim(nmlfile) ) write(STDOUT, nml = constants_nml) else call MessageNotify( 'W', subname, 'NAMELIST group "%c" is not found in "%c" (iostat=%d).', c1='constants_nml', c2=trim(nmlfile), i=(/iostat_nml/) ) end if close( unit_nml ) !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- 999 continue call StoreError(stat, subname, err, cause_c) call EndSub(subname) end subroutine ConstantsNmlRead
Subroutine : | |||
constant : | type(CONST), intent(in) | ||
unit : | integer, intent(in), optional
| ||
indent : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
引数 constant に設定されている情報を印字します. デフォルトではメッセージは標準出力に出力されます. unit に装置番号を指定することで, 出力先を変更することが可能です.
Print information of constant. By default messages are output to standard output. Unit number for output can be changed by unit argument.
subroutine ConstantsPutLine( constant, unit, indent, err ) ! ! 引数 *constant* に設定されている情報を印字します. ! デフォルトではメッセージは標準出力に出力されます. ! *unit* に装置番号を指定することで, 出力先を変更することが可能です. ! ! Print information of *constant*. ! By default messages are output to standard output. ! Unit number for output can be changed by *unit* argument. ! use dc_trace, only: BeginSub, EndSub use dc_types, only: STRING, STDOUT use dcpam_error, only: StoreError, DC_NOERR, DCPAM_ENOTINIT use dc_string, only: Printf implicit none type(CONST), intent(in):: constant integer, intent(in), optional:: unit ! 出力先の装置番号. ! デフォルトの出力先は標準出力. ! ! Unit number for output. ! Default value is standard output. character(*), intent(in), optional:: indent ! 表示されるメッセージの字下げ. ! ! Indent of displayed messages. logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. integer:: stat character(STRING):: cause_c integer:: out_unit integer:: indent_len character(STRING):: indent_str character(*), parameter:: subname = 'ConstantsPutLine' continue call BeginSub(subname) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if (present(unit)) then out_unit = unit else out_unit = STDOUT end if indent_len = 0 indent_str = '' if (present(indent)) then if (len(indent) /= 0) then indent_len = len(indent) indent_str(1:indent_len) = indent end if end if !----------------------------------------------------------------- ! "CONST" の設定の印字 ! Print the settings for "CONST" !----------------------------------------------------------------- if (constant % initialized) then call Printf(out_unit, indent_str(1:indent_len) // '#<CONST:: @initialized=%y', l=(/constant % initialized/)) call Printf(out_unit, indent_str(1:indent_len) // ' @PI=%f @RPlanet=%f @Omega=%f', d=(/constant % PI, constant % RPlanet, constant % Omega/)) call Printf(out_unit, indent_str(1:indent_len) // ' @Grav=%f @Cp=%f', d=(/constant % Grav, constant % Cp/)) call Printf(out_unit, indent_str(1:indent_len) // ' @RAir=%f @EL=%f @CpVap=%f @RVap=%f @DH2O=%f', d=(/constant % RAir, constant % EL, constant % CpVap, constant % RVap, constant % DH2O/)) call Printf(out_unit, indent_str(1:indent_len) // ' @EpsV=%f', d=(/constant % EpsV/)) call Printf(out_unit, indent_str(1:indent_len) // ' @ES0=%f @StB=%f @FKarm=%f', d=(/constant % ES0, constant % StB, constant % FKarm/)) call Printf(out_unit, indent_str(1:indent_len) // ' @EFoldTime=%f @VisOrder=%d', d=(/constant % EFoldTime/), i=(/constant % VisOrder/)) call Printf(out_unit, indent_str(1:indent_len) // '>' ) else call Printf(out_unit, indent_str(1:indent_len) // '#<CONST:: @initialized=%y>', l=(/constant % initialized/)) end if !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- 999 continue call StoreError(stat, subname, err, cause_c) call EndSub(subname) end subroutine ConstantsPutLine
Subroutine : | |||
nmlfile : | character(*), intent(in)
| ||
PI : | real(DP), intent(inout)
| ||
RPlanet : | real(DP), intent(inout)
| ||
Omega : | real(DP), intent(inout)
| ||
Grav : | real(DP), intent(inout)
| ||
Cp : | real(DP), intent(inout)
| ||
RAir : | real(DP), intent(inout)
| ||
EL : | real(DP), intent(inout)
| ||
CpVap : | real(DP), intent(inout)
| ||
RVap : | real(DP), intent(inout)
| ||
DH2O : | real(DP), intent(inout)
| ||
EpsV : | real(DP), intent(inout)
| ||
ES0 : | real(DP), intent(inout)
| ||
StB : | real(DP), intent(inout)
| ||
FKarm : | real(DP), intent(inout)
| ||
EFoldTime : | real(DP), intent(inout)
| ||
VisOrder : | integer , intent(inout)
| ||
err : | logical, intent(out), optional
|
NAMELIST ファイル nmlfile から値を入力するための 内部サブルーチンです. Create 内で呼び出されることを 想定しています.
値が NAMELIST ファイル内で指定されていない場合には, 入力された値がそのまま返ります.
なお, nmlfile に空文字が与えられた場合, または 与えられた nmlfile を読み込むことができない場合, プログラムはエラーを発生させます.
This is an internal subroutine to input values from NAMELIST file nmlfile. This subroutine is expected to be called by "Create".
A value not specified in NAMELIST file is returned without change.
If nmlfile is empty, or nmlfile can not be read, error is occurred.
This procedure input/output NAMELIST#constants_nml .
Alias for ConstantsNmlRead
Constant : | |
version = ’$Name: dcpam4-20080626 $’ // ’$Id: constants.f90,v 1.14 2008-04-21 10:36:20 morikawa Exp $’ : | character(*), parameter |