\hypertarget{namespaceregrid__consts}{}\section{regrid\+\_\+consts Module Reference}
\label{namespaceregrid__consts}\index{regrid\_consts@{regrid\_consts}}


\subsection{Detailed Description}
Contains constants for interpreting input parameters that control regridding. \subsection*{Data Types}
\begin{DoxyCompactItemize}
\item 
interface \mbox{\hyperlink{interfaceregrid__consts_1_1coordinateunits}{coordinateunits}}
\begin{DoxyCompactList}\small\item\em Returns a string with the coordinate units associated with the coordinate mode. \end{DoxyCompactList}\item 
interface \mbox{\hyperlink{interfaceregrid__consts_1_1state__dependent}{state\+\_\+dependent}}
\begin{DoxyCompactList}\small\item\em Returns true if the coordinate is dependent on the state density, returns false otherwise. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions/\+Subroutines}
\begin{DoxyCompactItemize}
\item 
integer function \mbox{\hyperlink{namespaceregrid__consts_a06ccba5b7b038bed853606a315df306a}{coordinatemode}} (string)
\begin{DoxyCompactList}\small\item\em Parse a string parameter specifying the coordinate mode and return the appropriate enumerated integer. \end{DoxyCompactList}\item 
character(len=16) function \mbox{\hyperlink{namespaceregrid__consts_a66013f9050702cc9015336389c311a4b}{coordinateunitsi}} (coord\+Mode)
\begin{DoxyCompactList}\small\item\em Returns a string with the coordinate units associated with the enumerated integer,. \end{DoxyCompactList}\item 
character(len=16) function \mbox{\hyperlink{namespaceregrid__consts_abb7bad7b33524d0373426750c48cb1c6}{coordinateunitss}} (string)
\begin{DoxyCompactList}\small\item\em Returns a string with the coordinate units associated with the string defining the coordinate mode. \end{DoxyCompactList}\item 
logical function \mbox{\hyperlink{namespaceregrid__consts_ab231ec7fa57aa5630c057ecbf9fbb95d}{state\+\_\+dependent\+\_\+char}} (string)
\begin{DoxyCompactList}\small\item\em Returns true if the coordinate is dependent on the state density, returns false otherwise. \end{DoxyCompactList}\item 
logical function \mbox{\hyperlink{namespaceregrid__consts_a5e0d6146992d81d5a47248019d7dfa71}{state\+\_\+dependent\+\_\+int}} (mode)
\begin{DoxyCompactList}\small\item\em Returns true if the coordinate is dependent on the state density, returns false otherwise. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Variables}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{namespaceregrid__consts_a3397fda7d3d1dbe306a3fe4cbcb67271}\label{namespaceregrid__consts_a3397fda7d3d1dbe306a3fe4cbcb67271}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_a3397fda7d3d1dbe306a3fe4cbcb67271}{regridding\+\_\+layer}} = 1
\begin{DoxyCompactList}\small\item\em Layer mode identifier. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a1b6704da36b4b860113690eedcb311af}\label{namespaceregrid__consts_a1b6704da36b4b860113690eedcb311af}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_a1b6704da36b4b860113690eedcb311af}{regridding\+\_\+zstar}} = 2
\begin{DoxyCompactList}\small\item\em z$\ast$ coordinates identifier \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_aef4186522ded3d18e67d332fddde5ea4}\label{namespaceregrid__consts_aef4186522ded3d18e67d332fddde5ea4}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_aef4186522ded3d18e67d332fddde5ea4}{regridding\+\_\+rho}} = 3
\begin{DoxyCompactList}\small\item\em Density coordinates identifier. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_acaaaed0d987a75852f7ef3d371e74094}\label{namespaceregrid__consts_acaaaed0d987a75852f7ef3d371e74094}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_acaaaed0d987a75852f7ef3d371e74094}{regridding\+\_\+sigma}} = 4
\begin{DoxyCompactList}\small\item\em Sigma coordinates identifier. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_ac4106c5add89927d7ea3be8d1366fe05}\label{namespaceregrid__consts_ac4106c5add89927d7ea3be8d1366fe05}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_ac4106c5add89927d7ea3be8d1366fe05}{regridding\+\_\+arbitrary}} = 5
\begin{DoxyCompactList}\small\item\em Arbitrary coordinates identifier. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a303726845f77761e06fa320a43848af7}\label{namespaceregrid__consts_a303726845f77761e06fa320a43848af7}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_a303726845f77761e06fa320a43848af7}{regridding\+\_\+hycom1}} = 6
\begin{DoxyCompactList}\small\item\em Simple Hy\+C\+OM coordinates without B\+BL. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_ab0d778e07655fc8187df01b4864d662a}\label{namespaceregrid__consts_ab0d778e07655fc8187df01b4864d662a}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_ab0d778e07655fc8187df01b4864d662a}{regridding\+\_\+slight}} = 7
\begin{DoxyCompactList}\small\item\em Identifier for stretched coordinates in the lightest water, isopycnal below. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_afa0560b2e29c73ee4427e46f9a0a97c8}\label{namespaceregrid__consts_afa0560b2e29c73ee4427e46f9a0a97c8}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_afa0560b2e29c73ee4427e46f9a0a97c8}{regridding\+\_\+sigma\+\_\+shelf\+\_\+zstar}} = 8
\begin{DoxyCompactList}\small\item\em Identifiered for z$\ast$ coordinates at the bottom, sigma-\/near the top. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a227622bf8cf9a62a3dbe5ed6643baaf1}\label{namespaceregrid__consts_a227622bf8cf9a62a3dbe5ed6643baaf1}} 
integer, parameter \mbox{\hyperlink{namespaceregrid__consts_a227622bf8cf9a62a3dbe5ed6643baaf1}{regridding\+\_\+adaptive}} = 9
\begin{DoxyCompactList}\small\item\em Adaptive coordinate mode identifier. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a7a9ff0c5f638d8724c95291121b31fd4}\label{namespaceregrid__consts_a7a9ff0c5f638d8724c95291121b31fd4}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a7a9ff0c5f638d8724c95291121b31fd4}{regridding\+\_\+layer\+\_\+string}} = \char`\"{}L\+A\+Y\+ER\char`\"{}
\begin{DoxyCompactList}\small\item\em Layer string. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a6951a9d55eb4e9facfb5c129902fd7da}\label{namespaceregrid__consts_a6951a9d55eb4e9facfb5c129902fd7da}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a6951a9d55eb4e9facfb5c129902fd7da}{regridding\+\_\+zstar\+\_\+string\+\_\+old}} = \char`\"{}Z$\ast$\char`\"{}
\begin{DoxyCompactList}\small\item\em z$\ast$ string (legacy name) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_ad153d62679686bdb472629358f438dfb}\label{namespaceregrid__consts_ad153d62679686bdb472629358f438dfb}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_ad153d62679686bdb472629358f438dfb}{regridding\+\_\+zstar\+\_\+string}} = \char`\"{}Z\+S\+T\+AR\char`\"{}
\begin{DoxyCompactList}\small\item\em z$\ast$ string \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a205d0f0ad67911f6b428b4bba14ed4bf}\label{namespaceregrid__consts_a205d0f0ad67911f6b428b4bba14ed4bf}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a205d0f0ad67911f6b428b4bba14ed4bf}{regridding\+\_\+rho\+\_\+string}} = \char`\"{}R\+HO\char`\"{}
\begin{DoxyCompactList}\small\item\em Rho string. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a35301c54a8480c446323596c9f63e8fb}\label{namespaceregrid__consts_a35301c54a8480c446323596c9f63e8fb}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a35301c54a8480c446323596c9f63e8fb}{regridding\+\_\+sigma\+\_\+string}} = \char`\"{}S\+I\+G\+MA\char`\"{}
\begin{DoxyCompactList}\small\item\em Sigma string. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a512d94be84b0ec586975b6228ed5e2bf}\label{namespaceregrid__consts_a512d94be84b0ec586975b6228ed5e2bf}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a512d94be84b0ec586975b6228ed5e2bf}{regridding\+\_\+arbitrary\+\_\+string}} = \char`\"{}A\+RB\char`\"{}
\begin{DoxyCompactList}\small\item\em Arbitrary coordinates. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a96963fd0d4aaa28826e13165ddd30b7f}\label{namespaceregrid__consts_a96963fd0d4aaa28826e13165ddd30b7f}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a96963fd0d4aaa28826e13165ddd30b7f}{regridding\+\_\+hycom1\+\_\+string}} = \char`\"{}H\+Y\+C\+O\+M1\char`\"{}
\begin{DoxyCompactList}\small\item\em Hycom string. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_afcc2c3104d2bd1c6cd90956ecf49e901}\label{namespaceregrid__consts_afcc2c3104d2bd1c6cd90956ecf49e901}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_afcc2c3104d2bd1c6cd90956ecf49e901}{regridding\+\_\+slight\+\_\+string}} = \char`\"{}S\+L\+I\+G\+HT\char`\"{}
\begin{DoxyCompactList}\small\item\em Hybrid S-\/rho string. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_aa99d2be0a57dfd487b5ae6f62331def9}\label{namespaceregrid__consts_aa99d2be0a57dfd487b5ae6f62331def9}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_aa99d2be0a57dfd487b5ae6f62331def9}{regridding\+\_\+sigma\+\_\+shelf\+\_\+zstar\+\_\+string}} = \char`\"{}S\+I\+G\+M\+A\+\_\+\+S\+H\+E\+L\+F\+\_\+\+Z\+S\+T\+AR\char`\"{}
\begin{DoxyCompactList}\small\item\em Hybrid z$\ast$/sigma. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_ab88a2ff359e56228be4b4b28456cb60c}\label{namespaceregrid__consts_ab88a2ff359e56228be4b4b28456cb60c}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_ab88a2ff359e56228be4b4b28456cb60c}{regridding\+\_\+adaptive\+\_\+string}} = \char`\"{}A\+D\+A\+P\+T\+I\+VE\char`\"{}
\begin{DoxyCompactList}\small\item\em Adaptive coordinate string. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{namespaceregrid__consts_a1e9cb6ecab50adb2d7ca1d2267c1986c}\label{namespaceregrid__consts_a1e9cb6ecab50adb2d7ca1d2267c1986c}} 
character(len= $\ast$), parameter \mbox{\hyperlink{namespaceregrid__consts_a1e9cb6ecab50adb2d7ca1d2267c1986c}{default\+\_\+coordinate\+\_\+mode}} = R\+E\+G\+R\+I\+D\+D\+I\+N\+G\+\_\+\+L\+A\+Y\+E\+R\+\_\+\+S\+T\+R\+I\+NG
\begin{DoxyCompactList}\small\item\em Default coordinate mode. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Function/\+Subroutine Documentation}
\mbox{\Hypertarget{namespaceregrid__consts_a06ccba5b7b038bed853606a315df306a}\label{namespaceregrid__consts_a06ccba5b7b038bed853606a315df306a}} 
\index{regrid\_consts@{regrid\_consts}!coordinatemode@{coordinatemode}}
\index{coordinatemode@{coordinatemode}!regrid\_consts@{regrid\_consts}}
\subsubsection{\texorpdfstring{coordinatemode()}{coordinatemode()}}
{\footnotesize\ttfamily integer function regrid\+\_\+consts\+::coordinatemode (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{string }\end{DoxyParamCaption})}



