VectorPropagationParameter Class |
Namespace: AGI.Foundation.Geometry
The VectorPropagationParameter type exposes the following members.
Name | Description | |
---|---|---|
VectorPropagationParameter | Initializes a new instance. | |
VectorPropagationParameter(Axes) |
Initializes a new instance with the given axes of integration.
|
Name | Description | |
---|---|---|
Dimension |
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.
| |
IntegrationAxes |
Gets or sets the Axes used to define the state during integration.
| |
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.) | |
StateParameter |
Gets or sets a parameter which represents the state during propagation. In general,
users should never need to explicitly set this property. It should only be set
in cases where elements of a state require additional instances of a NumericalPropagator
inside their implementation in order to produce their values. In such cases, it may
be necessary to distinguish between the state of the exterior propagator and the
state of the interior propagator. In these cases, it is up to the user to ensure
that both the state and all of its elements are configured with the same parameter.
Otherwise, the state will throw an exception when creating its propagator.
|
Name | Description | |
---|---|---|
Add |
Add a vector to this one.
(Inherited from Vector.) | |
Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) | |
ConfigureIndicesOnEvaluator | This is called by PropagationStateElement instances using VectorPropagationParameter so that the element can update the indices used to identify the individual values corresponding to this vector in the state during evaluation. In general, this should only be called from within the GetConverter(EvaluatorGroup, MotionInt32) method when configuring the indices provided by the NumericalPropagatorDefinition. The EvaluatorGroup will create an evaluator based on the StateParameter and the IntegrationAxes and cache it for future calls. This method updates the instance variables for the indices so that it will reflect the vector's elements within the state during evaluation. In general, this breaks the "Evaluator Pattern" by altering data on an evaluator after construction. However, so long as it is done once and only once prior to any evaluation this is deemed as following the "Evaluator Pattern" which stipulates that an evaluator should always return the same value for a given time. | |
CreateVectorDerivative |
Constructs a vector which represents a derivative of this vector.
(Inherited from Vector.) | |
Cross |
Produce the vector cross product between this vector and another one.
(Inherited from Vector.) | |
Divide(Double) |
Divide this vector by a scale factor.
(Inherited from Vector.) | |
Divide(Scalar) |
Divide this vector by a scale factor.
(Inherited from Vector.) | |
Dot |
Produce the vector dot product between this vector and another one.
(Inherited from Vector.) | |
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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetEvaluator |
Gets an evaluator that can be used to find the Motion<Cartesian>
of this vector at a given date with respect to the axes in which it is defined.
See GetEvaluator(EvaluatorGroup) for details.
(Inherited from Vector.) | |
GetEvaluator(EvaluatorGroup) | Gets an evaluator that can be used to find the Motion<Cartesian> of this vector at a given date with respect to the axes in which it is defined. See GetEvaluator(EvaluatorGroup) for details. This type will usually not be used directly, it is instead used by PropagationVector behind the scenes. If this type is used, such as during the implementation of a type similar to or deriving from PropagationVector, always call ConfigureIndicesOnEvaluator(EvaluatorGroup, VectorPropagationParameter, MotionInt32) prior to this method. | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetPartialDerivativesEvaluator |
This type does not have derivatives or partial derivatives with respect to any object with the exception of itself.
Because of that the created PartialDerivativesEvaluator has a
ColumnDimension of zero if this PointPropagationParameter
is not in the generalized state, and if it is in the generalized state it returns a 3x3 identity matrix.
| |
GetScalarElement(CartesianElement, Axes) |
Gets a Scalar representing the X, Y, Z, or Magnitude of this vector.
(Inherited from Vector.) | |
GetScalarElement(CartesianElement, Axes, Int32) |
Gets a Scalar representing the X, Y, Z, or Magnitude of this vector,
or any derivative of those elements.
(Inherited from Vector.) | |
GetService |
Gets the service object of the specified type.
(Inherited from Vector.) | |
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.) | |
Multiply(Double) |
Multiply this vector by a scale factor.
(Inherited from Vector.) | |
Multiply(Scalar) |
Multiply this vector by a scale factor.
(Inherited from Vector.) | |
Subtract |
Subtract a vector from this one.
(Inherited from Vector.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |