EngineCustom#

class ansys.stk.core.stkobjects.astrogator.EngineCustom#

Bases: IComponentInfo, ICloneable

Custom engine model.

Overview#

enable_control_parameter

Enable the specified control parameter.

disable_control_parameter

Disables the specified control parameter.

is_control_parameter_enabled

Sees if the specified control is enabled.

g

Get or set the earth surface gravity acceleration for Isp conversions. Uses Acceleration Dimension.

eval_function_name

Get or set the EvalFunction - custom function to call at every thrust evaluation.

post_function_name

Get or set the PostFunction - custom function to call after all propagation ends.

pre_function_name

Get or set the PreFunction - custom function to call before any propagation begins.

seg_start_function_name

Get or set the SegStartFunction - custom function to call at the beginning of each segment.

update_function_name

Get or set the UpdateFunction - custom function to call at the beginning of each integration step.

control_parameters_available

Return whether or not the control parameters can be set.

Import detail#

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

Property detail#

property EngineCustom.g: float#

Get or set the earth surface gravity acceleration for Isp conversions. Uses Acceleration Dimension.

property EngineCustom.eval_function_name: str#

Get or set the EvalFunction - custom function to call at every thrust evaluation.

property EngineCustom.post_function_name: str#

Get or set the PostFunction - custom function to call after all propagation ends.

property EngineCustom.pre_function_name: str#

Get or set the PreFunction - custom function to call before any propagation begins.

property EngineCustom.seg_start_function_name: str#

Get or set the SegStartFunction - custom function to call at the beginning of each segment.

property EngineCustom.update_function_name: str#

Get or set the UpdateFunction - custom function to call at the beginning of each integration step.

property EngineCustom.control_parameters_available: bool#

Return whether or not the control parameters can be set.

Method detail#

EngineCustom.enable_control_parameter(self, param: ControlEngineCustom) None#

Enable the specified control parameter.

Parameters:

param : ControlEngineCustom

Returns:

None

EngineCustom.disable_control_parameter(self, param: ControlEngineCustom) None#

Disables the specified control parameter.

Parameters:

param : ControlEngineCustom

Returns:

None

EngineCustom.is_control_parameter_enabled(self, param: ControlEngineCustom) bool#

Sees if the specified control is enabled.

Parameters:

param : ControlEngineCustom

Returns:

bool