1 |
\subsection {PTRACERS Package} |
2 |
\label{sec:pkg:ptracers} |
3 |
\begin{rawhtml} |
4 |
<!-- CMIREDIR:package_ptracers: --> |
5 |
\end{rawhtml} |
6 |
|
7 |
\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} |
25 |
|
26 |
\subsubsection {Key subroutines and parameters} |
27 |
|
28 |
The only code you shoul dhave to modify is: |
29 |
{\bf PTRACERS\_SIZE.h} where you need to set in the number of tracers to |
30 |
be used in the experiment: PTRACERS\_num. |
31 |
|
32 |
\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 |
43 |
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} |
97 |
\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 |
103 |
\begin{verbatim} |
104 |
|
105 |
------------------------------------------------------------------------ |
106 |
<-Name->|Levs|<-parsing code->|<-- Units -->|<- Tile (max=80c) |
107 |
------------------------------------------------------------------------ |
108 |
TRAC01 | 15 |SM P MR |mol C/m |Mass-Weighted Dissolved Inorganic Carbon |
109 |
UTRAC01 | 15 |UU 171MR |mol C/m.m/s |Zonal Mass-Weighted Transp of Dissolved Inorganic Carbon |
110 |
VTRAC01 | 15 |VV 170MR |mol C/m.m/s |Merid Mass-Weighted Transp of Dissolved Inorganic Carbon |
111 |
WTRAC01 | 15 |WM MR |mol C/m.m/s |Vert Mass-Weighted Transp of Dissolved Inorganic Carbon |
112 |
ADVrTr01| 15 |WM LR |mol C/m.m^3/s |Vertical Advective Flux of Dissolved Inorganic Carbon |
113 |
ADVxTr01| 15 |UU 175MR |mol C/m.m^3/s |Zonal Advective Flux of Dissolved Inorganic Carbon |
114 |
ADVyTr01| 15 |VV 174MR |mol C/m.m^3/s |Meridional Advective Flux of Dissolved Inorganic Carbon |
115 |
DFrETr01| 15 |WM LR |mol C/m.m^3/s |Vertical Diffusive Flux of Dissolved Inorganic Carbon (Explicit part) |
116 |
DIFxTr01| 15 |UU 178MR |mol C/m.m^3/s |Zonal Diffusive Flux of Dissolved Inorganic Carbon |
117 |
DIFyTr01| 15 |VV 177MR |mol C/m.m^3/s |Meridional Diffusive Flux of Dissolved Inorganic Carbon |
118 |
DFrITr01| 15 |WM LR |mol C/m.m^3/s |Vertical Diffusive Flux of Dissolved Inorganic Carbon (Implicit part) |
119 |
TRAC02 | 15 |SM P MR |mol eq/ |Mass-Weighted Alkalinity |
120 |
UTRAC02 | 15 |UU 182MR |mol eq/.m/s |Zonal Mass-Weighted Transp of Alkalinity |
121 |
VTRAC02 | 15 |VV 181MR |mol eq/.m/s |Merid Mass-Weighted Transp of Alkalinity |
122 |
WTRAC02 | 15 |WM MR |mol eq/.m/s |Vert Mass-Weighted Transp of Alkalinity |
123 |
ADVrTr02| 15 |WM LR |mol eq/.m^3/s |Vertical Advective Flux of Alkalinity |
124 |
ADVxTr02| 15 |UU 186MR |mol eq/.m^3/s |Zonal Advective Flux of Alkalinity |
125 |
ADVyTr02| 15 |VV 185MR |mol eq/.m^3/s |Meridional Advective Flux of Alkalinity |
126 |
DFrETr02| 15 |WM LR |mol eq/.m^3/s |Vertical Diffusive Flux of Alkalinity (Explicit part) |
127 |
DIFxTr02| 15 |UU 189MR |mol eq/.m^3/s |Zonal Diffusive Flux of Alkalinity |
128 |
DIFyTr02| 15 |VV 188MR |mol eq/.m^3/s |Meridional Diffusive Flux of Alkalinity |
129 |
DFrITr02| 15 |WM LR |mol eq/.m^3/s |Vertical Diffusive Flux of Alkalinity (Implicit part) |
130 |
TRAC03 | 15 |SM P MR |mol P/m |Mass-Weighted Phosphate |
131 |
UTRAC03 | 15 |UU 193MR |mol P/m.m/s |Zonal Mass-Weighted Transp of Phosphate |
132 |
VTRAC03 | 15 |VV 192MR |mol P/m.m/s |Merid Mass-Weighted Transp of Phosphate |
133 |
WTRAC03 | 15 |WM MR |mol P/m.m/s |Vert Mass-Weighted Transp of Phosphate |
134 |
ADVrTr03| 15 |WM LR |mol P/m.m^3/s |Vertical Advective Flux of Phosphate |
135 |
ADVxTr03| 15 |UU 197MR |mol P/m.m^3/s |Zonal Advective Flux of Phosphate |
136 |
ADVyTr03| 15 |VV 196MR |mol P/m.m^3/s |Meridional Advective Flux of Phosphate |
137 |
DFrETr03| 15 |WM LR |mol P/m.m^3/s |Vertical Diffusive Flux of Phosphate (Explicit part) |
138 |
DIFxTr03| 15 |UU 200MR |mol P/m.m^3/s |Zonal Diffusive Flux of Phosphate |
139 |
------------------------------------------------------------------------ |
140 |
<-Name->|Levs|<-parsing code->|<-- Units -->|<- Tile (max=80c) |
141 |
------------------------------------------------------------------------ |
142 |
DIFyTr03| 15 |VV 199MR |mol P/m.m^3/s |Meridional Diffusive Flux of Phosphate |
143 |
DFrITr03| 15 |WM LR |mol P/m.m^3/s |Vertical Diffusive Flux of Phosphate (Implicit part) |
144 |
TRAC04 | 15 |SM P MR |mol P/m |Mass-Weighted Dissolved Organic Phosphorus |
145 |
UTRAC04 | 15 |UU 204MR |mol P/m.m/s |Zonal Mass-Weighted Transp of Dissolved Organic Phosphorus |
146 |
VTRAC04 | 15 |VV 203MR |mol P/m.m/s |Merid Mass-Weighted Transp of Dissolved Organic Phosphorus |
147 |
WTRAC04 | 15 |WM MR |mol P/m.m/s |Vert Mass-Weighted Transp of Dissolved Organic Phosphorus |
148 |
ADVrTr04| 15 |WM LR |mol P/m.m^3/s |Vertical Advective Flux of Dissolved Organic Phosphorus |
149 |
ADVxTr04| 15 |UU 208MR |mol P/m.m^3/s |Zonal Advective Flux of Dissolved Organic Phosphorus |
150 |
ADVyTr04| 15 |VV 207MR |mol P/m.m^3/s |Meridional Advective Flux of Dissolved Organic Phosphorus |
151 |
DFrETr04| 15 |WM LR |mol P/m.m^3/s |Vertical Diffusive Flux of Dissolved Organic Phosphorus (Explicit part) |
152 |
DIFxTr04| 15 |UU 211MR |mol P/m.m^3/s |Zonal Diffusive Flux of Dissolved Organic Phosphorus |
153 |
DIFyTr04| 15 |VV 210MR |mol P/m.m^3/s |Meridional Diffusive Flux of Dissolved Organic Phosphorus |
154 |
DFrITr04| 15 |WM LR |mol P/m.m^3/s |Vertical Diffusive Flux of Dissolved Organic Phosphorus (Implicit part) |
155 |
TRAC05 | 15 |SM P MR |mol O/m |Mass-Weighted Dissolved Oxygen |
156 |
UTRAC05 | 15 |UU 215MR |mol O/m.m/s |Zonal Mass-Weighted Transp of Dissolved Oxygen |
157 |
VTRAC05 | 15 |VV 214MR |mol O/m.m/s |Merid Mass-Weighted Transp of Dissolved Oxygen |
158 |
WTRAC05 | 15 |WM MR |mol O/m.m/s |Vert Mass-Weighted Transp of Dissolved Oxygen |
159 |
ADVrTr05| 15 |WM LR |mol O/m.m^3/s |Vertical Advective Flux of Dissolved Oxygen |
160 |
ADVxTr05| 15 |UU 219MR |mol O/m.m^3/s |Zonal Advective Flux of Dissolved Oxygen |
161 |
ADVyTr05| 15 |VV 218MR |mol O/m.m^3/s |Meridional Advective Flux of Dissolved Oxygen |
162 |
DFrETr05| 15 |WM LR |mol O/m.m^3/s |Vertical Diffusive Flux of Dissolved Oxygen (Explicit part) |
163 |
DIFxTr05| 15 |UU 222MR |mol O/m.m^3/s |Zonal Diffusive Flux of Dissolved Oxygen |
164 |
DIFyTr05| 15 |VV 221MR |mol O/m.m^3/s |Meridional Diffusive Flux of Dissolved Oxygen |
165 |
DFrITr05| 15 |WM LR |mol O/m.m^3/s |Vertical Diffusive Flux of Dissolved Oxygen (Implicit part) |
166 |
|
167 |
\end{verbatim} |
168 |
} |
169 |
|
170 |
\subsubsection{Do's and Don'ts} |
171 |
|
172 |
\subsubsection{Reference Material} |
173 |
|