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

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

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

revision 1.1 by stephd, Thu Jan 17 22:17:17 2008 UTC revision 1.3 by jahn, Tue Jan 18 20:38:16 2011 UTC
# Line 32  $\tau_T$. These are set in data.rbcs (se Line 32  $\tau_T$. These are set in data.rbcs (se
32    
33  \subsubsection {Key subroutines and parameters}  \subsubsection {Key subroutines and parameters}
34    
35  The only change need in the code might be in {RBCS.H}, for  The only change need in the code might be in {RBCS.h}, for
36  PARAMETER(maskLEN = 3 ), if you need more than 3  PARAMETER(maskLEN = 3 ), if you need more than 3
37  masks (see below).  masks (see below).
38    
# Line 43  There are runtime parameters Line 43  There are runtime parameters
43  set in {\it data.rbcs}:\\  set in {\it data.rbcs}:\\
44  These runtime options include\\  These runtime options include\\
45  Set in {RBCS\_PARM01}:\\  Set in {RBCS\_PARM01}:\\
46  $\bullet$ Parameters to set the timing for periodic fields to  %$\bullet$ Parameters to set the timing for periodic fields to
47  relax to are to  %relax to are to
48  be loaded are: {\it rbcs\_ForcingPeriod}, {\it rbcs\_ForcingCycle}.  %be loaded are:
49    $\bullet$ {\bf rbcsForcingPeriod}, {\bf rbcsForcingCycle}: timing of
50    fields to relax to.
51  The former is how often to load, the latter is how often to cycle  The former is how often to load, the latter is how often to cycle
52  through those fields (eg. period couple be monthly and cycle one year).  through those fields (eg. period could be monthly and cycle one year).
53  rbcs\_ForcingCycle=0 meaning no periodic forcing, and the relax field  rbcs\_ForcingCycle=0 means non-cyclic forcing, and
54    rbcs\_ForcingPeriod=0 non-time-varying forcing, where the relax field
55  is only read in at the beginning of the run and kept constant  is only read in at the beginning of the run and kept constant
56  the rest of the run. Default is 0.  the rest of the run. Default is 0.
57  \\  \\
58  $\bullet$  {\bf rbcsIniter}: if you want to offset rbcs forcing  $\bullet$  {\bf rbcsForcingOffset}: if you want to offset rbcs forcing
59  timing. Default is nIter0.\\  timing. This is the time at the beginning of the first forcing period
60    (in seconds).  Default is 0.  (This used to be rbcsInIter and was in
61    units of iterations.)\\
62    $\bullet$  {\bf rbcsSingleTimeFiles}: if true, relax fields are given
63    1 file per time labeled by iteration number.\\
64    $\bullet$  {\bf deltaTrbcs}: time step used to compute iteration numbers
65    for rbcsSingleTimeFiles.\\
66    $\bullet$  {\bf rbcsIter0}: rbcsSingleTimeFiles iteration number
67    corresponding to rbcsForcingOffset.\\
68  $\bullet$  {\bf useRBCtemp}: true or false (default false)\\  $\bullet$  {\bf useRBCtemp}: true or false (default false)\\
69  $\bullet$  {\bf useRBCsalt}: true or false (default false)\\  $\bullet$  {\bf useRBCsalt}: true or false (default false)\\
70  $\bullet$  {\bf useRBCptracers}: true or false (default false), must be using  $\bullet$  {\bf useRBCptracers}: true or false (default false), must be using
# Line 85  $\bullet$ {\bf tauRelaxPTR(iTrc)}: relax Line 96  $\bullet$ {\bf tauRelaxPTR(iTrc)}: relax
96  $\bullet$ {\bf relaxPtracerFile(iTrc)}: file with relax  $\bullet$ {\bf relaxPtracerFile(iTrc)}: file with relax
97  fields.\\  fields.\\
98    
99    \noindent
100    Typical ways of specifying timing of relaxation fields:
101    \begin{enumerate}
102    \item Constant-in-time forcing:
103      \begin{quote}
104         rbcsForcingPeriod = 0
105      \end{quote}
106      One field is read and used for all times.  Use this to emulate the result of
107      rbcsForcingCycle=0 before 2010-11-10.
108    
109    \item Non-cyclic time-varying forcing:
110      \begin{quote}
111         rbcsForcingPeriod = period in seconds\\
112         rbcsForcingCycle = 0\\
113         rbcsForcingOffset = beginning of first forcing period in seconds (default 0)
114      \end{quote}
115      When starting the run at time 0 (as usually the case), a period with center before
116      or at time 0 is needed for time interpolation, hence Offset needs to be negative.
117      For aligned periods (one period starting at time 0) and one extra record before
118      time 0 (and ending at time 0), set Offset=-Period.
119    
120      This option makes most sense with rbcsSingleTimeFiles=T (see below), but may be
121      used with either setting.
122    
123    \item Cyclic Forcing:
124      \begin{quote}
125         rbcsForcingPeriod = period in seconds\\
126         rbcsForcingCycle = cycle in seconds\\
127         rbcsForcingOffset = beginning of first forcing period in seconds (default 0)
128      \end{quote}
129      Here Offset may be at or after the start time (actually starttime-period/2),
130      in which case records from the end of the cycle are used for missing records at
131      the beginning (via cyclicity).  Not very nice, but works.
132    
133      This is the traditional way used with rbcsSingleTimeFiles=F, but again may be
134      used with either setting.
135    \end{enumerate}
136    
137    \noindent
138    Ways to organize the files:
139    \begin{enumerate}
140    \item One big file with many time records:
141      \begin{quote}
142         rbcsSingleTimeFiles = .False.
143      \end{quote}
144      All time records are in one big file.
145    
146    \item A separate file for each time:
147      \begin{quote}
148         rbcsSingleTimeFiles = .True.\\
149         deltaTrbcs = time step used to generate forcing files\\
150         rbcsIter0 = forcing file iteration number corresponding to rbcsForcingOffset
151      \end{quote}
152      The rbcs field for each time needed is in a separate file, labeled by the
153      iteration number at the end of the forcing period.  If a different timestep
154      was used for generating the files (and the file names), set deltaTrbcs.
155      If there is a shift in time, set rbcsIter0.
156    \end{enumerate}
157    
158    
159    
160  \subsubsection{Do's and Don'ts}  \subsubsection{Do's and Don'ts}
161    
# Line 95  fields.\\ Line 166  fields.\\
166    
167    
168    
169  \end{itemize}  %%% \end{itemize}
170    
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.22