GravityFieldFunction

class ansys.stk.core.stkobjects.astrogator.GravityFieldFunction

Bases: IComponentInfo, ICloneable

Gravity Field gravity propagator function.

Overview

Properties

gravity_filename	Get or set the name of the file containing the gravity field.
degree	Get or set the degree of geopotential coefficients to be included for Central Body gravity computations. Valid range is from 0 to 90, depending on the gravity model. Dimensionless.
order	Get or set the order of geopotential coefficients to be included for Central Body gravity computations. Valid range is from 0 to 90, depending on the gravity model. Dimensionless.
max_degree_text	Displays the maximum degree permissible for the gravity model.
max_order_text	Displays the maximum order permissible for the gravity model.
include_time_dependent_solid_tides	True if including time dependent solid tides.
solid_tide_min_amp	Get or set the minimum amplitude for solid tides; contributors that are below the minimum amplitude will not be factored into the computation. Uses SmallDistance Dimension.
use_ocean_tides	True if using ocean tides.
ocean_tide_min_amplitude	Get or set the minimum amplitude for ocean tides; contributors that are below the minimum amplitude will not be factored into the computation. Uses SmallDistance Dimension.
min_radius_percent	Get or set the percentage of the central body’s minimum radius at which a modified force model (only the two-body force) will be used - provided there is no altitude stopping condition. Uses Percent Dimension.
central_body_name	Get the name of the central body.
ocean_tide_max_degree	Get or set the maximum degree for force contributions from ocean tides that will be included in the computation. Dimensionless.
ocean_tide_max_order	Get or set the maximum order for force contributions from ocean tides that will be included in the computation. Dimensionless.
solid_tide_type	Get or set the type of solid tide contribution to be modeled.
truncate_solid_tides	True if solid tide terms (including permanent tide) won’t be included beyond the degree and order selected for the gravity model.
use_secular_variations	Opt whether to include or ignore secular variations defined by the gravity field model.
partials_degree	Get or set the degree of geopotential coefficients to be included for Central Body gravity state transition matrix computations. Valid range is from 0 to 90, depending on the gravity model and the degree used for state computations. Dimensionless.
partials_order	Get or set the order of geopotential coefficients to be included for Central Body gravity state transition matrix computations. Valid range is from 0 to 90, depending on the gravity model and the order used for state computations. Dimensionless.
max_partials_degree_text	Displays the maximum degree permissible for the gravity model partials used in the STM.
max_partials_order_text	Displays the maximum order permissible for the gravity model partials used in the STM.

Import detail

from ansys.stk.core.stkobjects.astrogator import GravityFieldFunction

Property detail

property GravityFieldFunction.gravity_filename: str

Get or set the name of the file containing the gravity field.

property GravityFieldFunction.degree: int

Get or set the degree of geopotential coefficients to be included for Central Body gravity computations. Valid range is from 0 to 90, depending on the gravity model. Dimensionless.

property GravityFieldFunction.order: int

Get or set the order of geopotential coefficients to be included for Central Body gravity computations. Valid range is from 0 to 90, depending on the gravity model. Dimensionless.

property GravityFieldFunction.max_degree_text: str

Displays the maximum degree permissible for the gravity model.

property GravityFieldFunction.max_order_text: str

Displays the maximum order permissible for the gravity model.

property GravityFieldFunction.include_time_dependent_solid_tides: bool

True if including time dependent solid tides.

property GravityFieldFunction.solid_tide_min_amp: float

Get or set the minimum amplitude for solid tides; contributors that are below the minimum amplitude will not be factored into the computation. Uses SmallDistance Dimension.

property GravityFieldFunction.use_ocean_tides: bool

True if using ocean tides.

property GravityFieldFunction.ocean_tide_min_amplitude: float

Get or set the minimum amplitude for ocean tides; contributors that are below the minimum amplitude will not be factored into the computation. Uses SmallDistance Dimension.

property GravityFieldFunction.min_radius_percent: float

Get or set the percentage of the central body’s minimum radius at which a modified force model (only the two-body force) will be used - provided there is no altitude stopping condition. Uses Percent Dimension.

property GravityFieldFunction.central_body_name: str

Get the name of the central body.

property GravityFieldFunction.ocean_tide_max_degree: int

Get or set the maximum degree for force contributions from ocean tides that will be included in the computation. Dimensionless.

property GravityFieldFunction.ocean_tide_max_order: int

Get or set the maximum order for force contributions from ocean tides that will be included in the computation. Dimensionless.

property GravityFieldFunction.solid_tide_type: SolidTide

Get or set the type of solid tide contribution to be modeled.

property GravityFieldFunction.truncate_solid_tides: bool

True if solid tide terms (including permanent tide) won’t be included beyond the degree and order selected for the gravity model.

property GravityFieldFunction.use_secular_variations: bool

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

property GravityFieldFunction.partials_degree: int

Get or set the degree of geopotential coefficients to be included for Central Body gravity state transition matrix computations. Valid range is from 0 to 90, depending on the gravity model and the degree used for state computations. Dimensionless.

property GravityFieldFunction.partials_order: int

Get or set the order of geopotential coefficients to be included for Central Body gravity state transition matrix computations. Valid range is from 0 to 90, depending on the gravity model and the order used for state computations. Dimensionless.

property GravityFieldFunction.max_partials_degree_text: str

Displays the maximum degree permissible for the gravity model partials used in the STM.

property GravityFieldFunction.max_partials_order_text: str

Displays the maximum order permissible for the gravity model partials used in the STM.