electrical.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__ELECTRICAL_H
#define PLASK__ELECTRICAL_H
 
#include "plask/provider/providerfor.hpp"
 
namespace plask {
 
struct PLASK_API Potential: public ScalarFieldProperty {
    static constexpr const char* NAME = "potential";
    static constexpr const char* UNIT = "V";
};
 
struct PLASK_API Voltage: public ScalarFieldProperty {
    static constexpr const char* NAME = "voltage";
    static constexpr const char* UNIT = "V";
};
 
struct PLASK_API CurrentDensity: public VectorFieldProperty<> {
    static constexpr const char* NAME = "current density";
    static constexpr const char* UNIT = "kA/cm²";
};
 
struct PLASK_API CarriersConcentration: public MultiFieldProperty<double> {
    enum EnumType {
        PAIRS = 0,
        MAJORITY,
        ELECTRONS,
        HOLES
    };
    static constexpr size_t NUM_VALS = 4;
    static constexpr const char* NAME = "carriers concentration";
    static constexpr const char* UNIT = "1/cm³";
};
 
struct PLASK_API Conductivity: FieldProperty<Tensor2<double>> {
    static constexpr const char* NAME = "electrical conductivity";
    static constexpr const char* UNIT = "S/m";
};
 
struct PLASK_API FermiLevels: public MultiFieldProperty<double> {
    enum EnumType {
        ELECTRONS,
        HOLES
    };
    static constexpr size_t NUM_VALS = 2;
    static constexpr const char* NAME = "quasi-Fermi levels for electrons and holes";
    static constexpr const char* UNIT = "eV";
};
 
struct PLASK_API BandEdges: public MultiFieldProperty<double> {
    enum EnumType {
        CONDUCTION,
        VALENCE_HEAVY,
        VALENCE_LIGHT,
        SPIN_OFF
    };
    static constexpr size_t NUM_VALS = 2;
    static constexpr const char* NAME = "conduction and valence band edges";
    static constexpr const char* UNIT = "eV";
};
 
} // namespace plask
 
#endif // PLASK__ELECTRICAL_H