public final class PermanentSolidTideModel extends SolidTideModel
The term "tide-free model" implies that the spherical harmonic gravity model assumes that tidal forces of third bodies do not affect a central body's gravity field at all. In terms of .grv files, a spherical harmonic gravity model that does not include permanent tides is a "tide-free model".
The term "zero-tide model" implies that the spherical harmonic gravity model averages the effects of the tidal forces of third bodies over time to avoid having to implement time-varying solid tides. In terms of .grv files, a spherical harmonic gravity model that includes permanent tides is a "zero-tide model".
| Constructor and Description |
|---|
PermanentSolidTideModel()
Constructs a default Earth-centered tide model that adds the Earth's permanent tide C20 value that was determined by the
International Earth Rotation and Reference Systems Service (IERS) in their IERS Conventions (2003) Technical Note No.
|
PermanentSolidTideModel(CentralBody centralBody,
double gravitationalParameter,
double referenceDistance,
double permanentTideC20,
double permanentTideC21,
double permanentTideC22,
double permanentTideS21,
double permanentTideS22)
Constructs a generic permanent tide model that is degree and order 2 that can be used for any central body,
but needs to be used for bodies other than Earth.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(SolidTideModel 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 solid tide model.
|
double[][] |
getPermanentCosineTideCoefficients()
Gets the two-dimensional array of the permanent cosine tide coefficients.
|
double[][] |
getPermanentSineTideCoefficients()
Gets the two-dimensional array of the permanent sine tide coefficients.
|
double[] |
getPermanentZonalTideCoefficients()
Gets the one-dimensional array of the permanent zonal tide coefficients.
|
checkForSameDefinition, enumerateDependencies, getCentralBody, getCoefficientsEvaluator, getGravitationalParameter, getReferenceDistance, getTideCoefficientsDegree, getTideCoefficientsOrder, setCentralBody, setGravitationalParameter, setReferenceDistance, setTideCoefficientsDegree, setTideCoefficientsOrderareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic PermanentSolidTideModel()
This is the recommended model for Earth-centered permanent solid tide modeling.
public PermanentSolidTideModel(CentralBody centralBody, double gravitationalParameter, double referenceDistance, double permanentTideC20, double permanentTideC21, double permanentTideC22, double permanentTideS21, double permanentTideS22)
centralBody - The primary gravitational body whose gravitational field is being modified by permanent solid tides.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).permanentTideC20 - The normalized C20 value associated with the addition of permanent tides to the model. This is the negative of J2.permanentTideC21 - The normalized C21 value associated with the addition of permanent tides to the model.permanentTideC22 - The normalized C22 value associated with the addition of permanent tides to the model.permanentTideS21 - The normalized S21 value associated with the addition of permanent tides to the model.permanentTideS22 - The normalized S22 value associated with the addition of permanent tides to the model.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(SolidTideModel 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 SolidTideModelother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
PermanentSolidTideModel.checkForSameDefinition(agi.foundation.celestial.SolidTideModel) method.computeCurrentDefinitionHashCode in class SolidTideModel@Nonnull public final double[] getPermanentZonalTideCoefficients()
@Nonnull public final double[][] getPermanentCosineTideCoefficients()
@Nonnull public final double[][] getPermanentSineTideCoefficients()
public Evaluator<SphericalHarmonicCoefficients> getCoefficientsEvaluator(EvaluatorGroup group)
getCoefficientsEvaluator in class SolidTideModelgroup - The evaluator group in which to create evaluators.