ClimateParams.h
Go to the documentation of this file.
1/*!
2 * \file ClimateParams.h
3 * \brief Functions for climate related intermediate parameters,
4 * e.g., saturation vapor pressure, max solar radiation.
5 * \author LiangJun Zhu
6 * \date April 2016
7 *
8 */
9#ifndef SEIMS_CLIMATE_PARAMS_H
10#define SEIMS_CLIMATE_PARAMS_H
11
12#include <ctime>
13#include "seims.h"
14
15using std::time_t;
16
17/*!
18 * \defgroup ClimateParameters
19 * \ingroup common_algorithm
20 * \brief Functions for climate related intermediate parameters.
21 */
22
23/*!
24 * \ingroup ClimateParameters
25 * \brief Calculate latent heat of vaporization(MJ/kg)
26 * \param[in] tmean Mean temperature
27 * \return Latent heat of vaporization
28 */
29FLTPT LatentHeatVapor(FLTPT tmean);
30
31/*!
32 * \ingroup ClimateParameters
33 * \brief Calculate the max solar radiation for a station of one day
34 * \param[in] day Julian day
35 * \param[in] lat Latitude (degree) of the station
36 * \param[out] day_l day length (hr)
37 * \param[out] max_sr The max solar radiation
38 */
39void MaxSolarRadiation(int day, FLTPT lat, FLTPT& day_l, FLTPT& max_sr);
40
41/*!
42 * \ingroup ClimateParameters
43 * \brief Calculate mean barometric pressure
44 * \param[in] elev elevation of current cell or site
45 * \return mean atmospheric pressure (kPa)
46 */
47FLTPT MeanBarometricPressure(FLTPT elev);
48
49/*!
50 * \ingroup ClimateParameters
51 * \brief Calculate psychrometric constant
52 * \param[in] elev elevation of current cell or site
53 * \param[in] tmean Mean temperature
54 * \sa MeanBarometricPressure()
55 * \sa LatentHeatVapor()
56 * \return Psychrometric constant
57 */
58FLTPT PsychrometricConst(FLTPT tmean, FLTPT elev);
59
60/*!
61 * \ingroup ClimateParameters
62 * \brief Calculates saturation vapor pressure at a given air temperature.
63 * \param[in] mean_tmp Mean air temperature(deg C)
64 * \return saturation vapor pressure(kPa)
65*/
66FLTPT SaturationVaporPressure(FLTPT mean_tmp);
67
68#endif /* SEIMS_CLIMATE_PARAMS_H */
FLTPT SaturationVaporPressure(FLTPT mean_tmp)
Calculates saturation vapor pressure at a given air temperature.
FLTPT MeanBarometricPressure(FLTPT elev)
Calculate mean barometric pressure.
FLTPT PsychrometricConst(FLTPT tmean, FLTPT elev)
Calculate psychrometric constant.
void MaxSolarRadiation(int day, FLTPT lat, FLTPT &day_l, FLTPT &max_sr)
Calculate the max solar radiation for a station of one day.
FLTPT LatentHeatVapor(FLTPT tmean)
Calculate latent heat of vaporization(MJ/kg)
The SEIMS related definitions and utilities header.