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

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

This module set 3 Dimensional Grid Information.

3 次元の格子点情報の設定を行うためのモジュールである。

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

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

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

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

もしかすると、「３次元」という枠組ではなく、それぞれの次元に分けた
モジュールにすべきかも知れない。

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

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

\begin{verbatim}
private
public :: grid_3d_init, grid_3d_end ! subroutines
public :: im, jm, km                ! variables
\end{verbatim}
\subsection{\label{label:8} Public Data}

grid\_3d\_init において値が設定される。以下はデフォルト値。

\begin{verbatim}
integer(INTKIND), save :: im = 64 , &  ! 格子点の設定(X)
     &                    jm = 32 , &  ! 格子点の設定(Y)
     &                    km = 12      ! 格子点の設定(Y)
\end{verbatim}
\subsection{\label{label:9} Procedure Interface}

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

NAMELIST から x 軸、 y 軸、 z 軸の格子点数を取得する。
取得できない場合、またはゼロ以下の値が与えられた場合、
上記のデフォルト値が強制的に設定される。

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

\begin{verbatim}
subroutine grid_3d_init
\end{verbatim}
\paragraph{\label{label:11} Dependency} \

\begin{verbatim}
use type_mod,   only: INTKIND
use nmlfile_mod,only: nmlfile_init, nmlfile_open, nmlfile_close
use dc_trace,   only: DbgMessage, BeginSub, EndSub
use dc_message, only: MessageNotify
\end{verbatim}
\paragraph{\label{label:12} NAMELIST} \

\begin{verbatim}
namelist /grid_3d_nml/ & 
     & im , &      ! 東西格子点数
     & jm , &      ! 南北格子点数
     & km          ! 鉛直格子点数
\end{verbatim}
\subsubsection{\label{label:13} Terminate module}

NAMELIST から読み込んだ値を破棄し、各定数をデフォルトの値に戻す。

\begin{verbatim}
subroutine grid_3d_end
\end{verbatim}
\paragraph{\label{label:14} Dependency} \

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

\end{document}
