public final class GravityGradientTorque extends TorqueModel
PropagationNewtonianPoint and a PropagationEulerianAxes.
It is assumed that there are no inertia terms that are higher order than the moment of inertia matrix and that there are no gravity terms higher than the point-mass gravity term.
| Constructor and Description |
|---|
GravityGradientTorque(Point bodyCenterOfMass,
CentralBody centralBody,
double gravitationalParameter,
Matrix3By3Symmetric inertiaMatrix,
Axes bodyAxes)
Initializes the gravity-gradient torque model.
|
GravityGradientTorque(Point bodyCenterOfMass,
Matrix3By3Symmetric inertiaMatrix,
Axes bodyAxes)
Initializes the gravity-gradient torque model.
|
| Modifier and Type | Method and Description |
|---|---|
void |
buildTorqueEvaluator(ResultantTorqueBuilder builder,
EvaluatorGroup group)
Build lists of torques based on this model in order to create
an overall resultant torque.
|
protected boolean |
checkForSameDefinition(TorqueModel other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
Axes |
getBodyAxes()
Gets the body axes of the gravity-gradient satellite.
|
Point |
getBodyCenterOfMass()
Gets the center of mass point of the gravity-gradient satellite.
|
CentralBody |
getCentralBody()
Gets the body which creates the gravity and provides a reference point at its center of mass.
|
double |
getGravitationalParameter()
Gets the gravitational parameter to use when computing gravity, in meters cubed per second squared.
|
Matrix3By3Symmetric |
getInertiaMatrix()
Gets the 3x3 inertia matrix of the gravity-gradient satellite.
|
TorqueEvaluator |
getTorqueEvaluator(EvaluatorGroup group)
Gets an instance of an evaluator that can compute the torque.
|
void |
setBodyAxes(Axes value)
Sets the body axes of the gravity-gradient satellite.
|
void |
setBodyCenterOfMass(Point value)
Sets the center of mass point of the gravity-gradient satellite.
|
void |
setCentralBody(CentralBody value)
Sets the body which creates the gravity and provides a reference point at its center of mass.
|
void |
setGravitationalParameter(double value)
Sets the gravitational parameter to use when computing gravity, in meters cubed per second squared.
|
void |
setInertiaMatrix(Matrix3By3Symmetric value)
Sets the 3x3 inertia matrix of the gravity-gradient satellite.
|
checkForSameDefinition, freezeAggregatedObjects, getTorqueEvaluator, getTorqueVectorareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic GravityGradientTorque(@Nonnull Point bodyCenterOfMass, @Nonnull Matrix3By3Symmetric inertiaMatrix, Axes bodyAxes)
CentralBody (get / set) is set to Earth from the CentralBodiesFacet and the
GravitationalParameter (get / set) is set to WorldGeodeticSystem1984.GravitationalParameter.bodyCenterOfMass - The center of mass point of the gravity-gradient satellite.inertiaMatrix - The 3x3 inertia matrix of the gravity-gradient satellite.
This must be defined in the BodyAxes (get / set).bodyAxes - The body axes of the gravity-gradient satellite. These should be the
IntegrationAxes (get)
of the PropagationEulerianAxes associated with the gravity-gradient satellite.public GravityGradientTorque(@Nonnull Point bodyCenterOfMass, CentralBody centralBody, double gravitationalParameter, @Nonnull Matrix3By3Symmetric inertiaMatrix, Axes bodyAxes)
bodyCenterOfMass - The center of mass point of the gravity-gradient satellite.centralBody - The body which creates the gravity and provides a reference point at its center of mass.gravitationalParameter - The gravitational parameter to use when computing gravity, in meters cubed per second squared.inertiaMatrix - The 3x3 inertia matrix of the gravity-gradient satellite.
This must be defined in the BodyAxes (get / set).bodyAxes - The body axes of the gravity-gradient satellite. These should be the IntegrationAxes (get)
of the PropagationEulerianAxes associated with the gravity-gradient satellite.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T) to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T) to copy any reference fields.
A typical implementation of ICloneWithContext:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T). There are a couple of exceptions:
If one of these exceptions applies, the CopyContext should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected boolean checkForSameDefinition(TorqueModel other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class TorqueModelother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
GravityGradientTorque.checkForSameDefinition(agi.foundation.celestial.TorqueModel) method.computeCurrentDefinitionHashCode in class TorqueModelpublic void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class TorqueModelenumerator - The enumerator that is informed of the dependencies of this object.public final Point getBodyCenterOfMass()
public final void setBodyCenterOfMass(Point value)
public final CentralBody getCentralBody()
public final void setCentralBody(CentralBody value)
public final double getGravitationalParameter()
public final void setGravitationalParameter(double value)
@Nonnull public final Matrix3By3Symmetric getInertiaMatrix()
public final void setInertiaMatrix(@Nonnull Matrix3By3Symmetric value)
public final Axes getBodyAxes()
IntegrationAxes (get)
of the PropagationEulerianAxes associated with the gravity-gradient satellite.public final void setBodyAxes(Axes value)
IntegrationAxes (get)
of the PropagationEulerianAxes associated with the gravity-gradient satellite.public TorqueEvaluator getTorqueEvaluator(EvaluatorGroup group)
getTorqueEvaluator in class TorqueModelgroup - The group in which to create the evaluator and its dependents.ArgumentNullException - Thrown when group is null.PropertyInvalidException - Thrown when BodyAxes (get / set), BodyCenterOfMass (get / set), or CentralBody (get / set) is null.
Thrown when the GravitationalParameter (get / set) is negative.
Thrown when the InertiaMatrix (get / set) is not positive definite or has a determinant of less than 10^(-15).public void buildTorqueEvaluator(ResultantTorqueBuilder builder, EvaluatorGroup group)
buildTorqueEvaluator in class TorqueModelbuilder - The builder object containing the lists and additional information
on the Axes in which the overall resultant is defined.group - The evaluator group in which to create evaluators.ArgumentNullException - Thrown when builder or group is null.