agi.foundation.celestial

(agi.foundation.orbitpropagation-2024r3.jar)

Class TimeVaryingSolidTideModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.SolidTideModel

agi.foundation.celestial.TimeVaryingSolidTideModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

Iers2003SolidTideModel, SimpleSolidTideModel

public abstract class TimeVaryingSolidTideModel
extends SolidTideModel

A solid tide model that must vary with time.

Any user-designed class that inherits from this class must implement an evaluator that produces normalized tide coefficients.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimeVaryingSolidTideModel() Initializes a time-varying, solid tide model without any configuration.
protected	TimeVaryingSolidTideModel(CentralBody centralBody, int tideCoefficientsDegree, int tideCoefficientsOrder, double gravitationalParameter, double referenceDistance) Initializes most of the parameters of a time-varying solid tide model.
protected	TimeVaryingSolidTideModel(TimeVaryingSolidTideModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
void	addThirdBody(String name, Point point, double gravitationalParameter) Adds a Point representing the position of the tide-inducing gravitational body and a double representing its gravitational parameter, in meters cubed per second squared.
protected boolean	checkForSameDefinition(SolidTideModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(TimeVaryingSolidTideModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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.
ArrayList<ThirdBodyGravity.ThirdBodyInfo>	getThirdBodies() Gets a list of the tidal third bodies that are currently configured to this solid tide model.
boolean	removeThirdBody(double gravitationalParameter) Removes a tidal perturbations due to the body represented by the gravitational parameter.
boolean	removeThirdBody(Point point) Removes a tidal perturbations due to the body represented by the Point.
boolean	removeThirdBody(String name) Removes tidal perturbations due to the body represented by the name.

Methods inherited from class agi.foundation.celestial.SolidTideModel

checkForSameDefinition, getCentralBody, getCoefficientsEvaluator, getCoefficientsEvaluator, getGravitationalParameter, getReferenceDistance, getTideCoefficientsDegree, getTideCoefficientsOrder, setCentralBody, setGravitationalParameter, setReferenceDistance, setTideCoefficientsDegree, setTideCoefficientsOrder

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeVaryingSolidTideModel

protected TimeVaryingSolidTideModel()

Initializes a time-varying, solid tide model without any configuration.

TimeVaryingSolidTideModel

protected TimeVaryingSolidTideModel(CentralBody centralBody,
                                    int tideCoefficientsDegree,
                                    int tideCoefficientsOrder,
                                    double gravitationalParameter,
                                    double referenceDistance)

Initializes most of the parameters of a time-varying solid tide model. Tidal third bodies will still need to be added using TimeVaryingSolidTideModel.addThirdBody(java.lang.String, agi.foundation.geometry.Point, double).

Parameters:

centralBody - The primary gravitational body whose gravity field is affected by ThirdBodies (get).

tideCoefficientsDegree - The maximum Degree of the tide coefficients in this model.

tideCoefficientsOrder - The maximum Order of the tide coefficients in this model.

gravitationalParameter - The gravitational parameter of the primary gravitational body.

referenceDistance - The reference distance associated with the solid tide model (which is usually the equatorial radius of the primary gravitational body).

TimeVaryingSolidTideModel

protected TimeVaryingSolidTideModel(@Nonnull
                                    TimeVaryingSolidTideModel existingInstance,
                                    @Nonnull
                                    CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(SolidTideModel other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Specified by:

checkForSameDefinition in class SolidTideModel

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(TimeVaryingSolidTideModel other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the TimeVaryingSolidTideModel.checkForSameDefinition(agi.foundation.celestial.SolidTideModel) method.

Overrides:

computeCurrentDefinitionHashCode in class SolidTideModel

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling 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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class SolidTideModel

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getThirdBodies

@Nonnull
public final ArrayList<ThirdBodyGravity.ThirdBodyInfo> getThirdBodies()

Gets a list of the tidal third bodies that are currently configured to this solid tide model. In most cases, the user should use the TimeVaryingSolidTideModel.addThirdBody(java.lang.String, agi.foundation.geometry.Point, double) method to configure this parameter rather than setting it directly.

addThirdBody

public final void addThirdBody(@Nonnull
                               String name,
                               @Nonnull
                               Point point,
                               double gravitationalParameter)

Adds a Point representing the position of the tide-inducing gravitational body and a double representing its gravitational parameter, in meters cubed per second squared.

Parameters:

name - The name to identify the tide-inducing gravitational body.

point - The position of the tide-inducing gravitational body.

gravitationalParameter - The gravitational parameter of the tide-inducing body, in meters cubed per second squared.

removeThirdBody

public final boolean removeThirdBody(String name)

Removes tidal perturbations due to the body represented by the name.

Parameters:

name - The name of the body to remove.

Returns:

true if the removal was successful; otherwise false.

removeThirdBody

public final boolean removeThirdBody(Point point)

Removes a tidal perturbations due to the body represented by the Point.

Parameters:

point - The point of the body to remove.

Returns:

true if the removal was successful; otherwise false.

removeThirdBody

public final boolean removeThirdBody(double gravitationalParameter)

Removes a tidal perturbations due to the body represented by the gravitational parameter.

Parameters:

gravitationalParameter - The gravitational parameter of the body to remove.

Returns:

true if the removal was successful; otherwise false.