plask::optical::modal::GradientFunctions Struct Reference

#include <solvers/optical/modal/fourier/expansion3d.hpp>

Inheritance diagram for plask::optical::modal::GradientFunctions:

Collaboration diagram for plask::optical::modal::GradientFunctions:

Public Types
enum	EnumType { COS2 = 0 , COSSIN = 1 }
Public Types inherited from plask::MultiFieldProperty< 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 Attributes
static constexpr size_t	NUM_VALS = 2
static constexpr const char *	NAME = "refractive index gradient functions cos² and cos·sin"
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
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

Definition at line 26 of file expansion3d.hpp.

Member Enumeration Documentation

EnumType

enum plask::optical::modal::GradientFunctions::EnumType

Enumerator
COS2
COSSIN

Definition at line 27 of file expansion3d.hpp.

Member Data Documentation

NAME

constexpr const char * plask::optical::modal::GradientFunctions::NAME = "refractive index gradient functions cos² and cos·sin"

staticconstexpr

Definition at line 32 of file expansion3d.hpp.

NUM_VALS

constexpr size_t plask::optical::modal::GradientFunctions::NUM_VALS = 2

staticconstexpr

Definition at line 31 of file expansion3d.hpp.

UNIT

constexpr const char * plask::optical::modal::GradientFunctions::UNIT = "-"

staticconstexpr

Definition at line 33 of file expansion3d.hpp.

---

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

• solvers/optical/modal/fourier/expansion3d.hpp
• solvers/optical/modal/fourier/expansion3d.cpp