\documentclass[titlepage]{jarticle}
\title{DCPAM Reference Manual}
\author{GFD Dennou Club}
\begin{document}
\maketitle
\tableofcontents
\clearpage
\section{\label{label:0} Module axis\_x\_mod}

\begin{itemize}
\item Developers: Morikawa Yasuhiro
\item Version: \$Id: axis\_x.f90,v 1.8 2005/01/19 08:52:24 morikawa Exp \$
\item Tag Name: \$Name:  \$
\item Change History: 
\end{itemize}
\subsection{\label{label:1} Overview}

This module set axis X or axis Longitude.

X 軸または経度軸を設定する。

\subsection{\label{label:2} Error Handling}

\subsection{\label{label:3} Known Bugs}

netCDF データから X 軸を入力する axis\_x\_netcdf にて、
元データが radians でも degrees でも、そのまま入力されるように
なっている。本来は元データの units から判定すべき。

\subsection{\label{label:4} Note}

\subsection{\label{label:5} Future Plans}

\subsection{\label{label:6} Dependency}

\begin{verbatim}
use type_mod,      only : INTKIND, STRING
use axis_type_mod, only : AXISINFO
\end{verbatim}
\subsection{\label{label:7} Public Interface}

\begin{verbatim}
private
public :: axis_x_init, axis_x_weight, axis_x_spectral ! subroutines
public :: axis_x_manual, axis_x_netcdf, axis_x_end    ! subroutines
\end{verbatim}
\subsection{\label{label:8} Procedure Interface}

\subsubsection{\label{label:9} Initialize module and acquire NAMELIST}

モジュールを初期化し、NAMELIST から値を取得する。
NAMELIST から値が取得できないものに関しては上記のデフォルト値が
用いられる。

NAMELIST ファイルは、メインプログラムにて  nmlfile\_mod  の
 nmlfile\_init  で指定されることが想定されているが、
もしもこの初期化ルーチンより以前に指定されていなければ、
 nmlfile\_init  のデフォルトで指定される NAMELIST ファイルを
読む。

\begin{verbatim}
subroutine axis_x_init
\end{verbatim}
\paragraph{\label{label:10} Dependency} \

\begin{verbatim}
use type_mod,  only: STRING, TOKEN, INTKIND, REKIND, DBKIND, NMLARRAY
use nmlfile_mod,only: nmlfile_init, nmlfile_open, nmlfile_close
use grid_3d_mod,only: im, grid_3d_init
use spml_mod,   only: spml_init
use axis_type_mod, only : axis_attrs_copy, axis_attrs_init
use gt4_history, only: GT_HISTORY_ATTR
use dc_types,  only: GT_TOKEN => TOKEN, GT_STRING => STRING
use dc_url,    only: GT_ATMARK, GT_QUESTION
use dc_trace,  only: DbgMessage, BeginSub, EndSub
use dc_message,only: MessageNotify
\end{verbatim}
\paragraph{\label{label:11} NAMELIST} \

X 軸の次元変数に関する情報を与える。
値を与えないものに関しては以下のデフォルトの値が用いられる。

変数 decision には X 軸のデータをどのように与えるかを指定する。

\begin{itemize}
\item \verb! 'manual' !

\begin{itemize}
\item Data 配列に格納したデータをそのまま X 軸として与える。
\end{itemize}
\item \verb! 'spectral' !

\begin{itemize}
\item スペクトル法を用いる事を想定し、 length に応じて自動的に
    X 軸のデータが決まる。
\end{itemize}
\item gtool4 変数 (例えば \verb! 'foo.nc@lon' ! など)

\begin{itemize}
\item 該当する変数から X 軸のデータを取得する。
\end{itemize}
\end{itemize}
変数 length には、 grid\_3d\_mod の公開要素  im  と同じ
値を与えなければならない。

