Fourier2D.Scattering Class¶
-
class
Fourier2D.
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¶
get_raw_E (level) |
Get Fourier expansion coefficients for the electric field. |
get_raw_H (level) |
Get Fourier expansion coefficients for the magnetic field. |
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¶
-
Fourier2D.Scattering.
get_raw_E
(level)¶ Get Fourier expansion coefficients for the electric field.
This is a low-level function returning expansion coefficients for electric field. Please refer to the detailed solver description for their interpretation.
Parameters: level (float) – Vertical level at which the coefficients are computed. Return type: numpy.ndarray
-
Fourier2D.Scattering.
get_raw_H
(level)¶ Get Fourier expansion coefficients for the magnetic field.
This is a low-level function returning expansion coefficients for magnetic field. Please refer to the detailed solver description for their interpretation.
Parameters: level (float) – Vertical level at which the coefficients are computed. Return type: numpy.ndarray
-
Fourier2D.Scattering.
integrateEE
(z1, z2)¶ Get average integral of the squared electric field:
\[\frac 1 2 \int\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.
Returns: Computed integral [V2].
Return type: float
-
Fourier2D.Scattering.
integrateHH
(z1, z2)¶ Get average integral of the squared magnetic field:
\[\frac 1 2 \int\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.
Returns: Computed integral [A2].
Return type: float
Attribute Details¶
-
Fourier2D.Scattering.
R
¶ Total reflection coefficient (-).
-
Fourier2D.Scattering.
T
¶ Total transmission coefficient (-).
-
Fourier2D.Scattering.
incident
¶ Incident field details.
Return type: optical.modal.Fourier2D.Incident
-
Fourier2D.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.
Returns: 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) <plask.Data at 0x1234567>
-
Fourier2D.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.
Returns: 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) <plask.Data at 0x1234567>
-
Fourier2D.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.
Returns: 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) <plask.Data at 0x1234567>
See also
Provider class:
plask.flow.LightMagnitudeProvider2D
Receciver class:
plask.flow.LightMagnitudeReceiver2D
-
Fourier2D.Scattering.
reflected
¶ Reflected field details.
Return type: optical.modal.Fourier2D.Reflected
-
Fourier2D.Scattering.
reflectivity
¶ Total reflection coefficient [%].
This differs from
Scattering.R
by unit.
-
Fourier2D.Scattering.
transmitted
¶ Transmitted field details.
Return type: optical.modal.Fourier2D.Transmitted
-
Fourier2D.Scattering.
transmittivity
¶ Total transmission coefficient [%].
This differs from
Scattering.T
by unit.