SimulationInteractive

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

Bases: BaseSimulation

Type of simulation : Interactive.

By default, geometry distance tolerance is set to 0.01, maximum number of impacts is set to 100, a colorimetric standard is set to CIE 1931, ambient material URI is empty, and weight’s minimum energy percentage is set to 0.005. By default, each source will send 100 rays. By default, the simulation deactivates both light expert and impact report.

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_parametersOptional[ ansys.speos.core.generic.parameters.InteractiveSimulationParameters] = None

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

Parameters:

• project (SimulationInteractive.__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.InteractiveSimulationParameters])

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.

Properties

ambient_material_file_uri	The ambient material file URI.
rays_number_per_sources	The number of rays to stop the simulation.
light_expert	Whether light expert is enabled.
impact_report	Activate/Deactivate the details in the HTML simulation report.

Import detail

from ansys.speos.core.simulation import SimulationInteractive

Property detail

property SimulationInteractive.ambient_material_file_uri: str

The ambient material file URI.

Returns:

str

The ambient material file URI.

property SimulationInteractive.rays_number_per_sources: int | None

The number of rays to stop the simulation.

Returns:

ansys.speos.core.simulation.SimulationInteractive

Interactive simulation

property SimulationInteractive.light_expert: bool

Whether light expert is enabled.

Returns:

bool

True if light expert is enabled.

property SimulationInteractive.impact_report: bool

Activate/Deactivate the details in the HTML simulation report.

e.g: number of impacts, position and surface state

Returns:

bool

True if activated.

Method detail

SimulationInteractive.set_weight()

Activate weight. Highly recommended to fill.

Returns:

ansys.speos.core.simulation.BaseSimulation.Weight

Weight

SimulationInteractive.set_weight_none()

Deactivate weight.

Returns:

ansys.speos.core.simulation.SimulationInteractive

Interactive simulation

SimulationInteractive.set_colorimetric_standard_CIE_1931()

Set the colorimetric standard to CIE 1931.

2 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationInteractive

Interactive simulation

SimulationInteractive.set_colorimetric_standard_CIE_1964()

Set the colorimetric standard to CIE 1964.

10 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationInteractive

Interactive simulation

Classes

RaysNumberPerSource	Structure to describe the number of rays requested for a specific source.
SourceSampling	Disabled - Setting source sampling is not available for this simulation type.