OptProp

class ansys.speos.core.opt_prop.OptProp(project, name, description='', metadata=None)

Speos feature: optical property.

By default, a mirror 100% is chosen as surface optical property, without any volume optical property. By default, the optical property is applied to no geometry.

Parameters:

projectproject.Project

Project that will own the feature.

namestr

Name of the feature.

descriptionstr, optional

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]], optional

Metadata of the feature. By default, None.

Parameters:

• project (OptProp.__init__.project)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

Overview

Methods

set_surface_mirror	Perfect specular surface.
set_surface_opticalpolished	Transparent or perfectly polished material (glass, plastic).
set_surface_library	Based on surface optical properties file.
set_volume_none	No volume optical property.
set_volume_opaque	Non transparent material.
set_volume_optic	Transparent colorless material without bulk scattering.
set_volume_library	Based on *.material file.
set_geometries	Select geometries on which the optical properties will be applied.
get	Get dictionary corresponding to the project - 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.

Attributes

sop_template_link	Link object for the sop template in database.
vop_template_link	Link object for the vop template in database.

Special methods

__str__

Return the string representation of the optical property.

Import detail

from ansys.speos.core.opt_prop import OptProp

Attribute detail

OptProp.sop_template_link = None

Link object for the sop template in database.

OptProp.vop_template_link = None

Link object for the vop template in database.

Method detail

OptProp.set_surface_mirror(reflectance=100)

Perfect specular surface.

Parameters:

reflectancefloat

Reflectance, expected from 0. to 100. in %. By default, 100.

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_surface_opticalpolished()

Transparent or perfectly polished material (glass, plastic).

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_surface_library(path)

Based on surface optical properties file.

Parameters:

pathstr

Surface optical properties file, *.scattering, *.bsdf, *.brdf, *.coated, …

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_volume_none()

No volume optical property.

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_volume_opaque()

Non transparent material.

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_volume_optic(index=1.5, absorption=0, constringence=None)

Transparent colorless material without bulk scattering.

Parameters:

indexfloat

Refractive index. By default, 1.5.

absorptionfloat

Absorption coefficient value. mm-1. By default, 0.

constringencefloat, optional

Abbe number. By default, None, means no constringence.

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_volume_library(path)

Based on *.material file.

Parameters:

pathstr

*.material file

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.set_geometries(geometries=None)

Select geometries on which the optical properties will be applied.

Parameters:

geometriesList[ansys.speos.core.geo_ref.GeoRef], optional

List of geometries. Giving an empty list means “All geometries” By default, None, means “no geometry”.

Returns:

ansys.speos.core.opt_prop.OptProp

Optical property.

OptProp.get(key='')

Get dictionary corresponding to the project - read only.

Parameters:

key: str

Returns:

str | dict

OptProp.__str__()

Return the string representation of the optical property.

OptProp.commit()

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

Returns:

ansys.speos.core.opt_prop.OptProp

Optical Property feature.

OptProp.reset()

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

Returns:

ansys.speos.core.opt_prop.OptProp

OptProp feature.

OptProp.delete()

Delete feature: delete data from the speos server database.

The local data are still available

Returns:

ansys.speos.core.opt_prop.OptProp

OptProp feature.