[Dart-dev] [3929] DART/trunk/obs_def/obs_def_radar_mod.html: fixed some typos, missing html tags
nancy at ucar.edu
nancy at ucar.edu
Fri Jun 12 15:38:51 MDT 2009
An HTML attachment was scrubbed...
URL: http://mailman.ucar.edu/pipermail/dart-dev/attachments/20090612/476cc1fa/attachment-0001.html
-------------- next part --------------
Modified: DART/trunk/obs_def/obs_def_radar_mod.html
===================================================================
--- DART/trunk/obs_def/obs_def_radar_mod.html 2009-06-12 20:26:38 UTC (rev 3928)
+++ DART/trunk/obs_def/obs_def_radar_mod.html 2009-06-12 21:38:51 UTC (rev 3929)
@@ -171,40 +171,40 @@
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="read_radar_ref"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call read_radar_ref(obsvalue, refkey) </em>
- <pre>
- real(r8), intent(inout) :: <em class=code>obsvalue</em>
- integer, intent(out) :: <em class=code>refkey</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call read_radar_ref(obsvalue, refkey) </em>
+<pre>
+real(r8), intent(inout) :: <em class=code>obsvalue</em>
+integer, intent(out) :: <em class=code>refkey</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Reflectivity observations have no auxiliary data to read or write, but there
are namelist options that can alter the observation value at runtime. This
routine tests the observation value and alters it if required.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>obsvalue </em></TD>
- <TD>Observation value.</TD></TR>
- <TR><TD valign=top><em class=code>refkey </em></TD>
- <TD>Set to 0 to avoid uninitialized values, but otherwise unused.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>obsvalue </em></TD>
+ <TD>Observation value.</TD></TR>
+<TR><TD valign=top><em class=code>refkey</em></TD>
+ <TD>Set to 0 to avoid uninitialized values, but otherwise unused.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="get_expected_radar_ref"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call get_expected_radar_ref(state_vector, location, ref, istatus) </em>
- <pre>
- real(r8), intent(in) :: <em class=code>state_vector(:)</em>
- type(location_type), intent(in) :: <em class=code>location</em>
- real(r8), intent(out) :: <em class=code>ref</em>
- integer, intent(out) :: <em class=code>istatus</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call get_expected_radar_ref(state_vector, location, ref, istatus)</em>
+<pre>
+real(r8), intent(in) :: <em class=code>state_vector(:)</em>
+type(location_type), intent(in) :: <em class=code>location</em>
+real(r8), intent(out) :: <em class=code>ref</em>
+integer, intent(out) :: <em class=code>istatus</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Given a location and the state vector from one of the ensemble members,
compute the model-predicted radar reflectivity that would be observed
at that location. The returned value is in dBZ.
@@ -214,190 +214,190 @@
reflectivity values less than
<em class=code>reflectivity_limit_fwd_op</em>
will be set to <em class=code>lowest_reflectivity_fwd_op</em>.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>state_vector </em></TD>
- <TD>A one dimensional representation of the model state vector</TD></TR>
- <TR><TD valign=top><em class=code>location </em></TD>
- <TD>Location of this observation</TD></TR>
- <TR><TD valign=top><em class=code>ref </em></TD>
- <TD>The returned radar reflectivity value</TD></TR>
- <TR><TD valign=top><em class=code>istatus </em></TD>
- <TD>Returned integer status code describing problems with applying
- forward operator. 0 is a good value; any positive value
- indicates an error; negative values are reserved for
- internal DART use only.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>state_vector </em></TD>
+ <TD>A one dimensional representation of the model state vector</TD></TR>
+<TR><TD valign=top><em class=code>location</em></TD>
+ <TD>Location of this observation</TD></TR>
+<TR><TD valign=top><em class=code>ref</em></TD>
+ <TD>The returned radar reflectivity value</TD></TR>
+<TR><TD valign=top><em class=code>istatus</em></TD>
+ <TD>Returned integer status code describing problems with applying
+ forward operator. 0 is a good value; any positive value
+ indicates an error; negative values are reserved for
+ internal DART use only.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="real_radial_vel"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call read_radial_vel(velkey, ifile
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call read_radial_vel(velkey, ifile
<em class=optionalcode>[, fform]</em>) </em>
- <pre>
- integer, intent(out) :: <em class=code>velkey</em>
- integer, intent(in) :: <em class=code>ifile</em>
- character(len=*), optional, intent(in) :: <em class=optionalcode>fform</em>
+<pre>
+integer, intent(out) :: <em class=code>velkey</em>
+integer, intent(in) :: <em class=code>ifile</em>
+character(len=*), optional, intent(in) :: <em class=optionalcode>fform</em>
</pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<H3 class=indent1>Description</H3>
+<P>
Reads the additional auxiliary information associated with a
radial velocity observation. This includes the location of the
radar source, the beam direction, and the nyquist velocity.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>velkey </em></TD>
- <TD>Unique identifier associated with this radial velocity
- observation. In this code it is an integer index into module
- local arrays which hold the additional data. This routine
- increments it and returns the new value.</TD></TR>
- <TR><TD valign=top><em class=code>ifile </em></TD>
- <TD>File unit descriptor for input file</TD></TR>
- <TR><TD valign=top><em class=optionalcode>fform </em></TD>
- <TD>File format specifier: FORMATTED or UNFORMATTED; default FORMATTED</TD>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>velkey </em></TD>
+ <TD>Unique identifier associated with this radial velocity
+ observation. In this code it is an integer index into module
+ local arrays which hold the additional data. This routine
+ increments it and returns the new value.</TD></TR>
+<TR><TD valign=top><em class=code>ifile</em></TD>
+ <TD>File unit descriptor for input file</TD></TR>
+<TR><TD valign=top><em class=optionalcode>fform</em></TD>
+ <TD>File format specifier: FORMATTED or UNFORMATTED; default FORMATTED</TD>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="write_radial_vel"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call write_radial_vel(velkey, ifile
- <em class=optionalcode>[, fform]</em>) </em>
- <pre>
- integer, intent(in) :: <em class=code>velkey</em>
- integer, intent(in) :: <em class=code>ifile</em>
- character(len=*), optional, intent(in) :: <em class=optionalcode>fform</em>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call write_radial_vel(velkey, ifile
+ <em class=optionalcode>[, fform]</em>) </em>
+<pre>
+integer, intent(in) :: <em class=code>velkey</em>
+integer, intent(in) :: <em class=code>ifile</em>
+character(len=*), optional, intent(in) :: <em class=optionalcode>fform</em>
</pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<H3 class=indent1>Description</H3>
+<P>
Writes the additional auxiliary information associated with a
radial velocity observation. This includes the location of the
radar source, the beam direction, and the nyquist velocity.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>valkey </em></TD>
- <TD>Unique identifier associated with this radial velocity
- observation. In this code it is an integer index into module
- local arrays which hold the additional data. This routine uses
- the value to select the appropriate data to write for this
- observation.</TD></TR>
- <TR><TD valign=top><em class=code>ifile </em></TD>
- <TD>File unit descriptor for output file</TD></TR>
- <TR><TD valign=top><em class=optionalcode>fform </em></TD>
- <TD>File format specifier: FORMATTED or UNFORMATTED; default FORMATTED</TD>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>velkey </em></TD>
+ <TD>Unique identifier associated with this radial velocity
+ observation. In this code it is an integer index into module
+ local arrays which hold the additional data. This routine uses
+ the value to select the appropriate data to write for this
+ observation.</TD></TR>
+<TR><TD valign=top><em class=code>ifile</em></TD>
+ <TD>File unit descriptor for output file</TD></TR>
+<TR><TD valign=top><em class=optionalcode>fform</em></TD>
+ <TD>File format specifier: FORMATTED or UNFORMATTED; default FORMATTED</TD>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="get_obs_def_radial_vel"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call get_obs_def_radial_vel(velkey, radar_location,
- beam_direction, nyquist_velocity)</em>
- <pre>
- integer, intent(in) :: <em class=code>velkey</em>
- type(location_type), intent(out) :: <em class=code>radar_location</em>
- real(r8), intent(out) :: <em class=code>beam_direction(3)</em>
- real(r8), intent(out) :: <em class=code>nyquist_velocity</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call get_obs_def_radial_vel(velkey, radar_location,
+ beam_direction, nyquist_velocity)</em>
+<pre>
+integer, intent(in) :: <em class=code>velkey</em>
+type(location_type), intent(out) :: <em class=code>radar_location</em>
+real(r8), intent(out) :: <em class=code>beam_direction(3)</em>
+real(r8), intent(out) :: <em class=code>nyquist_velocity</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Returns the auxiliary information associated with a given radial
velocity observation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>velkey </em></TD>
- <TD>Unique identifier associated with this radial velocity
- observation. In this code it is an integer index into module
- local arrays which hold the additional data. This routine uses
- the value to select the appropriate data to return.</TD></TR>
- <TR><TD valign=top><em class=code>radar_location </em></TD>
- <TD>Location of the radar.</TD></TR>
- <TR><TD valign=top><em class=code>beam_orientation </em></TD>
- <TD>Orientation of the radar beam at the observation location.
- The three values are: sin(azimuth)*cos(elevation),
- cos(azimuth)*cos(elevation), and sin(elevation).</TD></TR>
- <TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
- <TD>Nyquist velocity at the observation point in meters/second.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>velkey</em></TD>
+ <TD>Unique identifier associated with this radial velocity
+ observation. In this code it is an integer index into module
+ local arrays which hold the additional data. This routine uses
+ the value to select the appropriate data to return.</TD></TR>
+<TR><TD valign=top><em class=code>radar_location</em></TD>
+ <TD>Location of the radar.</TD></TR>
+<TR><TD valign=top><em class=code>beam_orientation</em></TD>
+ <TD>Orientation of the radar beam at the observation location.
+ The three values are: sin(azimuth)*cos(elevation),
+ cos(azimuth)*cos(elevation), and sin(elevation).</TD></TR>
+<TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
+ <TD>Nyquist velocity at the observation point in meters/second.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="set_radial_vel"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call set_radial_vel(velkey, radar_location,
- beam_direction, nyquist_velocity)</em>
- <pre>
- integer, intent(out) :: <em class=code>velkey</em>
- type(location_type), intent(in) :: <em class=code>radar_location</em>
- real(r8), intent(in) :: <em class=code>beam_direction(3)</em>
- real(r8), intent(in) :: <em class=code>nyquist_velocity</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call set_radial_vel(velkey, radar_location,
+ beam_direction, nyquist_velocity)</em>
+<pre>
+integer, intent(out) :: <em class=code>velkey</em>
+type(location_type), intent(in) :: <em class=code>radar_location</em>
+real(r8), intent(in) :: <em class=code>beam_direction(3)</em>
+real(r8), intent(in) :: <em class=code>nyquist_velocity</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Sets the auxiliary information associated with a radial velocity
observation. This routine increments and returns the new key associated
with these values.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>velkey </em></TD>
- <TD>Unique identifier associated with this radial velocity
- observation. In this code it is an integer index into module
- local arrays which hold the additional data. This routine returns
- the incremented value associated with this data.</TD></TR>
- <TR><TD valign=top><em class=code>radar_location </em></TD>
- <TD>Location of the radar.</TD></TR>
- <TR><TD valign=top><em class=code>beam_orientation </em></TD>
- <TD>Orientation of the radar beam at the observation location.
- The three values are: sin(azimuth)*cos(elevation),
- cos(azimuth)*cos(elevation), and sin(elevation).</TD></TR>
- <TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
- <TD>Nyquist velocity at the observation point in meters/second.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>velkey</em></TD>
+ <TD>Unique identifier associated with this radial velocity
+ observation. In this code it is an integer index into module
+ local arrays which hold the additional data. This routine returns
+ the incremented value associated with this data.</TD></TR>
+<TR><TD valign=top><em class=code>radar_location</em></TD>
+ <TD>Location of the radar.</TD></TR>
+<TR><TD valign=top><em class=code>beam_orientation</em></TD>
+ <TD>Orientation of the radar beam at the observation location.
+ The three values are: sin(azimuth)*cos(elevation),
+ cos(azimuth)*cos(elevation), and sin(elevation).</TD></TR>
+<TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
+ <TD>Nyquist velocity at the observation point in meters/second.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="interactive_radial_vel"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call interactive_radial_vel(velkey) </em>
- <pre>
- integer, intent(out) :: <em class=code>velkey</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call interactive_radial_vel(velkey) </em>
+<pre>
+integer, intent(out) :: <em class=code>velkey</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Prompts the user for the auxiliary information needed for a radial
velocity observation, and returns the new key associated with this data.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>velkey </em></TD>
- <TD>Unique identifier associated with this radial velocity
- observation. In this code it is an integer index into module
- local arrays which hold the additional data. This routine returns
- the incremented value associated with this data.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>velkey </em></TD>
+ <TD>Unique identifier associated with this radial velocity
+ observation. In this code it is an integer index into module
+ local arrays which hold the additional data. This routine returns
+ the incremented value associated with this data.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="get_expected_radial_vel"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call> call get_expected_radial_vel(state_vector, location,
- velkey, radial_vel, istatus) </em>
- <pre>
- real(r8), intent(in) :: <em class=code>state_vector(:)</em>
- type(location_type), intent(in) :: <em class=code>location</em>
- integer, intent(in) :: <em class=code>velkey</em>
- real(r8), intent(out) :: <em class=code>radial_vel</em>
- integer, intent(out) :: <em class=code>istatus</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call> call get_expected_radial_vel(state_vector, location,
+ velkey, radial_vel, istatus) </em>
+<pre>
+real(r8), intent(in) :: <em class=code>state_vector(:)</em>
+type(location_type), intent(in) :: <em class=code>location</em>
+integer, intent(in) :: <em class=code>velkey</em>
+real(r8), intent(out) :: <em class=code>radial_vel</em>
+integer, intent(out) :: <em class=code>istatus</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Given a location and the state vector from one of the ensemble members,
compute the model-predicted radial velocity in meters/second
that would be observed at that location. <em class="code">velkey</em>
@@ -409,23 +409,23 @@
The along-beam component of the 3-d air velocity is computed from the
u, v, and w fields plus the beam_direction. The along-beam component
of power-weighted precipitation fall velocity is added to the result.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>state_vector </em></TD>
- <TD>A one dimensional representation of the model state vector</TD></TR>
- <TR><TD valign=top><em class=code>location </em></TD>
- <TD>Location of this observation</TD></TR>
- <TR><TD valign=top><em class=code>velkey </em></TD>
- <TD>Unique identifier associated with this radial velocity observation</TD></TR>
- <TR><TD valign=top><em class=code>radial_vel </em></TD>
- <TD>The returned radial velocity value in meters/second</TD></TR>
- <TR><TD valign=top><em class=code>istatus </em></TD>
- <TD>Returned integer status code describing problems with applying
- forward operator. 0 is a good value; any positive value
- indicates an error; negative values are reserved for
- internal DART use only.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>state_vector </em></TD>
+ <TD>A one dimensional representation of the model state vector</TD></TR>
+<TR><TD valign=top><em class=code>location</em></TD>
+ <TD>Location of this observation</TD></TR>
+<TR><TD valign=top><em class=code>velkey</em></TD>
+ <TD>Unique identifier associated with this radial velocity observation</TD></TR>
+<TR><TD valign=top><em class=code>radial_vel</em></TD>
+ <TD>The returned radial velocity value in meters/second</TD></TR>
+<TR><TD valign=top><em class=code>istatus</em></TD>
+ <TD>Returned integer status code describing problems with applying
+ forward operator. 0 is a good value; any positive value
+ indicates an error; negative values are reserved for
+ internal DART use only.</TD></TR>
+</TABLE>
+<BR>
<!--==================================================================-->
@@ -458,386 +458,385 @@
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="initialize_module"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call initialize_module()</em>
- <pre>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call initialize_module()</em>
+<pre>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Reads the namelist, allocates space for the auxiliary data associated
wtih radial velocity observations, initializes the constants used in
subsequent computations (possibly altered by values in the namelist),
and prints out the list of constants and the values in use. These
may need to change depending on which microphysics scheme is being used.
- </P>
- <BR>
+</P>
+<BR>
<!--===================== DESCRIPTION OF FUNCTION ====================-->
<A NAME="read_beam_direction"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>beam_direction = read_beam_direction(ifile, is_asciiformat)</em>
- <pre>
- real(r8), dimension(3) :: <em class=code>read_beam_direction</em>
- integer, intent(in) :: <em class=code>ifile</em>
- logical, intent(in) :: <em class=code>is_asciiformat</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>beam_direction = read_beam_direction(ifile, is_asciiformat)</em>
+<pre>
+real(r8), dimension(3) :: <em class=code>read_beam_direction</em>
+integer, intent(in) :: <em class=code>ifile</em>
+logical, intent(in) :: <em class=code>is_asciiformat</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Reads the beam direction at the observation location. Auxiliary data
for doppler radial velocity observations.
</P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>read_beam_direction </em></TD>
- <TD>Returns three real values for the radar beam orientation</TD></TR>
- <TR><TD valign=top><em class=code>ifile </em></TD>
- <TD>File unit descriptor for input file</TD></TR>
- <TR><TD valign=top><em class=code>is_asciiformat </em></TD>
- <TD>File format specifier: .TRUE. if file is formatted/ascii, or
- .FALSE. if unformatted/binary. Default .TRUE.</TD>
- </TABLE>
- <BR>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>read_beam_direction </em></TD>
+ <TD>Returns three real values for the radar beam orientation</TD></TR>
+<TR><TD valign=top><em class=code>ifile</em></TD>
+ <TD>File unit descriptor for input file</TD></TR>
+<TR><TD valign=top><em class=code>is_asciiformat</em></TD>
+ <TD>File format specifier: .TRUE. if file is formatted/ascii, or
+ .FALSE. if unformatted/binary. Default .TRUE.</TD></TR>
+</TABLE>
+<BR>
<!--===================== DESCRIPTION OF FUNCTION ====================-->
<A NAME="read_nyquist_velocity"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>nyquist_velocity = read_nyquist_velocity(ifile, is_asciiformat)</em>
- <pre>
- real(r8), :: <em class=code>read_nyquist_velocity</em>
- integer, intent(in) :: <em class=code>ifile</em>
- logical, intent(in) :: <em class=code>is_asciiformat</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>nyquist_velocity = read_nyquist_velocity(ifile, is_asciiformat)</em>
+<pre>
+real(r8), :: <em class=code>read_nyquist_velocity</em>
+integer, intent(in) :: <em class=code>ifile</em>
+logical, intent(in) :: <em class=code>is_asciiformat</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Reads nyquist velocity for a doppler radial velocity observation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>read_nyquist_velocity </em></TD>
- <TD>Returns a real value for the nyquist velocity value</TD></TR>
- <TR><TD valign=top><em class=code>ifile </em></TD>
- <TD>File unit descriptor for input file</TD></TR>
- <TR><TD valign=top><em class=code>is_asciiformat </em></TD>
- <TD>File format specifier: .TRUE. if file is formatted/ascii, or
- .FALSE. if unformatted/binary. Default .TRUE.</TD>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>read_nyquist_velocity </em></TD>
+ <TD>Returns a real value for the nyquist velocity value</TD></TR>
+<TR><TD valign=top><em class=code>ifile</em></TD>
+ <TD>File unit descriptor for input file</TD></TR>
+<TR><TD valign=top><em class=code>is_asciiformat</em></TD>
+ <TD>File format specifier: .TRUE. if file is formatted/ascii, or
+ .FALSE. if unformatted/binary. Default .TRUE.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="write_beam_direction"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call write_beam_direction(ifile, beam_direction, is_asciiformat)</em>
- <pre>
- integer, intent(in) :: <em class=code>ifile</em>
- real(r8), dimension(3), intent(in) :: <em class=code>beam_direction</em>
- logical, intent(in) :: <em class=code>is_asciiformat</em>
- </pre></div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call write_beam_direction(ifile, beam_direction, is_asciiformat)</em>
+<pre>
+integer, intent(in) :: <em class=code>ifile</em>
+real(r8), dimension(3), intent(in) :: <em class=code>beam_direction</em>
+logical, intent(in) :: <em class=code>is_asciiformat</em>
+</pre></div>
+<H3 class=indent1>Description</H3>
+<P>
Writes the beam direction at the observation location. Auxiliary data
for doppler radial velocity observations.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>ifile </em></TD>
- <TD>File unit descriptor for output file</TD></TR>
- <TR><TD valign=top><em class=code>beam_direction </em></TD>
- <TD>Three components of the radar beam orientation</TD></TR>
- <TR><TD valign=top><em class=code>is_asciiformat </em></TD>
- <TD>File format specifier: .TRUE. if file is formatted/ascii, or
- .FALSE. if unformatted/binary. Default .TRUE.</TD>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>ifile</em></TD>
+ <TD>File unit descriptor for output file</TD></TR>
+<TR><TD valign=top><em class=code>beam_direction </em></TD>
+ <TD>Three components of the radar beam orientation</TD></TR>
+<TR><TD valign=top><em class=code>is_asciiformat</em></TD>
+ <TD>File format specifier: .TRUE. if file is formatted/ascii, or
+ .FALSE. if unformatted/binary. Default .TRUE.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="write_nyquist_velocity"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call write_nyquist_velocity(ifile, nyquist_velocity, is_asciiformat)</em>
- <pre>
- integer, intent(in) :: <em class=code>ifile</em>
- real(r8), intent(in) :: <em class=code>nyquist_velocity</em>
- logical, intent(in) :: <em class=code>is_asciiformat</em>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call write_nyquist_velocity(ifile, nyquist_velocity, is_asciiformat)</em>
+<pre>
+integer, intent(in) :: <em class=code>ifile</em>
+real(r8), intent(in) :: <em class=code>nyquist_velocity</em>
+logical, intent(in) :: <em class=code>is_asciiformat</em>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Writes nyquist velocity for a doppler radial velocity observation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>ifile </em></TD>
- <TD>File unit descriptor for output file</TD></TR>
- <TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
- <TD>The nyquist velocity value for this observation</TD></TR>
- <TR><TD valign=top><em class=code>is_asciiformat </em></TD>
- <TD>File format specifier: .TRUE. if file is formatted/ascii, or
- .FALSE. if unformatted/binary. Default .TRUE.</TD>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>ifile</em></TD>
+ <TD>File unit descriptor for output file</TD></TR>
+<TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
+ <TD>The nyquist velocity value for this observation</TD></TR>
+<TR><TD valign=top><em class=code>is_asciiformat</em></TD>
+ <TD>File format specifier: .TRUE. if file is formatted/ascii, or
+ .FALSE. if unformatted/binary. Default .TRUE.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="interactive_beam_direction"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call interactive_beam_direction(beam_direction)</em>
- <pre>
- real(r8), dimension(3), intent(out) :: <em class=code>beam_direction</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call interactive_beam_direction(beam_direction)</em>
+<pre>
+real(r8), dimension(3), intent(out) :: <em class=code>beam_direction</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Prompts the user for input for the azimuth and elevation of the radar
beam at the observation location. Will be converted to the three values
actually stored in the observation sequence file.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>beam_direction </em></TD>
- <TD>Three components of the radar beam orientation</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>beam_direction </em></TD>
+ <TD>Three components of the radar beam orientation</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="interactive_nyquist_velocity"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call interactive_nyquist_velocity(nyquist_velocity)</em>
- <pre>
- real(r8), intent(out) :: <em class=code>nyquist_velocity</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call interactive_nyquist_velocity(nyquist_velocity)</em>
+<pre>
+real(r8), intent(out) :: <em class=code>nyquist_velocity</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Prompts the user for input for the nyquist velocity value
associated with a doppler radial velocity observation.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
- <TD>Nyquist velocity value for the observation.</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>nyquist_velocity </em></TD>
+ <TD>Nyquist velocity value for the observation.</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="get_reflectivity"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call get_reflectivity(qr, qg, qs, rho, temp, ref)</em>
- <pre>
- real(r8), intent(in) :: <em class=code>qr</em>
- real(r8), intent(in) :: <em class=code>qg</em>
- real(r8), intent(in) :: <em class=code>qs</em>
- real(r8), intent(in) :: <em class=code>rho</em>
- real(r8), intent(in) :: <em class=code>temp</em>
- real(r8), intent(out) :: <em class=code>ref</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call get_reflectivity(qr, qg, qs, rho, temp, ref)</em>
+<pre>
+real(r8), intent(in) :: <em class=code>qr</em>
+real(r8), intent(in) :: <em class=code>qg</em>
+real(r8), intent(in) :: <em class=code>qs</em>
+real(r8), intent(in) :: <em class=code>rho</em>
+real(r8), intent(in) :: <em class=code>temp</em>
+real(r8), intent(out) :: <em class=code>ref</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Computes the equivalent radar reflectivity factor in
mm<sup>6</sup> m<sup>-3</sup>
for simple single-moment microphysics schemes such as
Kessler and Lin, et al.
See the <A HREF="#References">references</A> for more details.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>qr </em></TD>
- <TD>Rain water content (kg kg<sup>-1</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>qg </em></TD>
- <TD>Graupel/hail content (kg kg<sup>-1</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>qs </em></TD>
- <TD>Snow content (kg kg<sup>-1</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>rho </em></TD>
- <TD>Air density (kg m<sup>-3</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>temp </em></TD>
- <TD>Air temperature (K)</TD></TR>
- <TR><TD valign=top><em class=code>ref </em></TD>
- <TD>The returned radar reflectivity value</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>qr</em></TD>
+ <TD>Rain water content (kg kg<sup>-1</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>qg</em></TD>
+ <TD>Graupel/hail content (kg kg<sup>-1</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>qs</em></TD>
+ <TD>Snow content (kg kg<sup>-1</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>rho</em></TD>
+ <TD>Air density (kg m<sup>-3</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>temp </em></TD>
+ <TD>Air temperature (K)</TD></TR>
+<TR><TD valign=top><em class=code>ref</em></TD>
+ <TD>The returned radar reflectivity value</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="get_precip_fall_speed"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call get_precip_fall_speed(qr, qg, qs, rho, temp, precip_fall_speed)</em>
- <pre>
- real(r8), intent(in) :: <em class=code>qr</em>
- real(r8), intent(in) :: <em class=code>qg</em>
- real(r8), intent(in) :: <em class=code>qs</em>
- real(r8), intent(in) :: <em class=code>rho</em>
- real(r8), intent(in) :: <em class=code>temp</em>
- real(r8), intent(out) :: <em class=code>precip_fall_speed</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call get_precip_fall_speed(qr, qg, qs, rho, temp, precip_fall_speed)</em>
+<pre>
+real(r8), intent(in) :: <em class=code>qr</em>
+real(r8), intent(in) :: <em class=code>qg</em>
+real(r8), intent(in) :: <em class=code>qs</em>
+real(r8), intent(in) :: <em class=code>rho</em>
+real(r8), intent(in) :: <em class=code>temp</em>
+real(r8), intent(out) :: <em class=code>precip_fall_speed</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Computes power-weighted precipitation fall speed in m s<sup>-1</sup>
for simple single-moment microphysics schemes such as Kessler and Lin, et al.
See the <A HREF="#References">references</A> for more details.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
- <TR><TD valign=top><em class=code>qr </em></TD>
- <TD>Rain water content (kg kg<sup>-1</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>qg </em></TD>
- <TD>Graupel/hail content (kg kg<sup>-1</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>qs </em></TD>
- <TD>Snow content (kg kg<sup>-1</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>rho </em></TD>
- <TD>Air density (kg m<sup>-3</sup>)</TD></TR>
- <TR><TD valign=top><em class=code>temp </em></TD>
- <TD>Air temperature (K)</TD></TR>
- <TR><TD valign=top><em class=code>precip_fall_speed </em></TD>
- <TD>The returned precipitation vall speed</TD></TR>
- </TABLE>
- <BR>
+</P>
+<TABLE width=100% border=0 summary="" celpadding=3>
+<TR><TD valign=top><em class=code>qr</em></TD>
+ <TD>Rain water content (kg kg<sup>-1</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>qg</em></TD>
+ <TD>Graupel/hail content (kg kg<sup>-1</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>qs</em></TD>
+ <TD>Snow content (kg kg<sup>-1</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>rho</em></TD>
+ <TD>Air density (kg m<sup>-3</sup>)</TD></TR>
+<TR><TD valign=top><em class=code>temp</em></TD>
+ <TD>Air temperature (K)</TD></TR>
+<TR><TD valign=top><em class=code>precip_fall_speed </em></TD>
+ <TD>The returned precipitation vall speed</TD></TR>
+</TABLE>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="initialize_constants"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call initialize_constants()</em>
- <pre>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call initialize_constants()</em>
+<pre>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Set values for a collection of constants used throughout the module
during the various calculations. These are set once in this routine
and are unchanged throughout the rest of the execution. They cannot
be true Fortran <em class=code>parameters</em> because some of the
values can be overwritten by namelist entries, but once they are set
they are treated as read-only parameters.
- </P>
- <BR>
+</P>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="print_constants"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call print_constants()</em>
- <pre>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call print_constants()</em>
+<pre>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Print out the names and values of all constant parameters used by this
module. The error handler message facility is used to print the message,
which by default goes to both the DART log file and to the standard
output of the program.
- </P>
- <BR>
+</P>
+<BR>
<!--============= DESCRIPTION OF A SUBROUTINE =======================-->
<A NAME="pr_con"></A>
- <P></P><HR><P></P>
- <div class=routine>
- <em class=call>call pr_con(c_val, c_str)</em>
- <pre>
- real(r8), intent(in) :: <em class=code>c_val</em>
- character(len=*), intent(in) :: <em class=code>c_str</em>
- </pre>
- </div>
- <H3 class=indent1>Description</H3>
- <P>
+<P></P><HR><P></P>
+<div class=routine>
+<em class=call>call pr_con(c_val, c_str)</em>
+<pre>
+real(r8), intent(in) :: <em class=code>c_val</em>
+character(len=*), intent(in) :: <em class=code>c_str</em>
+</pre>
+</div>
+<H3 class=indent1>Description</H3>
+<P>
Calls the DART error handler routine to print out a string label
and a real value to both the log file and to the standard output.
- </P>
- <TABLE width=100% border=0 summary="" celpadding=3>
@@ Diff output truncated at 40000 characters. @@
More information about the Dart-dev
mailing list