PermanentSolidTideModel Class

A constant solid tide model that can add permanent tides to a tide-free model to form a zero-tide model.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CelestialSolidTideModel
      AGI.Foundation.CelestialPermanentSolidTideModel

Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

C++

Copy

public sealed class PermanentSolidTideModel : SolidTideModel

Public NotInheritable Class PermanentSolidTideModel
	Inherits SolidTideModel

public ref class PermanentSolidTideModel sealed : public SolidTideModel

[<SealedAttribute>]
type PermanentSolidTideModel =  
    class
        inherit SolidTideModel
    end

The PermanentSolidTideModel type exposes the following members.

Constructors

	Name	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. 32.
	PermanentSolidTideModel(CentralBody, Double, Double, Double, Double, Double, Double, Double)	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.

Top

Properties

	Name	Description
	CentralBody	Gets or sets the primary gravitational body. (Inherited from SolidTideModel.)
	GravitationalParameter	Gets or sets the gravitational parameter of the primary gravitational body. (Inherited from SolidTideModel.)
	IsFrozen	Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so. (Inherited from DefinitionalObject.)
	PermanentCosineTideCoefficients	Gets the two-dimensional array of the permanent cosine tide coefficients.
	PermanentSineTideCoefficients	Gets the two-dimensional array of the permanent sine tide coefficients.
	PermanentZonalTideCoefficients	Gets the one-dimensional array of the permanent zonal tide coefficients.
	ReferenceDistance	Gets or sets the reference distance associated with the solid tide model (which is usually the equatorial radius of the primary gravitational body). (Inherited from SolidTideModel.)
	TideCoefficientsDegree	Gets or sets the degree of the tidal spherical harmonic gravity field. (Inherited from SolidTideModel.)
	TideCoefficientsOrder	Gets or sets the order of the tidal spherical harmonic gravity field. (Inherited from SolidTideModel.)

Top

Methods

	Name	Description
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	EnumerateDependencies	Enumerates the dependencies of this object by calling EnumerateT(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. (Inherited from SolidTideModel.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	GetCoefficientsEvaluator	Gets an instance of an evaluator that returns the normalized tide coefficients of the solid tide model at a given time. (Inherited from SolidTideModel.)
	GetCoefficientsEvaluator(EvaluatorGroup)	Gets an instance of an evaluator that returns the normalized tide coefficients of the solid tide model. For permanent tides, the tide coefficients are time-invariant. (Overrides SolidTideModelGetCoefficientsEvaluator(EvaluatorGroup).)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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

Reference

AGI.Foundation.Celestial Namespace