fr.cnes.sirius.patrius.bodies

Class BasicBoardSun

java.lang.Object

fr.cnes.sirius.patrius.bodies.BasicBoardSun

All Implemented Interfaces:

IDirection, Serializable

public class BasicBoardSun
extends Object
implements IDirection

This class provides the Sun direction at a specific date, according to a simple analytical model.

Since:

1.3

Version:

$Id$

Author:

Tiziana Sabatini

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
BasicBoardSun() Constructor with default values.
BasicBoardSun(AbsoluteDate ref, double alpha1, double alpha2, double nu1, double nu2, double lon1, double epsilon) Constructor with user values.

Method Summary

Modifier and Type	Method and Description
Line	getLine(PVCoordinatesProvider pvCoord, AbsoluteDate date, Frame frame) Get the line from the position in pvCoord to the Sun.
Vector3D	getVector(PVCoordinatesProvider pvCoord, AbsoluteDate date, Frame frame) Get the direction of the sun.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicBoardSun

public BasicBoardSun()

Constructor with default values.

BasicBoardSun

public BasicBoardSun(AbsoluteDate ref,
                     double alpha1,
                     double alpha2,
                     double nu1,
                     double nu2,
                     double lon1,
                     double epsilon)

Constructor with user values.

Parameters:

ref - Reference date

alpha1 - Sun mean longitude constant α1 (rad)

alpha2 - Sun mean longitude constant α2 (rad/s)

nu1 - Sun mean anomaly default constant ν1 (rad)

nu2 - Sun mean anomaly default constant ν2 (rad/s)

lon1 - Sun longitude amplitude

epsilon - epsilon

Method Detail

getVector

public Vector3D getVector(PVCoordinatesProvider pvCoord,
                          AbsoluteDate date,
                          Frame frame)
                   throws PatriusException

Get the direction of the sun. The parameter pvCoord is not used because all directions are colinear.

Provides the direction vector at a given date in a given frame.

Specified by:

getVector in interface IDirection

Parameters:

pvCoord - the current coordinates of the origin point of the direction (may be null, in that specific case, the origin of the direction is the frame origin).

date - the date

frame - the frame to project the vector's coordinates

Returns:

the direction vector at the given date in the given frame

Throws:

PatriusException - if some frame specific errors occur

getLine

public Line getLine(PVCoordinatesProvider pvCoord,
                    AbsoluteDate date,
                    Frame frame)
             throws PatriusException

Get the line from the position in pvCoord to the Sun.

Provides the line containing the origin (given PV coordinates) and directed by the direction vector.

Specified by:

getLine in interface IDirection

Parameters:

pvCoord - the origin of the direction

date - the current date

frame - the expression frame of the line

Returns:

the Line of space containing the origin and direction vector

Throws:

PatriusException - if some frame specific errors occur