DesignCR3BPSetup

class ansys.stk.core.stkobjects.astrogator.DesignCR3BPSetup

Bases: IComponentInfo, ICloneable

CR3BP Setup Tool.

Overview

Methods

create_ideal_secondary_body	Construct the idealized secondary for the three-body system.
reset_ideal_secondary_body	Reset the idealized secondary for the three-body system.
update_ideal_secondary_cb	Update the idealized secondary for the three-body system.
create_rotating_coordinate_system	Create the coordinate system for the RotatingSystemChoice selection.
delete_rotating_coordinate_system	Delete the coordinate system for the RotatingSystemChoice selection.
create_calculation_objects	Create the calculation objects for the selected coordinate system.
delete_calculation_objects	Delete the calculation objects for the selected coordinate system.
create_propagator	Create the propagator for the primary-secondary CR3BP formulation.
delete_propagator	Delete the propagator for the primary-secondary CR3BP formulation.

Properties

central_body_name	Primary central body for the three-body system.
secondary_body_name	Secondary Body.
initial_epoch	Date and time for system construction.
ideal_orbit_radius	Orbital radius of the idealized secondary definition.
ideal_secondary_name	Name to be used for the idealized secondary.
mass_parameter	Get the mass parameter computed from the primary and secondary bodies.
characteristic_distance	Get the characteristic distance computed from the primary and secondary bodies.
characteristic_time	Get the characteristic time computed from the primary and secondary bodies.
characteristic_velocity	Get the characteristic velocity computed from the primary and secondary bodies.
characteristic_acceleration	Get the characteristic acceleration computed from the primary and secondary bodies.
rotating_system_choice	Get the rotating coordinate system and associated calculation objects to interact with.
associated_objects	Get the list of associated objects.
include_stm	Get whether or not the STM propagator function is included on the propagator.

Import detail

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

Property detail

property DesignCR3BPSetup.central_body_name: str

Primary central body for the three-body system.

property DesignCR3BPSetup.secondary_body_name: str

Secondary Body.

property DesignCR3BPSetup.initial_epoch: Any

Date and time for system construction.

property DesignCR3BPSetup.ideal_orbit_radius: IdealOrbitRadius

Orbital radius of the idealized secondary definition.

property DesignCR3BPSetup.ideal_secondary_name: str

Name to be used for the idealized secondary.

property DesignCR3BPSetup.mass_parameter: float

Get the mass parameter computed from the primary and secondary bodies.

property DesignCR3BPSetup.characteristic_distance: float

Get the characteristic distance computed from the primary and secondary bodies.

property DesignCR3BPSetup.characteristic_time: float

Get the characteristic time computed from the primary and secondary bodies.

property DesignCR3BPSetup.characteristic_velocity: float

Get the characteristic velocity computed from the primary and secondary bodies.

property DesignCR3BPSetup.characteristic_acceleration: float

Get the characteristic acceleration computed from the primary and secondary bodies.

property DesignCR3BPSetup.rotating_system_choice: RotatingCoordinateSystem

Get the rotating coordinate system and associated calculation objects to interact with.

property DesignCR3BPSetup.associated_objects: DesignCR3BPObjectCollection

Get the list of associated objects.

property DesignCR3BPSetup.include_stm: bool

Get whether or not the STM propagator function is included on the propagator.

Method detail

DesignCR3BPSetup.create_ideal_secondary_body(self) → None

Construct the idealized secondary for the three-body system.

Returns:

None

DesignCR3BPSetup.reset_ideal_secondary_body(self) → None

Reset the idealized secondary for the three-body system.

Returns:

None

DesignCR3BPSetup.update_ideal_secondary_cb(self) → None

Update the idealized secondary for the three-body system.

Returns:

None

DesignCR3BPSetup.create_rotating_coordinate_system(self) → None

Create the coordinate system for the RotatingSystemChoice selection.

Returns:

None

DesignCR3BPSetup.delete_rotating_coordinate_system(self) → None

Delete the coordinate system for the RotatingSystemChoice selection.

Returns:

None

DesignCR3BPSetup.create_calculation_objects(self) → None

Create the calculation objects for the selected coordinate system.

Returns:

None

DesignCR3BPSetup.delete_calculation_objects(self) → None

Delete the calculation objects for the selected coordinate system.

Returns:

None

DesignCR3BPSetup.create_propagator(self) → None

Create the propagator for the primary-secondary CR3BP formulation.

Returns:

None

DesignCR3BPSetup.delete_propagator(self) → None

Delete the propagator for the primary-secondary CR3BP formulation.

Returns:

None