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

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

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

revision 1.2 by stephd, Tue Jan 15 18:04:23 2008 UTC revision 1.3 by stephd, Thu Jan 17 19:33:32 2008 UTC
# Line 6  Line 6 
6    
7  \subsubsection {Introduction}  \subsubsection {Introduction}
8    
9    This is a "passive" tracer package. Passive here means that the
10    tracers don't affect the density of the water (as opposed to
11    temperature and salinity) so no not actively affect the
12    physics of the ocean. Tracers are initialized, advected, diffused
13    and various outputs are taken care of in this package.
14    For methods to add additional sources and sinks of tracers use the pkg/gchem
15    (section \ref{sec:pkg:gchem}).
16    
17    Can use up tp 3843 tracers. But can not use pkg/diagnostics with more
18    than about 90 tracers.
19    Use utils/matlab/ioLb2num.m and num2ioLb.m to find correspondence
20    between tracer number and tracer designation in the code for more
21    than 99 tracers (since
22    tracers only have two digit designations).
23    
24  \subsubsection {Equations}  \subsubsection {Equations}
25    
26  \subsubsection {Key subroutines and parameters}  \subsubsection {Key subroutines and parameters}
27    
28  Run time parameters  set in {\bf data.ptracders}:  The only code you shoul dhave to modify is:
29  $\bullet$ {\bf PTRACERS\_Iter0} which is the integer timestep when the tracer experiment  {\bf PTRACERS\_SIZE.h} where you need to set in the number of tracers to
30   is initialized. If {\bf nIter0} $=$ {\bf PTRACERS\_Iter0} then the tracers  be used in the experiment:  PTRACERS\_num.
31   are initialized to zero or from initial files. If {\bf nIter0} $>$  
32   {\bf PTRACERS\_Iter0} then tracers (and previous timestep tendency terms)  \vspace{.5cm}
33    
34    
35    \noindent
36    {bf RUN TIME PARAMETERS  SET IN {\bf data.ptracers}}: \\
37    $\bullet$ {\bf PTRACERS\_Iter0}
38    which is the integer timestep when the tracer experiment
39     is initialized. If  nIter0 $=$  PTRACERS\_Iter0 then the tracers
40     are initialized to zero or from initial files. If nIter0 $>$
41      PTRACERS\_Iter0 then tracers (and previous timestep tendency terms)
42    are read in from a the ptracers pickup file. Note that tracers    are read in from a the ptracers pickup file. Note that tracers
43    of zeros will be carried around if {\bf nIter0} $<$ {\bf PTRACERS\_Iter0}.    of zeros will be carried around if nIter0 $<$  PTRACERS\_Iter0.\\
44    $\bullet$ {\bf PTRACERS\_numInUse}: number of tracers to be used in the
45    run (needs to be $<=$ PTRACERS\_num set in PTRACERS\_SIZE.h)\\
46    $\bullet$  {\bf PTRACERS\_dumpFreq}: defaults to dumpFreq (set in data)\\
47    $\bullet$  {\bf PTRACERS\_taveFreq}: defaults to taveFreq (set in data)\\
48    $\bullet$  {\bf PTRACERS\_monitorFreq}: defaults to monitorFreq (set in data)\\
49    $\bullet$  {\bf PTRACERS\_timeave\_mnc}: needs useMNC, timeave\_mnc, default to false\\
50    $\bullet$  {\bf PTRACERS\_snapshot\_mnc}:  needs useMNC, snapshot\_mnc, default to false \\
51    $\bullet$  {\bf PTRACERS\_monitor\_mnc}: needs useMNC, monitor\_mnc, default to false\\
52    $\bullet$  {\bf PTRACERS\_pickup\_write\_mnc}:  needs useMNC, pickup\_write\_mnc, default to false\\
53    $\bullet$  {\bf PTRACERS\_pickup\_read\_mnc}: needs useMNC, pickup\_read\_mnc, default to false\\
54    $\bullet$  {\bf PTRACERS\_useRecords}: defaults to false. If true, will write
55    all tracers in a single file, otherwise each tracer in a seperate file.\\
56    
57    \vspace{.5cm}
58    
59    The following can be set for each tracer (tracer number iTrc):\\
60    $\bullet$  {\bf PTRACERS\_advScheme(iTrc)} will default to saltAdvScheme (set in data). For other options see Table \ref {tab:advectionShemes_summary}.\\
61    $\bullet$  {\bf PTRACERS\_ImplVertAdv(iTrc)}: implicit vertical advection flag,
62     default to .FALSE.\\
63    $\bullet$  {\bf PTRACERS\_diffKh(iTrc)}: horizontal Laplacian Diffusivity,
64    dafaults to diffKhS (set in data).\\
65    $\bullet$  {\bf PTRACERS\_diffK4(iTrc)}: Biharmonic Diffusivity, defaults to
66    diffK4S (set in data).\\
67    $\bullet$  {\bf PTRACERS\_diffKr(iTrc)}: vertical diffusion, defaults to un-set.\\
68    $\bullet$  {\bf PTRACERS\_diffKrNr(k,iTrc)}: level specific vertical diffusion,
69    defaults to diffKrNrS. Will be set to PTRACERS\_diffKr if this is set.\\
70    $\bullet$  {\bf PTRACERS\_ref(k,iTrc)}: reference tracer value for each level k,
71    defaults to 0. Currently only used for
72    dilution/concentration of tracers at surface if  PTRACERS\_EvPrRn(iTrc) is
73    set and convertFW2Salt (set in data) is set to something other than -1
74    (note default is convertFW2Salt=35).\\
75    $\bullet$  {\bf PTRACERS\_EvPrRn(iTrc)}: tracer concentration in freshwater.
76    Needed for calculation of dilution/concentration in surface layer due to
77    freshwater addition/evaporation. Defaults to un-set in which case no
78    dilution/concentration occurs.\\
79    $\bullet$  {\bf PTRACERS\_useGMRedi(iTrc)}: apply GM or not. Defaults to
80    useGMREdi.\\
81    $\bullet$  {\bf PTRACERS\_useKPP(iTrc)}: apply KPP or not. Defaults to
82    useKPP.\\
83    $\bullet$  {\bf PTRACERS\_initialFile(iTrc)}: file with initial tracer
84    concentration. Will be used if PTRACERS\_Iter0 $=$ nIter0. Default
85    is no name, in which case tracer is initialised as zero. If
86     PTRACERS\_Iter0 $<$ nIter0, then tracer concentration will come
87    from pickup\_ptracer.\\
88    $\bullet$  {\bf PTRACERS\_names(iTrc)}: tracer name. Needed for netcdf.
89    Defaults to nothing.\\
90    $\bullet$  {\bf PTRACERS\_long\_names(iTrc)}: optional name in long form
91    of tracer.\\
92    $\bullet$  {\bf PTRACERS\_units(iTrc)}: optional units of tracer.
93  \\  \\
94    
95    
96  \subsubsection{PTRACERS Diagnostics}  \subsubsection{PTRACERS Diagnostics}
97  \label{sec:pkg:ptracers:diagnostics}  \label{sec:pkg:ptracers:diagnostics}
98    
99    Note that these will only work for 90 or less tracers (some
100    problems with the numbering/designation over this number)
101    
102  {\footnotesize  {\footnotesize
103  \begin{verbatim}  \begin{verbatim}
104    
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.22