DirectSimulationParameters#

class ansys.speos.core.generic.parameters.DirectSimulationParameters#

Direct Simulation Parameters.

Overview#

ambient_material_uri

Path to the ambient material file.

light_expoert

Whether light export is enabled.

stop_condition_rays_number

Maximum number of rays before stopping the simulation.

stop_condition_duration

Optional simulation stop duration in seconds.

automatic_save_frequency

Auto-save interval in seconds.

colorimetric_standard

Colorimetric standard used for result computation.

dispersion

Whether wavelength dispersion is enabled.

geom_distance_tolerance

Geometry distance tolerance value.

max_impact

Maximum number of impacts considered per ray.

minimum_energy_percentage

Minimum energy percentage threshold for ray continuation.

Import detail#

from ansys.speos.core.generic.parameters import DirectSimulationParameters

Attribute detail#

DirectSimulationParameters.ambient_material_uri: str | pathlib.Path = ''#

Path to the ambient material file.

DirectSimulationParameters.light_expoert: bool = False#

Whether light export is enabled.

DirectSimulationParameters.stop_condition_rays_number: int = 200000#

Maximum number of rays before stopping the simulation.

DirectSimulationParameters.stop_condition_duration: int | None = None#

Optional simulation stop duration in seconds.

DirectSimulationParameters.automatic_save_frequency: int = 1800#

Auto-save interval in seconds.

DirectSimulationParameters.colorimetric_standard: ColorimetricStandardTypes#

Colorimetric standard used for result computation.

DirectSimulationParameters.dispersion: bool = True#

Whether wavelength dispersion is enabled.

DirectSimulationParameters.geom_distance_tolerance: float = 0.01#

Geometry distance tolerance value.

DirectSimulationParameters.max_impact: int = 100#

Maximum number of impacts considered per ray.

DirectSimulationParameters.minimum_energy_percentage: float = 0.005#

Minimum energy percentage threshold for ray continuation.