ostk.physics.environment.gravitational.Earth

class Earth(*args, **kwargs)

Bases: Model

Earth gravitational model.

The gravitational potential is expanded as sum of spherical harmonics.

Reference:

https://en.wikipedia.org/wiki/Spherical_harmonics

Reference:

https://geographiclib.sourceforge.io/html/gravity.html

Overloaded function.

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

    Construct an Earth gravitational model.

    Args:

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

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

    Construct an Earth gravitational model.

    Args:

    type (Earth.Type): Earth model type.

  3. __init__(self: ostk.physics.environment.gravitational.Earth, type: ostk::physics::environment::gravitational::Earth::Type, directory: ostk.core.filesystem.Directory, gravitational_model_degree: ostk.core.type.Integer, gravitational_model_order: ostk.core.type.Integer) -> None

    Construct an Earth gravitational model.

    Args:

    type (Earth.Type): Earth model type. directory (Directory): Directory containing the gravity model data files. gravitational_model_degree (int): Degree of the gravitational model. gravitational_model_order (int): Order of the gravitational model.

  4. __init__(self: ostk.physics.environment.gravitational.Earth, type: ostk::physics::environment::gravitational::Earth::Type, gravitational_model_degree: ostk.core.type.Integer, gravitational_model_order: ostk.core.type.Integer) -> None

    Construct an Earth gravitational model.

    Args:

    type (Earth.Type): Earth model type. gravitational_model_degree (int): Degree of the gravitational model. gravitational_model_order (int): Order of the gravitational model.

Methods

get_degree

Get the Earth model degree.

get_field_value_at

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

get_order

Get the Earth model order.

get_parameters

get_type

Get the Earth model type.

is_defined

Check if the Earth model is defined.

Attributes

EGM2008

EGM84

EGM96

WGS84

WGS84_EGM96

gravity_constant

spherical

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

Bases: pybind11_object

Members:

Undefined :

Undefined.

Spherical :

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

WGS84 :

The normal gravitational field for the reference ellipsoid. This includes the zonal coefficients up to order 20.

EGM84 :

The Earth Gravity Model 1984, which includes terms up to degree 180.

WGS84_EGM96 :

The normal gravitational field for the reference ellipsoid plus the Earth Gravity Model 1996, which includes terms up to degree 360.

EGM96 :

The Earth Gravity Model 1996, which includes terms up to degree 360.

EGM2008 :

The Earth Gravity Model 2008, which includes terms up to degree 2190.

property name
get_degree(
self: ostk.physics.environment.gravitational.Earth,
) → ostk.core.type.Integer

Get the Earth model degree.

Returns:

Earth model degree.

Return type:

int

get_field_value_at(
self: ostk.physics.environment.gravitational.Earth,
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:
Returns:

Gravitational field value [m.s^-2].

Return type:

numpy.ndarray

get_order(
self: ostk.physics.environment.gravitational.Earth,
) → ostk.core.type.Integer

Get the Earth model order.

Returns:

Earth model order.

Return type:

int

get_parameters(
self: ostk.physics.environment.gravitational.Model,
) → ostk::physics::environment::gravitational::Model::Parameters
get_type(
self: ostk.physics.environment.gravitational.Earth,
) → ostk::physics::environment::gravitational::Earth::Type

Get the Earth model type.

Returns:

Earth model type.

Return type:

Earth.Type

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

Check if the Earth model is defined.

Returns:

True if the model is defined.

Return type:

bool