\begin{verbatim}
character(TOKEN)  :: name     = 'lon'          ! 次元変数名
integer(INTKIND)  :: length   = 64             ! 次元長 (配列サイズ)
character(STRING) :: longname = 'Longitude'    ! 次元変数の記述的名称
character(STRING) :: units    = 'degrees_east' ! 次元変数の単位
character(TOKEN)  :: xtype    = 'float'        ! 次元変数の型
character(STRING) :: decision = 'spectral'     ! 次元データの取得方法
real(REKIND)      :: Data(NMLARRAY)  = 0.0        ! 次元データ入力用

namelist /axis_x_nml/ &
     & name         , &  ! 次元変数名
     & length       , &  ! 次元長 (配列サイズ)
     & longname     , &  ! 次元変数の記述的名称
     & units        , &  ! 次元変数の単位
     & xtype        , &  ! 次元変数の型
     & decision     , &  ! 次元データの取得方法
     & Data              ! 次元データ
\end{verbatim}
X 軸の次元変数の属性に関する情報を与える。
NAMELIST に複数の axis\_x\_attr\_nml を用意しておく事で
複数の情報を与える事が可能である。
与えない場合には属性情報は付加されない。

attrtype には与える属性値の種類を設定する。
$<$URL:http://www.gfd-dennou.org/arch/gtool4/gt4f90io-current/doc/gt\_history.htm\#derived\_gthistoryattr$>$
を参照せよ。なお、arraysize に 1 以上の値を設定すると、
配列データが優先されて属性値に設定される。

\begin{verbatim}
character(GT_TOKEN)  :: attrname = '' ! 属性名
character(GT_TOKEN)  :: attrtype = '' ! 属性値の型
character(GT_STRING) :: cvalue   = '' ! 属性の値 (文字)
integer(INTKIND)     :: ivalue   = 0      ! 属性の値 (整数)
real(REKIND)         :: rvalue   = 0.0    ! 属性の値 (単精度実数)
real(DBKIND)         :: dvalue   = 0.0d0  ! 属性の値 (倍精度実数)
logical              :: lvalue   = .false.! 属性の値 (論理)
integer(INTKIND)     :: arraysize= 0      ! 配列のサイズ
integer(INTKIND) :: iarray(NMLARRAY)  = 0    ! 属性の値 (整数)
real(REKIND)     :: rarray(NMLARRAY)  = 0.0  ! 属性の値 (単精度実数)
real(DBKIND)     :: darray(NMLARRAY)  = 0.0d0! 属性の値 (倍精度実数)

namelist /axis_x_attr_nml/ &
     & attrname     , &  ! 属性名
     & attrtype     , &  ! 属性値の型
     & cvalue       , &  ! 属性の値 (文字)
     & ivalue       , &  ! 属性の値 (整数)
     & rvalue       , &  ! 属性の値 (単精度実数)
     & dvalue       , &  ! 属性の値 (倍精度実数)
     & lvalue       , &  ! 属性の値 (論理)
     & arraysize    , &  ! 配列のサイズ
     & iarray       , &  ! 属性の値 (整数)
     & rarray       , &  ! 属性の値 (単精度実数)
     & darray            ! 属性の値 (倍精度実数)
\end{verbatim}
\subsubsection{\label{label:12} Return Weight of axis X}

重みデータとその付加情報を返す。
 axis\_x\_init  の NAMELIST axis\_x\_nml の decision 変数で
\verb! 'spectral' ! 以外が与えられた場合は値を代入しないで返す。

また、X 軸の次元変数に重みデータに関する付加情報を加える。

\begin{verbatim}
subroutine axis_x_weight(Dim_Weight)
\end{verbatim}
\paragraph{\label{label:13} Dependency} \

