[Dart-dev] [4409] DART/trunk/models/lorenz_63: A proposed header change for our internal html doc pages,
nancy at ucar.edu
nancy at ucar.edu
Thu Jul 1 16:25:42 MDT 2010
Revision: 4409
Author: nancy
Date: 2010-07-01 16:25:42 -0600 (Thu, 01 Jul 2010)
Log Message:
-----------
A proposed header change for our internal html doc pages,
trying to make them look more like real web pages and less
like raw information that wasn't intended for end users.
There is a ton of great information in these files and if
dressing them up just a little makes people look at them
more, i think it's worth it. I also added just a bit of
info about the L63 model itself, with a public domain image.
I'm expecting people to comment and decide to change this
around, but it seemed like the easiest way to get people to
look at it was to commit it and then revert it back if
everyone hates it. send me your feedback? thanks, n.
Modified Paths:
--------------
DART/trunk/models/lorenz_63/model_mod.html
Added Paths:
-----------
DART/trunk/models/lorenz_63/lorenz_63_thumb.png
-------------- next part --------------
Added: DART/trunk/models/lorenz_63/lorenz_63_thumb.png
===================================================================
(Binary files differ)
Property changes on: DART/trunk/models/lorenz_63/lorenz_63_thumb.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Modified: DART/trunk/models/lorenz_63/model_mod.html
===================================================================
--- DART/trunk/models/lorenz_63/model_mod.html 2010-07-01 20:46:19 UTC (rev 4408)
+++ DART/trunk/models/lorenz_63/model_mod.html 2010-07-01 22:25:42 UTC (rev 4409)
@@ -8,9 +8,22 @@
<BODY>
<A NAME="TOP"></A>
+<div>
<center>
-<A HREF="#Interface">INTERFACES</A> /
-<A HREF="#Namelist">NAMELIST</A> /
+<strong><big><big><big>DART Project Documentation</big></big></big></strong> <br />
+<table width=80% border=0 summary="" cellpadding=0>
+<tr>
+<td align=center valign=middle>
+<a href="../../index.html">DART Documentation Main Index</a> </td>
+<td align=center valign=middle>
+<img src="../../doc/html/Dartboard9.png" alt="DART project logo" height=50 width=100> </td>
+<td align=center valign=middle>
+<small>Subversion info for this html file: <br />
+<!-- version tag follows, do not edit -->$Id$ </small> </td>
+</tr>
+</table> <br />
+<A HREF="#Interface">INTERFACES</A> /
+<A HREF="#Namelist">NAMELIST</A> /
<A HREF="#FilesUsed">FILES</A> /
<A HREF="#References">REFERENCES</A> /
<A HREF="#Errors">ERRORS</A> /
@@ -18,10 +31,9 @@
<A HREF="#PrivateComponents">PRIVATE COMPONENTS</A> /
<A HREF="#Legalese">TERMS OF USE</A>
</center>
+</div>
<H1>MODULE model_mod (Lorenz_63)</H1>
-<!-- version tag follows, do not edit --><P>$Id$</P>
-
<P>
DART interface module for the Lorenz-63 model. The 17 public interfaces
are standardized for all DART compliant models. These interfaces allow
@@ -29,19 +41,46 @@
this state, find state variables that are close to a given location,
and do spatial interpolation for model state variables. The distinctive
part of the model interfaces is the namelist.
-<br><br>
-This is the 3-variable model as described in:
-Lorenz, E. N. 1963. Deterministic nonperiodic flow.
- <i>J. Atmos. Sci.</i> <b>20</b>, 130-141.
-<br><br>
+</P>
+<P>
+This is the 3-variable model as described in:
+<blockquote>Lorenz, E. N. 1963. Deterministic nonperiodic flow.
+<i>J. Atmos. Sci.</i> <b>20</b>, 130-141. </blockquote>
+It was developed as a simplified model to study
+convection rolls in the atmosphere.
+Plotting the location of the X, Y, Z values as they progress
+through time traces out the classic 'butterfly' attractor plot
+which has become an iconic image of chaotic systems:<br /><br />
+<!-- public domain image obtained from wikipedia -->
+<img src="./lorenz_63_thumb.png" alt="plot of Lorenz 63 attractor">
+</P>
+<P>
The system of equations is:
-</P>
<pre>
X' = -sigma*X + sigma*Y
Y' = -XZ + rX - Y
Z' = XY -bZ
</pre>
+The values for the constants are settable by namelist
+(<a href="#Namelist">see below</a>).
+The default values are:
+<pre>
+ r = 28.0_r8
+ sigma = 10.0_r8
+ b = 8.0_r8 / 3.0_r8
+ runga-kutta delta t: 0.01 seconds
+ assimilation time step: 60 minutes
+</pre>
+</P>
+<P>
+This model is an interesting data assimilation test in that
+different ensemble members may bifurcate over to the
+other lobe of the attractor on different cycles. Also, as they
+diverge from each other they do not spread out uniformly
+in 3D space, but spread along the linear attractor lines.
+</P>
+
<!--==================================================================-->
<A NAME="OtherModulesUsed"></A>
@@ -56,8 +95,6 @@
<!--==================================================================-->
<!-- Declare all public entities ... -->
-<!-- duplicate public routines template as many times as necessary -->
-<!-- make sure you replace all yyyroutine?? strings -->
<!--==================================================================-->
<!--Note to authors. The first row of the table is different. -->
<!--==================================================================-->
@@ -153,7 +190,7 @@
<TR><TD valign=top><em class=code>x</em></TD>
<TD>State vector of length model_size.</TD></TR>
-<TR><TD valign=top><em class=code>time </em></TD>
+<TR><TD valign=top><em class=code>time</em></TD>
<TD>Specifies time of the initial model state.</TD></TR>
</TABLE>
@@ -167,7 +204,7 @@
<br>
<div class=routine>
<em class=call>call get_state_meta_data (index_in, location,
- <em class=optionalcode>[, var_type]</em> )</em>
+ <em class=optionalcode>[, var_type]</em> )</em>
<pre>
integer, intent(in) :: <em class=code>index_in</em>
type(location_type), intent(out) :: <em class=code>location</em>
@@ -188,7 +225,7 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>index_in </em></TD>
+<TR><TD valign=top><em class=code>index_in</em></TD>
<TD>Index of state vector element about which information is requested.</TD></TR>
<TR><TD valign=top><em class=code>location</em></TD>
@@ -233,7 +270,7 @@
<TR><TD valign=top><em class=code>x</em></TD>
<TD>A model state vector.</TD></TR>
-<TR><TD valign=top><em class=code>location </em></TD>
+<TR><TD valign=top><em class=code>location</em></TD>
<TD>Location to which to interpolate.</TD></TR>
<TR><TD valign=top><em class=code>itype</em></TD>
@@ -271,7 +308,7 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>var </em></TD>
+<TR><TD valign=top><em class=code>var</em></TD>
<TD>Smallest time step of model.</TD></TR>
</TABLE>
@@ -347,7 +384,7 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>time </em></TD>
+<TR><TD valign=top><em class=code>time</em></TD>
<TD>Initial model time.</TD></TR>
</TABLE>
@@ -377,7 +414,7 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>x </em></TD>
+<TR><TD valign=top><em class=code>x</em></TD>
<TD>Initial conditions for state vector.</TD></TR>
</TABLE>
@@ -410,7 +447,7 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ncFileID </em></TD>
+<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>ierr</em></TD>
@@ -453,7 +490,7 @@
<TR><TD valign=top><em class=code>statevec</em></TD>
<TD>A model state vector.</TD></TR>
-<TR><TD valign=top><em class=code>copyindex </em></TD>
+<TR><TD valign=top><em class=code>copyindex</em></TD>
<TD> Integer index of copy to be written.</TD></TR>
<TR><TD valign=top><em class=code>timeindex</em></TD>
@@ -497,7 +534,7 @@
<TR><TD valign=top><em class=code>pert_state</em></TD>
<TD>Perturbed state vector: NOT returned.</TD></TR>
-<TR><TD valign=top><em class=code>interf_provided </em></TD>
+<TR><TD valign=top><em class=code>interf_provided</em></TD>
<TD>Returned false; interface is not implemented.</TD></TR>
</TABLE>
@@ -561,7 +598,7 @@
<div class=routine>
<em class=call>call get_close_obs(gc, base_obs_loc, base_obs_kind,
obs, obs_kind, num_close, close_ind
- <em class=optionalcode>[, dist]</em>) </em>
+ <em class=optionalcode>[, dist]</em>) </em>
<pre>
type(get_close_type), intent(in) :: <em class=code>gc</em>
type(location_type), intent(in) :: <em class=code>base_obs_loc</em>
@@ -606,7 +643,7 @@
<TABLE width=100% border=0 summary="" cellpadding=3>
-<TR><TD valign=top><em class=code>ens_mean </em></TD>
+<TR><TD valign=top><em class=code>ens_mean</em></TD>
<TD>State vector containing the ensemble mean.</TD></TR>
</TABLE>
@@ -686,7 +723,7 @@
<TD>to read the model_mod namelist</TD></TR>
<TR><TD>Prior_Diag.nc</TD>
<TD>the time-history of the model state before assimilation</TD></TR>
-<TR><TD>Posterior_Diag.nc </TD>
+<TR><TD>Posterior_Diag.nc</TD>
<TD>the time-history of the model state after assimilation</TD></TR>
<TR><TD>dart_log.out [default name]</TD>
<TD>the run-time diagnostic output</TD></TR>
@@ -764,7 +801,7 @@
<H2>Terms of Use</H2>
<P>
-DART software - Copyright © 2004 - 2010 UCAR.<br>
+DART software - Copyright © 2004 - 2010 UCAR.<br>
This open source software is provided by UCAR, "as is",<br>
without charge, subject to all terms of use at<br>
<a href="http://www.image.ucar.edu/DAReS/DART/DART_download">
@@ -776,7 +813,7 @@
<TR><TD valign=top>Revision: </TD><TD> $Revision$ </TD></TR>
<TR><TD valign=top>Source: </TD><TD> $URL$ </TD></TR>
<TR><TD valign=top>Change Date: </TD><TD> $Date$ </TD></TR>
-<TR><TD valign=top>Change history: </TD><TD> try "svn log" or "svn diff" </TD></TR>
+<TR><TD valign=top>Change history:</TD><TD> try "svn log" or "svn diff" </TD></TR>
</TABLE>
<!--==================================================================-->
More information about the Dart-dev
mailing list