`SimulationInverse`#

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

Bases: BaseSimulation

Type of simulation : Inverse.

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 False, splitting is set to False, number of gathering rays per source is set to 1, maximum gathering error is set to 0, 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 5 passes, 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 (SimulationInverse.__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#

Methods

`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_splitting`	Activate/Deactivate the splitting.
`set_number_of_gathering_rays_per_source`	Set the number of gathering rays per source.
`set_maximum_gathering_error`	Set the maximum gathering error.
`set_ambient_material_file_uri`	To define the environment in which the light will propagate (water, fog, smoke etc.).
`set_stop_condition_passes_number`	To stop the simulation after a certain number of passes.
`set_stop_condition_duration`	To stop the simulation after a certain duration.
`set_automatic_save_frequency`	Define a backup interval (s).
`set_light_expert`	Activate/Deactivate the generation of light expert file.
`commit`	Save feature: send the local data to the speos server database.

Import detail#

from ansys.speos.core.simulation import SimulationInverse

Method detail#

SimulationInverse.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.SimulationInverse: Inverse simulation

SimulationInverse.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.SimulationInverse: Inverse simulation

SimulationInverse.set_weight()#

Activate weight. Highly recommended to fill.

Returns:

ansys.speos.core.simulation.BaseSimulation.Weight: Simulation.Weight

SimulationInverse.set_weight_none()#

Deactivate weight.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.set_colorimetric_standard_CIE_1931()#

Set the colorimetric standard to CIE 1931.

2 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.set_colorimetric_standard_CIE_1964()#

Set the colorimetric standard to CIE 1964.

10 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.set_dispersion(value=False)#

Activate/Deactivate the dispersion calculation.

Parameters:

valuebool: Activate/Deactivate. By default, False, means deactivate.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.set_splitting(value=False)#

Activate/Deactivate the splitting.

To split each propagated ray into several paths at their first impact after leaving the observer point.

Parameters:

valuebool: Activate/Deactivate. By default, False, means deactivate.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.set_number_of_gathering_rays_per_source(value=1)#

Set the number of gathering rays per source.

Parameters:

valueint: This number pilots the number of shadow rays to target at each source. By default, 1.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.set_maximum_gathering_error(value=0)#

Set the maximum gathering error.

Parameters:

valueint: This value defines the level below which a source can be neglected. By default, 0, means that no approximation will be done.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.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.SimulationInverse: Inverse simulation

SimulationInverse.set_stop_condition_passes_number(value=5)#

To stop the simulation after a certain number of passes.

Set None as value to have no condition about passes.

Parameters:

valueint, optional: The number of passes requested. Or None if no condition about passes. By default, 5.

Returns:

ansys.speos.core.simulation.SimulationInverse: Inverse simulation

SimulationInverse.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.SimulationInverse: Inverse simulation

SimulationInverse.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.SimulationInverse: Inverse simulation

SimulationInverse.set_light_expert(value=False, ray_number=10000000.0)#

Activate/Deactivate the generation of light expert file.

Parameters:

valuebool: Activate/Deactivate. By default, False, means deactivate.
ray_numberint: number of rays stored in lpf file By default, 10e6

Returns:

ansys.speos.core.simulation.SimulationInverse: Interactive simulation

SimulationInverse.commit()#

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

Returns:

ansys.speos.core.simulation.SimulationInverse: Simulation feature.

SimulationInverse#

Overview#

Import detail#

Method detail#

`SimulationInverse`#