Commit 86e851da authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.3.2.2 DOC: Pe_Oudin doc added

Showing with 69 additions and 2 deletions
+69 -2
Package: airGR Package: airGR
Type: Package Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.3.2.1 Version: 1.3.2.2
Date: 2019-05-22 Date: 2019-05-22
Authors@R: c( Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")), person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
......
...@@ -14,7 +14,7 @@ output: ...@@ -14,7 +14,7 @@ output:
### 1.3.2.0 Release Notes (2019-05-22) ### 1.3.2.2 Release Notes (2019-05-22)
#### New features #### New features
......
\encoding{UTF-8}
\name{PE_Oudin}
\alias{PE_Oudin}
\title{Computation of daily our hourly series of potential evapotranspiration with Oudin's formula}
\usage{
PE_Oudin(JD, Temp, LatRad, Lat, LatUnit, TimeStepIn = "daily", TimeStepOut = "daily")
}
\arguments{
\item{JD}{[numeric] time series of Julian day of the year [-]; see details below}
\item{Temp}{[numeric] time series of daily (or hourly) mean air temperature [°C]}
\item{LatRad}{(deprecated)[numeric] latitude of measurement for the temperature series [rad]. Please use \code{Lat} instead}
\item{Lat}{[numeric] latitude of measurement for the temperature series [radian or degrees]}
\item{LatUnit}{[character] latitude unit (default = \code{"rad"} or \code{"deg"})}
\item{TimeStepIn}{[character] time step of inputs (default = \code{"daily"} or \code{"hourly"})}
\item{TimeStepOut}{[character] time step of outputs (default = \code{"daily"} or \code{"hourly"})}
}
\value{
[numeric] time series of daily potential evapotranspiration [mm/time step]
}
\description{
Function which computes daily PE using the formula from Oudin et al. (2005).
}
\details{
In the \code{JD} argument, the Julian day of the year of the 1st of January is equal to 1 and the 31st of December to 365 (366 in leap years)). If the Julian day of the year is computed on an object of the \code{POSIXlt} class, the user has to add 1 to the returned value (e.g. \code{as.POSIXlt("2016-12-31")$yday + 1}).
For hourly temperature, all the values of the same day have to be set to the same Julian day of the year (e.g. \code{as.POSIXlt("2016-12-31 00:00:00")$yday + 1} and \code{as.POSIXlt("2016-12-31 00:01:00")$yday + 1}). Each days must have 24 identical Julian day values (one for each hour).
}
\examples{
library(airGR)
data(L0123001)
PotEvap <- PE_Oudin(JD = as.POSIXlt(BasinObs$DatesR)$yday + 1,
Temp = BasinObs$T,
Lat = 0.8, LatUnit = "rad")
}
\author{
Laurent Coron, Ludovic Oudin, Olivier Delaigue, Guillaume Thirel
}
\references{
Oudin, L., F. Hervieu, C. Michel, C. Perrin, V. Andréassian, F. Anctil and C. Loumagne (2005).
Which potential evapotranspiration input for a lumped rainfall-runoff model?:
Part 2-Towards a simple and efficient potential evapotranspiration model for rainfall-runoff modelling.
Journal of Hydrology, 303(1-4), 290-306. doi:10.1016/j.jhydrol.2004.08.026.
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment