docs(swf): refactoring swf into chf and olf chapters

distribution/build_docs.py

@@ -54,7 +54,7 @@
 
 # models to include in the docs by default,
 # filterable with the --models (-m) option
-DEFAULT_MODELS = ["gwf", "gwt", "gwe", "prt", "swf"]
+DEFAULT_MODELS = ["gwf", "gwt", "gwe", "prt", "chf", "olf"]
 
 # OS-specific extensions
 SYSTEM = platform.system()

doc/Common/swf-swfobs.tex → doc/Common/chf-chfobs.tex

@@ -1 +1 @@
-SWF-SWF & flow-ja-face & exchange number or boundname & -- & Flow between model 1 and model 2 for a specified exchange (which is the consecutive exchange number listed in the EXCHANGEDATA block), or the sum of these exchange flows by boundname if boundname is specified.
+CHF-CHF & flow-ja-face & exchange number or boundname & -- & Flow between model 1 and model 2 for a specified exchange (which is the consecutive exchange number listed in the EXCHANGEDATA block), or the sum of these exchange flows by boundname if boundname is specified.

doc/Common/chf-obs.tex

@@ -0,0 +1,2 @@
+CHF & stage & cellid & -- & Stage at a specified cell. \\
+CHF & flow-ja-face & cellid & cellid & Surface water flow in dimensions of length cubed per time between two adjacent cells.

doc/Common/swf-obstypetable.tex → doc/Common/chf-obstypetable.tex

@@ -9,7 +9,7 @@
 
 % model observations
 \begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
-\caption{Available observation types for the SWF Model} \tabularnewline
+\caption{Available observation types for the CHF Model} \tabularnewline
 
 \hline
 \hline
@@ -29,7 +29,7 @@
 \hline
 \endfoot
 
-\input{../Common/swf-obs.tex}
+\input{../Common/chf-obs.tex}
 \end{longtable}
 \addtocounter{table}{-1}
 
@@ -42,7 +42,7 @@
 \endfirsthead
 
 \captionsetup{textformat=simple}
-\caption*{\textbf{Table \arabic{table}.}{\quad}Available SWF observation types.---Continued} \\
+\caption*{\textbf{Table \arabic{table}.}{\quad}Available CHF observation types.---Continued} \\
 
 \hline
 \hline
@@ -53,7 +53,7 @@
 \hline
 \endfoot
 
-\label{table:swf-obstypetable}
+\label{table:chf-obstypetable}
 \end{longtable}
 \addtocounter{table}{-1}
 
@@ -66,7 +66,7 @@
 \endfirsthead
 
 \captionsetup{textformat=simple}
-\caption*{\textbf{Table \arabic{table}.}{\quad}Available SWF observation types.---Continued} \\
+\caption*{\textbf{Table \arabic{table}.}{\quad}Available CHF observation types.---Continued} \\
 
 \hline
 \hline
@@ -77,7 +77,7 @@
 \hline
 \endfoot
 
-\input{../Common/swf-swfobs.tex}
+\input{../Common/chf-chfobs.tex}
 \end{longtable}
 
 \normalsize

doc/Common/olf-obs.tex

@@ -0,0 +1,2 @@
+OLF & stage & cellid & -- & Stage at a specified cell. \\
+OLF & flow-ja-face & cellid & cellid & Surface water flow in dimensions of length cubed per time between two adjacent cells.

doc/Common/olf-obstypetable.tex

@@ -0,0 +1,83 @@
+
+\begingroup
+\makeatletter
+\ifx\LT@ii\@undefined\else
+\def\LT@entry#1#2{\noexpand\LT@entry{-#1}{#2}}
+\xdef\LT@i{\LT@ii}
+\fi
+\endgroup
+
+% model observations
+\begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
+\caption{Available observation types for the OLF Model} \tabularnewline
+
+\hline
+\hline
+\textbf{Model} & \textbf{Observation types} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endfirsthead
+
+\captionsetup{textformat=simple}
+\caption*{\textbf{Table \arabic{table}.}{\quad}List of symbols used in this report.---Continued} \\
+
+\hline
+\hline
+\textbf{Model} & \textbf{Observation types} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endhead
+
+\hline
+\endfoot
+
+\input{../Common/olf-obs.tex}
+\end{longtable}
+\addtocounter{table}{-1}
+
+% stress packages
+\begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
+\hline
+\hline
+\textbf{Stress Package} & \textbf{Observation type} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endfirsthead
+
+\captionsetup{textformat=simple}
+\caption*{\textbf{Table \arabic{table}.}{\quad}Available OLF observation types.---Continued} \\
+
+\hline
+\hline
+\textbf{Stress Package} & \textbf{Observation types} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endhead
+
+\hline
+\endfoot
+
+\label{table:olf-obstypetable}
+\end{longtable}
+\addtocounter{table}{-1}
+
+% exchange
+\begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
+\hline
+\hline
+\textbf{Exchange} & \textbf{Observation type} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endfirsthead
+
+\captionsetup{textformat=simple}
+\caption*{\textbf{Table \arabic{table}.}{\quad}Available OLF observation types.---Continued} \\
+
+\hline
+\hline
+\textbf{Exchange} & \textbf{Observation types} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endhead
+
+\hline
+\endfoot
+
+\input{../Common/olf-olfobs.tex}
+\end{longtable}
+
+\normalsize

