ForceEvaluator Class

Base class for evaluators created by a ForceModel to compute the force.

Inheritance Hierarchy

SystemObject
AGI.FoundationEvaluatorCartesian
AGI.Foundation.CelestialForceEvaluator

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

Syntax

C++

Copy

public abstract class ForceEvaluator : Evaluator<Cartesian>

Public MustInherit Class ForceEvaluator
	Inherits Evaluator(Of Cartesian)

public ref class ForceEvaluator abstract : public Evaluator<Cartesian>

[<AbstractClassAttribute>]
type ForceEvaluator =  
    class
        inherit Evaluator<Cartesian>
    end

The ForceEvaluator type exposes the following members.

Constructors

	Name	Description
	ForceEvaluator(ForceEvaluator, CopyContext)	Initializes a new instance as a copy of an existing instance.
	ForceEvaluator(EvaluatorGroup, RoleOfForce, KindOfForce)	Initializes a new instance.

Top

Properties

	Name	Description
	AvailabilityIntervals	Gets a TimeIntervalCollection over which data is available. If the availability interval is infinite, this returns Infinite. (Inherited from EvaluatorT.)
	DefinedIn	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.
	Group	Gets the group that contains this evaluator. (Inherited from EvaluatorT.)
	IsThreadSafe	Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously. (Inherited from EvaluatorT.)
	IsTimeVarying	Gets a value indicating whether or not the value of this evaluator changes with time. If , the evaluator is assumed to return the same value for any input JulianDate. (Inherited from EvaluatorT.)
	Kind	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).
	Role	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

	Name	Description
	Clone	Clones this object using the specified context. (Inherited from EvaluatorT.)
	Dispose	Releases any resources associated with this instance. (Inherited from EvaluatorT.)
	Dispose(Boolean)	Releases any resources associated with this instance. (Inherited from EvaluatorT.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Evaluate(JulianDate)	Evaluates the function. (Inherited from EvaluatorT.)
	Evaluate(TimeInterval, Duration)	Evaluates this evaluator at a specified fixed step over the specified interval. (Inherited from EvaluatorT.)
	Evaluate(JulianDate, JulianDate, Duration)	Evaluates this evaluator at a specified fixed step over the specified interval. (Inherited from EvaluatorT.)
	Evaluate(TimeInterval, Duration, ITrackCalculationProgress)	Evaluates this evaluator at a specified fixed step over the specified interval. (Inherited from EvaluatorT.)
	Evaluate(JulianDate, JulianDate, Duration, ITrackCalculationProgress)	Evaluates this evaluator at a specified fixed step over the specified interval. (Inherited from EvaluatorT.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAvailabilityIntervals	Gets the intervals over which data is available. (Inherited from EvaluatorT.)
	GetCachingWrapper	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 EvaluatorTGetCachingWrapper.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsAvailable	Determines if valid data is available for the given JulianDate. (Inherited from EvaluatorT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateEvaluatorReferences	Updates the evaluator references held by this object using the reference-to-reference mapping in the specified CopyContext. (Inherited from EvaluatorT.)

Top

Reference

AGI.Foundation.Celestial Namespace