<p><b>dwj07@fsu.edu</b> 2013-02-28 11:06:57 -0700 (Thu, 28 Feb 2013)</p><p><br>
-- DOCUMENT COMMIT --<br>
<br>
Adding some namelist record documentation.<br>
<br>
Removing text blocks from the descriptive table format in the users guide.<br>
</p><hr noshade><pre><font color="gray">Modified: trunk/documents/users_guide/mpas_ocean_users_guide.tex
===================================================================
--- trunk/documents/users_guide/mpas_ocean_users_guide.tex 2013-02-27 22:25:28 UTC (rev 2514)
+++ trunk/documents/users_guide/mpas_ocean_users_guide.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -5,6 +5,7 @@
\usepackage{longtable}
\usepackage{hyperref}
\usepackage{color}
+\usepackage{caption}
\setlength{\topmargin}{0in}
\setlength{\headheight}{0in}
@@ -14,7 +15,11 @@
\setlength{\evensidemargin}{0in}
\setlength{\oddsidemargin}{0in}
+\captionsetup{width=6in}
+\captionsetup{format=hang}
+\captionsetup{justification=RaggedRight}
+
\setlength\LTleft\parindent
\setlength\LTright\fill
Modified: trunk/documents/users_guide/ocn/namelist_section_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocn/namelist_section_documentation.tex 2013-02-27 22:25:28 UTC (rev 2514)
+++ trunk/documents/users_guide/ocn/namelist_section_documentation.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -443,7 +443,6 @@
\end{center}
\section{hmix}
\label{sec:nm_sec_hmix}
-\input{ocn/section_descriptions/hmix.tex}
\subsection{config\_hmix\_ScaleWithMesh}
\label{subsec:nm_sec_config_hmix_ScaleWithMesh}
\begin{center}
@@ -494,7 +493,6 @@
\end{center}
\section{hmix\_del2}
\label{sec:nm_sec_hmix_del2}
-\input{ocn/section_descriptions/hmix_del2.tex}
\subsection{config\_use\_mom\_del2}
\label{subsec:nm_sec_config_use_mom_del2}
\begin{center}
Modified: trunk/documents/users_guide/ocn/namelist_table_documentation.tex
===================================================================
--- trunk/documents/users_guide/ocn/namelist_table_documentation.tex 2013-02-27 22:25:28 UTC (rev 2514)
+++ trunk/documents/users_guide/ocn/namelist_table_documentation.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -1,6 +1,7 @@
\chapter{Namelist options}
\section{time\_management}
\label{sec:nm_tab_time_management}
+\input{ocn/section_descriptions/time_management.tex}
{\small
\begin{center}
\begin{longtable}{| p{2.0in} | p{4.0in} |}
@@ -70,6 +71,7 @@
}
\section{grid}
\label{sec:nm_tab_grid}
+\input{ocn/section_descriptions/grid.tex}
{\small
\begin{center}
\begin{longtable}{| p{2.0in} | p{4.0in} |}
@@ -91,6 +93,7 @@
}
\section{decomposition}
\label{sec:nm_tab_decomposition}
+\input{ocn/section_descriptions/decomposition.tex}
{\small
\begin{center}
\begin{longtable}{| p{2.0in} | p{4.0in} |}
@@ -454,6 +457,7 @@
}
\section{debug}
\label{sec:nm_tab_debug}
+\input{ocn/section_descriptions/debug.tex}
{\small
\begin{center}
\begin{longtable}{| p{2.0in} | p{4.0in} |}
Added: trunk/documents/users_guide/ocn/section_descriptions/debug.tex
===================================================================
--- trunk/documents/users_guide/ocn/section_descriptions/debug.tex (rev 0)
+++ trunk/documents/users_guide/ocn/section_descriptions/debug.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -0,0 +1,6 @@
+At run-time a user can enable debugging features within MPAS-Ocean. These
+features include disabling any tendencies to help determine why an issue might
+be happening. Debugging options also include various checks on certain fields,
+and the ability to prescribe both a thickness and velocity field at run-time
+which are constant throughout a simulation. All options that control these
+debugging features are specified within the debug namelist record.
Added: trunk/documents/users_guide/ocn/section_descriptions/decomposition.tex
===================================================================
--- trunk/documents/users_guide/ocn/section_descriptions/decomposition.tex (rev 0)
+++ trunk/documents/users_guide/ocn/section_descriptions/decomposition.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -0,0 +1,8 @@
+MPAS handles decompositing all variables into computational blocks. The
+decomposition used needs to be specified at run time and is computed by an
+external tool (e.g. metis). Additionally MPAS supports multiple computational
+blocks per MPI process, and the user may specify an additional decomposition
+file which can specify the assignment of blocks to MPI processes. Run-time
+parameters that control the run-time decomposition used are specified within
+the decomposition namelist record.
+
Added: trunk/documents/users_guide/ocn/section_descriptions/grid.tex
===================================================================
--- trunk/documents/users_guide/ocn/section_descriptions/grid.tex (rev 0)
+++ trunk/documents/users_guide/ocn/section_descriptions/grid.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -0,0 +1,4 @@
+The grid namelist records provides options that modify both the horizontal and
+vertical MPAS-Ocean grids. This namelist record can be used to modify the
+number of halo cells each computational block contains, as well as changing how
+vertical coordinates move.
Added: trunk/documents/users_guide/ocn/section_descriptions/time_management.tex
===================================================================
--- trunk/documents/users_guide/ocn/section_descriptions/time_management.tex (rev 0)
+++ trunk/documents/users_guide/ocn/section_descriptions/time_management.tex 2013-02-28 18:06:57 UTC (rev 2515)
@@ -0,0 +1,8 @@
+General time management is handlede by the time\_management namelist record.
+Included options handle time related parts of MPAS such as the calendar that is
+used throughout a simulation, and if the simulation is a restart or not.
+
+Users should use this record to specify the beginning time of the simulation,
+and either the duration or the end of the simulation. Only the end or the
+duration need to be specified as the other is derived within MPAS from the
+beginning time and other specified one.
</font>
</pre>