[Dart-dev] DART/branches Revision: 11924

[dart at ucar.edu]

thoar at ucar.edu
2017-08-30 16:38:53 -0600 (Wed, 30 Aug 2017)
34
Much more accurate descriptions.




Modified: DART/branches/rma_trunk/models/template/model_mod.html
===================================================================
--- DART/branches/rma_trunk/models/template/model_mod.html	2017-08-30 22:37:27 UTC (rev 11923)
+++ DART/branches/rma_trunk/models/template/model_mod.html	2017-08-30 22:38:53 UTC (rev 11924)
@@ -99,10 +99,8 @@
 A good example can be found in the lorenz_96 <em class=file>model_mod.f90</em>.
 </P>
 
-<br />
-<br />
-
 <!--==================================================================-->
+<P><!-- useless spacer to make the top behave correctly --></P>
 
 <A NAME="Interface"></A>
 <div class="top">[<a href="#">top</a>]</div><hr />
@@ -172,7 +170,7 @@
 <div class=routine>
 <em class=call>model_size = get_model_size( )</em>
 <pre>
-integer :: <em class=code>get_model_size</em>
+integer(i8) :: <em class=code>get_model_size</em>
 </pre>
 </div>
 
@@ -274,7 +272,7 @@
     <TD>The location of state variable element.</TD></TR>
 
 <TR><TD valign=top><em class=optionalcode>var_type</em></TD>
-    <TD>The generic kind of the state variable element.</TD></TR>
+    <TD>The generic quantity of the state variable element.</TD></TR>
 
 </TABLE>
 
@@ -308,9 +306,9 @@
 variable should be returned as 0 unless there is some problem in 
 computing the interpolation in which case a positive value should be 
 returned. The <em class=code>itype</em> variable
-is one of the KIND parameters defined in the
+is one of the quantity (QTY) parameters defined in the
 <a href="../../assimilation_code/modules/observations/obs_kind_mod.html">obs_kind_mod.f90</a> file
-and defines which generic kind of item is being interpolated.
+and maps the quantity to a model variable for the interpolation.
 In low-order models that have no notion of kinds of variables this argument may
 be ignored. For applications in which only perfect model experiments
 with identity observations (i.e. only the value of a particular
@@ -473,11 +471,10 @@
 <A NAME="nc_write_model_atts"></A>
 <br>
 <div class=routine>
-<em class=call>ierr = nc_write_model_atts(ncFileID)</em>
+<em class=call>call nc_write_model_atts(ncFileID, domain_id)</em>
 <pre>
-integer, intent(in)  :: <em class=code>ncFileID</em>
-logical, intent(out) :: <em class=code>model_mod_writes_state_variables</em>
-integer              :: <em class=code>nc_write_model_atts</em>
+integer, intent(in) :: <em class=code>ncFileID</em>
+integer, intent(in) :: <em class=code>domain_id</em>
 </pre>
 </div>
 
@@ -510,14 +507,13 @@
 <TR><TD valign=top><em class=code>ncFileID</em></TD>
     <TD>Integer file descriptor to previously-opened netCDF file.</TD></TR>
 
-<TR><TD valign=top><em class=code>model_mod_writes_state_variables   </em></TD>
-    <TD>logical descriptor to flag whether or not the <em class=code>model_mod</em>
-        will write the actual state variables or the DART-intrinsic routines will write them.
-    </TD></TR>
+<TR><TD valign=top><em class=code>domain_id</em></TD>
+        <TD>integer describing the domain (which can be a nesting level, a component 
+        model ...) Models with nested grids are decomposed into 'domains' in DART.
+        The concept is extended to refer to 'coupled' models where one model component
+        may be the atmosphere, another component may be the ocean, or land, or 
+        ionosphere ... these would be referenced as different domains. </TD></TR>
 
-<TR><TD valign=top><em class=code>ierr</em></TD>
-    <TD>Returns a 0 for successful completion.</TD></TR>
-
 </TABLE>
 
 </div>
@@ -528,13 +524,15 @@
 <A NAME="nc_write_model_vars"></A>
 <br>
 <div class=routine>
-<em class=call>ierr = nc_write_model_vars(ncFileID, statevec, copyindex, timeindex)</em>
+<em class=call>call nc_write_model_vars(ncFileID, domain_id, state_ens_handle 
+  <em class=optionalcode>[, memberindex]</em>
+  <em class=optionalcode>[, timeindex]</em>)</em>
 <pre>
-integer                            :: <em class=code>nc_write_model_vars</em>
-integer,                intent(in) :: <em class=code>ncFileID</em>
-real(r8), dimension(:), intent(in) :: <em class=code>statevec</em>
-integer,                intent(in) :: <em class=code>copyindex</em>
-integer,                intent(in) :: <em class=code>timeindex</em>
+integer,             intent(in) :: <em class=code>ncFileID</em>
+integer,             intent(in) :: <em class=code>domain_id</em>
+type(ensemble_type), intent(in) :: <em class=code>state_ens_handle</em>
+integer, optional,   intent(in) :: <em class=optionalcode>memberindex</em>
+integer, optional,   intent(in) :: <em class=optionalcode>timeindex</em>