Description
The PhaseCollocationOptions object allows users to tune the collocation dynamical solver used with the TrajectoryPhase object.
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.
Inheritance Hierarchy: Object->PhaseCollocationOptions
Parent Object: TrajectoryPhase
Available In Editions:
Mission
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.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
ForceModel
|
The ForceModel used by the collocation transcription to evaluate state derivatives. Modifying this property will also modify TrajectoryPhase.IntegrationOptions.Integrator.ForceModel property.
|
Type: ForceModel
Access: Read-Only
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
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
|
RelativeErrorTolerance
|
The relative error tolerance to use during mesh refinement when calling the CollocationOptions.RefineNodes method. This value is also used to determine error violation when a TrajectoryPhase element uses the 'Dynamical Error' coloring mode.
|
Type: Variable
Access: Read/Write
|
|
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.
|
RefineMesh
|
Inserts TrajectoryNodes in areas of the TrajectoryPhase where dynamical error is detected. TrajectoryNodes will also be removed in areas where dynamical accuracy is excessive. If no dynamical error is detected that violates the 'CollocationOptions.RelativeErrorTolerance' property, then no nodes will be added. Dynamical error is computed by comparing the TrajectoryPhase path to the results of explicit integration using the RK89 propagator.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
|
Name
|
Description
|
Attributes
|
Cd
|
The Coefficient of Drag is a property that is a function of the properties and shape of the spacecraft's area incident to the velocity direction. It is used in the calculation of the force on the spacecraft due to atmospheric Drag.
This property has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.Cd instead.
|
Type: Variable
Access: Read/Write
|
Cl
|
The Coefficient of Lift is a property that is a function of the properties and shape of the spacecraft's area incident to the velocity direction. It is used in the calculation of the force on the spacecraft due to aerodynamic Lift.
This property has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.Cl instead.
|
Type: Variable
Access: Read/Write
|
Cr
|
The Coefficient of Reflectivity is a property that is a function of the properties of the spacecraft's area incident to the Sun-Earth line. It is used in the calculation of the force on the spacecraft due to solar radiation pressure.
Note that this value is only used when ForceModel.SRPForceGeometry is set to spherical. If using a plate model, the coefficients of reflectivity should be set for each individual plate.
This property has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.Cr instead.
|
Type: Variable
Access: Read/Write
|
DragArea
|
The Drag Area is the incident cross sectional area to the velocity direction. It is used in the calculation of the force on the spacecraft due to atmospheric Drag.
This property has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.DragArea instead.
|
Type: Variable
Access: Read/Write
Units: m^2
|
LiftArea
|
The Lift Area is the incident cross sectional area to the velocity direction. It is used in the calculation of the force on the spacecraft due to atmospheric Lift.
This property has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.LiftArea instead.
|
Type: Variable
Access: Read/Write
Units: m^2
|
SRPArea
|
The SRP Area is the incident cross sectional area to the Sun-Earth line. It is used in the calculation of the force on the spacecraft due to solar radiation pressure.
If the Spacecraft's ForceModel.SRPForceGeometry is set to use a PlateModel, then this property will reflect the incident SRP area of the PlateModel, and an error will be reported if you try to assign a value to this property.
This property has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.SRPArea instead.
|
Type: Variable
Access: Read/Write
Units: m^2
|
|
Name
|
Description
|
GetAverageAccelerationDefect
|
Returns the average of the current acceleration defects across all collocation points.
Note: Dynamical error can still exist in the trajectory path after the collocation defects have been driven to zero. See the 'CollocationOptions.RefineNodes' method for more information.
This method has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.GetAverageVelocityDefect instead.
|
GetAverageMassFlowRateDefect
|
Returns the average of the current mass flow rate defects across all collocation points.
Note: Dynamical error can still exist in the trajectory path after the collocation defects have been driven to zero. See the 'CollocationOptions.RefineNodes' method for more information.
This method has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.GetAverageMassDefect instead.
|
GetAverageVelocityDefect
|
Returns the average of the current velocity defects across all collocation points.
Note: Dynamical error can still exist in the trajectory path after the collocation defects have been driven to zero. See the 'CollocationOptions.RefineNodes' method for more information.
This method has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.GetAveragePositionDefect instead.
|
GetDefectValues
|
Returns a Matrix of the current values of the collocation defects. Each row corresponds to a collocation point of the phase and each columns correspond to a state element of the phase (position, velocity, mass).
Note: Dynamical error can still exist in the trajectory path after the collocation defects have been driven to zero. See the 'CollocationOptions.RefineNodes' method for more information.
This method has been deprecated as of FreeFlyer version 7.10. Please use TrajectoryPhase.GetDefectValues instead.
|
|
|