doc/Common/olf-olfobs.tex

@@ -0,0 +1 @@
+OLF-OLF & flow-ja-face & exchange number or boundname & -- & Flow between model 1 and model 2 for a specified exchange (which is the consecutive exchange number listed in the EXCHANGEDATA block), or the sum of these exchange flows by boundname if boundname is specified.

doc/mf6io/body.tex

@@ -55,10 +55,19 @@
 \SECTION{Particle Tracking (PRT) Model Input and Output}
 \input{prt/prt.tex}
 
-%SWF Model Input Instructions
-% \newpage
-% \SECTION{Surface Water Flow (SWF) Model Input}
-% \input{swf/swf.tex}
+%CHF Model Input Instructions
+\IfFileExists{develop.version}{
+\newpage
+\SECTION{Channel Flow (CHF) Model Input}
+\input{chf/chf.tex}
+}{}
+
+%OLF Model Input Instructions
+\IfFileExists{develop.version}{
+\newpage
+\SECTION{Overland Flow (OLF) Model Input}
+\input{olf/olf.tex}
+}{}
 
 %Sparse Matrix Solution (IMS)
 \newpage

doc/mf6io/swf/cdb.tex → doc/mf6io/chf/cdb.tex

@@ -5,22 +5,22 @@ \subsubsection{Structure of Blocks}
 \vspace{5mm}
 
 \noindent \textit{FOR EACH SIMULATION}
-\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/swf-cdb-options.dat}
-\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/swf-cdb-dimensions.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/chf-cdb-options.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/chf-cdb-dimensions.dat}
 \vspace{5mm}
 \noindent \textit{FOR ANY STRESS PERIOD}
-\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/swf-cdb-period.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/chf-cdb-period.dat}
 \packageperioddescription
 
 \vspace{5mm}
 \subsubsection{Explanation of Variables}
 \begin{description}
-\input{./mf6ivar/tex/swf-cdb-desc.tex}
+\input{./mf6ivar/tex/chf-cdb-desc.tex}
 \end{description}
 
 \vspace{5mm}
 \subsubsection{Example Input File}
-\lstinputlisting[style=inputfile]{./mf6ivar/examples/swf-cdb-example.dat}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/chf-cdb-example.dat}
 
 %\vspace{5mm}
 %\subsubsection{Available observation types}

doc/mf6io/swf/chd.tex → doc/mf6io/chf/chd.tex

@@ -1,31 +1,31 @@
 
-Input to the Constant-Head (CHD) Package is read from the file that has type ``CHD6'' in the Name File.  Any number of CHD Packages can be specified for a single model; however, an error will occur if a CHD Package attempts to make a SWF cell a constant-head cell when that cell has already been designated as a constant-head cell either within the present CHD Package or within another CHD Package.
+Input to the Constant-Head (CHD) Package is read from the file that has type ``CHD6'' in the Name File.  Any number of CHD Packages can be specified for a single model; however, an error will occur if a CHD Package attempts to make a CHF cell a constant-head cell when that cell has already been designated as a constant-head cell either within the present CHD Package or within another CHD Package.
 
 \vspace{5mm}
 \subsubsection{Structure of Blocks}
 \vspace{5mm}
 
 \noindent \textit{FOR EACH SIMULATION}
-\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/swf-chd-options.dat}
-\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/swf-chd-dimensions.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/chf-chd-options.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/chf-chd-dimensions.dat}
 \vspace{5mm}
 \noindent \textit{FOR ANY STRESS PERIOD}
-\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/swf-chd-period.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/chf-chd-period.dat}
 \packageperioddescription
 
 \vspace{5mm}
 \subsubsection{Explanation of Variables}
 \begin{description}
