Click or drag to resize

PropagationStateElementConverter Class

Base class for output associated with a PropagationStateElement. This represents the indexed state, and a means of converting the raw output information back into useful information specific to this element.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Propagators.Advanced
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public abstract class PropagationStateElementConverter : IThreadAware, 
	ICloneWithContext

The PropagationStateElementConverter type exposes the following members.

Constructors
  NameDescription
Protected methodPropagationStateElementConverter(PropagationStateElementConverter, CopyContext)
Initializes a new instance as a copy of an existing instance.
Protected methodPropagationStateElementConverter(String, MotionInt32, MotionDouble)
Initializes a new instance.
Protected methodPropagationStateElementConverter(String, MotionInt32, MotionDouble, MotionDouble)
Initializes a new instance.
Top
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.
Public propertyDimension
Gets the number of parameters (per Order) within this element.
Public propertyIdentification
Gets the string identifying this instance in the overall output.
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.
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Public propertyOrder
Gets the order of the differential equation corresponding to this element. This corresponds to one greater than the Order of the InitialState.
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.
Public propertyTypeOfOutput
Gets the type associated with the output of this instance.
Top
Methods
  NameDescription
Public methodAdjustStateFromElement
Adjust the subset of the overall raw state corresponding to this element to new values.
Public methodAdjustStateWithTypeT
Adjust the subset of the raw state corresponding to this element to new values.
Public methodClone
Clones this object using the specified context.
Public methodConvertStateT
Convert the raw state into this instance's Type and its derivatives.
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.
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