Click or drag to resize

PropagationScalar Properties

The PropagationScalar type exposes the following members.

Properties
  NameDescription
Public propertyAdaptiveWeights
Gets or sets the weights to be applied to the scalar values 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. If not set, the weights are initialized to 1.0 as a default value.
Public propertyDimension
Gets the number of parameters (per Order) within this element.
(Overrides PropagationStateElementDimension.)
Public propertyIdentification
Gets or sets the string identifying this instance in the overall output.
(Inherited from PropagationStateElement.)
Public propertyIncludeHighestDerivativeInOutput
Gets or sets a value indicating whether to include the derivative computed at each step with the output. If this is true, the output converted from the raw state will contain the derivative associated with the Order of the differential equation.
(Inherited from PropagationStateElement.)
Public propertyInitialState
Gets or sets the initial value and its derivatives up to the order of the ScalarDerivative.
Public propertyIntegrationValue
Gets a Scalar object that is parameterized on this scalar value during integration. This scalar is only valid while the NumericalPropagator is running. For more general use, a ScalarInterpolator should be created from the NumericalPropagationStateHistory produced by the propagator.
Public propertyIsFrozen
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.)
Public propertyOrder
Gets the order of the differential equation corresponding to this element.
(Overrides PropagationStateElementOrder.)
Public propertyScalarDerivative
Gets or sets the derivative of the highest Order which specifies the motion of this scalar parameter over time. The order that this scalar represents will be determined by the number of values entered for the InitialState.
Public propertyStateParameter
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 when multiple NumericalPropagator objects are running in the same EvaluatorGroup, such as when 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.
(Overrides PropagationStateElementStateParameter.)
Top
See Also