FastTransmissionGathering

class ansys.speos.core.fast_transmission_gathering.FastTransmissionGathering(project, fast_transmission_gathering=None)

Speos feature: fast transmission gathering (FTG).

The fast transmission gathering accelerates the simulation by neglecting the light refraction that occurs when the light is being transmitted through the selected transparent geometries.

Only one fast transmission gathering feature per project.

Parameters:

projectansys.speos.core.project.Project

Project that will own the feature.

fast_transmission_gatheringansys.api.speos.scene.v2.scene_pb2.Scene.FastTransmissionGathering, optional

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

Parameters:

• project (FastTransmissionGathering.__init__.project)

• fast_transmission_gathering (Optional[ansys.speos.core.kernel.scene.ProtoScene.FastTransmissionGathering])

Notes

The geometries selected here are only taken into account if the fast transmission gathering is activated at simulation level, via the fast_transmission_gathering property of ansys.speos.core.simulation.SimulationDirect or ansys.speos.core.simulation.SimulationInverse.

Overview

Methods

get	Get dictionary corresponding to the fast transmission gathering - read only.
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.

Properties

geometries

Geometries with fast transmission gathering applied.

Special methods

__str__

Return the string representation of the fast transmission gathering.

Import detail

from ansys.speos.core.fast_transmission_gathering import FastTransmissionGathering

Property detail

property FastTransmissionGathering.geometries: List[str] | None

Geometries with fast transmission gathering applied.

This property gets and sets the geo paths on which the fast transmission gathering is applied.

Parameters:

geometriesOptional[List[Union[ansys.speos.core.geo_ref.GeoRef, ansys.speos.core.body.Body]]]

Geometries on which the fast transmission gathering is applied. Pass None or an empty list to clear the geometries.

Returns:

Optional[List[str]]

Geo paths with fast transmission gathering applied.

Notes

The geometries selected here are only taken into account if the fast transmission gathering is activated at simulation level, via the fast_transmission_gathering property of the direct or inverse simulation features.

Method detail

FastTransmissionGathering.get(key='')

Get dictionary corresponding to the fast transmission gathering - read only.

Parameters:

keystr, optional

Key prefix used to look up a value. By default, "", which returns the full dictionary.

Returns:

dict | None

Value found for the given key, or the full dictionary when key is empty.

FastTransmissionGathering.__str__()

Return the string representation of the fast transmission gathering.

FastTransmissionGathering.commit()

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

Returns:

ansys.speos.core.fast_transmission_gathering.FastTransmissionGathering

Fast transmission gathering feature.

FastTransmissionGathering.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.fast_transmission_gathering.FastTransmissionGathering

Fast transmission gathering feature.

FastTransmissionGathering.delete()

Delete feature: delete data from the speos server database.

The local data are still available.

Returns:

ansys.speos.core.fast_transmission_gathering.FastTransmissionGathering

Fast transmission gathering feature.