MODTRANPropagationModel#

class ansys.stk.core.stkobjects.MODTRANPropagationModel#

Bases: ILaserAtmosphericLossModel, IComponentInfo, ICloneable

Class defining a MODTRAN propagation model.

Overview#

set_aerosol_model_type_by_name

Set the aerosol model type by name.

supported_aerosol_models

Get an array of supported aerosol model names.

aerosol_model_type

Get or set the aerosol model type.

visibility

Get or set the visibility.

relative_humidity

Get or set the relative humidity.

surface_temperature

Get or set the surface temperature.

cloud_model_type

Get or set the cloud model type.

override_cloud_thickness

Get or set the option for overriding the cloud thickness.

cloud_thickness

Get or set the cloud thickness value.

override_cloud_altitude

Get or set the option for overriding the cloud altitude.

cloud_altitude

Get or set the cloud altitude value.

write_start_time

Get or set the time to start writing MODTRAN output files.

number_of_time_steps_to_write

Get or set the number of time steps to write MODTRAN output files.

Import detail#

from ansys.stk.core.stkobjects import MODTRANPropagationModel

Property detail#

property MODTRANPropagationModel.supported_aerosol_models: list#

Get an array of supported aerosol model names.

property MODTRANPropagationModel.aerosol_model_type: ModtranAerosolModelType#

Get or set the aerosol model type.

property MODTRANPropagationModel.visibility: float#

Get or set the visibility.

property MODTRANPropagationModel.relative_humidity: float#

Get or set the relative humidity.

property MODTRANPropagationModel.surface_temperature: float#

Get or set the surface temperature.

property MODTRANPropagationModel.cloud_model_type: ModtranCloudModelType#

Get or set the cloud model type.

property MODTRANPropagationModel.override_cloud_thickness: bool#

Get or set the option for overriding the cloud thickness.

property MODTRANPropagationModel.cloud_thickness: float#

Get or set the cloud thickness value.

property MODTRANPropagationModel.override_cloud_altitude: bool#

Get or set the option for overriding the cloud altitude.

property MODTRANPropagationModel.cloud_altitude: float#

Get or set the cloud altitude value.

property MODTRANPropagationModel.write_start_time: float#

Get or set the time to start writing MODTRAN output files.

property MODTRANPropagationModel.number_of_time_steps_to_write: int#

Get or set the number of time steps to write MODTRAN output files.

Method detail#

MODTRANPropagationModel.set_aerosol_model_type_by_name(self, name: str) None#

Set the aerosol model type by name.

Parameters:

name : str

Returns:

None