fr.cnes.sirius.patrius.forces.gravity

Class AbstractGravityModel

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.AbstractGravityModel

All Implemented Interfaces:

GravityModel, Serializable

Direct Known Subclasses:

AbstractHarmonicGravityModel, GridGravityModel

public abstract class AbstractGravityModel
extends Object
implements GravityModel

This class represents a gravitational attraction model.

Since:

2.3

Version:

$Id: AttractionModel.java 18082 2017-10-02 16:54:17Z bignon $

Author:

Tiziana Sabatini

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Frame	bodyFrame Central body frame (rotating).
protected boolean	centralTermContribution Central term contribution (true if the central term is considered, false if not).
protected static String	MU Parameter name for central attraction coefficient.
protected Parameter	paramMu Central attraction coefficient parameter.

Constructor Summary

Constructors

Constructor and Description
AbstractGravityModel() Simple constructor.
AbstractGravityModel(Parameter mu) Constructor.

Method Summary

Modifier and Type	Method and Description
Frame	getBodyFrame() Get the central body frame.
double	getMu() Get the central attraction coefficient.
void	setMu(double muIn) Set the central attraction coefficient.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.forces.gravity.GravityModel

checkData, computeAcceleration, computeDAccDPos

Field Detail

MU

protected static final String MU

Parameter name for central attraction coefficient.

See Also:

Constant Field Values

bodyFrame

protected Frame bodyFrame

Central body frame (rotating).

paramMu

protected Parameter paramMu

Central attraction coefficient parameter.

centralTermContribution

protected boolean centralTermContribution

Central term contribution (true if the central term is considered, false if not). The central term is considered by default, so this boolean is true by default.

Constructor Detail

AbstractGravityModel

public AbstractGravityModel(Parameter mu)

Constructor.

Parameters:

mu - gravitational parameter

AbstractGravityModel

public AbstractGravityModel()

Simple constructor. Mu is not provided and set to null.

Method Detail

getMu

public double getMu()

Get the central attraction coefficient.

Specified by:

getMu in interface GravityModel

Returns:

central attraction coefficient (m³/s²)

setMu

public void setMu(double muIn)

Set the central attraction coefficient.

Specified by:

setMu in interface GravityModel

Parameters:

muIn - the central attraction coefficient.

getBodyFrame

public Frame getBodyFrame()

Get the central body frame.

Specified by:

getBodyFrame in interface GravityModel

Returns:

the bodyFrame