SimpleSolidTideModel Class |
Namespace: AGI.Foundation.Celestial
The SimpleSolidTideModel type exposes the following members.
Name | Description | |
---|---|---|
SimpleSolidTideModel |
Initializes a simplified, time-varying solid tide model without any configuration.
| |
SimpleSolidTideModel(SimpleSolidTideModel, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
SimpleSolidTideModel(CentralBody, Double, Double, Double, Double) |
Initializes most of the parameters of a simplified, time-varying solid tide model. Tidal third bodies will still need to be added using AddThirdBody(String, Point, Double).
|
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.) | |
K2LoveNumber |
Gets or sets the normalized k20 tidal Love number that is used to correct the C20, C21, C22, S21, and S22 spherical harmonic coefficients.
| |
K3LoveNumber |
Gets or sets the normalized k30 tidal Love number that is used to correct the C30, C31, C32, C33, S31, S32, and S33 spherical harmonic 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.) | |
ThirdBodies |
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 AddThirdBody(String, Point, Double) method to configure this parameter rather than setting it directly.
(Inherited from TimeVaryingSolidTideModel.) | |
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.) |
Name | Description | |
---|---|---|
AddThirdBody |
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.
(Inherited from TimeVaryingSolidTideModel.) | |
CheckForSameDefinition(DefinitionalObject) |
Checks to determine if another instance has the same definition as this instance and
returns 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 for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from SolidTideModel.) | |
CheckForSameDefinition(SimpleSolidTideModel) |
Checks to determine if another instance has the same definition as this instance and
returns 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 for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
| |
CheckForSameDefinition(SolidTideModel) |
Checks to determine if another instance has the same definition as this instance and
returns 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 for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from TimeVaryingSolidTideModel.) | |
CheckForSameDefinition(TimeVaryingSolidTideModel) |
Checks to determine if another instance has the same definition as this instance and
returns 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 for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides TimeVaryingSolidTideModelCheckForSameDefinition(TimeVaryingSolidTideModel).) | |
Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) | |
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
CheckForSameDefinition(DefinitionalObject) method.
(Overrides TimeVaryingSolidTideModelComputeCurrentDefinitionHashCode.) | |
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 TimeVaryingSolidTideModel.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) | |
FreezeAggregatedObjects |
Called by Freeze to also freeze any objects that are considered to be a part of this object.
Derived classes which contain additional aggregated objects MUST override this method, call the base
implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be
frozen in this method are frequently created in this object's constructor and are not settable via
properties.
(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 simple solid tide model at a given time.
(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.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
RemoveThirdBody(Double) |
Removes a tidal perturbations due to the body represented by the gravitational parameter.
(Inherited from TimeVaryingSolidTideModel.) | |
RemoveThirdBody(Point) |
Removes a tidal perturbations due to the body represented by the Point.
(Inherited from TimeVaryingSolidTideModel.) | |
RemoveThirdBody(String) |
Removes tidal perturbations due to the body represented by the name.
(Inherited from TimeVaryingSolidTideModel.) | |
ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |