Weight#

class ansys.speos.core.simulation.BaseSimulation.Weight(weight, stable_ctr=False)#

The Weight represents the ray energy.

In real life, a ray loses some energy (power) when it interacts with an object. Activating weight means that the Weight message is present. When weight is not activated, rays’ energy stays constant and probability laws dictate if rays continue or stop propagating. When weight is activated, the rays’ energy evolves with interactions until rays reach the sensors. It is highly recommended to fill this parameter excepted in interactive simulation. Not filling this parameter is useful to understand certain phenomena as absorption.

Parameters:
weightansys.api.speos.simulation.v1.simulation_template_pb2.Weight to complete.
stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

  • weight (ansys.api.speos.simulation.v1.simulation_template_pb2.Weight)

  • stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_weight method available in simulation classes.

Overview#

set_minimum_energy_percentage

Set the minimum energy percentage.

Import detail#

from ansys.speos.core.simulation.BaseSimulation import Weight

Method detail#

Weight.set_minimum_energy_percentage(value=0.005)#

Set the minimum energy percentage.

Parameters:
valuefloat

The Minimum energy percentage parameter defines the minimum energy ratio to continue to propagate a ray with weight. By default, 0.005.

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

Weight.