fr.cnes.sirius.patrius.forces.gravity.grid

Class AttractionDataPoint

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.grid.AttractionDataPoint

All Implemented Interfaces:

Serializable

public class AttractionDataPoint
extends Object
implements Serializable

Attraction data: 3D acceleration and potential for one grid point. Grid point can be expressed either in 3D coordinates or in spherical coordinates.

This class is to be used in conjunction with GridGravityModel for attraction force defined by a grid.

Since:

4.7

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttractionDataPoint(SphericalCoordinates coordinates, Vector3D acceleration, double potential) Constructor with spherical coordinates.
AttractionDataPoint(Vector3D position, Vector3D acceleration, double potential) Constructor with 3D position.

Method Summary

Modifier and Type	Method and Description
Vector3D	getAcceleration() Returns the XYZ acceleration.
Vector3D	getPosition() Returns the position.
double	getPotential() Returns the potential.
SphericalCoordinates	getSphericalCoordinates() Returns the spherical coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttractionDataPoint

public AttractionDataPoint(Vector3D position,
                           Vector3D acceleration,
                           double potential)

Constructor with 3D position.

Parameters:

position - position

acceleration - XYZ acceleration at position

potential - potential at position

AttractionDataPoint

public AttractionDataPoint(SphericalCoordinates coordinates,
                           Vector3D acceleration,
                           double potential)

Constructor with spherical coordinates.

Parameters:

coordinates - spherical coordinates

acceleration - XYZ acceleration

potential - potential

Method Detail

getPosition

public Vector3D getPosition()

Returns the position.

Returns:

the position

getSphericalCoordinates

public SphericalCoordinates getSphericalCoordinates()

Returns the spherical coordinates.

Returns:

the spherical coordinates or null if unused

getAcceleration

public Vector3D getAcceleration()

Returns the XYZ acceleration.

Returns:

the XYZ acceleration

getPotential

public double getPotential()

Returns the potential.

Returns:

the potential