-\input{./mf6ivar/tex/swf-chd-desc.tex}
+\input{./mf6ivar/tex/chf-chd-desc.tex}
 \end{description}
 
 \vspace{5mm}
 \subsubsection{Example Input File}
-\lstinputlisting[style=inputfile]{./mf6ivar/examples/swf-chd-example.dat}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/chf-chd-example.dat}
 
 %\vspace{5mm}
 %\subsubsection{Available observation types}
-%CHD Package observations are limited to the simulated constant head flow rate (\texttt{chd}). The data required for the CHD Package observation type is defined in table~\ref{table:swf-chdobstype}. Negative and positive values for an observation represent a loss from and gain to the GWF model, respectively.
+%CHD Package observations are limited to the simulated constant head flow rate (\texttt{chd}). The data required for the CHD Package observation type is defined in table~\ref{table:chf-chdobstype}. Negative and positive values for an observation represent a loss from and gain to the GWF model, respectively.
 
 %\begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
 %\caption{Available CHD Package observation types} \tabularnewline

doc/mf6io/chf/chf-gwf.tex

@@ -0,0 +1,43 @@
+Input to the Channel Flow and Groundwater Flow (CHF-GWF) Exchange is read from the file that has type ``CHF6-GWF6'' in the Simulation Name File.
+
+\vspace{5mm}
+\subsubsection{Structure of Blocks}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/exg-chfgwf-options.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/exg-chfgwf-dimensions.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/exg-chfgwf-exchangedata.dat}
+
+\vspace{5mm}
+\subsubsection{Explanation of Variables}
+\begin{description}
+\input{./mf6ivar/tex/exg-chfgwf-desc.tex}
+\end{description}
+
+\vspace{5mm}
+\subsubsection{Example Input File}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/exg-chfgwf-example.dat}
+
+% \vspace{5mm}
+% \subsubsection{Available observation types}
+CHF-GWF Exchange observations include the simulated flow for any exchange (\texttt{flow-ja-face}). The data required for each CHF-GWF Exchange observation type is defined in table~\ref{table:chf-gwfobstype}. For \texttt{flow-ja-face} observation types, negative and positive values represent a loss from and gain to the first model specified for this exchange.
+
+% \begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
+% \caption{Available CHF-GWF Exchange observation types} \tabularnewline
+
+% \hline
+% \hline
+% \textbf{Exchange} & \textbf{Observation type} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+% \hline
+% \endhead
+
+% \hline
+% \endfoot
+
+% \input{../Common/chf-gwfobs.tex}
+% \label{table:chf-gwfobstype}
+% \end{longtable}
+
+
+% \vspace{5mm}
+% \subsubsection{Example Observation Input File}
+% \lstinputlisting[style=inputfile]{./mf6ivar/examples/exg-chfgwf-example-obs.dat}
+

doc/mf6io/swf/swf-obs.tex → doc/mf6io/chf/chf-obs.tex

@@ -1,5 +1,5 @@
 
-SWF Model observations include the simulated stage (\texttt{stage}) at a cell, and the flow between two connected cells (\texttt{flow-ja-face}). The data required for each SWF Model observation type is defined in table~\ref{table:swfobstype}. For \texttt{flow-ja-face} observation types, negative and positive values represent a loss from and gain to the \texttt{cellid} specified for ID, respectively.
+CHF Model observations include the simulated stage (\texttt{stage}) at a cell, and the flow between two connected cells (\texttt{flow-ja-face}). The data required for each CHF Model observation type is defined in table~\ref{table:chfobstype}. For \texttt{flow-ja-face} observation types, negative and positive values represent a loss from and gain to the \texttt{cellid} specified for ID, respectively.
 
 \subsubsection{Structure of Blocks}
 \vspace{5mm}
@@ -15,7 +15,7 @@ \subsubsection{Explanation of Variables}
 
 
 \begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
-\caption{Available SWF model observation types} \tabularnewline
+\caption{Available CHF model observation types} \tabularnewline
 
 \hline
 \hline
@@ -26,14 +26,14 @@ \subsubsection{Explanation of Variables}
 \hline
 \endfoot
 
-\input{../Common/swf-obs.tex}
-\label{table:swfobstype}
+\input{../Common/chf-obs.tex}
+\label{table:chfobstype}
 \end{longtable}
 
 \vspace{5mm}
 \subsubsection{Example Observation Input File}
 
 An example GWF Model observation file is shown below.
 
-\lstinputlisting[style=inputfile]{./mf6ivar/examples/utl-obs-swf-example.dat}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/utl-obs-chf-example.dat}