agi.foundation.celestial

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

Class SolidTideModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.SolidTideModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

PermanentSolidTideModel, TimeVaryingSolidTideModel

public abstract class SolidTideModel
extends DefinitionalObject

A solid tide model that could be permanent or time-varying.

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	SolidTideModel() Initializes a solid tide model without any configuration.
protected	SolidTideModel(CentralBody centralBody, int tideCoefficientsDegree, int tideCoefficientsOrder, double gravitationalParameter, double referenceDistance) Initializes most of the parameters of a generic solid tide model.
protected	SolidTideModel(SolidTideModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(SolidTideModel 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.
CentralBody	getCentralBody() Gets the primary gravitational body.
Evaluator<SphericalHarmonicCoefficients>	getCoefficientsEvaluator() Gets an instance of an evaluator that returns the normalized tide coefficients of the solid tide model at a given time.
abstract Evaluator<SphericalHarmonicCoefficients>	getCoefficientsEvaluator(EvaluatorGroup group) Gets an instance of an evaluator that returns the normalized tide coefficients of the solid tide model at a given time.
double	getGravitationalParameter() Gets the gravitational parameter of the primary gravitational body.
double	getReferenceDistance() Gets the reference distance associated with the solid tide model (which is usually the equatorial radius of the primary gravitational body).
int	getTideCoefficientsDegree() Gets the degree of the tidal spherical harmonic gravity field.
int	getTideCoefficientsOrder() Gets the order of the tidal spherical harmonic gravity field.
void	setCentralBody(CentralBody value) Sets the primary gravitational body.
void	setGravitationalParameter(double value) Sets the gravitational parameter of the primary gravitational body.
void	setReferenceDistance(double value) Sets the reference distance associated with the solid tide model (which is usually the equatorial radius of the primary gravitational body).
protected void	setTideCoefficientsDegree(int value) Sets the degree of the tidal spherical harmonic gravity field.
protected void	setTideCoefficientsOrder(int value) Sets the order of the tidal spherical harmonic gravity field.

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

SolidTideModel

protected SolidTideModel()

Initializes a solid tide model without any configuration.

SolidTideModel

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

Initializes most of the parameters of a generic solid tide model.

Parameters:

centralBody - The primary gravitational body.

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).

SolidTideModel

protected SolidTideModel(@Nonnull
                         SolidTideModel 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(DefinitionalObject 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 DefinitionalObject

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(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).

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 SolidTideModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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 DefinitionalObject

Parameters:

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

getTideCoefficientsDegree

public final int getTideCoefficientsDegree()

Gets the degree of the tidal spherical harmonic gravity field.

setTideCoefficientsDegree

protected final void setTideCoefficientsDegree(int value)

Sets the degree of the tidal spherical harmonic gravity field.

getTideCoefficientsOrder

public final int getTideCoefficientsOrder()

Gets the order of the tidal spherical harmonic gravity field.

setTideCoefficientsOrder

protected final void setTideCoefficientsOrder(int value)

Sets the order of the tidal spherical harmonic gravity field.

getCentralBody

public final CentralBody getCentralBody()

Gets the primary gravitational body.

setCentralBody

public final void setCentralBody(CentralBody value)

Sets the primary gravitational body.

getGravitationalParameter

public final double getGravitationalParameter()

Gets the gravitational parameter of the primary gravitational body.

setGravitationalParameter

public final void setGravitationalParameter(double value)

Sets the gravitational parameter of the primary gravitational body.

getReferenceDistance

public final double getReferenceDistance()

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

setReferenceDistance

public final void setReferenceDistance(double value)

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

getCoefficientsEvaluator

@Nonnull
public final Evaluator<SphericalHarmonicCoefficients> getCoefficientsEvaluator()

Gets an instance of an evaluator that returns the normalized tide coefficients of the solid tide model at a given time.

Returns:

The evaluator that computes the normalized tide coefficients of the solid tide model at a given time.

getCoefficientsEvaluator

@Nonnull
public abstract Evaluator<SphericalHarmonicCoefficients> getCoefficientsEvaluator(@Nonnull
                                                                                            EvaluatorGroup group)

Gets an instance of an evaluator that returns the normalized tide coefficients of the solid tide model at a given time.

Parameters:

group - The evaluator group in which to create evaluators.

Returns:

The evaluator that computes the normalized tide coefficients of the solid tide model at a given time.