/[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.7 by edhill, Fri Apr 2 15:56:02 2004 UTC revision 1.10 by edhill, Mon Jul 5 16:35: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 137  dimensions.  The second function call wi Line 137  dimensions.  The second function call wi
137  necessary, the current time level within the model.  necessary, the current time level within the model.
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/initialise\_fixed.F}{model-src-initialise_fixed.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
145          CALL MNC_CW_ADD_VNAME(myThid, 'iter', '-_-_--__-__t', 0,0)        CALL MNC_CW_ADD_VNAME('iter', '-_-_--__-__t', 0,0, myThid)
146          CALL MNC_CW_ADD_VATTR_TEXT(myThid,'iter',1,        CALL MNC_CW_ADD_VATTR_TEXT('iter',1,
147         &     'long_name','iteration_count')       &     'long_name','iteration_count', myThid)
148          CALL MNC_CW_ADD_VNAME(myThid, 'U', 'U_xy_Hn__C__t', 4,5)  
149          CALL MNC_CW_ADD_VATTR_TEXT(myThid,'U',1,'units','m/s')        CALL MNC_CW_ADD_VNAME('model_time', '-_-_--__-__t', 0,0, myThid)
150          CALL MNC_CW_ADD_VATTR_TEXT('model_time',1,
151         &     'long_name','Model Time', myThid)
152          CALL MNC_CW_ADD_VATTR_TEXT('model_time',1,'units','s', myThid)
153    
154          CALL MNC_CW_ADD_VNAME('U', 'U_xy_Hn__C__t', 4,5, myThid)
155          CALL MNC_CW_ADD_VATTR_TEXT('U',1,'units','m/s', myThid)
156          CALL MNC_CW_ADD_VATTR_TEXT('U',1,
157         &     'coordinates','XU YU RC iter', myThid)
158    
159          CALL MNC_CW_ADD_VNAME('T', 'Cen_xy_Hn__C__t', 4,5, myThid)
160          CALL MNC_CW_ADD_VATTR_TEXT('T',1,'units','degC', myThid)
161          CALL MNC_CW_ADD_VATTR_TEXT('T',1,'long_name',
162         &     'potential_temperature', myThid)
163          CALL MNC_CW_ADD_VATTR_TEXT('T',1,
164         &     '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 the DYNVARS.h variables using the MNC package  C       Write dynvars using the MNC package
177          mnc_iter = myIter          CALL MNC_CW_SET_UDIM('state', -1, myThid)
178          CALL MNC_CW_RL_W_R(myThid,'state',0,0,'iter',-1,mnc_iter)          CALL MNC_CW_I_W('I','state',0,0,'iter', myIter, myThid)
179          CALL MNC_CW_RL_W_D(myThid,'state',0,0,'U', 0, uVel)          CALL MNC_CW_SET_UDIM('state', 0, myThid)
180            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)
182            CALL MNC_CW_RL_W('D','state',0,0,'T', theta, myThid)
183  \end{verbatim}  \end{verbatim}
184  }  }
185    
186    
187  \subsection{Key subroutines, parameters and files}  \subsubsection{Parameters}
   
 All of the variables used to implement the lookup tables are described  
 in \filelink{model/src/write\_state.F}{model-src-write_state.F}  
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}  %\subsection{Package Reference}
227    
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.10
  ViewVC Help
Powered by ViewVC 1.1.22