% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cal0_time_solar.R
\name{calendar_time_solar}
\alias{calendar_time_solar}
\alias{cal_time_solar_transit}
\alias{cal_time_solar}
\title{Solar time unit classes}
\format{
A location-based calendar containing transit-based solar time units.
}
\usage{
cal_time_solar_transit

cal_time_solar
}
\value{
An S3 list of class \code{c("cal_time_solar", "mt_calendar")} containing
the named time unit classes of the solar transit calendar. Each unit is
accessible via \code{$} notation and calling it with a step size and location
produces a time granule (e.g., 1 solar day granule as
\code{cal_time_solar$day(1L, lat = 0, lon = 0)}). Because solar day boundaries
depend on the observer's position, each unit constructor requires \code{lat}
and \code{lon} arguments.
}
\description{
Time unit constructors for the transit-based solar time system, where the
boundary of each day is at apparent solar midnight. Solar events define the
\code{ampm} (midnight and noon) and \code{illumination} (dawn, sunrise, sunset, dusk)
units. \code{cal_time_solar} is an alias for \code{cal_time_solar_transit}.
}
\details{
The following time units are available in the solar calendar systems.
\itemize{
\item \code{day()}: Day unit
\item \code{ampm()}: Half-day units (AM = before solar noon, PM = after solar noon)
\item \code{hour()}: Hour units within the solar day
\item \code{minute()}: Minute units within the solar hour
\item \code{second()}: Second units within the solar minute
\item \code{degree()}: Solar angle units within the day
\item \code{arcminute()}: Arcminute units within the solar degree
\item \code{arcsecond()}: Arcsecond units within the solar arcminute
\item \code{illumination()}: Illumination phases (night, astronomical/nautical/civil dawn, day, civil/nautical/astronomical dusk)
}
\subsection{AM/PM half-days}{

The \code{ampm} unit divides each solar day into two halves between solar noon and
solar midnight:\tabular{lll}{
   Half \tab Period \tab Description \cr
   AM \tab Solar midnight to noon \tab Morning half; before solar transit \cr
   PM \tab Solar noon to midnight \tab Afternoon half; after solar transit \cr
}

}

\subsection{Solar illumination phases}{

Phases describe the illumination state of the sky and correspond to standard
twilight definitions used in astronomy and navigation. Each phase is bounded
by a pair of solar altitude thresholds:\tabular{lll}{
   Phase \tab Solar altitude range \tab Description \cr
   Night \tab < -18° \tab Sky fully dark; from last dusk to first dawn (spans noon) \cr
   Astronomical dawn \tab -18° to -12° \tab Astronomical twilight before sunrise; faint objects obscured \cr
   Nautical dawn \tab -12° to -6° \tab Nautical twilight before sunrise; horizon visible at sea \cr
   Civil dawn \tab -6° to -0.833° \tab Civil twilight before sunrise; sky brightening in the east \cr
   Day \tab > -0.833° \tab Sun above the horizon; spans solar noon \cr
   Civil dusk \tab -0.833° to -6° \tab Civil twilight after sunset; sky fading in the west \cr
   Nautical dusk \tab -6° to -12° \tab Nautical twilight after sunset; horizon visible at sea \cr
   Astronomical dusk \tab -12° to -18° \tab Astronomical twilight after sunset; faint objects obscured \cr
}


The -0.833° threshold for sunrise and sunset accounts for the mean angular
radius of the solar disc (0.267°) plus the standard atmospheric refraction
at the horizon (0.566°). Noon and midnight are derived from the equation of
time rather than a fixed altitude. Locations that experience polar day or
polar night (civil days where sunrise does not occur) are not currently
supported, it is recommended to use an alternative reference location.
}
}
\examples{
# Find the current solar time in Melbourne
datetime(Sys.time(), calendar = cal_time_solar, lat = -37.8136, lon = 144.9631)

}
\seealso{
\code{\link{cal_time_civil}}, \code{\link{cal_time_lunar}}
}
