ostk.physics.environment.gravitational.Sun

class Sun(*args, **kwargs)

Bases: Model

Sun gravitational model.

The gravitational potential of the Sun for now is kept as a simple spherical model.

Overloaded function.

1. __init__(self: ostk.physics.environment.gravitational.Sun, type: ostk::physics::environment::gravitational::Sun::Type, directory: ostk.core.filesystem.Directory) -> None

   Construct a Sun gravitational model.

   Args:

   type (Sun.Type): Sun model type. directory (Directory): Directory containing the gravity model data files.

2. __init__(self: ostk.physics.environment.gravitational.Sun, type: ostk::physics::environment::gravitational::Sun::Type) -> None

   Construct a Sun gravitational model.

   Args:

   type (Sun.Type): Sun model type.

Methods

get_field_value_at	Get the gravitational field value at a given position and instant.
get_parameters
get_type	Get the Sun model type.
is_defined	Check if the Sun model is defined.

Attributes

spherical

class Type(self: ostk.physics.environment.gravitational.Sun.Type, value: int)

Bases: pybind11_object

Members:

Undefined :

Undefined.

Spherical :

The spherical gravity originating from a point source at the center of the Sun.

property name

get_field_value_at(

self: ostk.physics.environment.gravitational.Sun,

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.

get_parameters(

self: ostk.physics.environment.gravitational.Model,

) → ostk::physics::environment::gravitational::Model::Parameters

get_type(

self: ostk.physics.environment.gravitational.Sun,

) → ostk::physics::environment::gravitational::Sun::Type

Get the Sun model type.

Returns:

Sun model type.

Return type:

Sun.Type

is_defined(self: ostk.physics.environment.gravitational.Sun) → bool

Check if the Sun model is defined.

Returns:

True if defined.

Return type:

bool