thoar at ucar.edu
2017-07-18 13:28:57 -0600 (Tue, 18 Jul 2017)
30
better interface description
Modified: DART/branches/rma_trunk/models/template/model_mod.html
===================================================================
--- DART/branches/rma_trunk/models/template/model_mod.html 2017-07-18 17:53:50 UTC (rev 11830)
+++ DART/branches/rma_trunk/models/template/model_mod.html 2017-07-18 19:28:57 UTC (rev 11831)
@@ -132,7 +132,7 @@
<TR><TD> </TD><TD><A HREF="#adv_1step">adv_1step</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#get_state_meta_data">get_state_meta_data</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#model_interpolate">model_interpolate</A></TD></TR>
-<TR><TD> </TD><TD><A HREF="#get_model_time_step">get_model_time_step</A></TD></TR>
+<TR><TD> </TD><TD><A HREF="#shortest_time_between_assimilations">shortest_time_between_assimilations</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#static_init_model">static_init_model</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#init_time">init_time</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#init_conditions">init_conditions</A></TD></TR>
@@ -139,13 +139,12 @@
<TR><TD> </TD><TD><A HREF="#nc_write_model_atts">nc_write_model_atts</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#nc_write_model_vars">nc_write_model_vars</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#pert_model_copies">pert_model_copies</A></TD></TR>
-<TR><TD> </TD><TD><A HREF="#get_close_maxdist_init">get_close_maxdist_init</A></TD></TR>
-<TR><TD> </TD><TD><A HREF="#get_close_obs_init">get_close_obs_init</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#get_close_obs">get_close_obs</A></TD></TR>
-<TR><TD> </TD><TD><A HREF="#get_close_state_init">get_close_state_init</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#get_close_state">get_close_state</A></TD></TR>
-<TR><TD> </TD><TD><A HREF="#query_vert_localization_coord">query_vert_localization_coord</A></TD></TR>
-<TR><TD> </TD><TD><A HREF="#vert_convert">vert_convert</A></TD></TR>
+
+<TR><TD> </TD><TD><A HREF="#convert_vertical_obs">convert_vertical_obs</A></TD></TR>
+<TR><TD> </TD><TD><A HREF="#convert_vertical_state">convert_vertical_state</A></TD></TR>
+
<TR><TD> </TD><TD><A HREF="#read_model_time">read_model_time</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#write_model_time">write_model_time</A></TD></TR>
<TR><TD> </TD><TD><A HREF="#end_model">end_model</A></TD></TR>
@@ -246,10 +245,9 @@
<A NAME="get_state_meta_data"></A>
<br>
<div class=routine>
-<em class=call>call get_state_meta_data (state_handle, index_in, location,
+<em class=call>call get_state_meta_data (index_in, location,
<em class=optionalcode>[, var_type]</em> )</em>
<pre>
-type(ensemble_type), intent(in) :: <em class=code>state_handle</em>
integer, intent(in) :: <em class=code>index_in</em>
type(location_type), intent(out) :: <em class=code>location</em>
integer, optional, intent(out) :: <em class=optionalcode> var_type </em>
@@ -260,8 +258,8 @@
<!-- Description -->
<P>
-Given a handle to a state structure and an integer index into the state vector, returns the
-associated location. A second intent(out) optional argument
+Given an integer index into the state vector, returns the
+associated location. An optional argument
returns the generic quantity of this item, e.g. QTY_TEMPERATURE,
QTY_DENSITY, QTY_SALINITY, QTY_U_WIND_COMPONENT.
This interface is required to be functional for all applications.
@@ -269,10 +267,6 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>state_handle </em></TD>
- <TD>The handle to the state structure containing the state vector
- about which information is requested.</TD></TR>
-
<TR><TD valign=top><em class=code>index_in</em></TD>
<TD>Index of state vector element about which information is requested.</TD></TR>
@@ -353,12 +347,12 @@
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
-<A NAME="get_model_time_step"></A>
+<A NAME="shortest_time_between_assimilations"></A>
<br>
<div class=routine>
-<em class=call>var = get_model_time_step()</em>
+<em class=call>var = shortest_time_between_assimilations()</em>
<pre>
-type(time_type) :: <em class=code>get_model_time_step</em>
+type(time_type) :: <em class=code>shortest_time_between_assimilations</em>
</pre>
</div>
@@ -638,162 +632,6 @@
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
-<A NAME="get_close_maxdist_init"></A>
-<br>
-<div class=routine>
-<em class=call>call get_close_maxdist_init(gc, maxdist
- <em class=optionalcode>[, maxdist_list]</em>)</em>
-<pre>
-type(get_close_type), intent(inout) :: <em class=code>gc</em>
-real(r8), intent(in) :: <em class=code>maxdist</em>
-real(r8), optional, intent(in) :: <em class=optionalcode>maxdist_list(:)</em>
-</pre>
-</div>
-
-<div class=indent1>
-<!-- Description -->
-
-<P>