[Dart-dev] [4220] DART/trunk: Huge overhaul to conform to HTML spec and to provide
nancy at ucar.edu
nancy at ucar.edu
Fri Jan 15 18:27:53 MST 2010
Revision: 4220
Author: thoar
Date: 2010-01-15 18:27:53 -0700 (Fri, 15 Jan 2010)
Log Message:
-----------
Huge overhaul to conform to HTML spec and to provide
new terms of use.
Modified Paths:
--------------
DART/trunk/adaptive_inflate/adaptive_inflate_mod.html
DART/trunk/diagnostics/oned/obs_diag.html
DART/trunk/diagnostics/threed_sphere/obs_diag.html
DART/trunk/diagnostics/threed_sphere/obs_seq_to_netcdf.html
DART/trunk/diagnostics/threed_sphere/wind_obs_to_table.html
DART/trunk/doc/html/ASP_DART_exercise.html
DART/trunk/doc/html/DART_ASP_Summer2003.html
DART/trunk/doc/html/Fiji_release.html
DART/trunk/doc/html/Guam_release.html
DART/trunk/doc/html/I_diffs_from_workshop.html
DART/trunk/doc/html/Iceland_release.html
DART/trunk/doc/html/Jamaica_diffs_from_I.html
DART/trunk/doc/html/Jamaica_release.html
DART/trunk/doc/html/PostI_diffs_from_I.html
DART/trunk/doc/html/Post_Iceland_release.html
DART/trunk/doc/html/hawaii_release.html
DART/trunk/doc/html/pre_guam_release.html
DART/trunk/doc/html/pre_hawaii_release.html
DART/trunk/doc/html/pre_j_release.html
DART/trunk/filter/filter.html
DART/trunk/filter/wakeup_filter.html
DART/trunk/integrate_model/integrate_model.html
DART/trunk/mkmf/mkmf.html
DART/trunk/models/MITgcm_ocean/create_ocean_obs.html
DART/trunk/models/MITgcm_ocean/trans_pv_sv.html
DART/trunk/models/MITgcm_ocean/trans_sv_pv.html
DART/trunk/models/wrf/WRF_DART_utilities/dart_to_wrf.html
DART/trunk/models/wrf/shell_scripts/advance_model.html
DART/trunk/ncep_obs/create_real_obs.html
DART/trunk/obs_sequence/create_fixed_network_seq.html
DART/trunk/obs_sequence/create_obs_sequence.html
DART/trunk/obs_sequence/obs_sequence_mod.html
DART/trunk/obs_sequence/obs_sequence_tool.html
DART/trunk/observations/AIRS/AIRS.html
DART/trunk/observations/GTSPP/GTSPP.html
DART/trunk/observations/MADIS/MADIS.html
DART/trunk/observations/SSEC/SSEC.html
DART/trunk/observations/WOD/WOD.html
DART/trunk/observations/gps/gps.html
DART/trunk/observations/observations.html
DART/trunk/observations/quikscat/QuikSCAT.html
DART/trunk/observations/radar/radar.html
DART/trunk/observations/var/littler_tf_dart.html
DART/trunk/observations/var/rad_3dvar_to_dart.html
DART/trunk/observations/var/var.html
DART/trunk/perfect_model_obs/perfect_model_obs.html
DART/trunk/preprocess/preprocess.html
DART/trunk/time_manager/advance_time.html
DART/trunk/utilities/PrecisionCheck.html
DART/trunk/utilities/restart_file_tool.html
Property Changed:
----------------
DART/trunk/diagnostics/threed_sphere/obs_seq_to_netcdf.html
DART/trunk/diagnostics/threed_sphere/wind_obs_to_table.html
DART/trunk/models/MITgcm_ocean/create_ocean_obs.html
DART/trunk/models/MITgcm_ocean/trans_pv_sv.html
DART/trunk/models/MITgcm_ocean/trans_sv_pv.html
DART/trunk/observations/AIRS/AIRS.html
DART/trunk/utilities/PrecisionCheck.html
-------------- next part --------------
Modified: DART/trunk/adaptive_inflate/adaptive_inflate_mod.html
===================================================================
--- DART/trunk/adaptive_inflate/adaptive_inflate_mod.html 2010-01-13 19:03:45 UTC (rev 4219)
+++ DART/trunk/adaptive_inflate/adaptive_inflate_mod.html 2010-01-16 01:27:53 UTC (rev 4220)
@@ -1,66 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
<HTML>
<HEAD>
<TITLE>module adaptive_inflate_mod</TITLE>
-<link rel="stylesheet" type="text/css" href="../doc/html/doc.css"></link>
+<link rel="stylesheet" type="text/css" href="../doc/html/doc.css">
</HEAD>
<BODY>
-<!--
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! !!
-!! GNU General Public License !!
-!! !!
-!! This file is part of the Data Assimilation Research Testbed (DART). !!
-!! !!
-!! DART is free software; you can redistribute it and/or modify !!
-!! it and are expected to follow the terms of the GNU General Public !!
-!! License as published by the Free Software Foundation. !!
-!! !!
-!! DART is distributed in the hope that it will be useful, !!
-!! but WITHOUT ANY WARRANTY; without even the implied warranty of !!
-!! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the !!
-!! GNU General Public License for more details. !!
-!! !!
-!! You should have received a copy of the GNU General Public License !!
-!! along with DART; if not, write to: !!
-!! Free Software Foundation, Inc. !!
-!! 59 Temple Place, Suite 330 !!
-!! Boston, MA 02111-1307 USA !!
-!! or see: !!
-!! http://www.gnu.org/licenses/gpl.txt !!
-!! !!
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
--->
+<A NAME="TOP"></A>
-<DIV ALIGN=CENTER>
-<A HREF="#Interface">INTERFACE</A> /
-<A HREF="#PublicEntities">PUBLIC COMPONENTS</A> /
-<A HREF="#Namelist">NAMELIST</A> /
+<div>
+<center>
+<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> /
-<A HREF="#KnownBugs">BUGS</A> /
<A HREF="#FuturePlans">PLANS</A> /
-<A HREF="#PrivateComponents">PRIVATE COMPONENTS</A>
-</DIV>
+<A HREF="#PrivateComponents">PRIVATE COMPONENTS</A> /
+<A HREF="#Legalese">TERMS OF USE</A>
+</center>
+</div>
-<!--==================================================================-->
-
<H1>MODULE adaptive_inflate_mod</H1>
-<A NAME="HEADER"></A>
-<TABLE summary="">
-<TR><TD>Contact: </TD><TD> Jeff Anderson </TD></TR>
-<TR><TD>Revision: </TD><TD> $Revision$ </TD></TR>
-<TR><TD>Source: </TD><TD> $URL$ </TD></TR>
-<TR><TD>Change Date: </TD><TD> $Date$ </TD></TR>
-<TR><TD>Change history:</TD><TD> try "svn log" or "svn diff" </TD></TR>
-</TABLE>
-<BR>
+<!-- version tag follows, do not edit --><P>$Id$</P>
-<!--==================================================================-->
-
-<A NAME="OVERVIEW"></A>
-<HR>
-<H2>OVERVIEW</H2>
<P>
This module implements a variety of hierarchical Bayesian adaptive
inflation algorithms for use with ensemble filters. It can provide
@@ -81,8 +44,8 @@
<!--==================================================================-->
-<A NAME="OTHER MODULES USED"></A>
-<BR><HR><BR>
+<A NAME="OtherModulesUsed"></A>
+<HR>
<H2>OTHER MODULES USED</H2>
<PRE>
types_mod
@@ -93,11 +56,16 @@
</PRE>
<!--==================================================================-->
+<!-- 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. -->
+<!--==================================================================-->
<A NAME="Interface"></A>
-<BR><HR><BR>
-<H2>PUBLIC INTERFACE</H2>
+<HR>
+<H2>PUBLIC INTERFACES</H2>
<TABLE>
<TR><TD><em class=call>use adaptive_inflate_mod, only : </em></TD>
@@ -117,423 +85,499 @@
<TR><TD> </TD><TD><A HREF="#deterministic_inflate">deterministic_inflate</A></TD></TR>
</TABLE>
-<BR>
+<P>
+Optional namelist interface
+<a href="#Namelist"><em class=code>&model_nml</em></a>
+may be read from file <em class=file>input.nml</em>.
</P>
+<P>
+ A note about documentation style.
+ Optional arguments are enclosed in brackets
+ <em class=optionalcode>[like this]</em>.
+</P>
-<!--==================================================================-->
-<!-- Declare all public entities ... -->
-<!-- duplicate public routines template as many times as necessary -->
-<!-- make sure you replace all yyyroutine?? strings -->
-<!--==================================================================-->
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
-<A NAME="PublicEntities"></A>
-<BR><HR><BR>
-<H2>PUBLIC COMPONENTS</H2>
-<BR>
+<A NAME="update_inflation"></A>
+<br>
+<div class=routine>
+<em class=call> call update_inflation(inflate_handle, inflate, inflate_sd,
+ prior_mean, prior_var, obs, obs_var, gamma) </em>
+<pre>
+type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
+real(r8), intent(inout) :: <em class=code>inflate</em>
+real(r8), intent(inout) :: <em class=code>inflate_sd</em>
+real(r8), intent(in) :: <em class=code>prior_mean</em>
+real(r8), intent(in) :: <em class=code>prior_var</em>
+real(r8), intent(in) :: <em class=code>obs</em>
+real(r8), intent(in) :: <em class=code>obs_var</em>
+real(r8), intent(in) :: <em class=code>gamma</em>
+</pre>
+</div>
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Updates the mean and standard deviation of an inflation distribution
+given the prior values, the prior observation ensemble mean and
+variance, and the observation and its error variance. The factor gamma
+is the expected impact (0 to 1) of the state variable corresponding to
+the inflation on the observation and is the product of the ensemble
+correlation plus an additional localization factor or group regression
+factors.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle to object that describes the inflation type and values.</TD></TR>
+<TR><TD valign=top><em class=code>inflate </em></TD>
+ <TD>Prior mean value of the inflation distribution.</TD></TR>
+<TR><TD valign=top><em class=code>inflate_sd </em></TD>
+ <TD>Prior standard deviation of the inflation distribution.</TD></TR>
+<TR><TD valign=top><em class=code>prior_mean </em></TD>
+ <TD>Mean of the prior observation ensemble.</TD></TR>
+<TR><TD valign=top><em class=code>prior_var </em></TD>
+ <TD>Variance of the prior observation ensemble.</TD></TR>
+<TR><TD valign=top><em class=code>obs </em></TD>
+ <TD>The observed value.</TD></TR>
+<TR><TD valign=top><em class=code>obs_var </em></TD>
+ <TD>Observational error variance.</TD></TR>
+<TR><TD valign=top><em class=code>gamma </em></TD>
+ <TD>Expected impact factor, product of correlation, localization, regression factor.</TD></TR>
</TABLE>
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="update_inflation"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call update_inflation(inflate_handle,inflate,inflate_sd,prior_mean,
- prior_var,obs,obs_var,gamma) </em>
- <pre>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- real(r8), intent(inout) :: <em class=code>inflate</em>
- real(r8), intent(inout) :: <em class=code>inflate_sd</em>
- real(r8), intent(in) :: <em class=code>prior_mean</em>
- real(r8), intent(in) :: <em class=code>prior_var</em>
- real(r8), intent(in) :: <em class=code>obs</em>
- real(r8), intent(in) :: <em class=code>obs_var</em>
- real(r8), intent(in) :: <em class=code>gamma</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Updates the mean and standard deviation of an inflation distribution
- given the prior values, the prior observation ensemble mean and
- variance, and the observation and its error variance. The factor gamma
- is the expected impact (0 to 1) of the state variable corresponding to
- the inflation on the observation and is the product of the ensemble
- correlation plus an additional localization factor or group regression
- factors.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle to object that describes the inflation type and values.</TD></TR>
- <TR><TD valign=top><em class=code>inflate </em></TD>
- <TD>Prior mean value of the inflation distribution.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_sd </em></TD>
- <TD>Prior standard deviation of the inflation distribution.</TD></TR>
- <TR><TD valign=top><em class=code>prior_mean </em></TD>
- <TD>Mean of the prior observation ensemble.</TD></TR>
- <TR><TD valign=top><em class=code>prior_var </em></TD>
- <TD>Variance of the prior observation ensemble.</TD></TR>
- <TR><TD valign=top><em class=code>obs </em></TD>
- <TD>The observed value.</TD></TR>
- <TR><TD valign=top><em class=code>obs_var </em></TD>
- <TD>Observational error variance.</TD></TR>
- <TR><TD valign=top><em class=code>gamma </em></TD>
- <TD>Expected impact factor, product of correlation, localization, regression factor.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+</div>
+<br>
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="adaptive_inflate_end"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call adaptive_inflate_end(inflate_handle,ens_handle,
- ss_inflate_index,ss_inflate_sd_index) </em>
- <pre>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- type(ensemble_type), intent(inout) :: <em class=code>ens_handle</em>
- integer, intent(in) :: <em class=code>ss_inflate_index</em>
- integer, intent(in) :: <em class=code>ss_inflate_sd_index</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Outputs the values of inflation to restart files using the ensemble_manager for
- state space inflation and file output for observation space inflation. Releases
- allocated storage in inflate_handle.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for the details of the inflation being performed.</TD></TR>
- <TR><TD valign=top><em class=code>ens_handle </em></TD>
- <TD>Handle for ensemble storage that holds values of state space inflation.
- </TD></TR>
- <TR><TD valign=top><em class=code>ss_inflate_index </em></TD>
- <TD>Index in ensemble storage copies for state space inflation.</TD></TR>
- <TR><TD valign=top><em class=code>ss_inflate_sd_index </em></TD>
- <TD>Index in ensemble storage copies for state space inflation standard
- deviation.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<A NAME="adaptive_inflate_end"></A>
+<br>
+<div class=routine>
+<em class=call> call adaptive_inflate_end(inflate_handle, ens_handle,
+ ss_inflate_index, ss_inflate_sd_index) </em>
+<pre>
+type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
+type(ensemble_type), intent(inout) :: <em class=code>ens_handle</em>
+integer, intent(in) :: <em class=code>ss_inflate_index</em>
+integer, intent(in) :: <em class=code>ss_inflate_sd_index</em>
+</pre>
+</div>
+<div class=indent1>
+<!-- Description -->
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="inflate_ens"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call inflate_ens(inflate_handle,ens,mean,inflate,var_in) </em>
- <pre>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- real(r8), dimension(:), intent(out) :: <em class=code>ens</em>
- real(r8), intent(in) :: <em class=code>mean</em>
- real(r8), intent(in) :: <em class=code>inflate</em>
- real(r8), optional, intent(in) :: <em class=code>var_in</em>
- </pre></div>
-<H3 class=indent1>Description</H3>
- <P>
+<P>
+Outputs the values of inflation to restart files using the ensemble_manager for
+state space inflation and file output for observation space inflation. Releases
+allocated storage in inflate_handle.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle for the details of the inflation being performed.</TD></TR>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
+ <TD>Handle for ensemble storage that holds values of state space inflation.
+</TD></TR>
+<TR><TD valign=top><em class=code>ss_inflate_index </em></TD>
+ <TD>Index in ensemble storage copies for state space inflation.</TD></TR>
+<TR><TD valign=top><em class=code>ss_inflate_sd_index </em></TD>
+ <TD>Index in ensemble storage copies for state space inflation standard
+ deviation.</TD></TR>
+</TABLE>
+
+</div>
+<br>
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="inflate_ens"></A>
+<br>
+<div class=routine>
+<em class=call> call inflate_ens(inflate_handle, ens,mean, inflate <em class=optionalcode>[,var_in]</em>)</em>
+<pre>
+type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
+real(r8), dimension(:), intent(out) :: <em class=code>ens</em>
+real(r8), intent(in) :: <em class=code>mean</em>
+real(r8), intent(in) :: <em class=code>inflate</em>
+real(r8), optional, intent(in) :: <em class=optionalcode>var_in</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
Given an ensemble, its mean and the covarance inflation factor,
inflates the ensemble.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for the details of the inflation being performed.</TD></TR>
- <TR><TD valign=top><em class=code>ens </em></TD>
- <TD>Values for the ensemble to be inflated</TD></TR>
- <TR><TD valign=top><em class=code>mean </em></TD>
- <TD>The mean of the ensemble.</TD></TR>
- <TR><TD valign=top><em class=code>inflate </em></TD>
- <TD>The covariance inflation factor.</TD></TR>
- <TR><TD valign=top><em class=code>var_in </em></TD>
- <TD>The variance of the ensemble.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+</P>
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle for the details of the inflation being performed.</TD></TR>
+<TR><TD valign=top><em class=code>ens </em></TD>
+ <TD>Values for the ensemble to be inflated</TD></TR>
+<TR><TD valign=top><em class=code>mean </em></TD>
+ <TD>The mean of the ensemble.</TD></TR>
+<TR><TD valign=top><em class=code>inflate </em></TD>
+ <TD>The covariance inflation factor.</TD></TR>
+<TR><TD valign=top><em class=code>var_in </em></TD>
+ <TD>The variance of the ensemble.</TD></TR>
+</TABLE>
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="output_inflate_diagnostics"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call output_inflate_diagnostics(inflate_handle, time) </em>
- <pre>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- type(time_type), intent(in) :: <em class=code>time</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Outputs diagnostic record of inflation for the observation space of
+</div>
+<br>
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="output_inflate_diagnostics"></A>
+<br>
+<div class=routine>
+<em class=call> call output_inflate_diagnostics(inflate_handle, time) </em>
+<pre>
+type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
+type(time_type), intent(in) :: <em class=code>time</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Outputs diagnostic record of inflation for the observation space of
spatially constant state space inflation. Spatially varying state space
diagnostics are in the Posterior and Prior Diagnostic netcdf files and
are written with calls from filter.f90.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for the details of the inflation being performed.</TD></TR>
- <TR><TD valign=top><em class=code>time </em></TD>
- <TD>Time of this diagnostic info.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+</P>
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle for the details of the inflation being performed.</TD></TR>
+<TR><TD valign=top><em class=code>time </em></TD>
+ <TD>Time of this diagnostic info.</TD></TR>
+</TABLE>
- <!--============= DESCRIPTION OF A FUNCTION ========================-->
- <A NAME="do_obs_inflate"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> var = do_obs_inflate(inflate_handle) </em>
- <pre>
- logical, intent(out) :: <em class=code>do_obs_inflate</em>
- adaptive_inflate_type, intent(in) :: <em class=code>inflate_handle</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Returns true if observation space inflation is being done by this handle.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>do_obs_inflate </em></TD>
- <TD>True if obs space inflation is being done by this handle.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle to inflation details.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+</div>
+<br>
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
- <!--============= DESCRIPTION OF A FUNCTION ========================-->
- <A NAME="do_varying_ss_inflate"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> var = do_varying_ss_inflate(inflate_handle) </em>
- <pre>
- logical, intent(out) :: <em class=code>do_varying_ss_inflate</em>
- adaptive_inflate_type, intent(in) :: <em class=code>inflate_handle</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Returns true if spatially varying state space inflation is being done by this handle.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>do_varying_ss_inflate </em></TD>
- <TD>True if spatially varying state space inflation is being done by this handle.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle to inflation details.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<A NAME="do_obs_inflate"></A>
+<br>
+<div class=routine>
+<em class=call> var = do_obs_inflate(inflate_handle) </em>
+<pre>
+logical, intent(out) :: <em class=code>do_obs_inflate</em>
+adaptive_inflate_type, intent(in) :: <em class=code>inflate_handle</em>
+</pre>
+</div>
+<div class=indent1>
+<!-- Description -->
+<P>
+Returns true if observation space inflation is being done by this handle.
+</P>
- <!--============= DESCRIPTION OF A FUNCTION ========================-->
- <A NAME="do_single_ss_inflate"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> var = do_single_ss_inflate(inflate_handle) </em>
- <pre>
- logical, intent(out) :: <em class=code>do_single_ss_inflate</em>
- adaptive_inflate_type, intent(in) :: <em class=code>inflate_handle</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Returns true if spatially fixed state space inflation is being done by this handle.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>do_single_ss_inflate </em></TD>
- <TD>True if spatially fixed state space inflation is being done by this handle.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle to inflation details.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>do_obs_inflate </em></TD>
+ <TD>True if obs space inflation is being done by this handle.</TD></TR>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle to inflation details.</TD></TR>
+</TABLE>
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="adaptive_inflate_init"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call adaptive_inflate_init(inflate_handle, inf_flavor, mean_from_restart,
- sd_from_restart, output_restart, deterministic, in_file_name, out_file_name,
- diag_file_name, inf_initial, sd_initial, inf_lower_bound, inf_upper_bound,
- sd_lower_bound, ens_handle, ss_inflate_index, ss_inflate_sd_index, label) </em>
- <pre>
- type(adaptive_inflate_type), intent(inout) :: <em class=code>inflate_handle</em>
- integer, intent(in) :: <em class=code>inf_flavor</em>
- logical, intent(in) :: <em class=code>mean_from_restart</em>
- logical, intent(in) :: <em class=code>sd_from_restart</em>
- logical, intent(in) :: <em class=code>output_restart</em>
- logical, intent(in) :: <em class=code>deterministic</em>
- character(len=*), intent(in) :: <em class=code>in_file_name</em>
- character(len=*), intent(in) :: <em class=code>out_file_name</em>
- character(len=*), intent(in) :: <em class=code>diag_file_name</em>
- real(r8), intent(in) :: <em class=code>inf_initial</em>
- real(r8), intent(in) :: <em class=code>sd_initial</em>
- real(r8), intent(in) :: <em class=code>inf_lower_bound</em>
- real(r8), intent(in) :: <em class=code>inf_upper_bound</em>
- real(r8), intent(in) :: <em class=code>sd_lower_bound</em>
- type(ensemble_type), intent(inout) :: <em class=code>ens_handle</em>
- integer, intent(in) :: <em class=code>ss_inflate_index</em>
- integer, intent(in) :: <em class=code>ss_inflate_sd_index</em>
- character(len=*), intent(in) :: <em class=code>label</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Initializes a descriptor of an inflation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for the inflation descriptor being initialized.</TD></TR>
- <TR><TD valign=top><em class=code>inf_flavor </em></TD>
- <TD>Type of inflation, 1=obs_inflate, 2=varying_ss_inflate, 3=single_ss_inflate.</TD></TR>
- <TR><TD valign=top><em class=code>mean_from_restart </em></TD>
- <TD>True if inflation mean values to be read from restart file.</TD></TR>
- <TR><TD valign=top><em class=code>sd_from_restart </em></TD>
- <TD>True if inflation standard deviation values to be read from restart file.</TD></TR>
- <TR><TD valign=top><em class=code>output_restart </em></TD>
- <TD>True if an inflation restart file is to be output.</TD></TR>
- <TR><TD valign=top><em class=code>deterministic </em></TD>
- <TD>True if deterministic inflation is to be done.</TD></TR>
- <TR><TD valign=top><em class=code>in_file_name </em></TD>
- <TD>File name from which to read restart.</TD></TR>
- <TR><TD valign=top><em class=code>out_file_name </em></TD>
- <TD>File name to which to write restart.</TD></TR>
- <TR><TD valign=top><em class=code>diag_file_name </em></TD>
- <TD>File name to which to write diagnostic output; obs space inflation only .</TD></TR>
- <TR><TD valign=top><em class=code>inf_initial </em></TD>
- <TD>Initial value of inflation for start_from_restart=.false.</TD></TR>
- <TR><TD valign=top><em class=code>sd_initial </em></TD>
- <TD>Initial value of inflation standard deviation for start_from_restart=.false.</TD></TR>
- <TR><TD valign=top><em class=code>inf_lower_bound </em></TD>
- <TD>Lower bound on inflation value.</TD></TR>
- <TR><TD valign=top><em class=code>inf_upper_bound </em></TD>
- <TD>Upper bound on inflation value.</TD></TR>
- <TR><TD valign=top><em class=code>sd_lower_bound </em></TD>
- <TD>Lower bound on inflation standard deviation.</TD></TR>
- <TR><TD valign=top><em class=code>ens_handle </em></TD>
- <TD>Ensemble handle with storage for state space inflation.</TD></TR>
- <TR><TD valign=top><em class=code>ss_inflate_index </em></TD>
- <TD>Index op copy in ensemble storage for inflation value.</TD></TR>
- <TR><TD valign=top><em class=code>ss_inflate_sd_index </em></TD>
- <TD>Index of copy in ensemble storage for inflation standard deviation.</TD></TR>
- <TR><TD valign=top><em class=code>label </em></TD>
- <TD>Character label to be used in diagnostic output (e.g. 'Prior', 'Posterior').</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+</div>
+<br>
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
- <!--============= DESCRIPTION OF A FUNCTION ========================-->
- <A NAME="get_sd"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> var = get_sd(inflate_handle) </em>
- <pre>
- real(r8), intent(out) :: <em class=code>get_sd</em>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Returns value of observation space inflation standard deviation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>get_sd </em></TD>
- <TD>Returns the value of observation space inflation.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for inflation descriptor.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<A NAME="do_varying_ss_inflate"></A>
+<br>
+<div class=routine>
+<em class=call> var = do_varying_ss_inflate(inflate_handle) </em>
+<pre>
+logical, intent(out) :: <em class=code>do_varying_ss_inflate</em>
+adaptive_inflate_type, intent(in) :: <em class=code>inflate_handle</em>
+</pre>
+</div>
- <!--============= DESCRIPTION OF A FUNCTION ========================-->
- <A NAME="get_inflate"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> var = get_inflate(inflate_handle) </em>
- <pre>
- real(r8), intent(out) :: <em class=code>get_inflate</em>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Returns value of observation space inflation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>get_inflate </em></TD>
- <TD>Returns the value of observation space inflation.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for inflation descriptor.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<div class=indent1>
+<!-- Description -->
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="set_inflate"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call set_inflate(inflate_handle,inflate) </em>
- <pre>
- type(adaptive_inflate_type), intent(inout) :: <em class=code>inflate_handle</em>
- real(r8), intent(in) :: <em class=code>inflate</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Set the value of observation space inflation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for inflation descriptor.</TD></TR>
- <TR><TD valign=top><em class=code>inflate </em></TD>
- <TD>Set observation space inflation to this value.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<P>
+Returns true if spatially varying state space inflation is being done by this handle.
+</P>
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>do_varying_ss_inflate </em></TD>
+ <TD>True if spatially varying state space inflation is being done by this handle.</TD></TR>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle to inflation details.</TD></TR>
+</TABLE>
- <!--============= DESCRIPTION OF A SUBROUTINE =======================-->
- <A NAME="set_sd"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call set_sd(inflate_handle,sd) </em>
- <pre>
- type(adaptive_inflate_type), intent(inout) :: <em class=code>inflate_handle</em>
- real(r8), intent(in) :: <em class=code>sd</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Set the value of observation space inflation standard deviation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for inflation descriptor.</TD></TR>
- <TR><TD valign=top><em class=code>sd </em></TD>
- <TD>Set observation space inflation standard deviation to this value.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+</div>
+<br>
- <!--============= DESCRIPTION OF A FUNCTION ========================-->
- <A NAME="deterministic_inflate"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> var = deterministic_inflate(inflate_handle) </em>
- <pre>
- logical, intent(out) :: <em class=code>deterministic_inflate</em>
- type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
- Returns true if deterministic inflation is being done.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>deterministic_inflate </em></TD>
- <TD>Returns true if deterministic inflation is being done.</TD></TR>
- <TR><TD valign=top><em class=code>inflate_handle </em></TD>
- <TD>Handle for inflation descriptor.</TD></TR>
- </TABLE>
- <P>
- <!--================================================================-->
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+<A NAME="do_single_ss_inflate"></A>
+<br>
+<div class=routine>
+<em class=call> var = do_single_ss_inflate(inflate_handle) </em>
+<pre>
+logical, intent(out) :: <em class=code>do_single_ss_inflate</em>
+adaptive_inflate_type, intent(in) :: <em class=code>inflate_handle</em>
+</pre>
+</div>
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Returns true if spatially fixed state space inflation is being done by this handle.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>do_single_ss_inflate </em></TD>
+ <TD>True if spatially fixed state space inflation is being done by this handle.</TD></TR>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle to inflation details.</TD></TR>
+</TABLE>
+
+</div>
+<br>
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="adaptive_inflate_init"></A>
+<br>
+<div class=routine>
+<em class=call> call adaptive_inflate_init(inflate_handle, inf_flavor, mean_from_restart,
+ sd_from_restart, output_restart, deterministic, in_file_name, out_file_name,
+ diag_file_name, inf_initial, sd_initial, inf_lower_bound, inf_upper_bound,
+ sd_lower_bound, ens_handle, ss_inflate_index, ss_inflate_sd_index, label) </em>
+<pre>
+type(adaptive_inflate_type), intent(inout) :: <em class=code>inflate_handle</em>
+integer, intent(in) :: <em class=code>inf_flavor</em>
+logical, intent(in) :: <em class=code>mean_from_restart</em>
+logical, intent(in) :: <em class=code>sd_from_restart</em>
+logical, intent(in) :: <em class=code>output_restart</em>
+logical, intent(in) :: <em class=code>deterministic</em>
+character(len=*), intent(in) :: <em class=code>in_file_name</em>
+character(len=*), intent(in) :: <em class=code>out_file_name</em>
+character(len=*), intent(in) :: <em class=code>diag_file_name</em>
+real(r8), intent(in) :: <em class=code>inf_initial</em>
+real(r8), intent(in) :: <em class=code>sd_initial</em>
+real(r8), intent(in) :: <em class=code>inf_lower_bound</em>
+real(r8), intent(in) :: <em class=code>inf_upper_bound</em>
+real(r8), intent(in) :: <em class=code>sd_lower_bound</em>
+type(ensemble_type), intent(inout) :: <em class=code>ens_handle</em>
+integer, intent(in) :: <em class=code>ss_inflate_index</em>
+integer, intent(in) :: <em class=code>ss_inflate_sd_index</em>
+character(len=*), intent(in) :: <em class=code>label</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Initializes a descriptor of an inflation object.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle for the inflation descriptor being initialized.</TD></TR>
+<TR><TD valign=top><em class=code>inf_flavor </em></TD>
+ <TD>Type of inflation, 1=obs_inflate, 2=varying_ss_inflate, 3=single_ss_inflate.</TD></TR>
+<TR><TD valign=top><em class=code>mean_from_restart </em></TD>
+ <TD>True if inflation mean values to be read from restart file.</TD></TR>
+<TR><TD valign=top><em class=code>sd_from_restart </em></TD>
+ <TD>True if inflation standard deviation values to be read from restart file.</TD></TR>
+<TR><TD valign=top><em class=code>output_restart </em></TD>
+ <TD>True if an inflation restart file is to be output.</TD></TR>
+<TR><TD valign=top><em class=code>deterministic </em></TD>
+ <TD>True if deterministic inflation is to be done.</TD></TR>
+<TR><TD valign=top><em class=code>in_file_name </em></TD>
+ <TD>File name from which to read restart.</TD></TR>
+<TR><TD valign=top><em class=code>out_file_name </em></TD>
+ <TD>File name to which to write restart.</TD></TR>
+<TR><TD valign=top><em class=code>diag_file_name </em></TD>
+ <TD>File name to which to write diagnostic output; obs space inflation only .</TD></TR>
+<TR><TD valign=top><em class=code>inf_initial </em></TD>
+ <TD>Initial value of inflation for start_from_restart=.false.</TD></TR>
+<TR><TD valign=top><em class=code>sd_initial </em></TD>
+ <TD>Initial value of inflation standard deviation for start_from_restart=.false.</TD></TR>
+<TR><TD valign=top><em class=code>inf_lower_bound </em></TD>
+ <TD>Lower bound on inflation value.</TD></TR>
+<TR><TD valign=top><em class=code>inf_upper_bound </em></TD>
+ <TD>Upper bound on inflation value.</TD></TR>
+<TR><TD valign=top><em class=code>sd_lower_bound </em></TD>
+ <TD>Lower bound on inflation standard deviation.</TD></TR>
+<TR><TD valign=top><em class=code>ens_handle </em></TD>
+ <TD>Ensemble handle with storage for state space inflation.</TD></TR>
+<TR><TD valign=top><em class=code>ss_inflate_index </em></TD>
+ <TD>Index op copy in ensemble storage for inflation value.</TD></TR>
+<TR><TD valign=top><em class=code>ss_inflate_sd_index </em></TD>
+ <TD>Index of copy in ensemble storage for inflation standard deviation.</TD></TR>
+<TR><TD valign=top><em class=code>label </em></TD>
+ <TD>Character label to be used in diagnostic output (e.g. 'Prior', 'Posterior').</TD></TR>
+</TABLE>
+
+</div>
+<br>
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="get_sd"></A>
+<br>
+<div class=routine>
+<em class=call> var = get_sd(inflate_handle) </em>
+<pre>
+real(r8), intent(out) :: <em class=code>get_sd</em>
+type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Returns value of observation space inflation standard deviation.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>get_sd </em></TD>
+ <TD>Returns the value of observation space inflation.</TD></TR>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle for inflation descriptor.</TD></TR>
+</TABLE>
+
+</div>
+<br>
+
+<!--===================== DESCRIPTION OF A ROUTINE =====================-->
+
+<A NAME="get_inflate"></A>
+<br>
+<div class=routine>
+<em class=call> var = get_inflate(inflate_handle) </em>
+<pre>
+real(r8), intent(out) :: <em class=code>get_inflate</em>
+type(adaptive_inflate_type), intent(in) :: <em class=code>inflate_handle</em>
+</pre>
+</div>
+
+<div class=indent1>
+<!-- Description -->
+
+<P>
+Returns value of observation space inflation.
+</P>
+
+<TABLE width=100% border=0 summary="" cellpadding=3>
+<TR><TD valign=top><em class=code>get_inflate </em></TD>
+ <TD>Returns the value of observation space inflation.</TD></TR>
+<TR><TD valign=top><em class=code>inflate_handle </em></TD>
+ <TD>Handle for inflation descriptor.</TD></TR>
+</TABLE>
+
+</div>
+<br>
+
@@ Diff output truncated at 40000 characters. @@
More information about the Dart-dev
mailing list