Parse a string parameter specifying the coordinate mode and return the appropriate enumerated integer. 

\begin{DoxyReturn}{Returns}
Enumerated integer indicating coordinate mode 
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em string} & String to indicate coordinate mode \\
\hline
\end{DoxyParams}


Definition at line 54 of file regrid\+\_\+consts.\+F90.


\begin{DoxyCode}{0}
\DoxyCodeLine{54   \textcolor{keywordtype}{integer} :: coordinateMode\textcolor{comment}{ !< Enumerated integer indicating coordinate mode}}
\DoxyCodeLine{55   \textcolor{keywordtype}{character(len=*)}, \textcolor{keywordtype}{intent(in)} :: string\textcolor{comment}{ !< String to indicate coordinate mode}}
\DoxyCodeLine{56   \textcolor{keywordflow}{select case} ( uppercase(trim(string)) )}
\DoxyCodeLine{57     \textcolor{keywordflow}{case} (trim(regridding\_layer\_string)); coordinatemode = regridding\_layer}
\DoxyCodeLine{58     \textcolor{keywordflow}{case} (trim(regridding\_zstar\_string)); coordinatemode = regridding\_zstar}
\DoxyCodeLine{59     \textcolor{keywordflow}{case} (trim(regridding\_zstar\_string\_old)); coordinatemode = regridding\_zstar}
\DoxyCodeLine{60     \textcolor{keywordflow}{case} (trim(regridding\_rho\_string));   coordinatemode = regridding\_rho}
\DoxyCodeLine{61     \textcolor{keywordflow}{case} (trim(regridding\_sigma\_string)); coordinatemode = regridding\_sigma}
\DoxyCodeLine{62     \textcolor{keywordflow}{case} (trim(regridding\_hycom1\_string)); coordinatemode = regridding\_hycom1}
\DoxyCodeLine{63     \textcolor{keywordflow}{case} (trim(regridding\_slight\_string)); coordinatemode = regridding\_slight}
\DoxyCodeLine{64     \textcolor{keywordflow}{case} (trim(regridding\_arbitrary\_string)); coordinatemode = regridding\_arbitrary}
\DoxyCodeLine{65     \textcolor{keywordflow}{case} (trim(regridding\_sigma\_shelf\_zstar\_string)); coordinatemode = regridding\_sigma\_shelf\_zstar}
\DoxyCodeLine{66     \textcolor{keywordflow}{case} (trim(regridding\_adaptive\_string)); coordinatemode = regridding\_adaptive}
\DoxyCodeLine{67 \textcolor{keywordflow}{    case default} ; \textcolor{keyword}{call }mom\_error(fatal, \textcolor{stringliteral}{"coordinateMode: "}//\&}
\DoxyCodeLine{68        \textcolor{stringliteral}{"Unrecognized choice of coordinate ("}//trim(string)//\textcolor{stringliteral}{")."})}
\DoxyCodeLine{69 \textcolor{keywordflow}{  end select}}

\end{DoxyCode}
\mbox{\Hypertarget{namespaceregrid__consts_a66013f9050702cc9015336389c311a4b}\label{namespaceregrid__consts_a66013f9050702cc9015336389c311a4b}} 
\index{regrid\_consts@{regrid\_consts}!coordinateunitsi@{coordinateunitsi}}
\index{coordinateunitsi@{coordinateunitsi}!regrid\_consts@{regrid\_consts}}
\subsubsection{\texorpdfstring{coordinateunitsi()}{coordinateunitsi()}}
{\footnotesize\ttfamily character(len=16) function regrid\+\_\+consts\+::coordinateunitsi (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{coord\+Mode }\end{DoxyParamCaption})}



Returns a string with the coordinate units associated with the enumerated integer,. 

\begin{DoxyReturn}{Returns}
Units of coordinate 
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em coordmode} & Coordinate mode \\
\hline
\end{DoxyParams}


Definition at line 75 of file regrid\+\_\+consts.\+F90.


\begin{DoxyCode}{0}
\DoxyCodeLine{75   \textcolor{keywordtype}{character(len=16)} :: coordinateUnitsI\textcolor{comment}{ !< Units of coordinate}}
\DoxyCodeLine{76   \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{intent(in)} :: coordMode\textcolor{comment}{ !< Coordinate mode}}
\DoxyCodeLine{77   \textcolor{keywordflow}{select case} ( coordmode )}
\DoxyCodeLine{78     \textcolor{keywordflow}{case} (regridding\_layer); coordinateunitsi = \textcolor{stringliteral}{"kg m\string^-3"}}
\DoxyCodeLine{79     \textcolor{keywordflow}{case} (regridding\_zstar); coordinateunitsi = \textcolor{stringliteral}{"m"}}
\DoxyCodeLine{80     \textcolor{keywordflow}{case} (regridding\_sigma\_shelf\_zstar); coordinateunitsi = \textcolor{stringliteral}{"m"}}
\DoxyCodeLine{81     \textcolor{keywordflow}{case} (regridding\_rho);   coordinateunitsi = \textcolor{stringliteral}{"kg m\string^-3"}}
\DoxyCodeLine{82     \textcolor{keywordflow}{case} (regridding\_sigma); coordinateunitsi = \textcolor{stringliteral}{"Non-dimensional"}}
\DoxyCodeLine{83     \textcolor{keywordflow}{case} (regridding\_hycom1); coordinateunitsi = \textcolor{stringliteral}{"m"}}
\DoxyCodeLine{84     \textcolor{keywordflow}{case} (regridding\_slight); coordinateunitsi = \textcolor{stringliteral}{"m"}}
\DoxyCodeLine{85     \textcolor{keywordflow}{case} (regridding\_adaptive); coordinateunitsi = \textcolor{stringliteral}{"m"}}
\DoxyCodeLine{86 \textcolor{keywordflow}{    case default} ; \textcolor{keyword}{call }mom\_error(fatal, \textcolor{stringliteral}{"coordinateUnts: "}//\&}
\DoxyCodeLine{87        \textcolor{stringliteral}{"Unrecognized coordinate mode."})}
\DoxyCodeLine{88 \textcolor{keywordflow}{  end select}}

\end{DoxyCode}
\mbox{\Hypertarget{namespaceregrid__consts_abb7bad7b33524d0373426750c48cb1c6}\label{namespaceregrid__consts_abb7bad7b33524d0373426750c48cb1c6}} 
\index{regrid\_consts@{regrid\_consts}!coordinateunitss@{coordinateunitss}}
\index{coordinateunitss@{coordinateunitss}!regrid\_consts@{regrid\_consts}}
\subsubsection{\texorpdfstring{coordinateunitss()}{coordinateunitss()}}
{\footnotesize\ttfamily character(len=16) function regrid\+\_\+consts\+::coordinateunitss (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{string }\end{DoxyParamCaption})}



Returns a string with the coordinate units associated with the string defining the coordinate mode. 

\begin{DoxyReturn}{Returns}
Units of coordinate 
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em string} & Coordinate mode \\
\hline
\end{DoxyParams}


Definition at line 94 of file regrid\+\_\+consts.\+F90.


\begin{DoxyCode}{0}
\DoxyCodeLine{94   \textcolor{keywordtype}{character(len=16)} :: coordinateUnitsS\textcolor{comment}{ !< Units of coordinate}}
\DoxyCodeLine{95   \textcolor{keywordtype}{character(len=*)}, \textcolor{keywordtype}{intent(in)} :: string\textcolor{comment}{ !< Coordinate mode}}
\DoxyCodeLine{96   \textcolor{keywordtype}{integer} :: coordMode}
\DoxyCodeLine{97   coordmode = coordinatemode(string)}
\DoxyCodeLine{98   coordinateunitss = coordinateunitsi(coordmode)}

\end{DoxyCode}
\mbox{\Hypertarget{namespaceregrid__consts_ab231ec7fa57aa5630c057ecbf9fbb95d}\label{namespaceregrid__consts_ab231ec7fa57aa5630c057ecbf9fbb95d}} 
\index{regrid\_consts@{regrid\_consts}!state\_dependent\_char@{state\_dependent\_char}}
\index{state\_dependent\_char@{state\_dependent\_char}!regrid\_consts@{regrid\_consts}}
\subsubsection{\texorpdfstring{state\_dependent\_char()}{state\_dependent\_char()}}
{\footnotesize\ttfamily logical function regrid\+\_\+consts\+::state\+\_\+dependent\+\_\+char (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{string }\end{DoxyParamCaption})}



Returns true if the coordinate is dependent on the state density, returns false otherwise. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em string} & String to indicate coordinate mode \\
\hline
\end{DoxyParams}


Definition at line 103 of file regrid\+\_\+consts.\+F90.


\begin{DoxyCode}{0}
\DoxyCodeLine{103   \textcolor{keywordtype}{character(len=*)}, \textcolor{keywordtype}{intent(in)} :: string\textcolor{comment}{ !< String to indicate coordinate mode}}
\DoxyCodeLine{104 }
\DoxyCodeLine{105   state\_dependent\_char = state\_dependent\_int( coordinatemode(string) )}
\DoxyCodeLine{106 }

\end{DoxyCode}
\mbox{\Hypertarget{namespaceregrid__consts_a5e0d6146992d81d5a47248019d7dfa71}\label{namespaceregrid__consts_a5e0d6146992d81d5a47248019d7dfa71}} 
\index{regrid\_consts@{regrid\_consts}!state\_dependent\_int@{state\_dependent\_int}}
\index{state\_dependent\_int@{state\_dependent\_int}!regrid\_consts@{regrid\_consts}}
\subsubsection{\texorpdfstring{state\_dependent\_int()}{state\_dependent\_int()}}
{\footnotesize\ttfamily logical function regrid\+\_\+consts\+::state\+\_\+dependent\+\_\+int (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{mode }\end{DoxyParamCaption})}



Returns true if the coordinate is dependent on the state density, returns false otherwise. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em mode} & Coordinate mode \\
\hline
\end{DoxyParams}


