plask::ModeWavelength Struct Reference

Wavelength (nm). More...

#include <plask/properties/optical.hpp>

Inheritance diagram for plask::ModeWavelength:

Collaboration diagram for plask::ModeWavelength:

Static Public Attributes
static constexpr const char *	NAME = "wavelength"
static constexpr const char *	UNIT = "nm"
Static Public Attributes inherited from plask::Property< _propertyType, _ValueType2D, _ValueType3D, _ExtraParams >
static const PropertyType	propertyType = _propertyType
	Type of property.
static constexpr const char *	NAME = PropertyTypeToProviderName<_propertyType>::value
	Name of the property.
static constexpr bool	hasUniqueValueType = false
	true only if property use same value type in 2D and 3D space

Additional Inherited Members
Public Types inherited from plask::MultiValueProperty< double >
typedef size_t	EnumType
	Default value enumeration type.
Public Types inherited from plask::Property< _propertyType, _ValueType2D, _ValueType3D, _ExtraParams >
typedef _ValueType2D	ValueType2D
	Type of provided value in 2D space.
typedef _ValueType3D	ValueType3D
	Type of provided value in 3D space.
typedef VariadicTemplateTypesHolder< _ExtraParams... >	ExtraParams
	Extra parameters passed as arguments to provider to get value.
Static Public Member Functions inherited from plask::Property< _propertyType, _ValueType2D, _ValueType3D, _ExtraParams >
static ValueType2D	getDefaultValue2D ()
	Return default value of the property (usually zero) in 2D space.
static ValueType3D	getDefaultValue3D ()
	Return default value of the property (usually zero) in 3D space.

Detailed Description

Wavelength (nm).

It can be either computed by some optical solvers or set by the user.

It is a complex number, so it can contain information about both the wavelength and losses. Its imaginary part is defined as .

Additional integer parameter is the mode number.

Definition at line 122 of file optical.hpp.

Member Data Documentation

NAME

constexpr const char * plask::ModeWavelength::NAME = "wavelength"

staticconstexpr

Definition at line 123 of file optical.hpp.

UNIT

constexpr const char * plask::ModeWavelength::UNIT = "nm"

staticconstexpr

Definition at line 124 of file optical.hpp.

---

The documentation for this struct was generated from the following files:

• plask/properties/optical.hpp
• plask/properties/names.cpp