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

Diff of /manual/s_phys_pkgs/mnc.tex

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

revision 1.8 by edhill, Sat Apr 3 23:05:05 2004 UTC revision 1.11 by edhill, Wed Sep 22 15:11:32 2004 UTC
# Line 117  file Line 117  file
117  The variable type is an association between a variable type name and the  The variable type is an association between a variable type name and the
118  following items:  following items:
119  \begin{center}  \begin{center}
120    \begin{tabular}[h]{|ll|}\hline    \begin{tabular}[h]{|l|l|}\hline
121      \textbf{Item}  & \textbf{Purpose}  \\\hline      \textbf{Item}  & \textbf{Purpose}  \\\hline
122      grid type  &  defines the in-memory arrangement  \\      grid type  &  defines the in-memory arrangement  \\
123      \texttt{bi,bj} dimensions  &  tiling indices, if present  \\\hline      \texttt{bi,bj} dimensions  &  tiling indices, if present  \\\hline
# Line 138  necessary, the current time level within Line 138  necessary, the current time level within
138    
139  Examples of the initialization calls can be found in the file  Examples of the initialization calls can be found in the file
140  \filelink{model/src/ini\_mnc\_io.F}{model-src-ini_mnc_io.F}  \filelink{model/src/ini\_mnc\_io.F}{model-src-ini_mnc_io.F}
141  where these four function calls:  where these function calls:
142  {\footnotesize  {\footnotesize
143  \begin{verbatim}  \begin{verbatim}
144  C     Create MNC definitions for DYNVARS.h variables  C     Create MNC definitions for DYNVARS.h variables
# Line 164  C     Create MNC definitions for DYNVARS Line 164  C     Create MNC definitions for DYNVARS
164       &     'coordinates','XC YC RC iter', myThid)       &     'coordinates','XC YC RC iter', myThid)
165  \end{verbatim}  \end{verbatim}
166  }  }
167  {\noindent initialize two \texttt{VNAME}s and add one NetCDF  {\noindent initialize four \texttt{VNAME}s and add one or more NetCDF
168    attribute to each.}    attributes to each.}
169            
170  The two variables defined above are subsequently written at specific  The four variables defined above are subsequently written at specific
171  time steps within  time steps within
172  \filelink{model/src/write\_state.F}{model-src-write_state.F}  \filelink{model/src/write\_state.F}{model-src-write_state.F}
173  using the function calls:  using the function calls:
174  {\footnotesize  {\footnotesize
175  \begin{verbatim}  \begin{verbatim}
176  C       Write dynvars using the MNC package  C       Write dynvars using the MNC package
         mnc_iter = myIter  
177          CALL MNC_CW_SET_UDIM('state', -1, myThid)          CALL MNC_CW_SET_UDIM('state', -1, myThid)
178          CALL MNC_CW_RL_W('D','state',0,0,'iter',mnc_iter, myThid)          CALL MNC_CW_I_W('I','state',0,0,'iter', myIter, myThid)
179          CALL MNC_CW_SET_UDIM('state', 0, myThid)          CALL MNC_CW_SET_UDIM('state', 0, myThid)
180          CALL MNC_CW_RL_W('D','state',0,0,'model_time',myTime, myThid)          CALL MNC_CW_RL_W('D','state',0,0,'model_time',myTime, myThid)
181          CALL MNC_CW_RL_W('D','state',0,0,'U', uVel, myThid)          CALL MNC_CW_RL_W('D','state',0,0,'U', uVel, myThid)
# Line 184  C       Write dynvars using the MNC pack Line 183  C       Write dynvars using the MNC pack
183  \end{verbatim}  \end{verbatim}
184  }  }
185    
 %\subsection{Key subroutines, parameters and files}  
186    
187  \subsection{Package Reference}  \subsubsection{Parameters}
188    
189    Most of the MNC--related parameters are contained within a Fortran
190    namelist file called \texttt{data.mnc}.  If this file does not exist,
191    then the MNC package will interpret that as an indication that it is
192    not to be used.  If the \texttt{data.mnc} file does exist, then it may
193    contain the following parameters:
194    
195    \begin{center}
196      {\footnotesize
197        \begin{tabular}[htb]{|l|c|l|l|}\hline
198          \textbf{Name}  &  \textbf{T}  &  
199          \textbf{Default}  &  \textbf{Description}  \\\hline
200          &  &  &  \\
201          \texttt{useMNC}  &  L  & \texttt{.FALSE.}  &  
202          \textbf{overall MNC ON/OFF switch}  \\
203          \texttt{mnc\_echo\_gvtypes}  &  L  & \texttt{.FALSE.}  &  
204          echo pre-defined ``types'' (debugging)   \\
205          \texttt{mnc\_use\_outdir}  &  L  & \texttt{.FALSE.}  &  
206          create a directory for output  \\
207          \texttt{mnc\_outdir\_str}  &  S  & \texttt{'mnc\_'}  &  
208          output directory name \\
209          \texttt{mnc\_outdir\_date}  &  L  & \texttt{.FALSE.}  &  
210          embed date in the output dir name  \\
211          \texttt{pickup\_write\_mnc}  &  L  & \texttt{.FALSE.}  &  
212          use MNC to write (create) pickup files  \\
213          \texttt{pickup\_read\_mnc}  &  L  & \texttt{.FALSE.}  &  
214          use MNC to read pickup files  \\
215          \texttt{mnc\_use\_indir}  &  L  & \texttt{.FALSE.}  &  
216          use a directory (path) for input  \\
217          \texttt{mnc\_indir\_str}  &  S  & \texttt{''}  &  
218          input directory (or path) name  \\
219          \texttt{snapshot\_mnc}  &  L  & \texttt{.FALSE.}  &  
220          write \texttt{snapshot} (instantaneous) w/MNC  \\
221          \texttt{monitor\_mnc}  &  L  & \texttt{.FALSE.}  &  
222          write \texttt{monitor} w/MNC  \\
223          \texttt{timeave\_mnc}  &  L  & \texttt{.FALSE.}  &  
224          write \texttt{timeave} w/MNC  \\\hline
225        \end{tabular}
226      }
227    \end{center}
228    
229    Additional MNC--related parameters are contained within the main
230    \texttt{data} namelist file and in some of the namelist files for
231    individual packages.  These options are:
232    \begin{center}
233      {\footnotesize
234        \begin{tabular}[htb]{|l|c|l|l|}\hline
235          \textbf{Name}  &  \textbf{T}  &  
236          \textbf{Default}  &  \textbf{Description}  \\\hline
237          \multicolumn{4}{|c|}{\ }  \\
238          \multicolumn{4}{|c|}{Main namelist file:
239            ``\textbf{data}''}  \\\hline
240          \texttt{snapshot\_ioinc}  &  L  & \texttt{.FALSE.}  &  
241          write \texttt{snapshot} ``inclusively''  \\
242          \texttt{timeave\_ioinc}  &  L  & \texttt{.FALSE.}  &  
243          write \texttt{timeave} ``inclusively''  \\
244          \texttt{monitor\_ioinc}  &  L  & \texttt{.FALSE.}  &  
245          write \texttt{monitor} ``inclusively''  \\\hline
246          \multicolumn{4}{|c|}{\ }  \\
247          \multicolumn{4}{|c|}{Diagnostics namelist file:
248            ``\textbf{data.diagnostics}''}  \\\hline
249          \texttt{diag\_mnc}  &  L  & \texttt{.FALSE.}  &  
250          write \texttt{diagnostics} w/MNC  \\
251          \texttt{diag\_ioinc}  &  L  & \texttt{.FALSE.}  &  
252          write \texttt{diagnostics} ``inclusively''  \\\hline
253        \end{tabular}
254      }
255    \end{center}
256    
257    By default, turning on MNC for a particular output stream will result
258    in turning off all the corresponding (usually, default) MDSIO or
259    STDOUT output mechanisms.  In other words, output defaults to being an
260    exclusive selection.  To enable multiple kinds of simultaneous output,
261    flags of the form \texttt{NAME\_ioinc} can be used where \texttt{NAME}
262    corresponds to the various MNC output flags.  When a
263    \texttt{NAME\_ioinc} flag is set to \texttt{.TRUE.}, then multiple
264    forms of output are allowed for the \texttt{NAME} output mechanism.
265    The intent of this design is that typical users will only want one
266    kind of output while people debugging the code (particularly the I/O
267    routines) may want simultaneous types of output.
268    
269    This ``inclusive'' versus ``exclusive'' design is easily applied in
270    cases where three or more kinds of output may be generated.  Thus, it
271    can be readily extended to additional new output types (eg. HDF5).
272    
273    Input types are always exclusive.
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.11
  ViewVC Help
Powered by ViewVC 1.1.22