/[MITgcm]/manual/s_phys_pkgs/rw.tex
ViewVC logotype

Diff of /manual/s_phys_pkgs/rw.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.5 by edhill, Thu Jan 29 21:12:31 2004 UTC revision 1.6 by edhill, Tue Oct 12 18:16:03 2004 UTC
# Line 4  Line 4 
4    
5  \section{RW Basic binary I/O utilities}  \section{RW Basic binary I/O utilities}
6  \label{sec:pkg:rw}  \label{sec:pkg:rw}
7    \begin{rawhtml}
8    <!-- CMIREDIR:package_rw: -->
9    \end{rawhtml}
10    
11  The {\tt rw} package provides a very rudimentary binary I/O capability  The {\tt rw} package provides a very rudimentary binary I/O capability
12  for quickly writing {\it single record} direct-access Fortran binary files.  for quickly writing {\it single record} direct-access Fortran binary files.
13  It is primarily used for writing diagnostic output.  It is primarily used for writing diagnostic output.
# Line 13  Package {\tt rw} is an interface to the Line 17  Package {\tt rw} is an interface to the
17  The {\tt rw} package can be used to write or read direct-access Fortran  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.  binary files for two-dimensional XY and three-dimensional XYZ arrays.
19  The arrays are assumed to have been declared according to the standard  The arrays are assumed to have been declared according to the standard
20  MITgcm two-dimensional or the-dimensional floating point array type  MITgcm two-dimensional or three-dimensional floating point array type:
 (see figure \ref{fig:pkg:rw:standarddeclaration}).  
   
 \begin[h]{figure}  
 {\small  
21  \begin{verbatim}  \begin{verbatim}
22  C     Example of declaring a standard two dimensional "long"  C     Example of declaring a standard two dimensional "long"
23  C     floating point type array (the _RL macro is usually  C     floating point type array (the _RL macro is usually
24  C     mapped to 64-bit floats in most configurations)  C     mapped to 64-bit floats in most configurations)
25        _RL anArray(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL anArray(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
26  \end{verbatim}  \end{verbatim}
 }  
 \caption{An example of the fixed form Fortran declaration for a  
 standard MITgcm two-dimensional array type.  }  
 \label{fig:pkg:rw:standarddeclaration}  
 \end{figure}  
27    
28  Each call to an {\tt rw} read or write routine will read (or write) to  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  the first record of a file. To write direct access Fortran files with
30  multiple records use the package {\tt mdsio} (see section  multiple records use the package {\tt mdsio} (see section
31  \ref{sec:pkg:mdsio}). To write self-describing files that contain  \ref{sec:pkg:mdsio}).  To write self-describing files that contain
32  embedded information describing the variables being written and the  embedded information describing the variables being written and the
33  spatial and temporal locations of those variables use the package {\tt  spatial and temporal locations of those variables use the package {\tt
34    mnc} (see section \ref{sec:pkg:mnc}) which produces    mnc} (see section \ref{sec:pkg:mnc}) which produces
35  \htlink{netCDF}{http://www.unidata.ucar.edu/packages/netcdf}  \htlink{netCDF}{http://www.unidata.ucar.edu/packages/netcdf}
36  \cite{rew:97} based output.  \cite{rew:97} based output.
37    
38  \subsection{Key subroutines, parameters and files}  %% \subsection{Key subroutines, parameters and files}
39  \label{sec:pkg:rw:implementation_synopsis}  %% \label{sec:pkg:rw:implementation_synopsis}
40  The {\tt rw} package has  %% The {\tt rw} package has
   
41    
 \subsection{Package Reference}  
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.6
  ViewVC Help
Powered by ViewVC 1.1.22