plask::RefractiveIndex Struct Reference

Refractive index. More...

#include <plask/properties/optical.hpp>

Inheritance diagram for plask::RefractiveIndex:

Collaboration diagram for plask::RefractiveIndex:

Public Types
enum	EnumType { COMPONENT_VERT = 0 , COMPONENT_LONG = 1 , COMPONENT_TRAN = 2 }
Public Types inherited from plask::MultiFieldProperty< dcomplex, 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
static dcomplex	getDefaultValue ()
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.

Static Public Attributes
static constexpr size_t	NUM_VALS = 3
static constexpr const char *	NAME = "refractive 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

Detailed Description

Refractive index.

Definition at line 27 of file optical.hpp.

Member Enumeration Documentation

EnumType

enum plask::RefractiveIndex::EnumType

Enumerator
COMPONENT_VERT
COMPONENT_LONG
COMPONENT_TRAN

Definition at line 28 of file optical.hpp.

Member Function Documentation

getDefaultValue()

static dcomplex plask::RefractiveIndex::getDefaultValue ( )

inlinestatic

Definition at line 36 of file optical.hpp.

Member Data Documentation

NAME

constexpr const char * plask::RefractiveIndex::NAME = "refractive index"

staticconstexpr

Definition at line 34 of file optical.hpp.

NUM_VALS

constexpr size_t plask::RefractiveIndex::NUM_VALS = 3

staticconstexpr

Definition at line 33 of file optical.hpp.

UNIT

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

staticconstexpr

Definition at line 35 of file optical.hpp.

---

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

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