# Fourier3D.Scattering Class¶

class Fourier3D.Scattering

Reflected mode proxy.

This class contains providers for the scattered field.

## Subclasses¶

 Incident Incident field details Reflected Reflected field details Transmitted Transmitted field details

## Methods¶

 integrateEE(z1, z2) Get average integral of the squared electric field: integrateHH(z1, z2) Get average integral of the squared magnetic field:

## Attributes¶

 R Total reflection coefficient [-]. T Total transmission coefficient [-]. incident Incident field details. outLightE Provider of the computed electric field [V/m]. outLightH Provider of the computed magnetic field [A/m]. outLightMagnitude Provider of the computed light intensity [W/m²]. reflected Reflected field details. reflectivity Total reflection coefficient [%]. transmitted Transmitted field details. transmittivity Total transmission coefficient [%].

## Descriptions¶

### Method Details¶

Fourier3D.Scattering.integrateEE(z1, z2)

Get average integral of the squared electric field:

$\frac 1 2 \int_{z_1}^{z_2} |E|^2.$

In the lateral direction integration is performed over the whole domain.

Parameters: z1 (float) – Lower vertical bound of the integral. z2 (float) – Upper vertical bound of the integral. Computed integral [V2 / m2]. float

Warning

This method may return incorrect results for layers with gain, due to the strong non-Hemiticity!

Fourier3D.Scattering.integrateHH(z1, z2)

Get average integral of the squared magnetic field:

$\frac 1 2 \int_{z_1}^{z_2} |H|^2.$

In the lateral direction integration is performed over the whole domain.

Parameters: z1 (float) – Lower vertical bound of the integral. z2 (float) – Upper vertical bound of the integral. Computed integral [A2 / m2]. float

Warning

This method may return incorrect results for layers with gain, due to the strong non-Hemiticity!

### Attribute Details¶

Fourier3D.Scattering.R

Total reflection coefficient [-].

Fourier3D.Scattering.T

Total transmission coefficient [-].

Fourier3D.Scattering.incident

Incident field details.

Return type: optical.slab.Fourier3D.Incident
Fourier3D.Scattering.outLightE

Provider of the computed electric field [V/m].

outLightE(mesh, interpolation=’default’)

Parameters: mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method. Data with the electric field on the specified mesh [V/m].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inLightE = solver.outLightE


Obtain the provided field:

>>> solver.outLightE(mesh)

Fourier3D.Scattering.outLightH

Provider of the computed magnetic field [A/m].

outLightH(mesh, interpolation=’default’)

Parameters: mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method. Data with the magnetic field on the specified mesh [A/m].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inLightH = solver.outLightH


Obtain the provided field:

>>> solver.outLightH(mesh)

Fourier3D.Scattering.outLightMagnitude

Provider of the computed light intensity [W/m²].

outLightMagnitude(mesh, interpolation=’default’)

Parameters: mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method. Data with the light intensity on the specified mesh [W/m²].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inLightMagnitude = solver.outLightMagnitude


Obtain the provided field:

>>> solver.outLightMagnitude(mesh)

Fourier3D.Scattering.reflected

Reflected field details.

Return type: optical.slab.Fourier3D.Reflected
Fourier3D.Scattering.reflectivity

Total reflection coefficient [%].

This differs from Scattering.R by unit.

Fourier3D.Scattering.transmitted

Transmitted field details.

Return type: optical.slab.Fourier3D.Transmitted
Fourier3D.Scattering.transmittivity

Total transmission coefficient [%].

This differs from Scattering.T by unit.