WindModel

class ansys.stk.core.stkobjects.aviator.WindModel

Class defining the wind model for a mission, scenario, or procedure.

Overview

Methods

copy	Copy the wind model.
paste	Paste the wind model.

Properties

wind_model_type	Get or set the wind model type.
wind_model_type_string	Get or set the wind model type as a string value. Use this for custom models.
wind_model_source	Get or set the wind model source.
mode_as_constant	Get the options for a Constant Bearing/Speed wind model.
mode_as_adds	Get the options for a NOAA ADDS Service wind model.

Examples

Configure the weather and atmosphere of the Mission

# Mission mission: Aviator Mission object
# Get the wind model used for the mission
windModel = mission.wind_model
# Let's use the mission model
windModel.wind_model_source = WindAtmosphereModelSource.MISSION_MODEL
# Let's use constant wind
windModel.wind_model_type = WindModelType.CONSTANT_WIND
# Get the constant wind model options
constantWind = windModel.mode_as_constant
# Set the wind bearing
constantWind.wind_bearing = 30
# Set the wind speed
constantWind.wind_speed = 5

# Get the atmosphere model used for the mission
atmosphere = mission.atmosphere_model
# Let's use the mission model
atmosphere.atmosphere_model_source = WindAtmosphereModelSource.MISSION_MODEL
# Get the basic atmosphere options
basicAtmosphere = atmosphere.mode_as_basic
# Use standard 1976 atmosphere
basicAtmosphere.basic_model_type = AtmosphereModelType.STANDARD1976
# Opt to override the values
basicAtmosphere.use_non_standard_atmosphere = True
# Override the temperature
basicAtmosphere.temperature = 290

Configure the wind and atmosphere for a procedure

# IProcedure procedure: Procedure object
# Get the wind model for the procedure
windModel = procedure.wind_model
# Use the procedure model
windModel.wind_model_source = WindAtmosphereModelSource.PROCEDURE_MODEL
# Let's use constant wind
windModel.wind_model_type = WindModelType.CONSTANT_WIND
# Get the constant wind model options
constantWind = windModel.mode_as_constant
# Set the wind bearing
constantWind.wind_bearing = 30
# Set the wind speed
constantWind.wind_speed = 5

# Get the atmosphere model used for the procedure
atmosphere = procedure.atmosphere_model
# Let's use the procedure model
atmosphere.atmosphere_model_source = WindAtmosphereModelSource.PROCEDURE_MODEL
# Get the basic atmosphere options
basicAtmosphere = atmosphere.mode_as_basic
# Use standard 1976 atmosphere
basicAtmosphere.basic_model_type = AtmosphereModelType.STANDARD1976

Import detail

from ansys.stk.core.stkobjects.aviator import WindModel

Property detail

property WindModel.wind_model_type: WindModelType

Get or set the wind model type.

property WindModel.wind_model_type_string: str

Get or set the wind model type as a string value. Use this for custom models.

property WindModel.wind_model_source: WindAtmosphereModelSource

Get or set the wind model source.

property WindModel.mode_as_constant: WindModelConstant

Get the options for a Constant Bearing/Speed wind model.

property WindModel.mode_as_adds: WindModelADDS

Get the options for a NOAA ADDS Service wind model.

Method detail

WindModel.copy(self) → None

Copy the wind model.

Returns:

None

WindModel.paste(self) → None

Paste the wind model.

Returns:

None