SimulationDirect#

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

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_valuesbool

Uses default values when True.

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_values (bool)

Overview#

set_geom_distance_tolerance

Set the geometry distance tolerance.

set_max_impact

Define a value to determine the maximum number of ray impacts during propagation.

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.

set_dispersion

Activate/Deactivate the dispersion calculation.

set_ambient_material_file_uri

To define the environment in which the light will propagate (water, fog, smoke etc.).

set_stop_condition_rays_number

To stop the simulation after a certain number of rays were sent.

set_stop_condition_duration

To stop the simulation after a certain duration.

set_automatic_save_frequency

Define a backup interval (s).

Import detail#

from ansys.speos.core.simulation import SimulationDirect

Method detail#

SimulationDirect.set_geom_distance_tolerance(value=0.01)#

Set the geometry distance tolerance.

Parameters:
valuefloat

Maximum distance in mm to consider two faces as tangent. By default, 0.01.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_max_impact(value=100)#

Define a value to determine the maximum number of ray impacts during propagation.

When a ray has interacted N times with the geometry, the propagation of the ray stops.

Parameters:
valueint

The maximum number of impacts. By default, 100.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation

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.set_dispersion(value=True)#

Activate/Deactivate the dispersion calculation.

Parameters:
valuebool

Activate/Deactivate. By default, True, means activate.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_ambient_material_file_uri(uri='')#

To define the environment in which the light will propagate (water, fog, smoke etc.).

Parameters:
uristr

The ambient material, expressed in a .material file. By default, "", means air as ambient material.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_stop_condition_rays_number(value=200000)#

To stop the simulation after a certain number of rays were sent.

Set None as value to have no condition about rays number.

Parameters:
valueint, optional

The number of rays to send. Or None if no condition about the number of rays. By default, 200000.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_stop_condition_duration(value=None)#

To stop the simulation after a certain duration.

Set None as value to have no condition about duration.

Parameters:
valueint, optional

Duration requested (s). Or None if no condition about duration. By default, None.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation

SimulationDirect.set_automatic_save_frequency(value=1800)#

Define a backup interval (s).

This option is useful when computing long simulations. But a reduced number of save operations naturally increases the simulation performance.

Parameters:
valueint, optional

Backup interval (s). By default, 1800.

Returns:
ansys.speos.core.simulation.SimulationDirect

Direct simulation