Changeset 1718 for trunk/src/STAtmosphere.cpp

Timestamp:

03/29/10 14:46:23 (14 years ago)

Author:

Max Voronkov

Message:

updated documentation to reflect better interpretation of the pressure

File:

• trunk/src/STAtmosphere.cpp (modified) (3 diffs)

trunk/src/STAtmosphere.cpp

@@ -76 +76 @@
  * Constructor with explicitly given parameters of the atmosphere 
  * @param[in] temperature air temperature at the observatory (K)
- * @param[in] pressure air pressure at the sea level (Pascals)
+ * @param[in] pressure air pressure at the sea level if the observatory elevation is set 
+ *            (default is set to 200m) or at the observatory ground level if the elevation 
+ *            is set to 0 (Pascals)
  * @param[in] humidity air humidity at the observatory (fraction)
  * @param[in] lapseRate temperature lapse rate (K/m), default is 0.0065 K/m to match MIRIAD and ISA 
@@ -98 +100 @@
  * Set the new weather station data, recompute the model 
  * @param[in] temperature air temperature at the observatory (K)
- * @param[in] pressure air pressure at the sea level (Pascals)
+ * @param[in] pressure air pressure at the sea level if the observatory elevation is set to non-zero value
+ *            (default is set to 200m) or at the observatory ground level if the elevation  
+ *            is set to 0 (Pascals)
  * @param[in] humidity air humidity at the observatory (fraction)
  **/
@@ -111 +115 @@
 /**
  * Set the elevation of the observatory (height above mean sea level)
- * By default, 200m is assumed.
+ * It affects only interpretation of the pressure supplied as part of the weather data, if this value 
+ * is non-zero, the pressure (e.g. in setWeather or constructor) is that at mean sea level. If the
+ * observatory elevation is set to zero, regardless on real elevation, the pressure is that at the 
+ * observatory ground level.
+ * 
+ * By default, 200m is assumed and the pressure should be a mean sea level pressure..
  * @param[in] elev elevation in metres
  **/