agi.foundation.celestial

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

Class SimpleSolidTideModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.SolidTideModel

agi.foundation.celestial.TimeVaryingSolidTideModel

agi.foundation.celestial.SimpleSolidTideModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class SimpleSolidTideModel
extends TimeVaryingSolidTideModel

A simplified, time-varying solid tide model.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	checkForSameDefinition(SimpleSolidTideModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(TimeVaryingSolidTideModel 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.
Evaluator<SphericalHarmonicCoefficients>	getCoefficientsEvaluator(EvaluatorGroup group) Gets an instance of an evaluator that returns the normalized tide coefficients of the simple solid tide model at a given time.
double	getK2LoveNumber() Gets the normalized k20 tidal Love number that is used to correct the C20, C21, C22, S21, and S22 spherical harmonic coefficients.
double	getK3LoveNumber() Gets the normalized k30 tidal Love number that is used to correct the C30, C31, C32, C33, S31, S32, and S33 spherical harmonic coefficients.
void	setK2LoveNumber(double value) Sets the normalized k20 tidal Love number that is used to correct the C20, C21, C22, S21, and S22 spherical harmonic coefficients.
void	setK3LoveNumber(double value) Sets the normalized k30 tidal Love number that is used to correct the C30, C31, C32, C33, S31, S32, and S33 spherical harmonic coefficients.

Methods inherited from class agi.foundation.celestial.TimeVaryingSolidTideModel

addThirdBody, checkForSameDefinition, enumerateDependencies, getThirdBodies, removeThirdBody, removeThirdBody, removeThirdBody

Methods inherited from class agi.foundation.celestial.SolidTideModel

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

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, 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

SimpleSolidTideModel

public SimpleSolidTideModel()

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

SimpleSolidTideModel

public SimpleSolidTideModel(CentralBody centralBody,
                            double gravitationalParameter,
                            double referenceDistance,
                            double k2LoveNumber,
                            double k3LoveNumber)

Initializes most of the parameters of a simplified, 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).

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

k2LoveNumber - The normalized k20 tidal Love number that is used to correct the C20, C21, C22, S21, and S22 spherical harmonic coefficients.

k3LoveNumber - The normalized k30 tidal Love number that is used to correct the C30, C31, C32, C33, S31, S32, and S33 spherical harmonic coefficients.

SimpleSolidTideModel

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

clone

public Object clone(CopyContext context)

Clones this object using the specified 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:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

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:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement 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;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

public boolean checkForSameDefinition(SimpleSolidTideModel 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.

checkForSameDefinition

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

Specified by:

checkForSameDefinition in class TimeVaryingSolidTideModel

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 SimpleSolidTideModel.checkForSameDefinition(agi.foundation.celestial.SimpleSolidTideModel) method.

Overrides:

computeCurrentDefinitionHashCode in class TimeVaryingSolidTideModel

Returns:

The computed hash code.

getK2LoveNumber

public final double getK2LoveNumber()

Gets the normalized k20 tidal Love number that is used to correct the C20, C21, C22, S21, and S22 spherical harmonic coefficients.

setK2LoveNumber

public final void setK2LoveNumber(double value)

Sets the normalized k20 tidal Love number that is used to correct the C20, C21, C22, S21, and S22 spherical harmonic coefficients.

getK3LoveNumber

public final double getK3LoveNumber()

Gets the normalized k30 tidal Love number that is used to correct the C30, C31, C32, C33, S31, S32, and S33 spherical harmonic coefficients.

setK3LoveNumber

public final void setK3LoveNumber(double value)

Sets the normalized k30 tidal Love number that is used to correct the C30, C31, C32, C33, S31, S32, and S33 spherical harmonic coefficients.

getCoefficientsEvaluator

public Evaluator<SphericalHarmonicCoefficients> getCoefficientsEvaluator(EvaluatorGroup group)

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

Specified by:

getCoefficientsEvaluator in class SolidTideModel

Parameters:

group - The evaluator group in which to create evaluators.

Returns:

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