[Dart-dev] [6508] DART/trunk/ensemble_manager/ensemble_manager_mod.html: change <br> to <br /> to make html checker happy.
nancy at ucar.edu
nancy at ucar.edu
Wed Oct 9 16:37:21 MDT 2013
Revision: 6508
Author: nancy
Date: 2013-10-09 16:37:21 -0600 (Wed, 09 Oct 2013)
Log Message:
-----------
change <br> to <br /> to make html checker happy.
ditto with adding a 'summary' tag to all <TABLE>s.
also removed unneeded s to make the routine
argument tables more legible. doesn't seem to affect
the resulting output in any way.
Modified Paths:
--------------
DART/trunk/ensemble_manager/ensemble_manager_mod.html
-------------- next part --------------
Modified: DART/trunk/ensemble_manager/ensemble_manager_mod.html
===================================================================
--- DART/trunk/ensemble_manager/ensemble_manager_mod.html 2013-10-09 22:31:00 UTC (rev 6507)
+++ DART/trunk/ensemble_manager/ensemble_manager_mod.html 2013-10-09 22:37:21 UTC (rev 6508)
@@ -11,7 +11,7 @@
<H1>MODULE ensemble_manager_mod</H1>
-<table border=0 summary="" cellpadding=5>
+<table border=0 summary="dart logo" cellpadding=5>
<tr>
<td valign=middle>
<img src="../doc/images/Dartboard7.png" alt="DART project logo" height=70 />
@@ -225,7 +225,7 @@
</table>
</div>
-<br>
+<br />
<!--==================================================================-->
@@ -296,7 +296,7 @@
<!--=================== DESCRIPTION OF A LOCAL TYPE ==================-->
<A NAME="ensemble_type"></A>
-<BR>
+<br />
<div class=type>
<pre>
<em class=call>type ensemble_type</em>
@@ -400,12 +400,12 @@
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="init_ensemble_manager"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call init_ensemble_manager(ens_handle, num_copies, num_vars
<em class=optionalcode>[, distribution_type_in]</em>
@@ -427,7 +427,7 @@
size descriptions in the ensemble_type are initialized.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
<TR><TD valign=top><em class=code>ens_handle</em></TD>
<TD>Handle for the ensemble being initialized</TD></TR>
<TR><TD valign=top><em class=code>num_copies</em></TD>
@@ -445,12 +445,12 @@
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="read_ensemble_restart"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call read_ensemble_restart(ens_handle, start_copy, end_copy,
start_from_restart, file_name
@@ -488,33 +488,33 @@
directly and independently.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle of ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>start_copy </em></TD>
+<TR><TD valign=top><em class=code>start_copy </em></TD>
<TD>Global index of first of continguous set of copies to be read.</TD></TR>
-<TR><TD valign=top><em class=code>end_copy </em></TD>
+<TR><TD valign=top><em class=code>end_copy </em></TD>
<TD>Global index of last of contiguous set of copies to be read,
copies(start_copy:end_copy).</TD></TR>
-<TR><TD valign=top><em class=code>start_from_restart </em></TD>
+<TR><TD valign=top><em class=code>start_from_restart </em></TD>
<TD>If true, read all copies from file. If false, read one copy and perturb
to get required number.</TD></TR>
-<TR><TD valign=top><em class=code>file_name </em></TD>
+<TR><TD valign=top><em class=code>file_name </em></TD>
<TD>Name of file from which to read.</TD></TR>
-<TR><TD valign=top><em class=optionalcode>init_time </em></TD>
+<TR><TD valign=top><em class=optionalcode>init_time </em></TD>
<TD>If present, set time of all copies read to this value.</TD></TR>
-<TR><TD valign=top><em class=optionalcode>force_single_file </em></TD>
+<TR><TD valign=top><em class=optionalcode>force_single_file </em></TD>
<TD>If present and true, force the read to be from a single file which
contains all copies.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="write_ensemble_restart"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call write_ensemble_restart(ens_handle, file_name, start_copy,
end_copy <em class=optionalcode>[, force_single_file]</em>) </em>
@@ -545,28 +545,30 @@
directly and independently.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
- <TD>Handle of ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>file_name </em></TD>
- <TD>Name of file from which to read.</TD></TR>
-<TR><TD valign=top><em class=code>start_copy </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD><em class=code> ens_handle </em></TD>
+ <TD>Handle of ensemble.</TD>
+</TR>
+<TR><TD><em class=code> file_name </em></TD>
+ <TD>Name of file from which to read.</TD>
+</TR>
+<TR><TD valign=top><em class=code>start_copy </em></TD>
<TD>Global index of first of continguous set of copies to be written.</TD></TR>
-<TR><TD valign=top><em class=code>end_copy </em></TD>
+<TR><TD valign=top><em class=code>end_copy </em></TD>
<TD>Global index of last of contiguous set of copies to be written,
copies(start_copy:end_copy).</TD></TR>
-<TR><TD valign=top><em class=optionalcode>force_single_file </em></TD>
+<TR><TD valign=top><em class=optionalcode>force_single_file </em></TD>
<TD>If present and true, force the write to be to a single file which
contains all copies.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_copy"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_copy(receiving_pe, ens_handle, copy, vars
<em class=optionalcode>[, mtime]</em>) </em>
@@ -591,30 +593,30 @@
Data is only returned in vars on the receiving PE; vars on all other PEs is unset.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>receiving_pe </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>receiving_pe </em></TD>
<TD>This process ends up with the requested copy of the state
vector.</TD></TR>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>copy </em></TD>
+<TR><TD valign=top><em class=code>copy </em></TD>
<TD>The global index of the copy of the state vector that is to be
retrieved.</TD></TR>
-<TR><TD valign=top><em class=code>vars </em></TD>
+<TR><TD valign=top><em class=code>vars </em></TD>
<TD>One dimensional array in which the requested copy of the state vector
is returned. Data is only returned in vars on the receiving PE;
vars on all other PEs is unset. </TD></TR>
-<TR><TD valign=top><em class=optionalcode>mtime </em></TD>
+<TR><TD valign=top><em class=optionalcode>mtime </em></TD>
<TD>If present returns the time of the requested copy.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="put_copy"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call put_copy(sending_pe, ens_handle, copy, vars
<em class=optionalcode>[, mtime]</em>) </em>
@@ -641,29 +643,29 @@
is processed; vars on all other PEs is ignored.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>sending_pe </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>sending_pe </em></TD>
<TD>This process sends the copy of the state vector.</TD></TR>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>copy </em></TD>
+<TR><TD valign=top><em class=code>copy </em></TD>
<TD>The global index of the copy of the state vector that is to be sent.
</TD></TR>
-<TR><TD valign=top><em class=code>vars </em></TD>
+<TR><TD valign=top><em class=code>vars </em></TD>
<TD>One dimensional array in which the requested copy of the state vector
is located. Only the data in vars on the sending PE
is processed; vars on all other PEs is ignored. </TD></TR>
-<TR><TD valign=top><em class=optionalcode>mtime </em></TD>
+<TR><TD valign=top><em class=optionalcode>mtime </em></TD>
<TD>If present send the time of the copy.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="broadcast_copy"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call broadcast_copy(ens_handle, copy, arraydata)</em>
<pre>
@@ -685,24 +687,24 @@
all processes in the job.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>copy </em></TD>
+<TR><TD valign=top><em class=code>copy </em></TD>
<TD>The global index of the copy of the state vector that is to be sent.
</TD></TR>
-<TR><TD valign=top><em class=code>arraydata </em></TD>
+<TR><TD valign=top><em class=code>arraydata </em></TD>
<TD>One dimensional array into which the requested copy of the state vector
will be copied on all PEs, including the sending PE.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="set_ensemble_time"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call set_ensemble_time(ens_handle, indx, mtime) </em>
<pre>
@@ -725,23 +727,23 @@
and to get the local index number for that copy.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>indx </em></TD>
+<TR><TD valign=top><em class=code>indx </em></TD>
<TD>The local index of the copy of the state vector that is to be set.
</TD></TR>
-<TR><TD valign=top><em class=code>mtime </em></TD>
+<TR><TD valign=top><em class=code>mtime </em></TD>
<TD>The time to set for this copy. </TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_ensemble_time"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_ensemble_time(ens_handle, indx, mtime) </em>
<pre>
@@ -764,18 +766,18 @@
<a href="#get_copy_time">get_copy_time()</a> which uses global copy numbers. -->
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>indx </em></TD>
+<TR><TD valign=top><em class=code>indx </em></TD>
<TD>The local index of the copy to retrieve the time from.
</TD></TR>
-<TR><TD valign=top><em class=code>mtime </em></TD>
+<TR><TD valign=top><em class=code>mtime </em></TD>
<TD>The returned time value. </TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--
@@ -785,7 +787,7 @@
....===================== DESCRIPTION OF A ROUTINE =====================...
<A NAME="set_copy_time"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call set_copy_time(ens_handle, copy, mtime) </em>
<pre>
@@ -807,18 +809,18 @@
but only the process that stores the requested copy will do the update.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>copy </em></TD>
+<TR><TD valign=top><em class=code>copy </em></TD>
<TD>The global number of the copy that is to be set.
</TD></TR>
-<TR><TD valign=top><em class=code>mtime </em></TD>
+<TR><TD valign=top><em class=code>mtime </em></TD>
<TD>The time to set for this copy. </TD></TR>
</TABLE>
</div>
-<br>
+<br />
....===================== DESCRIPTION OF A ROUTINE =====================...
@@ -827,7 +829,7 @@
should we make it communicate?
<A NAME="get_copy_time"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_copy_time(ens_handle, copy, mtime) </em>
<pre>
@@ -851,18 +853,18 @@
you are the owner.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>copy </em></TD>
+<TR><TD valign=top><em class=code>copy </em></TD>
<TD>The global index of the copy to retrieve the time from.
</TD></TR>
-<TR><TD valign=top><em class=code>mtime </em></TD>
+<TR><TD valign=top><em class=code>mtime </em></TD>
<TD>The returned time value. </TD></TR>
</TABLE>
</div>
-<br>
+<br />
-->
@@ -870,7 +872,7 @@
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="end_ensemble_manager"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call end_ensemble_manager(ens_handle) </em>
<pre>
@@ -885,18 +887,18 @@
Frees up storage associated with an ensemble.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="duplicate_ens"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call duplicate_ens(ens1, ens2, duplicate_time) </em>
<pre>
@@ -925,17 +927,17 @@
Data from the vars array will be replicated.</TD></TR>
<TR><TD valign=top><em class=code>ens2</em></TD>
<TD>Ensemble handle of ensemble into which ens1 vars data will be copied.</TD></TR>
-<TR><TD valign=top><em class=code>duplicate_time </em></TD>
+<TR><TD valign=top><em class=code>duplicate_time </em></TD>
<TD>If true, copy the times from ens1 into ens2, else leave ens2 times unchanged.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_my_num_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> var = get_my_num_copies(ens_handle) </em>
<pre>
@@ -954,21 +956,21 @@
with only a single process.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>var </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>var </em></TD>
<TD>Returns the number of copies stored by this process when storing all
variables for a subset of copies. </TD></TR>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_my_num_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> var = get_my_num_vars(ens_handle) </em>
<pre>
@@ -986,21 +988,21 @@
with only a single process.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>var </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>var </em></TD>
<TD>Returns the number of vars stored by this process when storing all
copies of a subset of variables. </TD></TR>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_my_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_my_copies(ens_handle, copies) </em>
<pre>
@@ -1017,21 +1019,21 @@
when storing subset of copies of all variables.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>copies </em></TD>
+<TR><TD valign=top><em class=code>copies </em></TD>
<TD>List of all copies stored by this process when storing subset of copies
of all variables.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_my_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_my_vars(ens_handle, vars) </em>
<pre>
@@ -1048,21 +1050,21 @@
when storing all copies of a subset of variables.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>vars </em></TD>
+<TR><TD valign=top><em class=code>vars </em></TD>
<TD>List of all variables stored on this process when storing all copies
of a subset of variables.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_copy_owner_index"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_copy_owner_index(copy_number, owner, owners_index) </em>
<pre>
@@ -1081,23 +1083,23 @@
the local storage index for this copy on that process.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
<TR><TD valign=top><em class=code>copy_number</em></TD>
<TD>Global index of a copy from an ensemble.</TD></TR>
<TR><TD valign=top><em class=code>owner</em></TD>
<TD>Process Element (PE) that stores this copy when each has all
variables of a subset of copies.</TD></TR>
-<TR><TD valign=top><em class=code>owners_index </em></TD>
+<TR><TD valign=top><em class=code>owners_index </em></TD>
<TD>Local storage index for this copy on the owning process.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_var_owner_index"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call get_var_owner_index(var_number, owner, owners_index) </em>
<pre>
@@ -1116,23 +1118,23 @@
the local storage index for this variable on that process.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
<TR><TD valign=top><em class=code>var_number</em></TD>
<TD>Global index of a variable in the vector from an ensemble.</TD></TR>
<TR><TD valign=top><em class=code>owner</em></TD>
<TD>Process Element (PE) that stores this variable when each has all
copies of subset of variables.</TD></TR>
-<TR><TD valign=top><em class=code>owners_index </em></TD>
+<TR><TD valign=top><em class=code>owners_index </em></TD>
<TD>Local storage index for this variable on the owning process.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="all_vars_to_all_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call all_vars_to_all_copies(ens_handle, label) </em>
<pre>
@@ -1167,21 +1169,21 @@
vars arrays, so either can be used as a data source.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>The handle of the ensemble being transposed.</TD></TR>
-<TR><TD valign=top><em class=code>label </em></TD>
+<TR><TD valign=top><em class=code>label </em></TD>
<TD>A character string label. If present, a timestamp with this
label is printed at the start and end of the transpose. </TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="all_copies_to_all_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call all_copies_to_all_vars(ens_handle, label) </em>
<pre>
@@ -1217,21 +1219,21 @@
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>The handle of the ensemble being transposed.</TD></TR>
-<TR><TD valign=top><em class=code>label </em></TD>
+<TR><TD valign=top><em class=code>label </em></TD>
<TD>A character string label. If present, a timestamp with this
label is printed at the start and end of the transpose. </TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="compute_copy_mean"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call compute_copy_mean(ens_handle, start_copy, end_copy, mean_copy) </em>
<pre>
@@ -1256,24 +1258,24 @@
array data is more current and the vars data is stale.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>start_copy </em></TD>
+<TR><TD valign=top><em class=code>start_copy </em></TD>
<TD>Global index of first copy in mean and sd computation.</TD></TR>
-<TR><TD valign=top><em class=code>end_copy </em></TD>
+<TR><TD valign=top><em class=code>end_copy </em></TD>
<TD>Global index of last copy in mean and sd computation.</TD></TR>
-<TR><TD valign=top><em class=code>mean_copy </em></TD>
+<TR><TD valign=top><em class=code>mean_copy </em></TD>
<TD>Global index of copy into which mean is written.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="compute_copy_mean_sd"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call compute_copy_mean_sd(ens_handle, start_copy, end_copy, mean_copy, sd_copy) </em>
<pre>
@@ -1300,26 +1302,26 @@
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>start_copy </em></TD>
+<TR><TD valign=top><em class=code>start_copy </em></TD>
<TD>Global index of first copy in mean and sd computation.</TD></TR>
-<TR><TD valign=top><em class=code>end_copy </em></TD>
+<TR><TD valign=top><em class=code>end_copy </em></TD>
<TD>Global index of last copy in mean and sd computation.</TD></TR>
-<TR><TD valign=top><em class=code>mean_copy </em></TD>
+<TR><TD valign=top><em class=code>mean_copy </em></TD>
<TD>Global index of copy into which mean is written.</TD></TR>
-<TR><TD valign=top><em class=code>sd_copy </em></TD>
+<TR><TD valign=top><em class=code>sd_copy </em></TD>
<TD>Global index of copy into which standard deviation is written.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="compute_copy_mean_var"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call compute_copy_mean_var(ens_handle, start_copy, end_copy, mean_copy, var_copy) </em>
<pre>
@@ -1345,26 +1347,26 @@
array data is more current and the vars data is stale.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>start_copy </em></TD>
+<TR><TD valign=top><em class=code>start_copy </em></TD>
<TD>Global index of first copy in mean and sd computation.</TD></TR>
-<TR><TD valign=top><em class=code>end_copy </em></TD>
+<TR><TD valign=top><em class=code>end_copy </em></TD>
<TD>Global index of last copy in mean and sd computation.</TD></TR>
-<TR><TD valign=top><em class=code>mean_copy </em></TD>
+<TR><TD valign=top><em class=code>mean_copy </em></TD>
<TD>Global index of copy into which mean is written.</TD></TR>
-<TR><TD valign=top><em class=code>var_copy </em></TD>
+<TR><TD valign=top><em class=code>var_copy </em></TD>
<TD>Global index of copy into which variance is written.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="prepare_to_update_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call prepare_to_update_vars(ens_handle) </em>
<pre>
@@ -1403,18 +1405,18 @@
the representations.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for the ensemble being accessed directly.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="prepare_to_update_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call prepare_to_update_copies(ens_handle) </em>
<pre>
@@ -1453,18 +1455,18 @@
the representations.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for the ensemble being accessed directly.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="prepare_to_read_from_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call prepare_to_read_from_vars(ens_handle) </em>
<pre>
@@ -1503,18 +1505,18 @@
the representations.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for the ensemble being accessed directly.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="prepare_to_read_from_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call prepare_to_read_from_copies(ens_handle) </em>
<pre>
@@ -1553,18 +1555,18 @@
the representations.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for the ensemble being accessed directly.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="prepare_to_write_to_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call prepare_to_write_to_vars(ens_handle) </em>
<pre>
@@ -1606,18 +1608,18 @@
the representations.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for the ensemble being accessed directly.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="prepare_to_write_to_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call prepare_to_write_to_copies(ens_handle) </em>
<pre>
@@ -1659,13 +1661,13 @@
the representations.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for the ensemble being accessed directly.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--==================================================================-->
@@ -1690,7 +1692,7 @@
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_max_num_copies"></A>
-<br>
+<br />
<div class=routine>
<em class=call> var = get_max_num_copies(num_copies) </em>
<pre>
@@ -1709,21 +1711,21 @@
Used to get size for creating storage to receive a list of the copies on a PE.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>var </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>var </em></TD>
<TD>Returns the largest number of copies any an individual PE when
var complete. </TD></TR>
-<TR><TD valign=top><em class=code>num_copies </em></TD>
+<TR><TD valign=top><em class=code>num_copies </em></TD>
<TD>Total number of copies in the ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_max_num_vars"></A>
-<br>
+<br />
<div class=routine>
<em class=call> var = get_max_num_vars(num_vars) </em>
<pre>
@@ -1742,21 +1744,21 @@
Used to get size for creating storage to receive a list of the vars on a PE.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>var </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>var </em></TD>
<TD>Returns the largest number of vars any an individual PE when
copy complete. </TD></TR>
-<TR><TD valign=top><em class=code>num_copies </em></TD>
+<TR><TD valign=top><em class=code>num_copies </em></TD>
<TD>Total number of vars in an ensemble vector.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="set_up_ens_distribution"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call set_up_ens_distribution(ens_handle) </em>
<pre>
@@ -1775,18 +1777,18 @@
total number of processes.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_var_list"></A>
-<br>
+<br />
<div class=routine>
<em class=call>call get_var_list(num_vars, pe, var_list, pes_num_vars) </em>
<pre>
@@ -1807,28 +1809,28 @@
Depends on distribution_type with only option 1 currently implemented.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>num_vars </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>num_vars </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>pe </em></TD>
+<TR><TD valign=top><em class=code>pe </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>var_list(:) </em></TD>
+<TR><TD valign=top><em class=code>var_list(:) </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>pes_num_vars </em></TD>
+<TR><TD valign=top><em class=code>pes_num_vars </em></TD>
<TD>
</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="get_copy_list"></A>
-<br>
+<br />
<div class=routine>
<em class=call>call get_copy_list(num_copies, pe, copy_list, pes_num_copies) </em>
<pre>
@@ -1849,28 +1851,28 @@
Depends on distribution_type with only option 1 currently implemented.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>num_copies </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>num_copies </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>pe </em></TD>
+<TR><TD valign=top><em class=code>pe </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>copy_list(:) </em></TD>
+<TR><TD valign=top><em class=code>copy_list(:) </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>pes_num_copies </em></TD>
+<TR><TD valign=top><em class=code>pes_num_copies </em></TD>
<TD>
</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="timestamp_message"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call timestamp_message(msg
<em class=optionalcode>[, sync]</em>
@@ -1892,16 +1894,16 @@
default is only task 0 prints a timestamp.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>msg </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>msg </em></TD>
<TD> character string to prepend to the time info
</TD></TR>
-<TR><TD valign=top><em class=optionalcode>sync </em></TD>
+<TR><TD valign=top><em class=optionalcode>sync </em></TD>
<TD> if present and true, execute an MPI_Barrier() to sync all MPI tasks
before printing the time. this means the time will be the
value of the slowest of the tasks to reach this point.
</TD></TR>
-<TR><TD valign=top><em class=optionalcode>alltasks </em></TD>
+<TR><TD valign=top><em class=optionalcode>alltasks </em></TD>
<TD> if present and true, have all tasks print out a timestamp.
the default is for just task 0 to print. the usual combination
is either sync=true and alltasks=false, or sync=false and alltasks=true.
@@ -1909,12 +1911,12 @@
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="print_ens_handle"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call print_ens_handle(ens_handle, force, label)</em>
<pre>
@@ -1935,26 +1937,26 @@
provide context for the output.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>The derived type to print information about.
</TD></TR>
-<TR><TD valign=top><em class=code>force </em></TD>
+<TR><TD valign=top><em class=code>force </em></TD>
<TD>If the <em class=code>debug</em> namelist item is false, set
this to true to enable printing.
</TD></TR>
-<TR><TD valign=top><em class=code>label </em></TD>
+<TR><TD valign=top><em class=code>label </em></TD>
<TD>Optional string label to print to provide context for the output.
</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="assign_tasks_to_pes"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call assign_tasks_to_pes(ens_handle, nEns_members, layout_type) </em>
<pre>
@@ -1977,24 +1979,24 @@
2. Round-robin on the nodes
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code> </em></TD>
+<TR><TD valign=top><em class=code> </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code> </em></TD>
+<TR><TD valign=top><em class=code> </em></TD>
<TD>
</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="round_robin"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call round_robin(ens_handle)</em>
<pre>
@@ -2013,18 +2015,18 @@
place to start. Test with the smoother.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="create_pe_to_task_list"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call create_pe_to_task_list(ens_handle)</em>
<pre>
@@ -2041,18 +2043,18 @@
otherwise this routine will just return nonsense.
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="calc_tasks_on_each_node"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call calc_tasks_on_each_node(nodes, last_node_task_number)</em>
<pre>
@@ -2072,22 +2074,22 @@
mpi tasks = 17
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>nodes </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>nodes </em></TD>
<TD>
</TD></TR>
-<TR><TD valign=top><em class=code>last_node_task_number </em></TD>
+<TR><TD valign=top><em class=code>last_node_task_number </em></TD>
<TD>
</TD></TR>
</TABLE>
</div>
-<br>
+<br />
<!--===================== DESCRIPTION OF A ROUTINE =====================-->
<A NAME="simple_layout"></A>
-<br>
+<br />
<div class=routine>
<em class=call> call simple_layout(ens_handle, n)</em>
<pre>
@@ -2104,21 +2106,21 @@
where my_pe = my_task_id()
</P>
-<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_handle </em></TD>
+<TABLE width=100% border=0 summary="argument description" cellpadding=3>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
<TD>Handle for an ensemble.</TD></TR>
-<TR><TD valign=top><em class=code>n </em></TD>
+<TR><TD valign=top><em class=code>n </em></TD>
<TD>
</TD></TR>
</TABLE>
</div>
-<br>
+<br />
@@ Diff output truncated at 40000 characters. @@
More information about the Dart-dev
mailing list