/[MITgcm]/manual/s_phys_pkgs/text/exch2.tex
ViewVC logotype

Diff of /manual/s_phys_pkgs/text/exch2.tex

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

revision 1.19 by afe, Mon May 10 21:39:11 2004 UTC revision 1.20 by edhill, Tue Oct 12 15:47:40 2004 UTC
# Line 44  file for single-processor execution. Line 44  file for single-processor execution.
44  \subsection{Invoking exch2}  \subsection{Invoking exch2}
45    
46  To use exch2 with the cubed sphere, the following conditions must be  To use exch2 with the cubed sphere, the following conditions must be
47  met: \\  met:
48    
49  $\bullet$ The exch2 package is included when \file{genmake2} is run.  \begin{itemize}
50    The easiest way to do this is to add the line \code{exch2} to the  \item The exch2 package is included when \file{genmake2} is run.  The
51    \file{profile.conf} file -- see Section    easiest way to do this is to add the line \code{exch2} to the
52    \ref{sect:buildingCode} \sectiontitle{Building the code} for general    \file{profile.conf} file -- see Section \ref{sect:buildingCode}
53    details. \\    \sectiontitle{Building the code} for general details.
54      
55  $\bullet$ An example of \file{W2\_EXCH2\_TOPOLOGY.h} and  \item An example of \file{W2\_EXCH2\_TOPOLOGY.h} and
56    \file{w2\_e2setup.F} must reside in a directory containing files    \file{w2\_e2setup.F} must reside in a directory containing files
57    symbolically linked by the \file{genmake2} script.  The safest place to    symbolically linked by the \file{genmake2} script.  The safest place
58    put these is the directory indicated in the \code{-mods=DIR} command    to put these is the directory indicated in the \code{-mods=DIR}
59    line modifier (typically \file{../code}), or the build directory.    command line modifier (typically \file{../code}), or the build
60    The default versions of these files reside in \file{pkg/exch2} and    directory.  The default versions of these files reside in
61    are linked automatically if no other versions exist elsewhere in the    \file{pkg/exch2} and are linked automatically if no other versions
62    build path, but they should be left untouched to avoid breaking    exist elsewhere in the build path, but they should be left untouched
63    configurations other than the one you intend to modify.\\    to avoid breaking configurations other than the one you intend to
64      modify.
65  $\bullet$ Files containing grid parameters, named    
66    \file{tile00$n$.mitgrid} where $n$=\code{(1:6)} (one per subdomain),  \item Files containing grid parameters, named \file{tile00$n$.mitgrid}
67    must be in the working directory when the MITgcm executable is run.    where $n$=\code{(1:6)} (one per subdomain), must be in the working
68    These files are provided in the example experiments for cubed sphere    directory when the MITgcm executable is run.  These files are
69    configurations with 32$\times$32 cube sides    provided in the example experiments for cubed sphere configurations
70    -- please contact MITgcm support if you want to generate    with 32$\times$32 cube sides -- please contact
71    files for other configurations. \\    \begin{rawhtml}
72        <A href=''mailto:mitgcm-support@dev.mitgcm.org">
73  $\bullet$ As always when compiling MITgcm, the file \file{SIZE.h} must    \end{rawhtml}
74    be placed where \file{genmake2} will find it.  In particular for  \begin{verbatim}
75    exch2, the domain decomposition specified in \file{SIZE.h} must  MITgcm-support@mitgcm.org
76    correspond with the particular configuration's topology specified in  \end{verbatim}
77      \begin{rawhtml} </A> \end{rawhtml}
78      if you want to generate files for other configurations.
79      
80    \item As always when compiling MITgcm, the file \file{SIZE.h} must be
81      placed where \file{genmake2} will find it.  In particular for exch2,
82      the domain decomposition specified in \file{SIZE.h} must correspond
83      with the particular configuration's topology specified in
84    \file{W2\_EXCH2\_TOPOLOGY.h} and \file{w2\_e2setup.F}.  Domain    \file{W2\_EXCH2\_TOPOLOGY.h} and \file{w2\_e2setup.F}.  Domain
85    decomposition issues particular to exch2 are addressed in Section    decomposition issues particular to exch2 are addressed in Section
86    \ref{sec:topogen} \sectiontitle{Generating Topology Files for exch2}    \ref{sec:topogen} \sectiontitle{Generating Topology Files for exch2}
87    and \ref{sec:exch2mpi} \sectiontitle{exch2, SIZE.h, and Multiprocessing}; a more    and \ref{sec:exch2mpi} \sectiontitle{exch2, SIZE.h, and
88    general background on the subject relevant to MITgcm is presented in      Multiprocessing}; a more general background on the subject
89    Section \ref{sect:specifying_a_decomposition}    relevant to MITgcm is presented in Section
90    \sectiontitle{Specifying a decomposition}.\\    \ref{sect:specifying_a_decomposition} \sectiontitle{Specifying a
91        decomposition}.
92    \end{itemize}
93    
94    
95    
96  At the time of this writing the following examples use exch2 and may  At the time of this writing the following examples use exch2 and may
97  be used for guidance:  be used for guidance:
# Line 300  equal \code{1} throughout the package. \ Line 311  equal \code{1} throughout the package. \
311    
312  The following arrays are of length \code{NTILES} and are indexed to  The following arrays are of length \code{NTILES} and are indexed to
313  the tile number, which is indicated in the diagrams with the notation  the tile number, which is indicated in the diagrams with the notation
314  \textsf{t}$n$.  The indices are omitted in the descriptions. \\  \code{tn}.  The indices are omitted in the descriptions. \\
315    
316  The arrays \varlink{exch2\_tnx}{exch2_tnx} and  The arrays \varlink{exch2\_tnx}{exch2_tnx} and
317  \varlink{exch2\_tny}{exch2_tny} express the $x$ and $y$ dimensions of  \varlink{exch2\_tny}{exch2_tny} express the $x$ and $y$ dimensions of
# Line 328  files. \\ Line 339  files. \\
339    
340  The array \varlink{exch2\_myFace}{exch2_myFace} contains the number of  The array \varlink{exch2\_myFace}{exch2_myFace} contains the number of
341  the subdomain of each tile, in a range \code{(1:6)} in the case of the  the subdomain of each tile, in a range \code{(1:6)} in the case of the
342  standard cube topology and indicated by \textbf{\textsf{f}}$n$ in  standard cube topology and indicated by \textbf{\textsf{fn}} in
343  figures \ref{fig:12tile} and  figures \ref{fig:12tile} and \ref{fig:24tile}. The
344  \ref{fig:24tile}. \varlink{exch2\_nNeighbours}{exch2_nNeighbours}  \varlink{exch2\_nNeighbours}{exch2_nNeighbours} variable contains a
345  contains a count of the neighboring tiles each tile has, and sets  count of the neighboring tiles each tile has, and sets the bounds for
346  the bounds for looping over neighboring tiles.  looping over neighboring tiles.  And
347  \varlink{exch2\_tProc}{exch2_tProc} holds the process rank of each  \varlink{exch2\_tProc}{exch2_tProc} holds the process rank of each
348  tile, and is used in interprocess communication.  \\  tile, and is used in interprocess communication.  \\
349    
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.20
  ViewVC Help
Powered by ViewVC 1.1.22