\begin{verbatim}
use constants_mod, only: constants_init, pi
use axis_type_mod, only: axis_type_copy, axis_attrs_copy, axis_attrs_init
use spml_mod,   only: wa_module_x_Lon_Weight => x_Lon_Weight
use grid_3d_mod,only: im
use gt4_history,only: GT_HISTORY_ATTR
use dc_trace,   only: DbgMessage, BeginSub, EndSub
\end{verbatim}
\paragraph{\label{label:14} Output} \

\begin{verbatim}
type(AXISINFO), intent(out) :: Dim_Weight ! 次元情報を包括する変数
\end{verbatim}
\subsubsection{\label{label:15} Return Data of axis X for Spectral Method.}

スペクトル法を用いる場合を想定した X 軸のデータを返す。

 axis\_x\_init  の NAMELIST axis\_x\_nml の units に 
\verb! 'radian' ! または \verb! 'rad.' ! を与える場合には
単位がラジアンでデータが返される。それ以外では度数でデータが返る。

 axis\_x\_init  の NAMELIST axis\_x\_nml の decision 変数で
\verb! 'spectral' ! 以外が与えられた場合は値を代入しないで返す。

\begin{verbatim}
subroutine axis_x_spectral(Dim)
\end{verbatim}
\paragraph{\label{label:16} Dependency} \

\begin{verbatim}
use axis_type_mod, only: axis_type_copy
use constants_mod, only: constants_init, pi
use spml_mod,   only: wa_module_x_Lon => x_Lon
use dc_string,  only: toChar, StrHead, LChar
use dc_trace,   only: DbgMessage, BeginSub, EndSub
\end{verbatim}
\paragraph{\label{label:17} In/Out} \

\begin{verbatim}
type(AXISINFO), intent(inout) :: Dim        ! 次元情報を包括する変数
\end{verbatim}
\subsubsection{\label{label:18} Return Data of axis X from NAMELIST}

NAMELIST から代入されたデータを X 軸データとして返す。

 axis\_x\_init  の NAMELIST axis\_x\_nml の decision 変数で
\verb! 'manual' ! 以外が与えられた場合は値を代入しないで返す。

\begin{verbatim}
subroutine axis_x_manual(Dim)
\end{verbatim}
\paragraph{\label{label:19} Dependency} \

\begin{verbatim}
use axis_type_mod, only: axis_type_copy
use spml_mod,   only: wa_module_x_Lon => x_Lon
use dc_trace,   only: DbgMessage, BeginSub, EndSub
\end{verbatim}
\paragraph{\label{label:20} In/Out} \

\begin{verbatim}
type(AXISINFO), intent(inout) :: Dim        ! 次元情報を包括する変数
\end{verbatim}
\subsubsection{\label{label:21} Return Data of axis X from netCDF file}

netCDF データから取得したデータを X 軸のデータとして返す。

現在、取得先のデータの単位に関わらず、そのままデータが
入力される。\ref{label:3} 参照。

 axis\_x\_init  の NAMELIST axis\_x\_nml の decision 変数で
gtool4 変数以外が与えられた場合は値を代入しないで返す。

\begin{verbatim}
subroutine axis_x_netcdf(Dim)
\end{verbatim}
\paragraph{\label{label:22} Dependency} \

\begin{verbatim}
use axis_type_mod, only: axis_type_copy
use gt4_history,only: HistoryGet
use dc_url  ,   only: UrlSplit
use dc_trace,   only: DbgMessage, BeginSub, EndSub
\end{verbatim}
\paragraph{\label{label:23} In/Out} \

\begin{verbatim}
type(AXISINFO), intent(inout) :: Dim        ! 次元情報を包括する変数
\end{verbatim}
\subsubsection{\label{label:24} Terminate module}

axis\_x\_init で設定された値を破棄し、デフォルトに戻す。

\begin{verbatim}
subroutine axis_x_end()
\end{verbatim}
\paragraph{\label{label:25} Dependency} \

\begin{verbatim}
use dc_trace,  only: DbgMessage, BeginSub, EndSub
\end{verbatim}

\end{document}
