Programming Reference for VirtualLab Fusion  2025.1
Loading...
Searching...
No Matches
VirtualLabAPI.Core.FieldRepresentations Namespace Reference

Classes

struct  AdditionalCAImportParams
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Struct containing additional parameters for Import of ComplexAmplitude. More...
 
struct  ASCIIParam
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Structure that contains parameters for ASCII Export. More...
 
class  ChromaticFieldsSet
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a two-dimensional Chromatic Fields Set More...
 
class  ChromaticFieldsSet_1D
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a one-dimensional Chromatic Fields Set More...
 
class  ChromaticFieldsSetBase
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Abstract base class for a Chromatic Fields Set (can be 1D or 2D) More...
 
class  ComplexAmplitude
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
This class represents a complex amplitude of a wave (without time depending part) in a plane or a complex transmission function.
Both X and Y field components are stored. In general all functions are applied to both components.
The ComplexAmplitude class is used to represent globally polarized fields and transmissions, too.
The ComplexAmplitude class contains one or two ComplexField as mathematical representations for complex fields. See manual for details of physical interpretation.
The ComplexAmplitude class can contain some additional information about the radius (distance from the origin) of a spherical phase factor. Using this information field may contain a spherical phase factor that is undersampled. If the radius of the spherical phase factor is known, the whole complex amplitude at every point can be reconstructed. The radius of the spherical phase factor helps to reduce the number of sampling points. Functions that use the ComplexAmplitude class have to take into account this spherical phase information to avoid numerical errors.
Operators ( \(a+b\), \(a-b\), \(a*b\) and \(a/b\)) can be used. Passing \(a\) or \(b\) as Complex is supported. \(a^b\) can be applied for pointwise power function: \(a[x,y] ^ b\) \(b\) must be Complex. Operator \(a|b\) is used for calculation of inner product of two ComplexAmplitudes: \(a|b=\sum _{j=0}^{m}\sum _{i=0}^{n}a_{{i,j}}b_{{i,j}^{\star}}\) ( \(z^{\star}\) means conjugation of complex number.). More...
 
class  ComplexAmplitudeInterpolation
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
This class contains static member functions for interpolating a complex amplitude to another sampling grid. More...
 
class  ComplexAmplitudePointInterpolation
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
ComplexAmplitudePointInterpolation is a class with static members that are able to interpolate pointwise between different sampling points of a complex amplitude. The point to interpolate is specified in physical coordinates. Additionally for most interpolation methods a non-static optimized version is supported. These functions are optimized for an interpolation on an equidistant grid. Different interpolation methods are supported. For more information see [Lehmann1999]. More...
 
class  ComplexAmplitudeView
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class which combines a complex amplitude with view settings. More...
 
class  HarmonicFieldBase
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base class for Harmonic Fields and Harmonic Fields Sets. More...
 
class  HarmonicFieldMode
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class to represent a harmonic field mode More...
 
class  HarmonicFieldsSetEvaluation
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Evaluation functions for HarmonicFieldSet objects. More...
 
class  HarmonicFieldsSetView
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class which combines a harmonic fields set with view settings. More...
 
class  ImportExport
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Collection of static support functions for export and import of data fields. More...
 
class  RigorousSimulationResult1D
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for storing the results of rigorous calculations for which there is no modulation in y-direction. In this case the result is a line of orders. For each order the efficiency and Rayleigh coefficients are stored. More...
 
class  Transformations
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Fourier transformations on various representations of fields. More...
 
struct  WaveParameters
  Contains wave parameters used in ComplexAmplitude if WaveParameters are used. More...
 

Enumerations

enum  CombinedComponent { ExEy , EzEx , EzEy , ExEyEz }
  Used for selection of the combination of the field components in a ComplexAmplitude. More...
 
enum  ComplexAmplitudeType {
  JonesMatrixTransmission , GloballyPolSpatialComplexAmplitudeField , SpatialSignalRegion , NotSupported ,
  LocallyPolSpatialComplexAmplitudeField , GloballyPolSpectralComplexAmplitudeField , LocallyPolSpectralComplexAmplitudeField , SpectralSignalRegion
}
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Type of the ComplexAmplitude. The type is the physical interpretation of a ComplexAmplitude. More...
 
enum  PhaseDerivativeApproximationLevel {
  TEA_Approximation , AnalyticalLinearPhaseApproximation , AnalyticalLinearAndSphericalPhaseApproximation , AnalyticalLinearAndSphericalAndCylindricalPhaseApproximation ,
  PolynomialFit , NumericalPhaseDerivative , Not_Specified
}
 This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum which specifies the method for phase derivatives calculation. More...
 
enum  VectorialComponent { Ex , Ey , Ez }
 Enum describing the vectorial components of a field ( \(E_x\), \(E_y\), and \(E_z\)). More...
 

Enumeration Type Documentation

◆ CombinedComponent

Used for selection of the combination of the field components in a ComplexAmplitude.

Enumerator
ExEy 

Indicated the Ex and Ey field component.

EzEx 

Indicated the Ex and Ez field component.

EzEy 

Indicated the Ey and Ez field component.

ExEyEz 

Indicated the Ex, Ey and Ez field component.

◆ ComplexAmplitudeType

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Type of the ComplexAmplitude. The type is the physical interpretation of a ComplexAmplitude.

Enumerator
JonesMatrixTransmission 

A Jones matrix transmission.

GloballyPolSpatialComplexAmplitudeField 

A globally polarized spatial harmonic field.

SpatialSignalRegion 

A spatial signal region.

LocallyPolSpatialComplexAmplitudeField 

A locally polarized spatial harmonic field.

GloballyPolSpectralComplexAmplitudeField 

A globally polarized spectral harmonic field.

LocallyPolSpectralComplexAmplitudeField 

A locally polarized spectral harmonic field.

SpectralSignalRegion 

A spectral signal region.

◆ PhaseDerivativeApproximationLevel

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum which specifies the method for phase derivatives calculation.

Enumerator
TEA_Approximation 

Phase derivatives are set to zero. Thus all rays are parallel to the z-axis.

AnalyticalLinearPhaseApproximation 

The phase derivatives are calculated from a linear phase fit only.

AnalyticalLinearAndSphericalPhaseApproximation 

The phase derivatives are calculated from a spherical and an additional linear phase fit only.

AnalyticalLinearAndSphericalAndCylindricalPhaseApproximation 

The phase derivatives are calculated from a spherical, a linear, and a cylindrical phase fit.

PolynomialFit 

The phase derivatives are calculated from a polynomial phase decomposition.

NumericalPhaseDerivative 

The phase derivatives are calculated numerically from two points. No fit is applied.

Not_Specified 

// phase derivation by four-point derivative (no fit applied) //

Place holder a non-specified phase derivative computation.

◆ VectorialComponent

Enum describing the vectorial components of a field ( \(E_x\), \(E_y\), and \(E_z\)).

Enumerator
Ex 

Indicates the \(E_x\) component of a field.

Ey 

Indicates the \(E_y\) component of a field.

Ez 

Indicates the \(E_z\) component of a field.