Zmanim.Calculator.SunTimesCalculator Class Reference

Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm written by Kevin Boone that is based on the US Naval Observatory'sAlmanac for Computer algorithm ( Amazon, Barnes & Noble) and is used with his permission. Added to Kevin's code is adjustment of the zenith to account for elevation. More...

Inheritance diagram for Zmanim.Calculator.SunTimesCalculator:

List of all members.

Public Member Functions
override double	GetUtcSunrise (IAstronomicalCalendar astronomicalCalendar, double zenith, bool adjustForElevation)
	A method that calculates UTC sunrise as well as any time based on an angle above or below sunrise. This abstract method is implemented by the classes that extend this class.
override double	GetUtcSunset (IAstronomicalCalendar astronomicalCalendar, double zenith, bool adjustForElevation)
	A method that calculates UTC sunset as well as any time based on an angle above or below sunset. This abstract method is implemented by the classes that extend this class.
Public Attributes
const double	ZENITH = 90 + 50.0/60.0
	Default value for Sun's zenith and true rise/set /summary>
Properties
override string	CalculatorName [get]

---

Detailed Description

Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm written by Kevin Boone that is based on the US Naval Observatory'sAlmanac for Computer algorithm ( Amazon, Barnes & Noble) and is used with his permission. Added to Kevin's code is adjustment of the zenith to account for elevation.

<author>Kevin Boone</author> <author>Eliyahu Hershfeld</author>

---

Member Function Documentation

override double Zmanim.Calculator.SunTimesCalculator.GetUtcSunrise	(	IAstronomicalCalendar	astronomicalCalendar,
		double	zenith,
		bool	adjustForElevation
	)			[virtual]

A method that calculates UTC sunrise as well as any time based on an angle above or below sunrise. This abstract method is implemented by the classes that extend this class.

Parameters:

	astronomicalCalendar	Used to calculate day of year.
	zenith	the azimuth below the vertical zenith of 90 degrees. for sunrise typically the zenith used for the calculation uses geometric zenith of 90°; and adjusts this slightly to account for solar refraction and the sun's radius. Another example would be AstronomicalCalendar.GetBeginNauticalTwilight that passes AstronomicalCalendar.NAUTICAL_ZENITH to this method.
	adjustForElevation	if set to true [adjust for elevation].

Returns:

The UTC time of sunrise in 24 hour format. 5:45:00 AM will return 5.75.0. If an error was encountered in the calculation (expected behavior for some locations such as near the poles, Double.NaN will be returned.

See also:

AstronomicalCalculator.GetUtcSunrise

Implements Zmanim.Calculator.AstronomicalCalculator.

override double Zmanim.Calculator.SunTimesCalculator.GetUtcSunset	(	IAstronomicalCalendar	astronomicalCalendar,
		double	zenith,
		bool	adjustForElevation
	)			[virtual]

A method that calculates UTC sunset as well as any time based on an angle above or below sunset. This abstract method is implemented by the classes that extend this class.

Parameters:

	astronomicalCalendar	Used to calculate day of year.
	zenith	the azimuth below the vertical zenith of 90°;. For sunset typically the zenith used for the calculation uses geometric zenith of 90°; and adjusts this slightly to account for solar refraction and the sun's radius. Another example would be AstronomicalCalendar.GetEndNauticalTwilight that passes AstronomicalCalendar.NAUTICAL_ZENITH to this method.
	adjustForElevation

Returns:

The UTC time of sunset in 24 hour format. 5:45:00 AM will return 5.75.0. If an error was encountered in the calculation (expected behavior for some locations such as near the poles,

See also:

Double.NaN

will be returned.

See also:

AstronomicalCalculator.GetUtcSunset

summary> sin of an angle in degrees /summary>

Implements Zmanim.Calculator.AstronomicalCalculator.

---

Property Documentation

override string Zmanim.Calculator.SunTimesCalculator.CalculatorName [get]

the descriptive name of the algorithm.

Reimplemented from Zmanim.Calculator.AstronomicalCalculator.

---

The documentation for this class was generated from the following file:

• D:/Projects/Zmanim/src/Zmanim/Calculator/SunTimesCalculator.cs