Click or drag to resize

ForceEvaluator Class

Base class for evaluators created by a ForceModel to compute the force.
Inheritance Hierarchy
System.Object
  AGI.Foundation.Evaluator<Cartesian>
    AGI.Foundation.Celestial.ForceEvaluator

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 25.1.421.0 (25.1.421.0)
Syntax
public abstract class ForceEvaluator : Evaluator<Cartesian>

The ForceEvaluator type exposes the following members.

Constructors
  NameDescription
Protected methodForceEvaluator(ForceEvaluator, CopyContext)
Initializes a new instance as a copy of an existing instance.
Protected methodForceEvaluator(EvaluatorGroup, RoleOfForce, KindOfForce)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyAvailabilityIntervals
Gets a TimeIntervalCollection over which data is available. If the availability interval is infinite, this returns Infinite.
(Inherited from Evaluator<T>.)
Public propertyDefinedIn
Gets the Axes in which this force is defined. While a Newtonian force is only valid in an inertial frame, the coordinates in which this force is defined may be a fixed frame. If so, the torque should be rotated to transform the torque into a common Axes considered to be 'inertial' before applying them in equations of motion.
Public propertyGroup
Gets the group that contains this evaluator.
(Inherited from Evaluator<T>.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Inherited from Evaluator<T>.)
Public propertyIsTimeVarying
Gets a value indicating whether or not the value of this evaluator changes with time. If false, the evaluator is assumed to return the same value for any input JulianDate.
(Inherited from Evaluator<T>.)
Public propertyKind
Gets the kind of force this evaluator represents. In particular, it indicates whether the mass of the object on which the force will be applied is already included in the result ("specific" force).
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.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
(Inherited from Evaluator<T>.)
Public methodDispose()
Releases any resources associated with this instance.
(Inherited from Evaluator<T>.)
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
(Inherited from Evaluator<T>.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate(JulianDate)
Evaluates the function.
(Inherited from Evaluator<T>.)
Public methodEvaluate(TimeInterval, Duration)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from Evaluator<T>.)
Public methodEvaluate(JulianDate, JulianDate, Duration)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from Evaluator<T>.)
Public methodEvaluate(TimeInterval, Duration, ITrackCalculationProgress)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from Evaluator<T>.)
Public methodEvaluate(JulianDate, JulianDate, Duration, ITrackCalculationProgress)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from Evaluator<T>.)
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 methodGetAvailabilityIntervals
Gets the intervals over which data is available.
(Inherited from Evaluator<T>.)
Public methodGetCachingWrapper
Gets a version of this evaluator that caches the previously computed value so that if it is evaluated twice at the same date the computation is done only once.
(Overrides Evaluator<T>.GetCachingWrapper().)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsAvailable
Determines if valid data is available for the given JulianDate.
(Inherited from Evaluator<T>.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodCode exampleUpdateEvaluatorReferences
Updates the evaluator references held by this object using the reference-to-reference mapping in the specified CopyContext.
(Inherited from Evaluator<T>.)
Top
See Also