Programming Reference for VirtualLab Fusion
2025.1
|
Classes | |
class | AxisRotationSequence |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for describing a sequence of rotations about coordinate axes More... | |
class | CartesianCoordinateSystem |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for right-handed Cartesian coordinate systems. More... | |
class | CFieldDerivative1DReal |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class derived from ComplexField, designed especially for one dimensional, real valued data. More... | |
class | ColorMapping |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Used to describe the color mapping between a ComplexAmplitude and a bitmap. Colors from StartColor to EndColor are linearly mapped to double values from StartValue to EndValue. Optional a third color can be inserted in the middle. All parameters are stored separately for each FieldQuantity. More... | |
struct | Complex |
This struct holds a complex number. Operators ( \(a+b\), \(a-b\), \(a*b\), \(a/b\) and \(a^b\)) can be used. Passing \(a\) or \(b\) as double is supported. More... | |
class | ComplexField |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. This class is a matrix of complex values. If no imaginary part is needed (real valued fields) one can set a special flag that indicates a real valued field (ComplexField with imaginary part zero). This different internal representations are used to optimize the computer memory and computational time. Operators ( \(a+b\), \(a-b\), \(a*b\) and \(a/b\)) can be used. Passing \(a\) or \(b\) as Complex or double is supported (Except of \(/\), only \(b\) may be a scalar). Operator \(a|b\) is used for calculation of inner product of two ComplexFields: \(a|b=\sum _{j=0}^{m}\sum _{i=0}^{n}a_{{i,j}}b_{{i,j}^{\star}}\) ( \(z^{\star}\) means conjugation of complex number.). IsComplex property is always taken from first operand. More... | |
class | ComplexField1DArray |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class to encapsulate an array of objects of type ComplexFieldDerivative1D. It also ensures that all entries are either complex or real valued. More... | |
class | ComplexFieldArray |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class to encapsulate an array of objects of type ComplexField. More... | |
class | ComplexFieldDerivative1D |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class derived from ComplexField, designed especially for one dimensional data. More... | |
class | ComplexFieldInterpolation |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. This class contains static member function to interpolate a ComplexField to another sampling grid. More... | |
class | ComplexFieldPointInterpolation |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. ComplexFieldPointInterpolation is a class with static members that are able to interpolated pointwise between different sampling points of a ComplexField. Additionally a non static-optimized version is supported for most interpolation methods. These functions are optimized for an interpolation on an equidistant grid. Different interpolation methods are supported. For more information see [Lehmann1999]. More... | |
class | CoordinateSystemBaseVectors |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for the base vectors of a Cartesian coordinate system. This kind of triple vector is also called "trihedron". More... | |
class | CoordinateTransformations |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Provides static conversion functions from one coordinate system to another one, among others More... | |
class | DataArray1D |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for objects that store data in C^N which are equidistant or non equidistant distributed in R^1 More... | |
class | DataArray2D |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for objects that store gridded data in C^N which are equidistant or non equidistant distributed in R^2 More... | |
class | DataArrayBase |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Abstract class for storing a map R^M → C^N More... | |
class | DataArrayGridLess |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for objects that store data in C^N which are arbitrarily distributed (i.e. not on a grid) in ℝ^M More... | |
class | DirectionByDirectionAngles |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining directions by direction angles. More... | |
class | DirectionByRotationMatrix |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining directions by applying a rotation matrix to a starting vector. More... | |
class | DirectionByRotationSequence |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining directions by applying a sequence of axis rotations to a starting vector. More... | |
class | EulerAnglesSet |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Struct for Euler angles, following the Z-X'-Z'-convention. More... | |
class | ExtrapolationInfo |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class which holds information about extrapolation of 1D and 2D data with a finite domain of definition. The extrapolation information tells how to operate outside of the definition domain. More... | |
interface | IOrientationDefinition |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Interface to be implemented by all classes that describe a rotation definition More... | |
interface | IProvidesPositioningReferences |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Interface to be implemented by all classes that contain coordinate systems that can serve as positioning references More... | |
interface | IRegion1D2D |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Interface to connect 1D and 2D regions. More... | |
class | MathFunctions |
This class contains various mathematical functions and constants. More... | |
class | Matrix3x3C |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. This class defines a 3x3 Matrix of complex numbers. Operators ( \(a+b\), \(a-b\)). Operator ( \(a*b\)) supports \(b\) as complex or Vector3C as well. More... | |
class | Matrix3x3D |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. This class defines a 3x3 Matrix of double numbers. Operators ( \(a+b\), \(a-b\)). Operator ( \(a*b\)) supports \(b\) as double or VectorD as well. More... | |
class | OrientationByCartesianAngles |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining orientations by Cartesian angles, i.e. the angles between the projection of the direction to be defined onto the x-z-plane and the z-axis (alpha), and between the projection of the direction to be defined onto the y-z-plane and the z-axis (beta). More... | |
class | OrientationByDirectionAngles |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining orientations by direction angles, i.e. the angles between the direction to be defined and each of the Cartesian axis respectively. More... | |
class | OrientationByEulerAngles |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining orientations by Euler angles. More... | |
class | OrientationByMatrix |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining orientations via rotation matrix. More... | |
class | OrientationBySphereAngles |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. A class for defining orientations by sphere angles. More... | |
class | OrientationDefinitionBase |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Base for all classes that describe a rotation definition. More... | |
class | OrientedPlane |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for objects that describe planes with a right-hand orientation. Data are stored in parametrized form, i.e. as one point and two vectors. The third base vector gives the orientated normal vector. More... | |
class | PhysicalUnit |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Association between unit string and corresponding factor. More... | |
class | PhysicalValue |
class for a double value with a physical unit. More... | |
class | PhysicalValueBase |
Base class for a complex or double value with a physical unit. More... | |
class | PhysicalValuePair |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for a pair of physical values. More... | |
class | PhysicalValueRange |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for a range of physical values. More... | |
class | Position |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class to describe a position object, that is a point in R^3, with reference information added. More... | |
class | PositionedLine |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for objects that describe positioned lines in space More... | |
class | SamplingParameters |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. This class contains parameters for proper sampling of a complex field. More... | |
class | SimpleRotation |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Class for describing a rotation about one of the coordinate axes or by a certain predefined angle More... | |
class | Transformations |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Contains static functions that perform transformations of one or two ComplexField like Fourier Transform of Convolution. More... | |
struct | Vector |
This struct defines a two-dimensional vector of integer numbers. Operators \(a+b\), \(a-b\) and \(a|b\) (Scalar product) can be used. One operand on \(a*b\) and \(a/b\) can be an integer too. Implicit casting to System.Drawing.Point and System.Drawing.Size is supported. More... | |
struct | Vector3C |
This class defines 3-dimensional vectors of complex numbers. The class saves the x,y and z coordinates. More... | |
struct | Vector3D |
This struct defines a three dimensional vector of double numbers. Operators \(a+b\), \(a-b\) and \(a|b\) (Scalar product) can be used. Second operand on \(a*b\), \(a/b\) and \(a^b\) (applied separate on components) can be a double too. More... | |
struct | VectorB |
This struct defines a two-dimensional vector of boolean values. More... | |
struct | VectorC |
This struct defines a two-dimensional vector of complex numbers. Operators \(a+b\), \(a-b\) and \(a|b\) (Scalar product) can be used. One operand on \(a*b\), \(a/b\) (applied separate on components) can also be a Complex. Implicit casting from Vector is supported. More... | |
struct | VectorD |
This struct defines a two-dimensional vector of double numbers. Operators \(a+b\), \(a-b\) and \(a|b\) (Scalar product) can be used. One operand on \(a*b\), \(a/b\) (applied separate on components) can be also a double. It is also possible to raise a VectorD to a given power ( \(a^b\)). Implicit casting from Vector is supported. More... | |
struct | VectorL |
This struct defines a two-dimensional vector of long numbers. Operators \(a+b\), \(a-b\) and \(a|b\) (Scalar product) can be used. One operand on \(a*b\) and \(a/b\) can be an long too. More... | |
Enumerations | |
enum | AxisDirection { X , Y , Z } |
These enum flags are used to indicate different directions. More... | |
enum | ComplexPart { ExtractPhase , ExtractAmplitude , ExtractImaginary , ExtractReal , ExtractSquaredAmplitude , ShiftRealToPhase , ShiftImaginaryToReal , ShiftRealToImaginary , ShiftPhaseToReal , SwapRealImaginary , NoChangings } |
This enum lists actions a function can perform on the ComplexPart of a Complex number like extracting, shifting and swapping. More... | |
enum | ComplexToStringConversionFormat { RealImaginary , AmplitudePhase , PTF , Matlab } |
Output formats which are supported by the Complex.ToString() method and by the Complex.Parse() method. More... | |
enum | DirectionDefinitionType { Vector , SphericalAngles , DirectionAngles , CartesianAngles , AxisRotationSequence , RotationMatrix } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum for different types of definition for directions More... | |
enum | ExtrapolationType { Constant , BorderContinuation , Periodic } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum for the mode of extrapolation, applied to a ComplexField if coordinates outside its definition area are needed. More... | |
enum | FieldQuantity { RealPart , ImaginaryPart , Amplitude , Phase , SquaredAmplitude , SummedSquaredAmplitudes } |
Enumerator containing the distinct components of a Complex number. More... | |
enum | IndependentDirectionAngles { RhoSigma , SigmaTau , TauRho } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum to differentiate possible combinations of independent direction angles. More... | |
enum | InterpolationMethod { SincFFT , SincPointwise , TruncatedSinc , Linear_AmplitudeAndPhase , Nearest , Cubic4P , Cubic6P , Cubic8P , WindowedSinc , Combined , AcceleratedSinc , Linear_RealAndImaginaryPart } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enumeration of constants for different interpolation types. (See manual for details) More... | |
enum | InterpolationMethodForNonequidistantData { ConstantInterval , LinearOnRealAndImaginaryPart , LinearOnAmplitudeAndPhase } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum for the different methods of interpolation for non equidistant data More... | |
enum | OrientationDefinitionType { SphericalAngles , DirectionAngles , CartesianAngles , EulerAngles , AxisRotationSequence , RotationMatrix } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum for different types of definition for rotations of vectors, planes or solids More... | |
enum | PhysicalProperty { NoUnit , Length , AngleRad , AngleDeg , Time , WaveNumber , AbsorptionCoefficient , Percentage , Power , ElectricalField , TemporalFrequency , PowerPerArea , PowerPerVolume , AreaPerEnergy , VolumePerEnergy , AreaPerEnergySquared , VolumePerEnergySquared , EnergyPerArea , EnergyPerVolume , PowerPerSolidAngle , PowerPerSolidAngleAndArea , Illuminance , Luminance , LuminousIntensity , ArbitraryUnit , LogarithmicLevel , ElectricFieldStrengthSquared , MagneticFieldStrength , MagneticFieldStrengthSquared , PowerPerAreaSquared , PerVolume , Energy , Temperature , Pressure , ResolvingCapacity , ElectricFieldStrengthSpectral , MagneticFieldStrengthSpectral , ElectricFieldStrengthSpectralSquared , MagneticFieldStrengthSpectralSquared , SpectralRadiantFlux , SpectralRadiantEnergyDensity , SpectralRadiantIntensity , LuminousEnergyDensity , EnergyJoule , LuminousFlux , SpectralRadiantEnergy , LuminousEnergy , Information_Binary , Information_Decimal , TemperatureKelvin , UserDefined } |
Supported physical units. More... | |
enum | PositionRelationOfGeometricalObjects { Parallel , Intersecting , Containedness , SkewLines } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum for the types of position relations of lines and planes More... | |
enum | PrecisionMode { Double , Float , Short , Long } |
This enumerator lists precisions of the internal complex number representation of the ComplexField class supported by VirtualLab. Different internal representations are used to save computer memory and to increase the calculation speed in case of calculations that need not such a high accuracy. More... | |
enum | RotationAxisOrAngleName { EulerAnglePhi , EulerAngleTheta , EulerAnglePsi , SphereAnglePhi , SphereAngleTheta , DirectionAngleRho , DirectionAngleSigma , DirectionAngleTau , CartesianAngleAlpha , CartesianAngleBeta , AxisRotationX , AxisRotationY , AxisRotationZ } |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab. Enum for all kinds of angles that are to be used within classes implementing IOrientationDefinition. More... | |
Functions | |
double[] | BivariateFunction (double parameter1, double parameter2) |
Delegate for a real valued function(s) which depend(s) on two variables. | |
Complex | ComplexFunction (double x, double y) |
This is intended for callbacks to a function from ℝ² to ℂ. | |
double | RealFunction (double x, double y) |
This is intended for callbacks to a function from ℝ² to ℝ. | |
double | RealFunctionIntersection (Vector3D startPosition, Vector3D direction, double distanceOnRay) |
Delegate for a function which returns a real value (distance to surface) for a specific distance on the ray (starting at the start position with the given direction). | |
double | RealFunctionWithSingleArgument (double x) |
Delegate for computing integrals of real functions from ℝ to ℝ; | |
VectorD | RealVectorDFunction (double x, double y) |
This is intended for callbacks to a function from ℝ² to ℝ². | |
enum AxisDirection |
enum ComplexPart |
This enum lists actions a function can perform on the ComplexPart of a Complex number like extracting, shifting and swapping.
Output formats which are supported by the Complex.ToString() method and by the Complex.Parse() method.
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum for different types of definition for directions
enum ExtrapolationType |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum for the mode of extrapolation, applied to a ComplexField if coordinates outside its definition area are needed.
enum FieldQuantity |
Enumerator containing the distinct components of a Complex number.
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum to differentiate possible combinations of independent direction angles.
enum InterpolationMethod |
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enumeration of constants for different interpolation types. (See manual for details)
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum for the different methods of interpolation for non equidistant data
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum for different types of definition for rotations of vectors, planes or solids
enum PhysicalProperty |
Supported physical units.
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum for the types of position relations of lines and planes
enum PrecisionMode |
This enumerator lists precisions of the internal complex number representation of the ComplexField class supported by VirtualLab. Different internal representations are used to save computer memory and to increase the calculation speed in case of calculations that need not such a high accuracy.
This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Enum for all kinds of angles that are to be used within classes implementing IOrientationDefinition.
double[] BivariateFunction | ( | double | parameter1, |
double | parameter2 | ||
) |
Delegate for a real valued function(s) which depend(s) on two variables.
parameter1 | First independent variable. |
parameter2 | Second independent variable. |
Complex ComplexFunction | ( | double | x, |
double | y | ||
) |
This is intended for callbacks to a function from ℝ² to ℂ.
x | The x-coordinate. |
y | The y-coordinate. |
double RealFunction | ( | double | x, |
double | y | ||
) |
This is intended for callbacks to a function from ℝ² to ℝ.
x | The x-coordinate. |
y | The y-coordinate. |
double RealFunctionIntersection | ( | Vector3D | startPosition, |
Vector3D | direction, | ||
double | distanceOnRay | ||
) |
Delegate for a function which returns a real value (distance to surface) for a specific distance on the ray (starting at the start position with the given direction).
startPosition | The 3D start position |
direction | The 3D direction |
distanceOnRay | The distance on the ray. |
double RealFunctionWithSingleArgument | ( | double | x | ) |
Delegate for computing integrals of real functions from ℝ to ℝ;
x | abscissa |
VectorD RealVectorDFunction | ( | double | x, |
double | y | ||
) |
This is intended for callbacks to a function from ℝ² to ℝ².
x | The x-coordinate. |
y | The y-coordinate. |