Click or drag to resize

IersTechnicalNote36RelativisticCorrectionForce Class

A NewtonianSpecificForce that models the first order correction to the acceleration of a space object about a CentralBody. The mathematical details for this model may be found in chapter 10 of "IERS Conventions (2010)". The model was primarily designed for artificial satellites about Earth, but may be used with any space object and any CentralBody in the solar system. The force always returns the primary contributor to the correction, the Schwarzchild field of the central body. By default, corrections for frame-dragging and precession of the geodesic are also included, but may be turned off if so desired.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class IersTechnicalNote36RelativisticCorrectionForce : ForceModel

The IersTechnicalNote36RelativisticCorrectionForce type exposes the following members.

Constructors
  NameDescription
Public methodIersTechnicalNote36RelativisticCorrectionForce
Initializes a new instance.
Public methodIersTechnicalNote36RelativisticCorrectionForce(Point)
Initializes the correction force with the specified Point. The CentralBody is set to Earth from the CentralBodiesFacet, and the SolarCentralBody is set to the sun from the CentralBodiesFacet. Both additional corrections (de Sitter and Lense-Thirring) will be used.
Protected methodIersTechnicalNote36RelativisticCorrectionForce(IersTechnicalNote36RelativisticCorrectionForce, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodIersTechnicalNote36RelativisticCorrectionForce(CentralBody, Double, Double)
Initializes the correction force with the specified CentralBody, solar gravitational parameter, and central body gravitational parameter. The SolarCentralBody is set to the sun from the CentralBodiesFacet. Both additional corrections (de Sitter and Lense-Thirring) will be used.
Public methodIersTechnicalNote36RelativisticCorrectionForce(Point, CentralBody, CentralBody, Vector, Double, Double, Boolean, Boolean)
Initializes the correction force with the specified parameters.
Top
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the CentralBody about which this correction is applied.
Public propertyCentralBodyAngularMomentumPerUnitMass
Gets or sets a vector that describes the angular momentum per unit mass of the CentralBody. This vector is used for the Lense-Thirring correction, and may be safely ignored if this term is not used. Two easy-to-use static helper methods for this vector exist on this class; RouthsRuleAngularMomentumPerUnitMass(CentralBody) and ScaledAngularVelocityAngularMomentumPerUnitMass(CentralBody, Double).
Public propertyCentralBodyGravitationalParameter
Gets or sets the gravitational parameter for the CentralBody.
Public propertyForceVector
Gets the Vector representation of this force.
(Inherited from ForceModel.)
Public propertyIsFrozen
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.)
Public propertyKind
Gets an enumeration indicating the nature of this force and whether it implicitly includes mass.
(Inherited from ForceModel.)
Public propertyRole
Gets the role that this force plays in a combined resultant force. In particular, it indicates whether this force is dominant and easy to compute or whether it is a small perturbation that is expensive to compute.
(Inherited from ForceModel.)
Public propertySolarCentralBody
Gets or sets the CentralBody that represents the sun of the solar system where this force is used.
Public propertySolarGravitationalParameter
Gets or sets the gravitational parameter for the Sun.
Public propertyTargetPoint
Gets or sets the point at which the IersTechnicalNote36RelativisticCorrectionForce is applied.
Public propertyUseDeSitterCorrection
Gets or sets a bool that indicates if the de Sitter correction is to be used. This defaults to .
Public propertyUseLenseThirringCorrection
Gets or sets a bool that indicates if the Lense-Thirring correction is to be used. This defaults to .
Top
Methods
  NameDescription
Public methodBuildForceEvaluator
Build lists of principal and perturbation forces based on this model in order to create an overall resultant force.
(Overrides ForceModelBuildForceEvaluator(ResultantForceBuilder, EvaluatorGroup).)
Protected methodCheckForSameDefinition(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 ForceModel.)
Protected methodCheckForSameDefinition(ForceModel)
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 ForceModelCheckForSameDefinition(ForceModel).)
Protected methodCheckForSameDefinition(IersTechnicalNote36RelativisticCorrectionForce)
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).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 ForceModelComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
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.
(Overrides ForceModelEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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 ForceModel.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetForceEvaluator
Gets an instance of an evaluator that can compute the force.
(Inherited from ForceModel.)
Public methodGetForceEvaluator(EvaluatorGroup)
Gets an instance of an evaluator that can compute the force.
(Inherited from ForceModel.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberRouthsRuleAngularMomentumPerUnitMass
A static helper method that computes a CentralBodyAngularMomentumPerUnitMass vector for the input centralBody. This method uses Routh's rule for an ellipsoid coupled with the angular velocity vector computed between the fixed and inertial frames defined on the centralBody.
Public methodStatic memberScaledAngularVelocityAngularMomentumPerUnitMass
A static helper method that computes a CentralBodyAngularMomentumPerUnitMass vector for the input centralBody. This method computes the rotational velocity between the central body's fixed and inertial frames. This vector is then normalized and the magnitude is set to the input scale factor. An appropriate scale factor for the Earth, for example, would be 9.8e8 m^2/s as was cited in "IERS Conventions (2010)".
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also