Click or drag to resize

MatrixStateElementConverter Class

Converts output associated with a PropagationStateElement corresponding to a set of Matrix values back and forth between its raw indexed state, and a Motion<Matrix>.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Propagators.Advanced
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public class MatrixStateElementConverter : PropagationStateElementConverter

The MatrixStateElementConverter type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAdaptiveWeights
Gets or sets the weights to be applied to the state elements when computing the error which determines how to adapt the step size during integration. This is in addition to any weights used in the integration algorithm itself. The weights are initialized to default values of one based on the Order and Dimension of the state element. The order of the motion is one less than the Order and each array is of length Dimension.
(Inherited from PropagationStateElementConverter.)
Public propertyDimension
Gets the number of parameters (per Order) within this element.
(Overrides PropagationStateElementConverterDimension.)
Public propertyIdentification
Gets the string identifying this instance in the overall output.
(Inherited from PropagationStateElementConverter.)
Public propertyInitialState
Gets the initial values of this element of the state and their derivatives. The size of the initial state is its Dimension and the order of the motion is one less than the Order of the differential equation defining the derivative of this element.
(Inherited from PropagationStateElementConverter.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Inherited from PropagationStateElementConverter.)
Public propertyOrder
Gets the order of the differential equation corresponding to this element. This corresponds to one greater than the Order of the InitialState.
(Inherited from PropagationStateElementConverter.)
Public propertyStateIndices
Gets the indices locating each variable of this element within the overall state. The motion represents the value of this state element and its derivatives up to but not including the Order of the differential equation defining the state's derivative. The indices will be set by the NumericalPropagatorDefinition when this element is added.
(Inherited from PropagationStateElementConverter.)
Public propertyTypeOfOutput
Gets the type associated with the output of this instance.
(Overrides PropagationStateElementConverterTypeOfOutput.)
Top
Methods
  NameDescription
Public methodAdjustStateFromElement
Adjust the subset of the overall raw state corresponding to this element to new values.
(Overrides PropagationStateElementConverterAdjustStateFromElement(Double, MotionDouble).)
Public methodAdjustStateWithTypeT(Double, MotionT)
Adjust the subset of the raw state corresponding to this element to new values.
(Overrides PropagationStateElementConverterAdjustStateWithTypeT(Double, MotionT).)
Public methodAdjustStateWithTypeT(Double, MotionT)
Adjust the subset of the raw state corresponding to this element to new values.
(Inherited from PropagationStateElementConverter.)
Public methodClone
Clones this object using the specified context.
(Overrides PropagationStateElementConverterClone(CopyContext).)
Public methodConvertState(Double)
Convert the raw state into a Matrix and its derivatives.
Public methodConvertStateT(Double)
Convert the raw state into this instance's Type and its derivatives.
(Overrides PropagationStateElementConverterConvertStateT(Double).)
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 methodGetElementFromState
Produces this state element's values and their derivatives from the overall raw state.
(Overrides PropagationStateElementConverterGetElementFromState(Double).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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.)
Top
See Also