/[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.9 by edhill, Tue Apr 6 16:48:33 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_RL_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    All the MNC parameters are contained within a file named
190    \texttt{data.mnc}.  If this file does not exist, then the MNC package
191    will interpret that as an indication that it is not to be used.  If
192    the \texttt{data.mnc} does exist, then it may contain the following
193    parameters:
194    
195    \begin{center}
196      {\footnotesize
197        \begin{tabular}[htb]{|l|l|l|l|}\hline
198          &  &  &  \\
199          \textbf{Name}  &  \textbf{Type}  &  
200          \textbf{Default}  &  \textbf{Description}  \\\hline
201          &  &  &  \\
202          \texttt{useMNC}  &  Logical  & \texttt{.FALSE.}  &  
203          \textbf{overall MNC ON/OFF switch}  \\
204          \texttt{mnc\_echo\_gvtypes}  &  Logical  & \texttt{.FALSE.}  &  
205          echo pre-defined ``types'' to STDOUT?   \\
206          \texttt{mnc\_use\_outdir}  &  Logical  & \texttt{.FALSE.}  &  
207          create a directory for output?  \\
208          \texttt{mnc\_outdir\_str}  &  String  & \texttt{'mnc\_'}  &  
209          output directory name \\
210          \texttt{mnc\_outdir\_date}  &  Logical  & \texttt{.FALSE.}  &  
211          embed date in output directory name?  \\
212          \texttt{mnc\_pickup\_write}  &  Logical  & \texttt{.FALSE.}  &  
213          use MNC to write (create) pickup files?  \\
214          \texttt{mnc\_pickup\_read}  &  Logical  & \texttt{.FALSE.}  &  
215          use MNC to read pickup files?  \\
216          \texttt{mnc\_use\_indir}  &  Logical  & \texttt{.FALSE.}  &  
217          use a directory (path) for input?  \\
218          \texttt{mnc\_indir\_str}  &  String  & \texttt{''}  &  
219          input directory (or path) name  \\
220          \texttt{mnc\_use\_for\_mon}  &  Logical  & \texttt{.FALSE.}  &  
221          write \texttt{monitor} output using MNC?  \\\hline
222        \end{tabular}
223      }
224    \end{center}
225    
226    %\subsection{Package Reference}
227    
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.9
  ViewVC Help
Powered by ViewVC 1.1.22