VehicleHPOPForceModelDrag

class ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag

Class defining the HPOP atmospheric drag model.

Overview

Methods

set_solar_flux_geo_magnitude_type	Set the method for specifying solar and geomagnetic flux.
set_drag_model_type	Change the active drag model type.
is_drag_model_type_supported	Get a value indicating whether the specified type can be used.

Properties

use	Opt whether to take account of atmospheric drag.
atmospheric_density_model	Select the atmospheric density model to be used.
solar_flux_geo_magnitude_type	Get the method for specifying solar and geomagnetic flux.
solar_flux_geo_magnitude	Solar and geomagnetic flux.
drag_model_type	Return a type of the active drag model.
drag_model_supported_types	Return an array of valid choices.
drag_model	Return the active drag model.
low_altitude_atmospheric_density_model	Do not use this property, as it is deprecated. Use LowAltAtmosDensityModel instead. Select the low altitude atmospheric density model to be used.
blending_range	Atmospheric blending range: measured from the lower extent of the upper atmospheric model. Uses distance dimension.
low_altitude_atmosphere_density_model	Select the low altitude atmospheric density model to be used.

Import detail

from ansys.stk.core.stkobjects import VehicleHPOPForceModelDrag

Property detail

property VehicleHPOPForceModelDrag.use: bool

Opt whether to take account of atmospheric drag.

property VehicleHPOPForceModelDrag.atmospheric_density_model: AtmosphericDensityModel

Select the atmospheric density model to be used.

property VehicleHPOPForceModelDrag.solar_flux_geo_magnitude_type: VehicleSolarFluxGeomagneticType

Get the method for specifying solar and geomagnetic flux.

property VehicleHPOPForceModelDrag.solar_flux_geo_magnitude: IVehicleSolarFluxGeoMagnitude

Solar and geomagnetic flux.

property VehicleHPOPForceModelDrag.drag_model_type: DragModel

Return a type of the active drag model.

property VehicleHPOPForceModelDrag.drag_model_supported_types: list

Return an array of valid choices.

property VehicleHPOPForceModelDrag.drag_model: IVehicleHPOPDragModel

Return the active drag model.

property VehicleHPOPForceModelDrag.low_altitude_atmospheric_density_model: AtmosphericDensityModel

Do not use this property, as it is deprecated. Use LowAltAtmosDensityModel instead. Select the low altitude atmospheric density model to be used.

property VehicleHPOPForceModelDrag.blending_range: float

Atmospheric blending range: measured from the lower extent of the upper atmospheric model. Uses distance dimension.

property VehicleHPOPForceModelDrag.low_altitude_atmosphere_density_model: LowAltitudeAtmosphericDensityModel

Select the low altitude atmospheric density model to be used.

Method detail

VehicleHPOPForceModelDrag.set_solar_flux_geo_magnitude_type(self, solar_flux_geo_mag: VehicleSolarFluxGeomagneticType) → None

Set the method for specifying solar and geomagnetic flux.

Parameters:

solar_flux_geo_mag : VehicleSolarFluxGeomagneticType

Returns:

None

VehicleHPOPForceModelDrag.set_drag_model_type(self, drag_model: DragModel) → None

Change the active drag model type.

Parameters:

drag_model : DragModel

Returns:

None

VehicleHPOPForceModelDrag.is_drag_model_type_supported(self, drag_model: DragModel) → bool

Get a value indicating whether the specified type can be used.

Parameters:

drag_model : DragModel

Returns:

bool