CoatedSurfaceSample

class ansys.speos.core.input_files.coated_surface.CoatedSurfaceSample(reflection_p=100.0, transmission_p=0.0, reflection_s=100.0, transmission_s=0.0)

Bases: ansys.speos.core.input_files._base._ValueComparable

Coating response at one angle of incidence and one wavelength.

Called without arguments, the constructor creates a perfect reflector.

Parameters:

reflection_pfloat, optional

Reflected part of the P polarization, in percent. By default, 100.0.

transmission_pfloat, optional

Transmitted part of the P polarization, in percent. By default, 0.0.

reflection_sfloat, optional

Reflected part of the S polarization, in percent. By default, 100.0.

transmission_sfloat, optional

Transmitted part of the S polarization, in percent. By default, 0.0.

Parameters:

• reflection_p (float)

• transmission_p (float)

• reflection_s (float)

• transmission_s (float)

Overview

Methods

validate

Check the coating response of the sample.

Properties

reflection_p	Reflected P polarization, in percent.
transmission_p	Transmitted P polarization, in percent.
reflection_s	Reflected S polarization, in percent.
transmission_s	Transmitted S polarization, in percent.
absorption_p	Absorbed part of the P polarization, in percent.
absorption_s	Absorbed part of the S polarization, in percent.

Import detail

from ansys.speos.core.input_files.coated_surface import CoatedSurfaceSample

Property detail

property CoatedSurfaceSample.reflection_p: float

Reflected P polarization, in percent.

Parameters:

valuefloat

New reflected part of the P polarization, in percent.

Returns:

float

Contribution between 0 and 100.

property CoatedSurfaceSample.transmission_p: float

Transmitted P polarization, in percent.

Parameters:

valuefloat

New transmitted part of the P polarization, in percent.

Returns:

float

Contribution between 0 and 100.

property CoatedSurfaceSample.reflection_s: float

Reflected S polarization, in percent.

Parameters:

valuefloat

New reflected part of the S polarization, in percent.

Returns:

float

Contribution between 0 and 100.

property CoatedSurfaceSample.transmission_s: float

Transmitted S polarization, in percent.

Parameters:

valuefloat

New transmitted part of the S polarization, in percent.

Returns:

float

Contribution between 0 and 100.

property CoatedSurfaceSample.absorption_p: float

Absorbed part of the P polarization, in percent.

Returns:

float

Complement to 100 of the P reflection and transmission.

Notes

This property is read-only.

property CoatedSurfaceSample.absorption_s: float

Absorbed part of the S polarization, in percent.

Returns:

float

Complement to 100 of the S reflection and transmission.

Notes

This property is read-only.

Method detail

CoatedSurfaceSample.validate()

Check the coating response of the sample.

Raises:

ValueError

If a value is outside the 0 to 100 range.

Warns:

UserWarning

If computed absorption is negative, excluding rounding noise within 1e-9 percent.

Notes

A negative CoatedSurfaceSample.absorption_p or CoatedSurfaceSample.absorption_s is not rejected: the coating samples published by Ansys do overrun 100 percent on a polarization, and the Coated Surface Editor only flags it.