ostk.physics.environment.atmospheric.Earth¶
- class Earth(
- self: ostk.physics.environment.atmospheric.Earth,
- type: ostk.physics.environment.atmospheric.Earth.Type,
- input_data_type: ostk.physics.environment.atmospheric.Earth.InputDataType = <InputDataType.Undefined: 0>,
- f107_constant_value: ostk.core.type.Real = 150.0,
- f107_average_constant_value: ostk.core.type.Real = 150.0,
- kp_constant_value: ostk.core.type.Real = 3.0,
- earth_frame: ostk.physics.coordinate.Frame = Frame.ITRF(),
- earth_radius: ostk.physics.unit.Length = WGS84.equatorialRadius_,
- earth_flattening: ostk.core.type.Real = WGS84.flattening_,
- sun_celestial: ostk.physics.environment.object.Celestial = None,
- type: ostk.physics.environment.atmospheric.Earth.Type,
Bases:
pybind11_object
Earth atmospheric model.
Constructor.
- Parameters:
type (Earth.Type) -- Earth atmospheric model type.
input_data_type (Earth.InputDataType) -- Earth atmospheric model input data type.
f107_constant_value (Real) -- F10.7 constant value.
f107_average_constant_value (Real) -- F10.7a constant value.
kp_constant_value (Real) -- Kp constant value.
earth_frame (Frame) -- Earth frame.
earth_radius (Length) -- Earth radius [m].
earth_flattening (Real) -- Earth flattening.
sun_celestial (Celestial) -- Sun celestial object.
- Returns:
Earth atmospheric model.
- Return type:
Methods
Overloaded function.
Get the Earth atmospheric model input data type.
Get the Earth atmospheric model type.
Check if the Earth atmospheric model is defined.
- class InputDataType(
- self: ostk.physics.environment.atmospheric.Earth.InputDataType,
- value: int,
Bases:
pybind11_object
Members:
- Undefined :
Undefined.
- ConstantFluxAndGeoMag :
Use constant values for F10.7, F10.7a and Kp NRLMSISE00 input parameters.
- CSSISpaceWeatherFile :
Use historical and predicted values for F10.7, F10.7a and Kp NRLMSISE00 input parameters from CSSI.
- property name¶
- class Type(self: ostk.physics.environment.atmospheric.Earth.Type, value: int)¶
Bases:
pybind11_object
Members:
- Undefined :
Undefined.
- Exponential :
Exponential atmospheric density model, valid up to 1000 km.
- NRLMSISE00 :
Navy Research Lab Mass Spectrometer and Incoherent Scatter Radar Exosphere 2000.
- property name¶
- get_density_at(*args, **kwargs)¶
Overloaded function.
get_density_at(self: ostk.physics.environment.atmospheric.Earth, position: ostk.physics.coordinate.Position, instant: ostk.physics.time.Instant) -> ostk.core.type.Real
Get the atmospheric density value at a given position and instant.
- Args:
position (Position): A position. instant (Instant): An instant.
- Returns:
float: Atmospheric density value [kg.m^-3].
get_density_at(self: ostk.physics.environment.atmospheric.Earth, lla: ostk.physics.coordinate.spherical.LLA, instant: ostk.physics.time.Instant) -> ostk.core.type.Real
Get the atmospheric density value at a given position and instant.
- Args:
lla (LLA): A position, expressed as latitude, longitude, altitude [deg, deg, m]. instant (Instant): An instant.
- Returns:
float: Atmospheric density value [kg.m^-3].
- get_input_data_type( ) ostk.physics.environment.atmospheric.Earth.InputDataType ¶
Get the Earth atmospheric model input data type.
- Returns:
Earth atmospheric model input data type.
- Return type:
- get_type( ) ostk.physics.environment.atmospheric.Earth.Type ¶
Get the Earth atmospheric model type.
- Returns:
Earth atmospheric model type.
- Return type:
- is_defined(self: ostk.physics.environment.atmospheric.Earth) bool ¶
Check if the Earth atmospheric model is defined.
- Returns:
True if defined.
- Return type: