Effective index. More...

Inheritance diagram for plask::ModeEffectiveIndex:

Collaboration diagram for plask::ModeEffectiveIndex:

Static Public Attributes
static constexpr const char *	NAME = "effective index"

static constexpr const char *	UNIT = "-"

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< dcomplex >
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

Effective index.

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 propagation and losses.

Additional integer parameter is the mode number.

Definition at line 156 of file optical.hpp.

Member Data Documentation

constexpr const char * plask::ModeEffectiveIndex::NAME = "effective index"

staticconstexpr

Definition at line 157 of file optical.hpp.

constexpr const char * plask::ModeEffectiveIndex::UNIT = "-"

staticconstexpr

Definition at line 158 of file optical.hpp.

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