SimulationDirect

class ansys.speos.core.simulation.SimulationDirect(project, name, description='', metadata=None, simulation_instance=None, default_parameters=None)

Bases: BaseSimulation

Type of Simulation: Direct.

By default, geometry distance tolerance is set to 0.01, maximum number of impacts is set to 100, colorimetric standard is set to CIE 1931, dispersion is set to True, fast transmission gathering is set to False, ambient material URI is empty, and weight’s minimum energy percentage is set to 0.005. By default, the simulation will stop after 200000 rays, with an automatic save frequency of 1800s.

Parameters:

projectansys.speos.core.project.Project

Project in which simulation shall be created.

namestr

Name of the simulation.

descriptionstr

Description of the Simulation. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

simulation_instanceansys.api.speos.scene.v2.scene_pb2.Scene.SimulationInstance, optional

Simulation instance to provide if the feature does not have to be created from scratch By default, None, means that the feature is created from scratch by default.

default_parametersansys.speos.core.generic.parameters.DirectSimulationParameters, optional

If defined the values in the direct simulation instance will be overwritten by the values of the data class.

Parameters:

• project (SimulationDirect.__init__.project)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• simulation_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SimulationInstance])

• default_parameters (Optional[ansys.speos.core.generic.parameters.DirectSimulationParameters])

Overview

Methods

set_weight	Activate weight. Highly recommended to fill.
set_weight_none	Deactivate weight.
set_colorimetric_standard_CIE_1931	Set the colorimetric standard to CIE 1931.
set_colorimetric_standard_CIE_1964	Set the colorimetric standard to CIE 1964.
commit	Save feature: send the local data to the speos server database.

Properties

dispersion	Activate/Deactivate the dispersion calculation.
ambient_material_file_uri	The ambient material file URI.
stop_condition_rays_number	The number of rays to stop the simulation.
stop_condition_duration	The duration to stop the simulation.
automatic_save_frequency	The automatic save frequency.
light_expert	Whether light expert is enabled.

Import detail

from ansys.speos.core.simulation import SimulationDirect

Property detail

property SimulationDirect.dispersion: bool

Activate/Deactivate the dispersion calculation.

Returns:

bool

True if dispersion is activated.

property SimulationDirect.ambient_material_file_uri: str

The ambient material file URI.

Returns:

str

The ambient material file URI.

property SimulationDirect.stop_condition_rays_number: int | None

The number of rays to stop the simulation.

Returns:

Optional[int]

The number of rays, or None if no condition.

property SimulationDirect.stop_condition_duration: int | None

The duration to stop the simulation.

Returns:

Optional[int]

The duration in seconds, or None if no condition.

property SimulationDirect.automatic_save_frequency: int

The automatic save frequency.

Returns:

int

The save frequency in seconds.

property SimulationDirect.light_expert: bool

Whether light expert is enabled.

Returns:

bool

True if light expert is enabled.

Method detail

SimulationDirect.set_weight()

Activate weight. Highly recommended to fill.

Returns:

ansys.speos.core.simulation.BaseSimulation.Weight

Weight.

SimulationDirect.set_weight_none()

Deactivate weight.

Returns:

ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_colorimetric_standard_CIE_1931()

Set the colorimetric standard to CIE 1931.

2 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_colorimetric_standard_CIE_1964()

Set the colorimetric standard to CIE 1964.

10 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.simulation.SimulationDirect

Simulation feature.

Classes

SourceSampling

Disabled - Setting source sampling is not available for this simulation type.