Definition at line 111 of file regrid\+\_\+consts.\+F90.


\begin{DoxyCode}{0}
\DoxyCodeLine{111   \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{intent(in)} :: mode\textcolor{comment}{ !< Coordinate mode}}
\DoxyCodeLine{112   \textcolor{keywordflow}{select case} ( mode )}
\DoxyCodeLine{113     \textcolor{keywordflow}{case} (regridding\_layer); state\_dependent\_int = .true.}
\DoxyCodeLine{114     \textcolor{keywordflow}{case} (regridding\_zstar); state\_dependent\_int = .false.}
\DoxyCodeLine{115     \textcolor{keywordflow}{case} (regridding\_sigma\_shelf\_zstar); state\_dependent\_int = .false.}
\DoxyCodeLine{116     \textcolor{keywordflow}{case} (regridding\_rho);   state\_dependent\_int = .true.}
\DoxyCodeLine{117     \textcolor{keywordflow}{case} (regridding\_sigma); state\_dependent\_int = .false.}
\DoxyCodeLine{118     \textcolor{keywordflow}{case} (regridding\_hycom1); state\_dependent\_int = .true.}
\DoxyCodeLine{119     \textcolor{keywordflow}{case} (regridding\_slight); state\_dependent\_int = .true.}
\DoxyCodeLine{120     \textcolor{keywordflow}{case} (regridding\_adaptive); state\_dependent\_int = .true.}
\DoxyCodeLine{121 \textcolor{keywordflow}{    case default} ; \textcolor{keyword}{call }mom\_error(fatal, \textcolor{stringliteral}{"state\_dependent: "}//\&}
\DoxyCodeLine{122        \textcolor{stringliteral}{"Unrecognized choice of coordinate."})}
\DoxyCodeLine{123 \textcolor{keywordflow}{  end select}}

\end{DoxyCode}
