<p><b>dwj07@fsu.edu</b> 2011-09-07 09:20:38 -0600 (Wed, 07 Sep 2011)</p><p><br>
        Expanding on the initial condition generator.<br>
</p><hr noshade><pre><font color="gray">Modified: branches/ocean_projects/performance/MPASOceanTesting.pdf
===================================================================
(Binary files differ)

Modified: branches/ocean_projects/performance/MPASOceanTesting.tex
===================================================================
--- branches/ocean_projects/performance/MPASOceanTesting.tex        2011-09-07 14:45:56 UTC (rev 980)
+++ branches/ocean_projects/performance/MPASOceanTesting.tex        2011-09-07 15:20:38 UTC (rev 981)
@@ -27,7 +27,6 @@
 %-----------------------------------------------------------------------
 
 \chapter{Requirements}
-
 \section{Initial Condition Generator}
 Date last modified: 2011/09/06 \\
 Contributors: (Doug Jacobsen, others?) \\
@@ -38,15 +37,6 @@
 as well as applying initial conditions for all fields required to run a test
 case.
 
-This code should be well documented so users can easily add a new routine for a
-test case they are interested in, or modify the code to create a grid specific
-to a run they want to perform.
-
-It will read in an MPAS grid, and write out a new MPAS grid file with the
-associated fields set correctly. In addition to this it will output a new
-graph.info file for use with metis.
-
-
 \section{Unit Tests}
 Date last modified: 2011/09/02 \\
 Contributors: (Phil Jones) \\
@@ -91,12 +81,37 @@
 Date last modified: 2011/09/06 \\
 Contributors: (Doug Jacobsen, Others?) \\
 
-This software should be written in a user friendly way and well documented such that a user should easily be able to pick it up, use it, and modify it if needed. It should include routines for the initial conditions of each test case described below, and will allow for a variety of different grids to be generated with the required initial conditions.
+This tools is expected to read in an MPAS grid file. Based on user input, a suitable test case will be selected, which can be either pre-defined or user-defined. Pre-defined examples include those described in this document, where a user-defined one might be something specific a user would want to run. On reading in the grid file, the geometry needs to be modified to fit the test case of interest. For example, if a basin or channel test case is to be used portions of the grid will be removed to build a basin or channel geometry.
 
-This tool should allow the removal of module\_test\_cases.F from within the MPAS source.
+After the geometry is initialized for the test case, the initial conditions will be generated for that test case. These will include fields such as fluid thickness, number of layers, initial velocity, temperature, salinity, etc. Finally, the new grid file using the modified geometry and initial conditions will be written to a new grid file which will be readable by MPAS.
 
-Each test case described in this document should be implemented in this new tool, allowing a grid to be initialized with the correct values for it. In addition to these test cases, the shallow water test cases from Williamson will be implemented, allowing the removal of module\_test\_cases.F from the shallow water core.
+The tool will be written and documented to allow a user to easily use it to generate grid for specific test cases, as well as add new test cases to it. After this tool is complete module\_test\_cases.F can be removed from both core\_sw and core\_ocean as all test cases for these two cores will be included in the tool. 
 
+The layout of the program will be as follows.
+
+\begin{verbatimtab}
+Read in input parameters.
+        Could contain things like what test case to use.
+
+Read in input grid file.
+        To perform grid cutting we only really need to store
+        the coordinates of cells, edges, and vertices.
+
+Using coordinates, build masks for cells edges and vertices.
+
+Build a new grid by applying the masks.
+
+Copy the needed grid data to the new grid file.
+
+Generate initial conditions required for test case.
+        Need to ensure all fields are created that are
+        required for MPAS to run.
+\end{verbatimtab}
+
+To begin, a single ocean test case will be implemented to allow testing of ocean branches. Shallow water test cases should be easily implemented. Afterwards, the rest of the ocean test cases can be implemented.
+
+The test case of choice could be a compile time parameter, or a run time parameter. Each has it's own benefits. Test cases can also be developed as classes, which might allow easier development of new ones.
+
 \section{Unit Tests}
 Date last modified: 2011/09/02 \\
 Contributors: (Doug Jacobsen, Phil Jones) \\

</font>
</pre>