PhaseSimpleThrusterOptions Object

The PhaseSimpleThrusterOptions object allows users to edit thruster parameters such as DutyCylce, Isp, and Thrust for use with a TrajectoryPhase configured with an 'Simple Thruster' control type.

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
ApplyNormConstraint	Whether to constrain the norm of the cartesian control variable vector to be within or equal to the bounds in 'SimpleThrusterOptions.NormConstraintBounds' property. Warning: Setting this property to false (0) will often result in an ill-conditioned and/or non-physical problem unless the control variables are constrained directly by the user.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DutyCycle	The percentage of on-time of the thruster during a burn. This property scales the mass depletion and the acceleration due to thrust.	Type: Variable Access: Read/Write
Isp	The isp value for the thruster in units of seconds.	Type: Variable Access: Read/Write Units: s
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NormConstraintBounds	The array containing the lower (first element) and upper (second element) bounds to apply to the norm constraint. The norm constraint is only applied if the 'SimpleThrusterOptions.ApplyNormConstraint' property is set to true (1).	Type: Array Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
ShadowConstraintBufferFactor	If a buffer region is desired when turning the thruster off before shadow/turning the thruster on after shadow, assign this property a value larger than 1. Larger values will create a larger buffer region. This value is used to scale the spherical body radius of potential shadowing bodies when computing shadow conditions. For instance, if this property is set to 2, the shadow constraint will see the radius of potiential shadowing bodies as being double their actual size. Note: in order to apply a shadow constraint, add at least one shadowing body via the ControlModel.AddShadowingBody method.	Type: Variable Access: Read/Write
Thrust	The nominal thrust level for the thruster in units of newtons.	Type: Variable Access: Read/Write Units: N

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

PhaseSimpleThrusterOptions Object

Description

Available In Editions:

Timing Precision Mode