VehicleHPOPCentralBodyGravity#

class ansys.stk.core.stkobjects.VehicleHPOPCentralBodyGravity#

Class defining Central Body Gravity options for the High Precision Orbit Propagator (HPOP).

Overview#

set_maximum_degree_and_order

Set maximum degree and maximum order of geopotential coefficients to be included for Central Body gravity computations. An exception is raised if MaximumDegree is less than MaximumOrder. Both values are dimensionless.

file

Name of gravity (.grv) file, an ASCII file containing the Central Body geopotential model coefficients.

maximum_degree

Maximum degree of geopotential coefficients to be included for Central Body gravity computations. Dimensionless.

maximum_order

Maximum order of geopotential coefficients to be included for Central Body gravity computations. Dimensionless.

use_ocean_tides

Opt whether to include the perturbation of the gravity field caused by the effects of ocean tides.

solid_tide_type

Solid Tide Type.

use_secular_variations

Opt whether to include or ignore secular variations defined by the gravity field model.

Import detail#

from ansys.stk.core.stkobjects import VehicleHPOPCentralBodyGravity

Property detail#

property VehicleHPOPCentralBodyGravity.file: str#

Name of gravity (.grv) file, an ASCII file containing the Central Body geopotential model coefficients.

property VehicleHPOPCentralBodyGravity.maximum_degree: int#

Maximum degree of geopotential coefficients to be included for Central Body gravity computations. Dimensionless.

property VehicleHPOPCentralBodyGravity.maximum_order: int#

Maximum order of geopotential coefficients to be included for Central Body gravity computations. Dimensionless.

property VehicleHPOPCentralBodyGravity.use_ocean_tides: bool#

Opt whether to include the perturbation of the gravity field caused by the effects of ocean tides.

property VehicleHPOPCentralBodyGravity.solid_tide_type: SolidTide#

Solid Tide Type.

property VehicleHPOPCentralBodyGravity.use_secular_variations: bool#

Opt whether to include or ignore secular variations defined by the gravity field model.

Method detail#

VehicleHPOPCentralBodyGravity.set_maximum_degree_and_order(self, maximum_degree: int, maximum_order: int) None#

Set maximum degree and maximum order of geopotential coefficients to be included for Central Body gravity computations. An exception is raised if MaximumDegree is less than MaximumOrder. Both values are dimensionless.

Parameters:

maximum_degree : int

maximum_order : int

Returns:

None