\hypertarget{structoil__tracer_1_1oil__tracer__cs}{}\section{oil\+\_\+tracer\+::oil\+\_\+tracer\+\_\+cs Type Reference}
\label{structoil__tracer_1_1oil__tracer__cs}\index{oil\_tracer::oil\_tracer\_cs@{oil\_tracer::oil\_tracer\_cs}}


\subsection{Detailed Description}
The control structure for the oil tracer package. 

Definition at line 38 of file oil\+\_\+tracer.\+F90.



Collaboration diagram for oil\+\_\+tracer\+::oil\+\_\+tracer\+\_\+cs\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structoil__tracer_1_1oil__tracer__cs__coll__graph}
\end{center}
\end{figure}
\subsection*{Public variables and constants}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_ac9f7d966b2cc238867f953db52638a7f}\label{structoil__tracer_1_1oil__tracer__cs_ac9f7d966b2cc238867f953db52638a7f}} 
integer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_ac9f7d966b2cc238867f953db52638a7f}{ntr}}
\begin{DoxyCompactList}\small\item\em The number of tracers that are actually used. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_af18ed08625d05cba2a538ff80519c2db}\label{structoil__tracer_1_1oil__tracer__cs_af18ed08625d05cba2a538ff80519c2db}} 
logical \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_af18ed08625d05cba2a538ff80519c2db}{coupled\+\_\+tracers}} = .false.
\begin{DoxyCompactList}\small\item\em These tracers are not offered to the coupler. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_aca5db27de13b5e7899189854555515ba}\label{structoil__tracer_1_1oil__tracer__cs_aca5db27de13b5e7899189854555515ba}} 
character(len=200) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_aca5db27de13b5e7899189854555515ba}{ic\+\_\+file}}
\begin{DoxyCompactList}\small\item\em The file in which the age-\/tracer initial values can be found, or an empty string for internal initialization. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a06bf3d3d978d92070eac0d72fe06423c}\label{structoil__tracer_1_1oil__tracer__cs_a06bf3d3d978d92070eac0d72fe06423c}} 
logical \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a06bf3d3d978d92070eac0d72fe06423c}{z\+\_\+ic\+\_\+file}}
\begin{DoxyCompactList}\small\item\em If true, the I\+C\+\_\+file is in Z-\/space. The default is false. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a74b5da542a5a30cf89d9a0be4aa8da20}\label{structoil__tracer_1_1oil__tracer__cs_a74b5da542a5a30cf89d9a0be4aa8da20}} 
real \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a74b5da542a5a30cf89d9a0be4aa8da20}{oil\+\_\+source\+\_\+longitude}}
\begin{DoxyCompactList}\small\item\em Latitude of source location (geographic) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a27ae2daf72f728b916f955e01fa32f90}\label{structoil__tracer_1_1oil__tracer__cs_a27ae2daf72f728b916f955e01fa32f90}} 
real \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a27ae2daf72f728b916f955e01fa32f90}{oil\+\_\+source\+\_\+latitude}}
\begin{DoxyCompactList}\small\item\em Longitude of source location (geographic) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a33a7f7dc9a1115c0793ed370c7097205}\label{structoil__tracer_1_1oil__tracer__cs_a33a7f7dc9a1115c0793ed370c7097205}} 
integer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a33a7f7dc9a1115c0793ed370c7097205}{oil\+\_\+source\+\_\+i}} =-\/999
\begin{DoxyCompactList}\small\item\em Local i of source location (computational) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_afa5d30170ecbd6ec50738fa9f12eb956}\label{structoil__tracer_1_1oil__tracer__cs_afa5d30170ecbd6ec50738fa9f12eb956}} 
integer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_afa5d30170ecbd6ec50738fa9f12eb956}{oil\+\_\+source\+\_\+j}} =-\/999
\begin{DoxyCompactList}\small\item\em Local j of source location (computational) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a65b170eb3dc9190cc003b759757d31f7}\label{structoil__tracer_1_1oil__tracer__cs_a65b170eb3dc9190cc003b759757d31f7}} 
real \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a65b170eb3dc9190cc003b759757d31f7}{oil\+\_\+source\+\_\+rate}}
\begin{DoxyCompactList}\small\item\em Rate of oil injection \mbox{[}kg T-\/1 $\sim$$>$ kg s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_ac44d97a388e116c6679a55b8e3f00699}\label{structoil__tracer_1_1oil__tracer__cs_ac44d97a388e116c6679a55b8e3f00699}} 
real \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_ac44d97a388e116c6679a55b8e3f00699}{oil\+\_\+start\+\_\+year}}
\begin{DoxyCompactList}\small\item\em The year in which tracers start aging, or at which the surface value equals young\+\_\+val, in years. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_aef3a186b97e1be605367772935dc3440}\label{structoil__tracer_1_1oil__tracer__cs_aef3a186b97e1be605367772935dc3440}} 
real \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_aef3a186b97e1be605367772935dc3440}{oil\+\_\+end\+\_\+year}}
\begin{DoxyCompactList}\small\item\em The year in which tracers start aging, or at which the surface value equals young\+\_\+val, in years. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a064d1578316998073997a90af328ca8d}\label{structoil__tracer_1_1oil__tracer__cs_a064d1578316998073997a90af328ca8d}} 
type(time\+\_\+type), pointer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a064d1578316998073997a90af328ca8d}{time}} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em A pointer to the ocean model\textquotesingle{}s clock. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a460b8f653915a215718841abe226f54b}\label{structoil__tracer_1_1oil__tracer__cs_a460b8f653915a215718841abe226f54b}} 
type(tracer\+\_\+registry\+\_\+type), pointer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a460b8f653915a215718841abe226f54b}{tr\+\_\+reg}} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em A pointer to the M\+OM tracer registry. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a315c7bd000e54fcb8f02e6df5cb08895}\label{structoil__tracer_1_1oil__tracer__cs_a315c7bd000e54fcb8f02e6df5cb08895}} 
real, dimension(\+:,\+:,\+:,\+:), pointer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a315c7bd000e54fcb8f02e6df5cb08895}{tr}} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em The array of tracers used in this subroutine, in g m-\/3? \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a4b0ade7abfc29eb15ad0997734d8856b}\label{structoil__tracer_1_1oil__tracer__cs_a4b0ade7abfc29eb15ad0997734d8856b}} 
real, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a4b0ade7abfc29eb15ad0997734d8856b}{ic\+\_\+val}} = 0.\+0
\begin{DoxyCompactList}\small\item\em The (uniform) initial condition value. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_acc38b33229ad359df4a1adb1010fcc6f}\label{structoil__tracer_1_1oil__tracer__cs_acc38b33229ad359df4a1adb1010fcc6f}} 
real, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_acc38b33229ad359df4a1adb1010fcc6f}{young\+\_\+val}} = 0.\+0
\begin{DoxyCompactList}\small\item\em The value assigned to tr at the surface. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_ac69392d89ff855913364dadf7ad64772}\label{structoil__tracer_1_1oil__tracer__cs_ac69392d89ff855913364dadf7ad64772}} 
real, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_ac69392d89ff855913364dadf7ad64772}{land\+\_\+val}} = -\/1.\+0
\begin{DoxyCompactList}\small\item\em The value of tr used where land is masked out. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a7f8d5797303572dab3953025e987fe36}\label{structoil__tracer_1_1oil__tracer__cs_a7f8d5797303572dab3953025e987fe36}} 
real, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a7f8d5797303572dab3953025e987fe36}{sfc\+\_\+growth\+\_\+rate}}
\begin{DoxyCompactList}\small\item\em The exponential growth rate for the surface value \mbox{[}year-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a7f724027d4521b12740e4f61213accf3}\label{structoil__tracer_1_1oil__tracer__cs_a7f724027d4521b12740e4f61213accf3}} 
real, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a7f724027d4521b12740e4f61213accf3}{oil\+\_\+decay\+\_\+days}}
\begin{DoxyCompactList}\small\item\em Decay time scale of oil \mbox{[}days\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a41b187837656466a85f4ccb40ae790e5}\label{structoil__tracer_1_1oil__tracer__cs_a41b187837656466a85f4ccb40ae790e5}} 
real, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a41b187837656466a85f4ccb40ae790e5}{oil\+\_\+decay\+\_\+rate}}
\begin{DoxyCompactList}\small\item\em Decay rate of oil \mbox{[}T-\/1 $\sim$$>$ s-\/1\mbox{]} calculated from oil\+\_\+decay\+\_\+days. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_adc1bbe9bec8ccb1069fabbba51c0c2a1}\label{structoil__tracer_1_1oil__tracer__cs_adc1bbe9bec8ccb1069fabbba51c0c2a1}} 
integer, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_adc1bbe9bec8ccb1069fabbba51c0c2a1}{oil\+\_\+source\+\_\+k}}
\begin{DoxyCompactList}\small\item\em Layer of source. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_aa7cadb302938496d5d206756eaa41e6a}\label{structoil__tracer_1_1oil__tracer__cs_aa7cadb302938496d5d206756eaa41e6a}} 
logical \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_aa7cadb302938496d5d206756eaa41e6a}{oil\+\_\+may\+\_\+reinit}}
\begin{DoxyCompactList}\small\item\em If true, oil tracers may be reset by the initialization code if they are not found in the restart files. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a81a952fb3df3ab55abca38ea6cb27d20}\label{structoil__tracer_1_1oil__tracer__cs_a81a952fb3df3ab55abca38ea6cb27d20}} 
integer, dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a81a952fb3df3ab55abca38ea6cb27d20}{ind\+\_\+tr}}
\begin{DoxyCompactList}\small\item\em Indices returned by aof\+\_\+set\+\_\+coupler\+\_\+flux if it is used and the surface tracer concentrations are to be provided to the coupler. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a26fe3195514daedad70eb6faad9a03de}\label{structoil__tracer_1_1oil__tracer__cs_a26fe3195514daedad70eb6faad9a03de}} 
type(vardesc), dimension(\mbox{\hyperlink{namespaceoil__tracer_a7d9cefa818e16dd56e1051c3bcff940f}{ntr\+\_\+max}}) \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a26fe3195514daedad70eb6faad9a03de}{tr\+\_\+desc}}
\begin{DoxyCompactList}\small\item\em Descriptions and metadata for the tracers. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_a7662cc42c6829c7f4d8f0ef6d7cebe3f}\label{structoil__tracer_1_1oil__tracer__cs_a7662cc42c6829c7f4d8f0ef6d7cebe3f}} 
type(diag\+\_\+ctrl), pointer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_a7662cc42c6829c7f4d8f0ef6d7cebe3f}{diag}} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em A structure that is used to regulate the timing of diagnostic output. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structoil__tracer_1_1oil__tracer__cs_ab0f6c16e45d0b9506ae9551df91f2532}\label{structoil__tracer_1_1oil__tracer__cs_ab0f6c16e45d0b9506ae9551df91f2532}} 
type(mom\+\_\+restart\+\_\+cs), pointer \mbox{\hyperlink{structoil__tracer_1_1oil__tracer__cs_ab0f6c16e45d0b9506ae9551df91f2532}{restart\+\_\+csp}} =$>$ N\+U\+LL()
\begin{DoxyCompactList}\small\item\em A pointer to the restart control structure. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
The control structure for the oil tracer package. 

Definition at line 38 of file oil\+\_\+tracer.\+F90.



The documentation for this type was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/home/cermak/src/\+M\+O\+M6.\+devrob/src/tracer/oil\+\_\+tracer.\+F90\end{DoxyCompactItemize}