Click or drag to resize

TwoBodyGravity Class

Represents the acceleration from a simple two body gravity model.
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 TwoBodyGravity : ForceModel, 
	IPartialDifferentiable, IEquatableDefinition

The TwoBodyGravity type exposes the following members.

Constructors
  NameDescription
Public methodTwoBodyGravity
Initializes a new instance. By default the CentralBody is set to Earth from the CentralBodiesFacet and the GravitationalParameter is set to GravitationalParameter.
Public methodTwoBodyGravity(Point)
Initializes a new instance based on the given target point. By default the CentralBody is set to Earth from the CentralBodiesFacet and the GravitationalParameter is set to GravitationalParameter.
Protected methodTwoBodyGravity(TwoBodyGravity, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodTwoBodyGravity(Point, CentralBody, Double)
Initializes a new instance based on the given target point and central body.
Top
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the body which creates the gravity and defines the inertial frame of propagation.
Public propertyDimension
Gets the dimension of the values produced by the object. For example, Vectors would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator created by this type will have a "RowDimension" equal to this property, and a "ColumnDimension equal to the summation of the dimensions of the independent variables that this object is dependent on.
Public propertyForceVector
Gets the Vector representation of this force.
(Inherited from ForceModel.)
Public propertyGravitationalParameter
Gets or sets the gravitational parameter to use when computing gravity, in meters cubed per second squared.
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 propertyTargetPoint
Gets or sets the target point at which to measure the gravitational acceleration.
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).)
Public methodStatic memberCalculateAcceleration
Calculates the acceleration at a position caused by two-body gravity. This low-level call is provided for convenience in simple use cases, in general you should produce a ForceEvaluator from this class that will model gravitational acceleration on an object over time.
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(TwoBodyGravity)
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.
(Overrides ForceModelGetForceEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPartialDerivativesEvaluator
Gets an evaluator that calculates the partial derivatives of the two body gravity acceleration with respect to any of the independentVariables parameters that apply.
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.)
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