ManeuverOptimalFinite

class ansys.stk.core.stkobjects.astrogator.ManeuverOptimalFinite

Bases: IManeuver, IRuntimeTypeInfoProvider

The Optimal Finite Maneuver.

Overview

Methods

run_seed	Run seed.
export_nodes	Export the current set of collocation nodes to a file.

Properties

pressure_mode	Get or set the pressure mode.
thrust_efficiency	Get or set the fraction of ideal thrust applied. Any number above zero is valid, with typical values around 0.98 to 1.02. Dimensionless.
thrust_efficiency_mode	Thrust - the calculations that are effected by the thrust efficiency value.
number_of_nodes	Number of nodes to discretize collocation problem into.
initial_guess_file_name	File containing ephemeris for nodes that serve as an initial guess.
seed_method	Initial seed method.
node_status_message	A message that indicates what nodes are currently held by the segment.
run_mode	Run mode.
halt_mission_control_sequence_for_nonconvergence	Halt MCS and discard result if optimization is unsuccessful.
discretization_strategy	Discretization Strategy.
working_variables	Working Variables.
scaling_options	Scaling Options.
enable_unit_vector_controls	Enable unit vector for thrust direction.
thrust_axes	Label reflecting coordinate axes for the thrust vector.
snopt_optimizer	SNOPT Optimizer Options.
initial_boundary_conditions	Initial Boundary Conditions.
final_boundary_conditions	Final Boundary Conditions.
path_boundary_conditions	Path Boundary Conditions.
log_file_name	Log file name for optimal finite maneuver.
export_format	Format for exporting collocation control variables.
steering_nodes	Get the list of steering nodes.
initial_guess_interpolation_method	Guess interpolation method.
should_reinitialize_stm_at_start_of_segment_propagation	If this segment is propagating the state transition matrix, reset it to the identity matrix at the start of the segment.

Import detail

from ansys.stk.core.stkobjects.astrogator import ManeuverOptimalFinite

Property detail

property ManeuverOptimalFinite.pressure_mode: PressureMode

Get or set the pressure mode.

property ManeuverOptimalFinite.thrust_efficiency: float

Get or set the fraction of ideal thrust applied. Any number above zero is valid, with typical values around 0.98 to 1.02. Dimensionless.

property ManeuverOptimalFinite.thrust_efficiency_mode: ThrustType

Thrust - the calculations that are effected by the thrust efficiency value.

property ManeuverOptimalFinite.number_of_nodes: int

Number of nodes to discretize collocation problem into.

property ManeuverOptimalFinite.initial_guess_file_name: str

File containing ephemeris for nodes that serve as an initial guess.

property ManeuverOptimalFinite.seed_method: OptimalFiniteSeedMethod

Initial seed method.

property ManeuverOptimalFinite.node_status_message: str

A message that indicates what nodes are currently held by the segment.

property ManeuverOptimalFinite.run_mode: OptimalFiniteRunMode

Run mode.

property ManeuverOptimalFinite.halt_mission_control_sequence_for_nonconvergence: bool

Halt MCS and discard result if optimization is unsuccessful.

property ManeuverOptimalFinite.discretization_strategy: OptimalFiniteDiscretizationStrategy

Discretization Strategy.

property ManeuverOptimalFinite.working_variables: OptimalFiniteWorkingVariables

Working Variables.

property ManeuverOptimalFinite.scaling_options: OptimalFiniteScalingOptions

Scaling Options.

property ManeuverOptimalFinite.enable_unit_vector_controls: bool

Enable unit vector for thrust direction.

property ManeuverOptimalFinite.thrust_axes: str

Label reflecting coordinate axes for the thrust vector.

property ManeuverOptimalFinite.snopt_optimizer: ManeuverOptimalFiniteSNOPTOptimizer

SNOPT Optimizer Options.

property ManeuverOptimalFinite.initial_boundary_conditions: ManeuverOptimalFiniteInitialBoundaryConditions

Initial Boundary Conditions.

property ManeuverOptimalFinite.final_boundary_conditions: ManeuverOptimalFiniteFinalBoundaryConditions

Final Boundary Conditions.

property ManeuverOptimalFinite.path_boundary_conditions: ManeuverOptimalFinitePathBoundaryConditions

Path Boundary Conditions.

property ManeuverOptimalFinite.log_file_name: str

Log file name for optimal finite maneuver.

property ManeuverOptimalFinite.export_format: OptimalFiniteExportNodesFormat

Format for exporting collocation control variables.

property ManeuverOptimalFinite.steering_nodes: ManeuverOptimalFiniteSteeringNodeCollection

Get the list of steering nodes.

property ManeuverOptimalFinite.initial_guess_interpolation_method: OptimalFiniteGuessMethod

Guess interpolation method.

property ManeuverOptimalFinite.should_reinitialize_stm_at_start_of_segment_propagation: bool

If this segment is propagating the state transition matrix, reset it to the identity matrix at the start of the segment.

Method detail

ManeuverOptimalFinite.run_seed(self) → None

Run seed.

Returns:

None

ManeuverOptimalFinite.export_nodes(self, file_name: str) → None

Export the current set of collocation nodes to a file.

Parameters:

file_name : str

Returns:

None