PLaSK library

Loading...
Searching...
No Matches
electrical.hpp
Go to the documentation of this file.
1/*
2 * This file is part of PLaSK (https://plask.app) by Photonics Group at TUL
3 * Copyright (c) 2022 Lodz University of Technology
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, version 3.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 */
14#ifndef PLASK__ELECTRICAL_H
15#define PLASK__ELECTRICAL_H
16
17#include <plask/provider/providerfor.hpp>
18
19 namespace plask {
20
24 struct PLASK_API Potential: public ScalarFieldProperty {
25 static constexpr const char* NAME = "potential";
26 static constexpr const char* UNIT = "V";
27};
28
32 struct PLASK_API Voltage: public ScalarFieldProperty {
33 static constexpr const char* NAME = "voltage";
34 static constexpr const char* UNIT = "V";
35};
36
41 struct PLASK_API CurrentDensity: public VectorFieldProperty<> {
42 static constexpr const char* NAME = "current density";
43 static constexpr const char* UNIT = "kA/cm²";
44};
45
50 struct PLASK_API CarriersConcentration: public MultiFieldProperty<double> {
51 enum EnumType {
52 PAIRS = 0,
53 MAJORITY,
54 ELECTRONS,
55 HOLES
56 };
57 static constexpr size_t NUM_VALS = 4;
58 static constexpr const char* NAME = "carriers concentration";
59 static constexpr const char* UNIT = "1/cm³";
60};
61
65 struct PLASK_API Conductivity: FieldProperty<Tensor2<double>> {
66 static constexpr const char* NAME = "electrical conductivity";
67 static constexpr const char* UNIT = "S/m";
68};
69
73 struct PLASK_API FermiLevels: public MultiFieldProperty<double> {
74 enum EnumType {
75 ELECTRONS,
76 HOLES
77 };
78 static constexpr size_t NUM_VALS = 2;
79 static constexpr const char* NAME = "quasi-Fermi levels for electrons and holes";
80 static constexpr const char* UNIT = "eV";
81};
82
86 struct PLASK_API BandEdges: public MultiFieldProperty<double> {
87 enum EnumType {
88 CONDUCTION,
89 VALENCE_HEAVY,
90 VALENCE_LIGHT,
91 SPIN_OFF
92 };
93 static constexpr size_t NUM_VALS = 2;
94 static constexpr const char* NAME = "conduction and valence band edges";
95 static constexpr const char* UNIT = "eV";
96};
97
98} // namespace plask
99
100#endif // PLASK__ELECTRICAL_H