ostk.astrodynamics.GuidanceLaw

class GuidanceLaw(self: ostk.astrodynamics.GuidanceLaw, name: ostk.core.type.String)

Bases: pybind11_object

Guidance law base class.

A guidance law is a mathematical model that computes the acceleration based on specific guidance law logic.

Constructor.

Parameters:

name (str) -- The name of the guidance law.

Methods

calculate_thrust_acceleration_at

Compute the acceleration.

get_name

Get the name of the guidance law.

calculate_thrust_acceleration_at(
self: ostk.astrodynamics.GuidanceLaw,
instant: ostk.physics.time.Instant,
position_coordinates: numpy.ndarray[numpy.float64[3, 1]],
velocity_coordinates: numpy.ndarray[numpy.float64[3, 1]],
thrust_acceleration: ostk.core.type.Real,
output_frame: ostk.physics.coordinate.Frame,
) → numpy.ndarray[numpy.float64[3, 1]]

Compute the acceleration.

Parameters:

  • instant (Instant) -- Instant of computation.

  • position_coordinates (np.array) -- Position coordinates.

  • velocity_coordinates (np.array) -- Velocity coordinates.

  • thrust_acceleration (float) -- Thrust acceleration magnitude.

  • output_frame (Frame) -- The frame the acceleration is expressed in.

Returns:

The acceleration.

Return type:

np.array

get_name(self: ostk.astrodynamics.GuidanceLaw) → ostk.core.type.String

Get the name of the guidance law.

Returns:

The name of the guidance law.

Return type:

str