manual/s_phys_pkgs/rw.tex

% $Header: /u/gcmpack/manual/part6/rw.tex,v 1.5 2004/01/29 21:12:31 edhill Exp $
% $Name:  $


\section{RW Basic binary I/O utilities}
\label{sec:pkg:rw}
\begin{rawhtml}
<!-- CMIREDIR:package_rw: -->
\end{rawhtml}

The {\tt rw} package provides a very rudimentary binary I/O capability
for quickly writing {\it single record} direct-access Fortran binary files. 
It is primarily used for writing diagnostic output.

\subsection{Introduction}
Package {\tt rw} is an interface to the more general {\tt mdsio} package.
The {\tt rw} package can be used to write or read direct-access Fortran 
binary files for two-dimensional XY and three-dimensional XYZ arrays. 
The arrays are assumed to have been declared according to the standard
MITgcm two-dimensional or three-dimensional floating point array type:
\begin{verbatim}
C     Example of declaring a standard two dimensional "long" 
C     floating point type array (the _RL macro is usually 
C     mapped to 64-bit floats in most configurations)
      _RL anArray(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
\end{verbatim}

Each call to an {\tt rw} read or write routine will read (or write) to
the first record of a file. To write direct access Fortran files with
multiple records use the package {\tt mdsio} (see section
\ref{sec:pkg:mdsio}).  To write self-describing files that contain
embedded information describing the variables being written and the
spatial and temporal locations of those variables use the package {\tt
  mnc} (see section \ref{sec:pkg:mnc}) which produces
\htlink{netCDF}{http://www.unidata.ucar.edu/packages/netcdf}
\cite{rew:97} based output.

%% \subsection{Key subroutines, parameters and files}
%% \label{sec:pkg:rw:implementation_synopsis}
%% The {\tt rw} package has 

1	edhill	1.6	% $Header: /u/gcmpack/manual/part6/rw.tex,v 1.5 2004/01/29 21:12:31 edhill Exp $
2	edhill	1.5	% $Name: $
3
4
5	cnh	1.4	\section{RW Basic binary I/O utilities}
6	cnh	1.2	\label{sec:pkg:rw}
7	edhill	1.6	\begin{rawhtml}
8			<!-- CMIREDIR:package_rw: -->
9			\end{rawhtml}
10
11	cnh	1.3	The {\tt rw} package provides a very rudimentary binary I/O capability
12			for quickly writing {\it single record} direct-access Fortran binary files.
13	cnh	1.2	It is primarily used for writing diagnostic output.
14	cnh	1.3
15	cnh	1.2	\subsection{Introduction}
16	cnh	1.3	Package {\tt rw} is an interface to the more general {\tt mdsio} package.
17			The {\tt rw} package can be used to write or read direct-access Fortran
18			binary files for two-dimensional XY and three-dimensional XYZ arrays.
19	edhill	1.5	The arrays are assumed to have been declared according to the standard
20	edhill	1.6	MITgcm two-dimensional or three-dimensional floating point array type:
21	cnh	1.3	\begin{verbatim}
22	edhill	1.5	C Example of declaring a standard two dimensional "long"
23			C floating point type array (the _RL macro is usually
24			C mapped to 64-bit floats in most configurations)
25	cnh	1.3	_RL anArray(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
26			\end{verbatim}
27	cnh	1.4
28	edhill	1.5	Each call to an {\tt rw} read or write routine will read (or write) to
29			the first record of a file. To write direct access Fortran files with
30			multiple records use the package {\tt mdsio} (see section
31	edhill	1.6	\ref{sec:pkg:mdsio}). To write self-describing files that contain
32	edhill	1.5	embedded information describing the variables being written and the
33			spatial and temporal locations of those variables use the package {\tt
34			mnc} (see section \ref{sec:pkg:mnc}) which produces
35			\htlink{netCDF}{http://www.unidata.ucar.edu/packages/netcdf}
36	cnh	1.4	\cite{rew:97} based output.
37	cnh	1.2
38	edhill	1.6	%% \subsection{Key subroutines, parameters and files}
39			%% \label{sec:pkg:rw:implementation_synopsis}
40			%% The {\tt rw} package has
41	edhill	1.5