\hypertarget{namespacebaroclinic__zone__initialization}{}\doxysection{baroclinic\+\_\+zone\+\_\+initialization Module Reference} \label{namespacebaroclinic__zone__initialization}\index{baroclinic\_zone\_initialization@{baroclinic\_zone\_initialization}} \doxysubsection{Detailed Description} Initial conditions for an idealized baroclinic zone. \hypertarget{namespacebaroclinic__zone__initialization_section_baroclinic_zone}{}\doxysubsection{Description of the baroclinic zone initial conditions}\label{namespacebaroclinic__zone__initialization_section_baroclinic_zone} yada yada yada \doxysubsection*{Functions/\+Subroutines} \begin{DoxyCompactItemize} \item subroutine \mbox{\hyperlink{namespacebaroclinic__zone__initialization_ae61a49364522c0a98058b170932974dc}{bcz\+\_\+params}} (G, GV, US, param\+\_\+file, S\+\_\+ref, d\+Sdz, delta\+\_\+S, d\+Sdx, T\+\_\+ref, d\+Tdz, delta\+\_\+T, d\+Tdx, L\+\_\+zone, just\+\_\+read\+\_\+params) \begin{DoxyCompactList}\small\item\em Reads the parameters unique to this module. \end{DoxyCompactList}\item subroutine, public \mbox{\hyperlink{namespacebaroclinic__zone__initialization_a00eea273e33b70e67bc8df9a5e2b8793}{baroclinic\+\_\+zone\+\_\+init\+\_\+temperature\+\_\+salinity}} (T, S, h, G, GV, US, param\+\_\+file, just\+\_\+read\+\_\+params) \begin{DoxyCompactList}\small\item\em Initialization of temperature and salinity with the baroclinic zone initial conditions. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection*{Variables} \begin{DoxyCompactItemize} \item \mbox{\Hypertarget{namespacebaroclinic__zone__initialization_a28cab2b958411c14f4ae24bc83f8faee}\label{namespacebaroclinic__zone__initialization_a28cab2b958411c14f4ae24bc83f8faee}} character(len=40) \mbox{\hyperlink{namespacebaroclinic__zone__initialization_a28cab2b958411c14f4ae24bc83f8faee}{mdl}} = \char`\"{}baroclinic\+\_\+zone\+\_\+initialization\char`\"{} \begin{DoxyCompactList}\small\item\em This module\textquotesingle{}s name. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection{Function/\+Subroutine Documentation} \mbox{\Hypertarget{namespacebaroclinic__zone__initialization_a00eea273e33b70e67bc8df9a5e2b8793}\label{namespacebaroclinic__zone__initialization_a00eea273e33b70e67bc8df9a5e2b8793}} \index{baroclinic\_zone\_initialization@{baroclinic\_zone\_initialization}!baroclinic\_zone\_init\_temperature\_salinity@{baroclinic\_zone\_init\_temperature\_salinity}} \index{baroclinic\_zone\_init\_temperature\_salinity@{baroclinic\_zone\_init\_temperature\_salinity}!baroclinic\_zone\_initialization@{baroclinic\_zone\_initialization}} \doxysubsubsection{\texorpdfstring{baroclinic\_zone\_init\_temperature\_salinity()}{baroclinic\_zone\_init\_temperature\_salinity()}} {\footnotesize\ttfamily subroutine, public baroclinic\+\_\+zone\+\_\+initialization\+::baroclinic\+\_\+zone\+\_\+init\+\_\+temperature\+\_\+salinity (\begin{DoxyParamCaption}\item[{real, dimension(szi\+\_\+(g),szj\+\_\+(g), szk\+\_\+(g)), intent(out)}]{T, }\item[{real, dimension(szi\+\_\+(g),szj\+\_\+(g), szk\+\_\+(g)), intent(out)}]{S, }\item[{real, dimension(szi\+\_\+(g),szj\+\_\+(g), szk\+\_\+(g)), intent(in)}]{h, }\item[{type(ocean\+\_\+grid\+\_\+type), intent(in)}]{G, }\item[{type(verticalgrid\+\_\+type), intent(in)}]{GV, }\item[{type(unit\+\_\+scale\+\_\+type), intent(in)}]{US, }\item[{type(param\+\_\+file\+\_\+type), intent(in)}]{param\+\_\+file, }\item[{logical, intent(in), optional}]{just\+\_\+read\+\_\+params }\end{DoxyParamCaption})} Initialization of temperature and salinity with the baroclinic zone initial conditions. \begin{DoxyParams}[1]{Parameters} \mbox{\texttt{ in}} & {\em g} & Grid structure \\ \hline \mbox{\texttt{ in}} & {\em gv} & The ocean\textquotesingle{}s vertical grid structure. \\ \hline \mbox{\texttt{ in}} & {\em us} & A dimensional unit scaling type \\ \hline \mbox{\texttt{ out}} & {\em t} & Potential temperature \mbox{[}degC\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em s} & Salinity \mbox{[}ppt\mbox{]} \\ \hline \mbox{\texttt{ in}} & {\em h} & The model thicknesses \mbox{[}H $\sim$$>$ m or kg m-\/2\mbox{]} \\ \hline \mbox{\texttt{ in}} & {\em param\+\_\+file} & Parameter file handle \\ \hline \mbox{\texttt{ in}} & {\em just\+\_\+read\+\_\+params} & If present and true, this call will only read parameters without changing T \& S. \\ \hline \end{DoxyParams} Definition at line 78 of file baroclinic\+\_\+zone\+\_\+initialization.\+F90. \begin{DoxyCode}{0} \DoxyCodeLine{80 \textcolor{keywordtype}{type}(ocean\_grid\_type), \textcolor{keywordtype}{intent(in)} :: G\textcolor{comment}{ !< Grid structure}} \DoxyCodeLine{81 \textcolor{keywordtype}{type}(verticalGrid\_type), \textcolor{keywordtype}{intent(in)} :: GV\textcolor{comment}{ !< The ocean's vertical grid structure.}} \DoxyCodeLine{82 \textcolor{keywordtype}{type}(unit\_scale\_type), \textcolor{keywordtype}{intent(in)} :: US\textcolor{comment}{ !< A dimensional unit scaling type}} \DoxyCodeLine{83 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(SZI\_(G),SZJ\_(G), SZK\_(G))}, \textcolor{keywordtype}{intent(out)} :: T\textcolor{comment}{ !< Potential temperature [degC]}} \DoxyCodeLine{84 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(SZI\_(G),SZJ\_(G), SZK\_(G))}, \textcolor{keywordtype}{intent(out)} :: S\textcolor{comment}{ !< Salinity [ppt]}} \DoxyCodeLine{85 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(SZI\_(G),SZJ\_(G), SZK\_(G))}, \textcolor{keywordtype}{intent(in)} :: h\textcolor{comment}{ !< The model thicknesses [H \string~> m or kg m-\/2]}} \DoxyCodeLine{86 \textcolor{keywordtype}{type}(param\_file\_type), \textcolor{keywordtype}{intent(in)} :: param\_file\textcolor{comment}{ !< Parameter file handle}} \DoxyCodeLine{87 \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: just\_read\_params\textcolor{comment}{ !< If present and true, this call will}} \DoxyCodeLine{88 \textcolor{comment}{ !! only read parameters without changing T \& S.}} \DoxyCodeLine{89 } \DoxyCodeLine{90 \textcolor{keywordtype}{integer} :: i, j, k, is, ie, js, je, nz} \DoxyCodeLine{91 \textcolor{keywordtype}{ real} :: T\_ref, dTdz, dTdx, delta\_T \textcolor{comment}{! Parameters describing temperature distribution}} \DoxyCodeLine{92 \textcolor{keywordtype}{ real} :: S\_ref, dSdz, dSdx, delta\_S \textcolor{comment}{! Parameters describing salinity distribution}} \DoxyCodeLine{93 \textcolor{keywordtype}{ real} :: L\_zone \textcolor{comment}{! Width of baroclinic zone in [G\%axis\_units]}} \DoxyCodeLine{94 \textcolor{keywordtype}{ real} :: zc, zi \textcolor{comment}{! Depths in depth units [Z \string~> m]}} \DoxyCodeLine{95 \textcolor{keywordtype}{ real} :: x, xd, xs, y, yd, fn} \DoxyCodeLine{96 \textcolor{keywordtype}{ real} :: PI \textcolor{comment}{! 3.1415926... calculated as 4*atan(1)}} \DoxyCodeLine{97 \textcolor{keywordtype}{logical} :: just\_read \textcolor{comment}{! If true, just read parameters but set nothing.}} \DoxyCodeLine{98 } \DoxyCodeLine{99 is = g\%isc ; ie = g\%iec ; js = g\%jsc ; je = g\%jec ; nz = g\%ke} \DoxyCodeLine{100 just\_read = .false. ; \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(just\_read\_params)) just\_read = just\_read\_params} \DoxyCodeLine{101 } \DoxyCodeLine{102 \textcolor{keyword}{call }bcz\_params(g, gv, us, param\_file, s\_ref, dsdz, delta\_s, dsdx, t\_ref, dtdz, \&} \DoxyCodeLine{103 delta\_t, dtdx, l\_zone, just\_read\_params)} \DoxyCodeLine{104 } \DoxyCodeLine{105 \textcolor{keywordflow}{if} (just\_read) \textcolor{keywordflow}{return} \textcolor{comment}{! All run-\/time parameters have been read, so return.}} \DoxyCodeLine{106 } \DoxyCodeLine{107 t(:,:,:) = 0.} \DoxyCodeLine{108 s(:,:,:) = 0.} \DoxyCodeLine{109 pi = 4.*atan(1.)} \DoxyCodeLine{110 } \DoxyCodeLine{111 \textcolor{keywordflow}{do} j = g\%jsc,g\%jec ; \textcolor{keywordflow}{do} i = g\%isc,g\%iec} \DoxyCodeLine{112 zi = -\/g\%bathyT(i,j)} \DoxyCodeLine{113 x = g\%geoLonT(i,j) -\/ (g\%west\_lon + 0.5*g\%len\_lon) \textcolor{comment}{! Relative to center of domain}} \DoxyCodeLine{114 xd = x / g\%len\_lon \textcolor{comment}{! -\/1/2 < xd 1/2}} \DoxyCodeLine{115 y = g\%geoLatT(i,j) -\/ (g\%south\_lat + 0.5*g\%len\_lat) \textcolor{comment}{! Relative to center of domain}} \DoxyCodeLine{116 yd = y / g\%len\_lat \textcolor{comment}{! -\/1/2 < yd 1/2}} \DoxyCodeLine{117 \textcolor{keywordflow}{if} (l\_zone/=0.) \textcolor{keywordflow}{then}} \DoxyCodeLine{118 xs = min(1., max(-\/1., x/l\_zone)) \textcolor{comment}{! -\/1 < ys < 1}} \DoxyCodeLine{119 fn = sin((0.5*pi)*xs)} \DoxyCodeLine{120 \textcolor{keywordflow}{else}} \DoxyCodeLine{121 xs = sign(1., x) \textcolor{comment}{! +/-\/ 1}} \DoxyCodeLine{122 fn = xs} \DoxyCodeLine{123 \textcolor{keywordflow}{ endif}} \DoxyCodeLine{124 \textcolor{keywordflow}{do} k = nz, 1, -\/1} \DoxyCodeLine{125 zc = zi + 0.5*h(i,j,k)*gv\%H\_to\_Z \textcolor{comment}{! Position of middle of cell}} \DoxyCodeLine{126 zi = zi + h(i,j,k)*gv\%H\_to\_Z \textcolor{comment}{! Top interface position}} \DoxyCodeLine{127 t(i,j,k) = t\_ref + dtdz * zc \& \textcolor{comment}{! Linear temperature stratification}} \DoxyCodeLine{128 + dtdx * x \& \textcolor{comment}{! Linear gradient}} \DoxyCodeLine{129 + delta\_t * fn \textcolor{comment}{! Smooth fn of width L\_zone}} \DoxyCodeLine{130 s(i,j,k) = s\_ref + dsdz * zc \& \textcolor{comment}{! Linear temperature stratification}} \DoxyCodeLine{131 + dsdx * x \& \textcolor{comment}{! Linear gradient}} \DoxyCodeLine{132 + delta\_s * fn \textcolor{comment}{! Smooth fn of width L\_zone}} \DoxyCodeLine{133 \textcolor{keywordflow}{ enddo}} \DoxyCodeLine{134 \textcolor{keywordflow}{ enddo} ;\textcolor{keywordflow}{ enddo}} \DoxyCodeLine{135 } \end{DoxyCode} \mbox{\Hypertarget{namespacebaroclinic__zone__initialization_ae61a49364522c0a98058b170932974dc}\label{namespacebaroclinic__zone__initialization_ae61a49364522c0a98058b170932974dc}} \index{baroclinic\_zone\_initialization@{baroclinic\_zone\_initialization}!bcz\_params@{bcz\_params}} \index{bcz\_params@{bcz\_params}!baroclinic\_zone\_initialization@{baroclinic\_zone\_initialization}} \doxysubsubsection{\texorpdfstring{bcz\_params()}{bcz\_params()}} {\footnotesize\ttfamily subroutine baroclinic\+\_\+zone\+\_\+initialization\+::bcz\+\_\+params (\begin{DoxyParamCaption}\item[{type(ocean\+\_\+grid\+\_\+type), intent(in)}]{G, }\item[{type(verticalgrid\+\_\+type), intent(in)}]{GV, }\item[{type(unit\+\_\+scale\+\_\+type), intent(in)}]{US, }\item[{type(param\+\_\+file\+\_\+type), intent(in)}]{param\+\_\+file, }\item[{real, intent(out)}]{S\+\_\+ref, }\item[{real, intent(out)}]{d\+Sdz, }\item[{real, intent(out)}]{delta\+\_\+S, }\item[{real, intent(out)}]{d\+Sdx, }\item[{real, intent(out)}]{T\+\_\+ref, }\item[{real, intent(out)}]{d\+Tdz, }\item[{real, intent(out)}]{delta\+\_\+T, }\item[{real, intent(out)}]{d\+Tdx, }\item[{real, intent(out)}]{L\+\_\+zone, }\item[{logical, intent(in), optional}]{just\+\_\+read\+\_\+params }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} Reads the parameters unique to this module. \begin{DoxyParams}[1]{Parameters} \mbox{\texttt{ in}} & {\em g} & Grid structure \\ \hline \mbox{\texttt{ in}} & {\em gv} & The ocean\textquotesingle{}s vertical grid structure. \\ \hline \mbox{\texttt{ in}} & {\em us} & A dimensional unit scaling type \\ \hline \mbox{\texttt{ in}} & {\em param\+\_\+file} & Parameter file handle \\ \hline \mbox{\texttt{ out}} & {\em s\+\_\+ref} & Reference salinity \mbox{[}ppt\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em dsdz} & Salinity stratification \mbox{[}ppt Z-\/1 $\sim$$>$ ppt m-\/1\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em delta\+\_\+s} & Salinity difference across baroclinic zone \mbox{[}ppt\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em dsdx} & Linear salinity gradient \mbox{[}ppt m-\/1\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em t\+\_\+ref} & Reference temperature \mbox{[}degC\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em dtdz} & Temperature stratification \mbox{[}degC Z-\/1 $\sim$$>$ degC m-\/1\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em delta\+\_\+t} & Temperature difference across baroclinic zone \mbox{[}degC\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em dtdx} & Linear temperature gradient in \mbox{[}degC Gx\+\_\+axis\+\_\+units-\/1\mbox{]} \\ \hline \mbox{\texttt{ out}} & {\em l\+\_\+zone} & Width of baroclinic zone in \mbox{[}Gx\+\_\+axis\+\_\+units\mbox{]} \\ \hline \mbox{\texttt{ in}} & {\em just\+\_\+read\+\_\+params} & If present and true, this call will only read parameters without changing h. \\ \hline \end{DoxyParams} Definition at line 30 of file baroclinic\+\_\+zone\+\_\+initialization.\+F90. \begin{DoxyCode}{0} \DoxyCodeLine{32 \textcolor{keywordtype}{type}(ocean\_grid\_type), \textcolor{keywordtype}{intent(in)} :: G\textcolor{comment}{ !< Grid structure}} \DoxyCodeLine{33 \textcolor{keywordtype}{type}(verticalGrid\_type), \textcolor{keywordtype}{intent(in)} :: GV\textcolor{comment}{ !< The ocean's vertical grid structure.}} \DoxyCodeLine{34 \textcolor{keywordtype}{type}(unit\_scale\_type), \textcolor{keywordtype}{intent(in)} :: US\textcolor{comment}{ !< A dimensional unit scaling type}} \DoxyCodeLine{35 \textcolor{keywordtype}{type}(param\_file\_type), \textcolor{keywordtype}{intent(in)} :: param\_file\textcolor{comment}{ !< Parameter file handle}} \DoxyCodeLine{36 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: S\_ref\textcolor{comment}{ !< Reference salinity [ppt]}} \DoxyCodeLine{37 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: dSdz\textcolor{comment}{ !< Salinity stratification [ppt Z-\/1 \string~> ppt m-\/1]}} \DoxyCodeLine{38 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: delta\_S\textcolor{comment}{ !< Salinity difference across baroclinic zone [ppt]}} \DoxyCodeLine{39 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: dSdx\textcolor{comment}{ !< Linear salinity gradient [ppt m-\/1]}} \DoxyCodeLine{40 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: T\_ref\textcolor{comment}{ !< Reference temperature [degC]}} \DoxyCodeLine{41 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: dTdz\textcolor{comment}{ !< Temperature stratification [degC Z-\/1 \string~> degC m-\/1]}} \DoxyCodeLine{42 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: delta\_T\textcolor{comment}{ !< Temperature difference across baroclinic zone [degC]}} \DoxyCodeLine{43 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: dTdx\textcolor{comment}{ !< Linear temperature gradient in [degC G\%x\_axis\_units-\/1]}} \DoxyCodeLine{44 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{intent(out)} :: L\_zone\textcolor{comment}{ !< Width of baroclinic zone in [G\%x\_axis\_units]}} \DoxyCodeLine{45 \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: just\_read\_params\textcolor{comment}{ !< If present and true, this call will}} \DoxyCodeLine{46 \textcolor{comment}{ !! only read parameters without changing h.}} \DoxyCodeLine{47 } \DoxyCodeLine{48 \textcolor{keywordtype}{logical} :: just\_read \textcolor{comment}{! If true, just read parameters but set nothing.}} \DoxyCodeLine{49 } \DoxyCodeLine{50 just\_read = .false. ; \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(just\_read\_params)) just\_read = just\_read\_params} \DoxyCodeLine{51 } \DoxyCodeLine{52 \textcolor{keywordflow}{if} (.not.just\_read) \&} \DoxyCodeLine{53 \textcolor{keyword}{call }log\_version(param\_file, mdl, version, \textcolor{stringliteral}{'Initialization of an analytic baroclinic zone'})} \DoxyCodeLine{54 \textcolor{keyword}{call }openparameterblock(param\_file,\textcolor{stringliteral}{'BCZIC'})} \DoxyCodeLine{55 \textcolor{keyword}{call }get\_param(param\_file, mdl, \textcolor{stringliteral}{"S\_REF"}, s\_ref, \textcolor{stringliteral}{'Reference salinity'}, units=\textcolor{stringliteral}{'ppt'}, \&} \DoxyCodeLine{56 default=35., do\_not\_log=just\_read)} \DoxyCodeLine{57 \textcolor{keyword}{call }get\_param(param\_file, mdl, \textcolor{stringliteral}{"DSDZ"}, dsdz, \textcolor{stringliteral}{'Salinity stratification'}, \&} \DoxyCodeLine{58 units=\textcolor{stringliteral}{'ppt/m'}, default=0.0, scale=us\%Z\_to\_m, do\_not\_log=just\_read)} \DoxyCodeLine{59 \textcolor{keyword}{call }get\_param(param\_file, mdl,\textcolor{stringliteral}{"DELTA\_S"},delta\_s,\textcolor{stringliteral}{'Salinity difference across baroclinic zone'}, \&} \DoxyCodeLine{60 units=\textcolor{stringliteral}{'ppt'}, default=0.0, do\_not\_log=just\_read)} \DoxyCodeLine{61 \textcolor{keyword}{call }get\_param(param\_file, mdl,\textcolor{stringliteral}{"DSDX"},dsdx,\textcolor{stringliteral}{'Meridional salinity difference'}, \&} \DoxyCodeLine{62 units=\textcolor{stringliteral}{'ppt/'}//trim(g\%x\_axis\_units), default=0.0, do\_not\_log=just\_read)} \DoxyCodeLine{63 \textcolor{keyword}{call }get\_param(param\_file, mdl,\textcolor{stringliteral}{"T\_REF"},t\_ref,\textcolor{stringliteral}{'Reference temperature'},units=\textcolor{stringliteral}{'C'}, \&} \DoxyCodeLine{64 default=10., do\_not\_log=just\_read)} \DoxyCodeLine{65 \textcolor{keyword}{call }get\_param(param\_file, mdl, \textcolor{stringliteral}{"DTDZ"}, dtdz, \textcolor{stringliteral}{'Temperature stratification'}, \&} \DoxyCodeLine{66 units=\textcolor{stringliteral}{'C/m'}, default=0.0, scale=us\%Z\_to\_m, do\_not\_log=just\_read)} \DoxyCodeLine{67 \textcolor{keyword}{call }get\_param(param\_file, mdl,\textcolor{stringliteral}{"DELTA\_T"},delta\_t,\textcolor{stringliteral}{'Temperature difference across baroclinic zone'}, \&} \DoxyCodeLine{68 units=\textcolor{stringliteral}{'C'}, default=0.0, do\_not\_log=just\_read)} \DoxyCodeLine{69 \textcolor{keyword}{call }get\_param(param\_file, mdl,\textcolor{stringliteral}{"DTDX"},dtdx,\textcolor{stringliteral}{'Meridional temperature difference'}, \&} \DoxyCodeLine{70 units=\textcolor{stringliteral}{'C/'}//trim(g\%x\_axis\_units), default=0.0, do\_not\_log=just\_read)} \DoxyCodeLine{71 \textcolor{keyword}{call }get\_param(param\_file, mdl,\textcolor{stringliteral}{"L\_ZONE"},l\_zone,\textcolor{stringliteral}{'Width of baroclinic zone'}, \&} \DoxyCodeLine{72 units=g\%x\_axis\_units, default=0.5*g\%len\_lat, do\_not\_log=just\_read)} \DoxyCodeLine{73 \textcolor{keyword}{call }closeparameterblock(param\_file)} \DoxyCodeLine{74 } \end{DoxyCode}