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