ostk.physics.environment.gravitational.Spherical

class Spherical(
self: ostk.physics.environment.gravitational.Spherical,
gravitational_parameters: ostk.physics.environment.gravitational.GravitationalParameters,
)

Bases: Model

Spherical gravitational model.

Construct a Spherical gravitational model.

Parameters:

gravitational_parameters (GravitationalParameters) -- Gravitational model parameters.

Methods

get_field_value_at

Get the gravitational field value at a given position and instant.

get_parameters

is_defined

Check if the Spherical gravitational model is defined.

get_field_value_at(
self: ostk.physics.environment.gravitational.Spherical,
position: numpy.ndarray[numpy.float64[3, 1]],
instant: ostk.physics.time.Instant,
) numpy.ndarray[numpy.float64[3, 1]]

Get the gravitational field value at a given position and instant.

Parameters:
  • position (numpy.ndarray) -- Position, expressed in the gravitational object frame [m].

  • instant (Instant) -- Instant.

Returns:

Gravitational field value, expressed in the gravitational object frame [m.s-2].

Return type:

numpy.ndarray

get_parameters(
self: ostk.physics.environment.gravitational.Model,
) ostk::physics::environment::gravitational::Model::Parameters
is_defined(self: ostk.physics.environment.gravitational.Spherical) bool

Check if the Spherical gravitational model is defined.

Returns:

True if the Spherical gravitational model is defined.

Return type:

bool