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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.22