capacitance_python.cpp

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.
 */
#include <cmath>
#include <plask/python.hpp>
#include <plask/common/fem/python.hpp>
using namespace plask;
using namespace plask::python;
 
#include "../capacitance2d.hpp"
using namespace plask::electrical::capacitance;
 
template <typename __Class__>
inline static ExportSolver<__Class__> register_capacitance_solver(const char* name, const char* geoname) {
    ExportSolver<__Class__> solver(name,
                                   format(u8"{0}(name=\"\")\n\n"
                                          u8"Finite element AC electric solver for {1} geometry.",
                                          name, geoname)
                                       .c_str(),
                                   py::init<std::string>(py::arg("name") = ""));
    METHOD(compute, compute, u8"Run calculations");
    METHOD(get_ac_current, getAcCurrent,
        u8"Get total current flowing through active region (mA)\n\n"
        u8"Args:\n"
        u8"    nact (int): number of the active region\n"
        u8"    active (bool): if true, the active current (in phase with the voltage)\n"
        u8"                   is returned, otherwise the total current is returned\n\n"
        u8"Returns:\n"
        u8"    complex: computed total current (mA)",
        (py::arg("nact") = 0, py::arg("active") = false));
    RECEIVER(inTemperature, u8"");
    RECEIVER(inDifferentialConductivity, u8"");
    PROVIDER(outAcVoltage, u8"");
    PROVIDER(outAcCurrentDensity, u8"");
    BOUNDARY_CONDITIONS(voltage_boundary, u8"Boundary conditions of the first kind (constant potential)");
    RW_PROPERTY(frequency, getFrequency, setFrequency, u8"AC modulation frequency (MHz)");
    METHOD(get_impedance, getImpedance, u8"Get the impedance at the current frequency");
    METHOD(get_S11, getS11, u8"Get scattering parameter <i>S</i><sub>11</sub> at the current frequency\n\n"
                            u8"Args:\n"
                            u8"    Z0 (complex): reference impedance (default 50 Ω)\n\n"
                            u8"Returns:\n"
                            u8"    complex: computed S11 parameter",
                            (py::arg("Z0") = 50.));
 
    // solver.def_readwrite("algorithm", &__Class__::algorithm, "Chosen matrix factorization algorithm");
    solver.add_property("empty_elements", &__Class__::getEmptyElements, &__Class__::setEmptyElements,
                        "Should empty regions (e.g. air) be included into computation domain?");
 
 
    return solver;
}
 
BOOST_PYTHON_MODULE(capacitance) {
    register_capacitance_solver<Capacitance2DSolver<Geometry2DCartesian>>("Capacitance2D", "2D Cartesian");
    register_capacitance_solver<Capacitance2DSolver<Geometry2DCylindrical>>("CapacitanceCyl", "2D cylindrical");
}