optical.hpp

Go to the documentation of this file.

/*
 * This file is part of PLaSK (https://plask.app) by Photonics Group at TUL
 * Copyright (c) 2022 Lodz University of Technology
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
#ifndef PLASK__OPTICAL_H
#define PLASK__OPTICAL_H
 
#include <plask/math.hpp>
#include <plask/provider/providerfor.hpp>
#include <plask/provider/scaled_provider.hpp>
#include <plask/provider/combined_provider.hpp>
 
namespace plask {
 
struct PLASK_API RefractiveIndex: MultiFieldProperty<dcomplex, dcomplex> {
    enum EnumType {
        COMPONENT_VERT = 0,
        COMPONENT_LONG = 1,
        COMPONENT_TRAN = 2
    };
    static constexpr size_t NUM_VALS = 3;
    static constexpr const char* NAME = "refractive index";
    static constexpr const char* UNIT = "-";
    static inline dcomplex getDefaultValue() { return dcomplex(1.); }
};
 
struct PLASK_API Epsilon: FieldProperty<Tensor3<dcomplex>, dcomplex> {
    static constexpr const char* NAME = "permittivity tensor";
    static constexpr const char* UNIT = "-";
    static inline Tensor3<dcomplex> getDefaultValue() { return Tensor3<dcomplex>(1.); }
};
 
struct PLASK_API LightMagnitude: public FieldProperty<double> {
    static constexpr const char* NAME = "optical field magnitude";
    static constexpr const char* UNIT = "W/m²";
};
 
 
struct PLASK_API LightE: public FieldProperty<Vec<3,dcomplex>> {
    static constexpr const char* NAME = "electric field";
    static constexpr const char* UNIT = "V/m";
};
 
 
struct PLASK_API LightH: public FieldProperty<Vec<3,dcomplex>> {
    static constexpr const char* NAME = "magnetic field";
    static constexpr const char* UNIT = "A/m";
};
 
 
struct PLASK_API ModeLightMagnitude: public MultiFieldProperty<double> {
    static constexpr const char* NAME = "optical field magnitude";
    static constexpr const char* UNIT = "W/m²";
};
 
template <typename SpaceT>
struct LightMagnitudeSumProvider: public FieldSumProvider<ModeLightMagnitude, SpaceT> {};
 
 
struct PLASK_API ModeLightE: public MultiFieldProperty<Vec<3,dcomplex>> {
    static constexpr const char* NAME = "electric field";
    static constexpr const char* UNIT = "V/m";
};
 
 
struct PLASK_API ModeLightH: public MultiFieldProperty<Vec<3,dcomplex>> {
    static constexpr const char* NAME = "magnetic field";
    static constexpr const char* UNIT = "A/m";
};
 
 
struct PLASK_API ModeWavelength: public MultiValueProperty<double> {
    static constexpr const char* NAME = "wavelength";
    static constexpr const char* UNIT = "nm";
};
 
struct PLASK_API ModeLoss: public MultiValueProperty<double> {
    static constexpr const char* NAME = "modal extinction";
    static constexpr const char* UNIT = "1/cm";
};
 
struct PLASK_API ModePropagationConstant: public MultiValueProperty<dcomplex> {
    static constexpr const char* NAME = "propagation constant";
    static constexpr const char* UNIT = "1/µm";
};
 
struct PLASK_API ModeEffectiveIndex: public MultiValueProperty<dcomplex> {
    static constexpr const char* NAME = "effective index";
    static constexpr const char* UNIT = "-";
};
 
} // namespace plask
 
#endif // PLASK__OPTICAL_H